🟦 LuxNix - Professional NixOS Configuration Framework

A comprehensive NixOS configuration framework designed for research and development environments, emphasizing security, reproducibility, and automated deployment. Built using Snowfall Lib and Nixicle, this architecture easily manages multiple systems and user environments with a focus on enabling fast GPU computing and secure networking.

It provides a securely encrypted setup for study laptops, enabling research on protected data. This enables cooperation among research centers.

This infrastructure was built in the context of the ColoReg study. Here the main use case will be gathering medical study data.

🔎 Overview

Table Of Contents - automatically generated

Shortcuts For Easy LuxNix Usage

Common Errors In LuxNix

Prerequisites

• NixOS installation media
• UEFI-capable system
• Storage device (NVMe or SATA)
• USB drive for boot decryption (optional)
• FIDO2 security key (optional)

Example Of Deploying LuxNix: Deployment Guide

LUKS Secrets Management

Boot Decryption & USB Stick Setup

Service Management

Access Management

Tools For Development

🛠️ Initial Setup

1. Verify UEFI boot mode
2. Prepare storage devices
3. Set up LUKS encryption
4. Follow hardware setup guide

References for the NixOS Setup used:

• Nixicle https://github.com/hmajid2301/nixicle
• Snowflakes OS Quickstart https://snowfall.org/guides/lib/quickstart/

🛠 Getting Started

Prerequisites

• NixOS installation media
• Basic understanding of Nix flakes
• Hardware compatible with NixOS

Quick Start

1. Boot from NixOS installation media
2. Follow the deployment guide in the Wiki
3. Choose appropriate system configuration from systems/x86_64-linux/

Deployment

# Clone the repository
git clone https://github.com/wg-lux/luxnix.git

# Deploy to a new system
nixos-anywhere --flake '.#hostname' nixos@ip-address

# Update existing system
nh os switch
nho #shortcut

📁 Repository Structure

luxnix/
├── flake.nix           # Main flake configuration
├── modules/            # Modular system configurations
│   ├── home/          # Home-manager configurations
│   └── nixos/         # System-level configurations
├── systems/           # Per-machine configurations
└── homes/            # User-specific configurations

🔒 Security Features

• LUKS2 encryption with FIDO2 device support
• Secure boot configuration (optional)
• VPN integration for secure networking
• Role-based access control
• Secrets management with SOPS

🖥️ Supported System Types

• Development Workstations (gc-*)

  • Hybrid GPU configurations
  • Development toolchain preinstalled
  • Desktop environment with KDE and Plasma on Linux (NixOS Distro)

• Servers (s-*)

  • Infrastructure to outsource computation
  • Monitoring systems
  • Network services

📚 Documentation

Comprehensive documentation is available in the Luxnix Wiki:

• Deployment Guide
• Network Architecture
• Service Configuration
• Hardware Setup
• User Management

🛟 Support

For issues and questions:

• Create an issue in the repository
• Check the Luxnix Wiki for documentation
• Review the deployment guide for common problems

Keycloak and Nextcloud login

Make sure account has been created.

Step 1: Access Keycloak

Please visit the following link:
https://keycloak.endo-reg.net/
Use the provided credentials to log in.

Step 2: Complete Required Actions

After logging in, you will be automatically guided through the following steps:

• Verify your email address
• Set up OTP (two-factor authentication)
• Change your password

Make sure to complete all steps.

Step 3: Log In to Nextcloud

Once all steps are completed, go to:
https://cloud.endo-reg.net/login

Click "Login with Keycloak".

You can now use your Keycloak credentials to access Nextcloud.

Ste 4: Log In to Nextcloud Mobile Application

Download the mobile app. Use this link: https://cloud.endo-reg.net Enter credential/login using keyscloak

📚 Documentation Wiki

The following documents have been moved from the repository into the Luxnix Wiki for easier access and centralized maintenance:

Luxnix Documentation

• Installation Guide - NixOS and Setting Up Luxnix
• Flake.nix & Garbage Collection
• Access Management
• Roles
• LX Cheatsheet
• tmux CLI Cheatsheet
• Deployment Guide
• Development
• Hardware Setup
• Network Architecture
• Security Improvements
• Security
• Service Architecture
• User Management
• Systemd tmpfiles Rules in NixOS
• Common Errors
• NixOs Configuration Testing with Eval
• System Language Change
• Roles Documentation
• Doc Maintenance Schedule
• Luxnix Server Setup with example

Database Documentation

• Postgres Config Guide
• Postgres Documentation
• Postgres gc-10 Declarative Setup Summary
• Endoreg Central Architecture

Ansible

• Readme
• Ansible CMDB Readme
• Process flow of creating Hosts, Roles, Groups
• Adding a New User Configuration
• Maintenance & Security: Auto Update #6
• Home Configuration Autoconf Flow (Step-by-Step)
• Guide to Define New Setting With Example
• Autoconfig- create inventory.yml using Python Script
• Updated : Generating home config files using autoconfig

Devlog

• git
• vscode
• fix_long_lines
• kernel
• keycloak-setup
• network
• setup-mail
• setup-s04
• syncthing
• 2025-01-29 - postgres

Figures

• Diagram for Luxnix
• Cloudflare-traefik
• Forward Auth Sonarr
• HTTP Basic Auth
• tls-cloudflare-issue
• Tunnel Order
• update-outpost

Miscellaneous

• Style Guide

📜 License

MIT - see LICENSE

Built with ❄️ using NixOS