- Add CreamInstaller with an NVIDIA WebKit workaround - Enable Minecraft Plymouth theme and Docker on fractal - Add development, terminal, gaming, and launcher utilities - Expand firewall ports and enable automatic generation cleanup
101 lines
5.1 KiB
Markdown
Executable file
101 lines
5.1 KiB
Markdown
Executable file
<div align="center">
|
||
|
||
# SerenityOS
|
||
|
||
_Declarative NixOS configuration with Flakes & Home Manager_ <br>
|
||
(no it's not the ladybug)
|
||
|
||
[](https://nixos.org)
|
||
[](https://codeberg.org/Serenity-F/SerenityOS/src/branch/main/LICENSE)
|
||
|
||
</div>
|
||
|
||
<br>
|
||
|
||

|
||
|
||
## 💻 System Information
|
||
|
||
### Software In Use
|
||
|
||
| Component | Implementation |
|
||
| ------------------ | ------------------------------------ |
|
||
| **OS** | NixOS Unstable |
|
||
| **Display Server** | Wayland |
|
||
| **Session Manager**| Regreet |
|
||
| **Window Manager** | Niri |
|
||
| **Desktop** | Noctalia |
|
||
| **Terminal** | Kitty |
|
||
| **Shell** | Fish |
|
||
| **Editor** | Helix |
|
||
| **Browser** | Firefox |
|
||
| **File Manager** | Yazi |
|
||
| **Themeing** | Stylix |
|
||
| **Filesystem** | Ext4, Btrfs, or ZFS (host-dependent) |
|
||
|
||
### Local machine profile: `fractal`
|
||
|
||
The `fractal` host targets Porta's MSI MS-7C95 desktop (AMD Ryzen 5 5500, NVIDIA GeForce RTX 5060 Ti, Intel Wireless-AC 3168 Wi-Fi/Bluetooth, and x86_64 UEFI). It enables the Niri/Noctalia desktop, terminal tools, gaming, and multimedia modules. The configured displays are HDMI-A-1 at 1920×1080/180 Hz and DP-2 at 1920×1080/60 Hz.
|
||
|
||
The host configuration does not select or partition a disk. Before installing NixOS, decide which drive and filesystem to use. After mounting the target at `/mnt` and cloning this repository to `/mnt/etc/nixos`, run `nixos-generate-config --root /mnt --force`. This replaces the tracked root-level `hardware-configuration.nix` placeholder with detected hardware, filesystem, and UUID settings; the `fractal-hardware` module imports it automatically. This machine currently runs Arch Linux, so the profile has not been installed or switched on the running system.
|
||
|
||
The account is configured as `porta` and uses the local Git identity. No login password is stored in the Nix configuration; after mounting the installed system at `/mnt`, set one before the first normal login with `nixos-enter --root /mnt -c 'passwd porta'`.
|
||
|
||
The `cream-installer` feature installs [CreamInstaller](https://github.com/Novattz/creamlinux-installer) using its upstream Nix package, pinned in `flake.lock`. It is enabled on `fractal` and applies the upstream WebKit workaround automatically when NVIDIA video drivers are configured. Add `cream-installer` to another host's module list to enable it there; run `creamlinux` or use the desktop launcher after rebuilding.
|
||
|
||
### Common Commands
|
||
|
||
| Command | Description |
|
||
| ------------------------------------------ | -------------------------------------------------- |
|
||
| `hx <path/to/file>` | Edit file |
|
||
| `nix flake update` | Update system |
|
||
| `git add --all && git commit -m "<message>"`| Save system changes or updates to git tree |
|
||
| `sudo nixos-rebuild test --flake .#<host>` | Test changes or updates without switching |
|
||
| `sudo nixos-rebuild switch --flake .#<host>`| Apply system changes or updates |
|
||
|
||
## 📋 To-Do List
|
||
|
||
- [Enable multi-user functionality](https://codeberg.org/serenity-F/SerenityOS/milestone/145563)
|
||
- [Provide a wiki for this config](https://codeberg.org/serenity-F/SerenityOS/milestone/145569)
|
||
- [Provide an installer ISO or script](https://codeberg.org/serenity-F/SerenityOS/milestone/145563)
|
||
|
||
## 📝 Dev Notes
|
||
|
||
For the purposes of authenticity and earnestness
|
||
|
||
- I will not rebase or squash any commits
|
||
- I will not remove any outdated branches
|
||
|
||
## 📜 License
|
||
|
||
- MIT License: Feel free to use and modify as you wish.
|
||
|
||
## 📚 Learning Resources
|
||
|
||
- [NixOS Manual](https://nixos.org/manual/nixos/stable/)
|
||
- [Nix Pills](https://nixos.org/guides/nix-pills/)
|
||
- [Home Manager](https://nix-community.github.io/home-manager/)
|
||
- [Niri Flake](https://github.com/epireyn/niri-flake)
|
||
- [Stylix](https://stylix.danth.me/)
|
||
- [Nixflix](https://kiriwalawren.github.io/nixflix/)
|
||
|
||
## 🙋 Attributions
|
||
|
||
### Artwork
|
||
|
||
- [Helvetica Blanc](https://helveticablanc.com/)
|
||
- [Vincent Van Gogh](https://en.wikipedia.org/wiki/Almond_Blossoms/)
|
||
|
||
### Code
|
||
|
||
- [V3rm1n](https://codeberg.org/v3rm1n/dotfiles/)
|
||
- [Sashanoraa](https://codeberg.org/sashanoraa/nixcfg/)
|
||
- [Quantenzitrone](https://codeberg.org/quantenzitrone/nixos-config/)
|
||
|
||
<div align="center">
|
||
|
||
<br>
|
||
|
||
_Built with 🩵_
|
||
|
||
</div>
|