ragusa-it/nixos
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

update README.md

Browse Source
This commit is contained in:
Melvin Ragusa
2026-02-04 10:18:21 +01:00
parent 6b920fe785
commit 63b634d0de
2 changed files with 237 additions and 214 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
.gitconfig
View File

@@ -1,11 +0,0 @@
[safe]
directory = /home/pinj/nixos
[credential "https://github.com"]
helper =
helper = !/run/current-system/sw/bin/gh auth git-credential
[credential "https://gist.github.com"]
helper =
helper = !/run/current-system/sw/bin/gh auth git-credential
[user]
email = kontakt@ragusa-it.dev
name = Melvin Ragusa

440
README.md
View File

@@ -1,281 +1,315 @@
# 🐧 Atlas - NixOS Configuration # Atlas - NixOS Desktop Configuration
A modular, flake-based NixOS configuration for a desktop workstation optimized for gaming, development, and daily use. A modular, flake-based NixOS configuration for a high-performance desktop workstation with AMD GPU, optimized for gaming and development.
## ✨ Features ## Features
- **🎮 Gaming-Ready**: Steam with Proton-GE, Lutris, Heroic, Faugus Launcher, Gamemode with AMD GPU optimizations - **Nix Flakes** - Reproducible, declarative system configuration
- **🖥️ Wayland-Native**: Niri compositor with Noctalia shell and modern Wayland tooling - **CachyOS Kernel** - Performance-optimized kernel with sched-ext scheduler
- **⚡ Performance**: CachyOS kernel (x86_64-v3) with scx_lavd scheduler for low-latency gaming - **Wayland Desktop** - Niri compositor with Noctalia shell
- **🛠️ Development**: Docker, Node.js 22, Rust (rustup), Python 3, Bun, and modern CLI tools - **AMD GPU** - Full Vulkan, VA-API, and overclocking support via CoreCtrl
- **🎨 Theming**: Adwaita dark theme, Papirus icons, JetBrains Mono & Inter fonts - **Gaming Ready** - Steam, Proton-GE, Gamemode, Gamescope, Wine, Lutris
- **🎵 Media**: Navidrome music server, PipeWire audio with JACK support, full Bluetooth codec support - **Development** - Docker, direnv, modern CLI tools, multiple language runtimes
- **🔒 Security**: Secure Boot with Limine bootloader - **Audio** - PipeWire with high-quality Bluetooth codecs (LDAC, AAC, aptX)
- **Secure Boot** - Limine bootloader with Secure Boot support
## 📁 Structure ## Quick Start
```bash
# Clone the repository
git clone https://github.com/ragusa-it/nixos.git
cd nixos
# Test configuration (recommended first)
sudo nixos-rebuild test --flake .#nixos
# Apply configuration
sudo nixos-rebuild switch --flake .#nixos
```
## Repository Structure
``` ```
nixos/ nixos/
├── flake.nix # Flake definition with inputs ├── flake.nix # Flake inputs and outputs
├── flake.lock # Locked dependencies ├── flake.lock # Pinned dependency versions
├── configuration.nix # Main config (boot, networking, user, localization) ├── configuration.nix # Main config (imports all modules)
├── hardware-configuration.nix # Auto-generated hardware config (don't edit) ├── hardware-configuration.nix # Auto-generated hardware config
├── AGENTS.md # Guidelines for AI agents
└── modules/ └── modules/
├── apps.nix # User applications (media, productivity, communication) ├── apps.nix # User applications
├── audio.nix # PipeWire, Bluetooth codecs, audio controls ├── audio.nix # PipeWire & Bluetooth audio
├── desktop.nix # Wayland, XDG portals, polkit, Vicinae launcher ├── boot-plymouth.nix # Plymouth boot splash
├── dev.nix # Docker, languages, build tools, CLI utilities ├── desktop.nix # Wayland, portals, polkit
├── gaming.nix # Steam, Gamemode, launchers, Wine/Proton ├── dev.nix # Docker, dev tools, languages
├── gpu-amd.nix # AMD drivers, Vulkan, VA-API, CoreCtrl ├── gaming.nix # Steam, Gamemode, Wine
├── navidrome.nix # Music streaming server ├── gpu-amd.nix # AMD GPU drivers & tools
├── power.nix # Power profiles daemon, CPU governor ├── navidrome.nix # Music streaming server
├── services.nix # System services (fstrim, zram, avahi, psd, earlyoom) ├── power.nix # Power management
├── shell.nix # Fish shell config with plugins and aliases ├── services.nix # System services
└── theming.nix # Fonts, GTK/Qt themes, cursors, dconf ├── shell.nix # Fish shell config
└── theming.nix # Fonts, themes, cursors
``` ```
## 🚀 Flake Inputs ## Flake Inputs
| Input | Description | | Input | Description |
|-------|-------------| |-------|-------------|
| `nixpkgs` | NixOS unstable channel | | `nixpkgs` | NixOS unstable channel |
| `nix-cachyos-kernel` | CachyOS optimized kernel with x86_64-v3 | | `nix-cachyos-kernel` | CachyOS performance-optimized kernels |
| `noctalia` | Noctalia desktop shell | | `noctalia` | Noctalia desktop shell |
| `zen-browser` | Zen Browser (Firefox-based) | | `zen-browser` | Zen Browser (Firefox fork) |
| `opencode` | OpenCode AI coding assistant | | `opencode` | AI coding assistant |
## 📦 Installation ## Module Overview
### Prerequisites ### Desktop Environment
- NixOS installed with flakes enabled | Component | Choice |
- AMD CPU and GPU (configuration includes AMD-specific optimizations) |-----------|--------|
- UEFI system (for Secure Boot support) | Compositor | Niri (Wayland) |
| Shell | Noctalia |
| Display Manager | Ly |
| Terminal | Ghostty |
| File Manager | Nautilus |
| Editor | Zed |
| Browser | Zen Browser, Firefox |
### Steps ### Hardware Configuration
1. **Clone this repository:** | Hardware | Configuration |
```bash |----------|---------------|
git clone https://github.com/ragusa-it/nixos.git /etc/nixos | CPU | AMD Ryzen with `amd_pstate=active` |
``` | GPU | AMD with RADV, VA-API, CoreCtrl |
| Audio | PipeWire (ALSA, PulseAudio, JACK) |
| Bluetooth | Enabled with LDAC, AAC, aptX codecs |
2. **Generate hardware configuration:** ### Gaming Stack
```bash
sudo nixos-generate-config --show-hardware-config > /etc/nixos/hardware-configuration.nix
```
3. **Update the configuration:** | Component | Description |
- In `flake.nix`: Change `username = "pinj"` to your username |-----------|-------------|
- In `configuration.nix`: | Steam | With Proton-GE, remote play, LAN transfers |
- Update `networking.hostName` if desired | Gamemode | CPU/GPU optimization during gaming |
- Adjust `time.timeZone` (currently "Europe/Berlin") | Gamescope | Micro-compositor for games |
- Review and adjust locale settings | Lutris | Game launcher |
- Update secondary storage mount points or remove them | Heroic | Epic/GOG launcher |
- Review keyboard layout (currently German) | Wine | Latest staging with winetricks |
| Scheduler | `scx_lavd` low-latency scheduler |
4. **Rebuild the system:** ### Development Tools
```bash
sudo nixos-rebuild switch --flake .#nixos
```
5. **(Optional) Set up Secure Boot:** | Category | Tools |
```bash |----------|-------|
sudo sbctl create-keys | Containers | Docker, docker-compose, lazydocker |
sudo sbctl enroll-keys -m | Languages | Node.js, Bun, Python, Rust |
``` | Build | gcc, cmake, make, pkg-config |
| Version Control | git, gh, lazygit, delta |
| CLI | ripgrep, fd, fzf, eza, bat, jq, yq |
6. **Flatpak is auto-configured** - Flathub repository is automatically added on system activation ## Shell Aliases
## 🔧 Usage The Fish shell is configured with useful aliases:
```bash
# NixOS
rebuild # sudo nixos-rebuild switch --flake .
rebuild-test # sudo nixos-rebuild test --flake .
update # nix flake update
gc-nix # sudo nix-collect-garbage -d
# Git shortcuts
gs, gd, gl, ga, gc, gp, gpu, gco, gb
# Docker shortcuts
dc, dps, dpa, dl, dex
# Modern replacements
ll, ls, cat, find, grep, df, du # → eza, bat, fd, rg, duf, dust
```
## Common Tasks
### Rebuild System ### Rebuild System
```bash ```bash
# Test configuration without switching # Test without switching (dry-run)
sudo nixos-rebuild test --flake .#nixos sudo nixos-rebuild test --flake .#nixos
# Switch to new configuration # Apply changes
sudo nixos-rebuild switch --flake .#nixos sudo nixos-rebuild switch --flake .#nixos
# Build and set as boot default (without switching) # Rebuild for next boot only
sudo nixos-rebuild boot --flake .#nixos sudo nixos-rebuild boot --flake .#nixos
``` ```
### Update Flake Inputs ### Update Dependencies
```bash ```bash
# Update all inputs # Update all flake inputs
nix flake update nix flake update
# Update specific input # Update specific input
nix flake lock --update-input nixpkgs nix flake update nixpkgs
```
### Search and Install Packages
```bash
# Search for packages
nix search nixpkgs <package-name>
# Aliases available in Fish shell
search <package-name> # Same as above
``` ```
### Garbage Collection ### Garbage Collection
Automatic garbage collection is configured weekly, but you can run it manually:
```bash ```bash
# Collect garbage older than 14 days # Manual cleanup (removes generations older than 14 days)
sudo nix-collect-garbage --delete-older-than 14d sudo nix-collect-garbage --delete-older-than 14d
# Optimize store # List generations
nix-store --optimise nix-env --list-generations
# Remove all old generations
sudo nix-collect-garbage -d
``` ```
## 🖥️ Desktop Environment ### Package Management
- **Compositor**: Niri (scrollable tiling Wayland compositor) ```bash
- **Display Manager**: Ly # Search for packages
- **Terminal**: Ghostty nix search nixpkgs <package>
- **Browser**: Zen Browser (primary), Firefox
- **File Manager**: Nautilus (GNOME Files)
- **Editors**: Zed Editor, Claude Code, OpenCode
## 🎮 Gaming # Install user GUI apps (via nix profile)
nix profile install nixpkgs#<package>
The gaming module provides: # Update user apps
nix profile upgrade '.*'
- **Steam** with Proton-GE for enhanced Windows game compatibility # List installed user apps
- **Gamemode** for automatic CPU/GPU performance optimizations nix profile list
- **Game Launchers**: Lutris, Heroic (Epic/GOG), Faugus Launcher ```
- **Wine Support**: Wine Staging with Winetricks and Protontricks
- **Gamescope** micro-compositor for fixing problematic games
- **Kernel Tweaks**: Increased inotify watchers, optimized swap settings
### AMD GPU Optimizations ### Validate Configuration
- **CoreCtrl** for fan curves, overclocking, and GPU monitoring ```bash
- Full power management features enabled (`amdgpu.ppfeaturemask=0xffffffff`) # Quick syntax check
- **RADV** (Mesa Vulkan) driver - best for gaming nix flake check
- **VA-API** hardware video acceleration (decode/encode)
- **Monitoring Tools**: radeontop, nvtop (AMD edition)
- **Vulkan Tools**: vulkan-tools, vulkan-loader for debugging
## 🛠️ Development # Show flake outputs
nix flake show
```
Included tools: ## Services
- **Languages**: Node.js 22, Python 3, Rust (via rustup), Bun | Service | Port | Description |
- **Containers**: Docker with weekly auto-prune, Docker Compose |---------|------|-------------|
- **Environment Management**: direnv with nix-direnv for per-project environments | Navidrome | 4533 | Music streaming (localhost only) |
- **Build Tools**: gcc, gnumake, cmake, pkg-config | Tailscale | - | Mesh VPN |
- **Version Control**: git, gh (GitHub CLI), delta (better diffs), lazygit | SSH | 22 | Remote access |
- **CLI Utilities**:
- Search: ripgrep, fd, fzf
- Files: eza, bat, broot
- Data: jq, yq
- System: duf, dust, pv, parallel
- Text: sd (better sed), tealdeer (tldr)
- **Editors**: Zed Editor, micro, Claude Code, OpenCode
- **Nix Tools**: nil (LSP), nixd, nixfmt (formatter)
- **Package Manager**: pnpm (for Node.js)
## 🎵 Audio & Media ## System Optimizations
- **Audio Stack**: PipeWire with ALSA, PulseAudio, and JACK support - **ZRAM Swap** - Compressed RAM swap with zstd
- **Volume Control**: pwvucontrol (Qt/PipeWire), pavucontrol (GTK/fallback) - **SSD TRIM** - Weekly fstrim for SSD longevity
- **Media Control**: playerctl for media keys and D-Bus control - **EarlyOOM** - Prevents system freeze on memory exhaustion
- **Bluetooth**: Full codec support (LDAC, AAC, aptX HD, aptX, SBC-XQ) - **Profile Sync Daemon** - Browser profiles in RAM
- **Music Server**: Navidrome (localhost:4533) with Last.fm scrobbling - **Auto GC** - Weekly garbage collection of old generations
- **Music Tools**: Feishin (client), Picard (tagger), beets (library manager), cava (visualizer)
- **Video Players**: MPV, Celluloid (MPV GUI), VLC
- **Screen Recording**: OBS Studio, GPU Screen Recorder, Swappy (annotation)
## ⚙️ Key Services ## Kernel Tweaks
| Service | Description | ```nix
|---------|-------------| # Gaming optimizations
| **Tailscale** | Mesh VPN for secure remote access | "fs.inotify.max_user_watches" = 524288 # Large games support
| **OpenSSH** | Remote shell access | "vm.swappiness" = 10 # Prefer RAM over swap
| **Navidrome** | Music streaming server (port 4533) | "vm.vfs_cache_pressure" = 50 # Keep directory caches
| **Avahi** | mDNS for .local network discovery | ```
| **Profile-sync-daemon** | Browser profiles in tmpfs for faster performance |
| **ZRAM** | Compressed swap in RAM (zstd, 100% memory) |
| **fstrim** | Weekly SSD TRIM for longevity |
| **earlyoom** | Prevent system freeze on low memory |
| **plocate** | Fast file search database (daily updates) |
| **fwupd** | Firmware updates |
| **scx_lavd** | Low-latency scheduler for gaming |
## 📦 Package Management ## Theming
All packages in this configuration are installed as system packages (`environment.systemPackages`) across different modules. This provides: | Element | Choice |
|---------|--------|
| GTK Theme | adw-gtk3-dark |
| Icons | Papirus-Dark |
| Cursor | Adwaita (24px) |
| Fonts | Inter (UI), JetBrains Mono Nerd Font (mono) |
| Color Scheme | Dark |
- **Unified Management**: All packages updated together during system rebuild Configure with `nwg-look` or `dconf-editor`.
- **Reproducibility**: Entire system configuration in one place
- **No Profile Conflicts**: Avoid nix profile state issues
### Package Categories ## Adding New Modules
| Category | Module | Examples | 1. Create `modules/newmodule.nix`:
|----------|--------|----------|
| **Desktop Core** | configuration.nix, desktop.nix | Nautilus, Ghostty, Zen Browser, Noctalia, wl-clipboard |
| **Applications** | apps.nix | Vesktop, Thunderbird, Signal, Telegram, Obsidian, OnlyOffice |
| **Media** | apps.nix | Loupe, Evince, MPV, Celluloid, VLC, Feishin, Picard, OBS |
| **Development** | dev.nix | Docker, Node.js, Rust, Python, Bun, git, lazygit, CLI tools |
| **Gaming** | gaming.nix | Steam, Lutris, Heroic, Faugus Launcher, Wine, Gamescope |
| **System Tools** | apps.nix | btop, Mission Center, Bitwarden, file-roller, disk utility |
| **GPU** | gpu-amd.nix | CoreCtrl, radeontop, nvtop, Vulkan tools |
| **Shell** | shell.nix | Fish plugins (pure, autopair, fzf-fish, done, grc) |
| **Theming** | theming.nix | Fonts (JetBrains Mono, Inter, Noto), themes (adw-gtk3), icons (Papirus) |
### Adding Packages ```nix
# modules/newmodule.nix
# Brief description
{
config,
pkgs,
lib,
...
}:
To add a new package: {
1. Identify the appropriate module (e.g., apps.nix for GUI apps, dev.nix for dev tools) # Module content
2. Add the package to the `environment.systemPackages` list }
3. Run `sudo nixos-rebuild switch --flake .#nixos` ```
## 📝 Notes 2. Add import to `configuration.nix`:
### System Details ```nix
- **Kernel**: CachyOS latest with x86_64-v3 optimizations imports = [
- **Bootloader**: Limine with Secure Boot support # ...
- **Scheduler**: scx_lavd (low-latency scheduler optimized for gaming) ./modules/newmodule.nix
- **Shell**: Fish (default), Zsh (available as fallback) ];
- **Display Manager**: Ly (TUI) ```
- **Compositor**: Niri with Noctalia shell
- **User**: `pinj` (Melvin Ragusa)
- **Hostname**: `nix`
- **Timezone**: Europe/Berlin (German locale with English UI)
- **Keyboard**: German (de-latin1-nodeadkeys)
### Configuration Features 3. Test: `sudo nixos-rebuild test --flake .#nixos`
- **Unfree Packages**: Enabled globally
- **Flakes**: Enabled with nix-command
- **Binary Caches**: nix-community, lantian (CachyOS)
- **Auto-Optimization**: Store optimization enabled
- **Garbage Collection**: Weekly, keeping 14 days
- **State Version**: 26.05
- **Hibernation**: Configured with encrypted swap (`/dev/mapper/cryptswap`)
- **Flatpak**: Enabled with auto-configured Flathub repository
### Secondary Storage ## Troubleshooting
Three additional SSDs mounted at:
- `/mnt/Intenso-SSD`
- `/mnt/Samsung-SSD`
- `/mnt/Extern-SSD`
### Fish Shell Aliases ### Build Fails
Common aliases configured in `shell.nix`:
- `rebuild`, `rebuild-boot`, `rebuild-test` - NixOS rebuild commands
- `update` - Update flake inputs
- `gc-nix` - Run garbage collection
- `ll`, `ls`, `la`, `lt` - eza file listings
- `dc`, `dps`, `dl` - Docker shortcuts
- `gs`, `gd`, `gl`, `gp` - Git shortcuts
## 📄 License ```bash
# Check for syntax errors
nix flake check
This configuration is provided as-is for personal use and reference. # Build with verbose output
sudo nixos-rebuild switch --flake .#nixos --show-trace
```
### Rollback
```bash
# Boot into previous generation from bootloader menu
# Or switch to specific generation:
sudo nixos-rebuild switch --rollback
```
### GPU Issues
```bash
# Check Vulkan
vulkaninfo | grep deviceName
# Check VA-API
vainfo
# Monitor GPU
nvtop
radeontop
```
### Audio Issues
```bash
# Check PipeWire status
systemctl --user status pipewire pipewire-pulse wireplumber
# Restart audio stack
systemctl --user restart pipewire pipewire-pulse wireplumber
```
## Notes
- **State Version**: `26.05` - Do not change unless migrating
- **Username**: `pinj` - Configured throughout the system
- **Locale**: English (US) with German regional settings
- **Keyboard**: German (nodeadkeys)
- **Timezone**: Europe/Berlin
## License
Personal configuration. Feel free to use as inspiration for your own setup.