auxolotl/templates
20
2
Fork 4
Code Issues 3 Pull requests 2 Actions Packages Projects Releases Wiki Activity

feat: NixOS template for new users #33

Open
8bitbuddhist wants to merge 14 commits from new-user-templates into main
pull from: new-user-templates
merge into: auxolotl:main
Conversation 9 Commits 14 Files changed 25 +61 -59
14 changed files with 61 additions and 59 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files
Showing only changes of commit 5d1480fe3b - Show all commits

10
system/README.md
View file

@ -7,8 +7,10 @@ A ready-to-run NixOS template with sane defaults.
1. Install a fresh copy of NixOS and boot into your new system.
2. Download, copy, or clone this repository onto your new system.
3. Run `nixos-generate-config --show-hardware-config` to generate your system's `hardware-configuration.nix` file. Copy this file into the `host` folder, overwriting the existing file.
4. Edit `flake.nix` and set the value of `hostName` to the host name you want to use for this system.
4. Edit the `host/configuration.nix` file to suit your needs. This file contains all of the available options and is fully documented.
4. Edit `flake.nix` and set the following variables:
1. Change `hostName` to the hostname you want to give this system.
2. If your system is running on an architecture other than 64-bit Linux, change `platform` to the architecture that you're using. Details on the various options are documented in `flake.nix`.
4. Edit the `host/configuration.nix` file to suit your needs. This file documents all of the different options available.
5. Run `nixos-rebuild boot --flake .#<your hostname>` and restart.
6. Enjoy your new NixOS system!
@ -48,7 +50,7 @@ To enable Secure Boot support:
...
```
2. Generate a set of Secure Boot keys by running the following command: `sudo sbctl create-keys`. This creates a set of keys in `/etc/secureboot`.
3. Enable Secure Boot in your system configuration by setting `aux.bootloader.secureboot.enable = true;`.
3. Enable Secure Boot in your system configuration by setting `aux.system.bootloader.secureboot.enable = true;`.
4. Rebuild your system using `nixos-rebuild switch --flake .`.
5. Confirm that Secure Boot has been set up properly by running `sudo sbctl verify`:
```sh
@ -79,4 +81,4 @@ To enable Secure Boot support:
#### Disabling Secure Boot
To disable Secure Boot, just set `aux.bootloader.secureboot.enable = false;` and rebuild the system.
To disable Secure Boot, just set `aux.system.bootloader.secureboot.enable = false;` and rebuild the system.

31
system/flake.nix
View file

@ -36,14 +36,20 @@
...
}:
let
forAllSystems =
function:
nixpkgs.lib.genAttrs [
"x86_64-linux"
"aarch64-linux"
"x86_64-darwin"
"aarch64-darwin"
] (system: function nixpkgs.legacyPackages.${system});
###*** IMPORTANT: Please set your system's hostname here ***###
hostName = builtins.abort "Please set the 'hostName' variable in flake.nix";
/*
What kind of system are you running NixOS on?
If you're not sure, leave this as the default.
Options are:
x86_64-linux - (Default) 64-bit PCs.
aarch64-linux - 64-bit ARM PCs.
x86_64-darwin - Intel Macs.
aarch64-darwin - M-series Macs.
*/
platform = "x86_64-linux";
baseModules = [
./modules/autoimport.nix
@ -64,8 +70,6 @@
};
}
];
###*** IMPORTANT: Please set your system's hostname here ***###
hostName = builtins.abort "Please set the hostName variable in flake.nix";
in
{
nixosConfigurations."${hostName}" = nixpkgs.lib.nixosSystem {
@ -73,7 +77,10 @@
inherit inputs;
};
modules = baseModules ++ [
{ networking.hostName = hostName; }
{
networking.hostName = hostName;
nixpkgs.hostPlatform = platform;
}
./host/configuration.nix
# NixOS-Hardware
@ -82,6 +89,6 @@
];
};
formatter = forAllSystems (pkgs: pkgs.nixfmt-rfc-style);
formatter.${platform} = nixpkgs.legacyPackages.${platform}.nixfmt-rfc-style;
};
}

19
system/host/configuration.nix
View file

@ -15,18 +15,6 @@ in
system.stateVersion = stateVersion;
###*** Configure your system below this line. ***###
/*
What kind of system are you running NixOS on?
If you're not sure, leave this as the default.
Options are:
x86_64-linux - (Default) 64-bit PCs.
aarch64-linux - 64-bit ARM PCs.
x86_64-darwin - Intel Macs.
aarch64-darwin - M-series Macs.
*/
nixpkgs.hostPlatform = "x86_64-linux";
# Set your time zone.
# To see all available timezones, run `timedatectl list-timezones`.
time.timeZone = "Europe/Amsterdam";
@ -48,10 +36,15 @@ in
home-manager.users.axol = {
# The state version is required and should stay at the version you originally installed.
home.stateVersion = stateVersion;
programs = {
# Let home Manager install and manage itself.
home-manager.enable = true;
};
};
# Configure the system.
aux = {
aux.system = {
# Enable to allow unfree (e.g. closed source) packages.
# https://nixos.org/manual/nixpkgs/stable/#sec-allow-unfree
allowUnfree = false;

4
system/modules/system/bluetooth.nix
View file

@ -7,12 +7,12 @@
}:
let
cfg = config.aux.bluetooth;
cfg = config.aux.system.bluetooth;
in
{
options = {
aux.bluetooth = {
aux.system.bluetooth = {
enable = lib.mkEnableOption (lib.mdDoc "Enables bluetooth");
};
};

4
system/modules/system/bootloader.nix
View file

@ -9,12 +9,12 @@
# Bootloader
let
cfg = config.aux.bootloader;
cfg = config.aux.system.bootloader;
in
{
options = {
aux.bootloader = {
aux.system.bootloader = {
enable = lib.mkOption {
description = "Automatically configures the bootloader. Set to false to configure manually.";
type = lib.types.bool;

4
system/modules/system/editor.nix
View file

@ -8,11 +8,11 @@
}:
let
cfg = config.aux.editor;
cfg = config.aux.system.editor;
in
{
options = {
aux.editor = lib.mkOption {
aux.system.editor = lib.mkOption {
description = "Selects the default text editor.";
default = "nano";
type = lib.types.enum [

6
system/modules/system/nix.nix
View file

@ -8,12 +8,12 @@
}:
let
cfg = config.aux;
cfg = config.aux.system;
in
{
options = {
aux.allowUnfree = lib.mkEnableOption (lib.mdDoc "Allow unfree packages to install.");
aux.retentionPeriod = lib.mkOption {
aux.system.allowUnfree = lib.mkEnableOption (lib.mdDoc "Allow unfree packages to install.");
aux.system.retentionPeriod = lib.mkOption {
description = "How long to retain NixOS generations. Defaults to 30 days (30d).";
type = lib.types.str;
default = "30d";

4
system/modules/ui/audio.nix
View file

@ -7,11 +7,11 @@
}:
let
cfg = config.aux.ui.audio;
cfg = config.aux.system.ui.audio;
in
{
options = {
aux.ui.audio = {
aux.system.ui.audio = {
enable = lib.mkEnableOption (lib.mdDoc "Enables audio.");
enableLowLatency = lib.mkEnableOption (
lib.mdDoc "Enables low-latency audio (may cause crackling) per https://nixos.wiki/wiki/PipeWire#Low-latency_setup."

6
system/modules/ui/desktops/budgie.nix
View file

@ -6,17 +6,17 @@
...
}:
let
cfg = config.aux.ui.desktops.budgie;
cfg = config.aux.system.ui.desktops.budgie;
in
{
options = {
aux.ui.desktops.budgie.enable = lib.mkEnableOption (
aux.system.ui.desktops.budgie.enable = lib.mkEnableOption (
lib.mdDoc "Enables the Budgie desktop environment."
);
};
config = lib.mkIf cfg.enable {
aux.ui.desktops.enable = true;
aux.system.ui.desktops.enable = true;
services.xserver = {
enable = true;

8
system/modules/ui/desktops/common.nix
View file

@ -7,11 +7,11 @@
}:
let
cfg = config.aux.ui.desktops;
cfg = config.aux.system.ui.desktops;
in
{
options = {
aux.ui.desktops = {
aux.system.ui.desktops = {
enable = lib.mkEnableOption (lib.mdDoc "Enables base desktop environment support.");
xkb = lib.mkOption {
description = "The keyboard layout to use by default. Defaults to us.";
@ -25,7 +25,7 @@ in
};
config = lib.mkIf cfg.enable {
aux.ui.audio.enable = true;
aux.system.ui.audio.enable = true;
boot = {
# Enable Plymouth for graphical bootsplash.
@ -48,7 +48,7 @@ in
libinput.enable = true;
# Configure keymap in X11
xkb = config.aux.ui.desktops.xkb;
xkb = config.aux.system.ui.desktops.xkb;
};
};

6
system/modules/ui/desktops/gnome.nix
View file

@ -6,17 +6,17 @@
...
}:
let
cfg = config.aux.ui.desktops.gnome;
cfg = config.aux.system.ui.desktops.gnome;
in
{
options = {
aux.ui.desktops.gnome.enable = lib.mkEnableOption (
aux.system.ui.desktops.gnome.enable = lib.mkEnableOption (
lib.mdDoc "Enables the Gnome Desktop Environment."
);
};
config = lib.mkIf cfg.enable {
aux.ui.desktops.enable = true;
aux.system.ui.desktops.enable = true;
# Enable Gnome
services.xserver = {

6
system/modules/ui/desktops/hyprland.nix
View file

@ -6,17 +6,17 @@
...
}:
let
cfg = config.aux.ui.desktops.hyprland;
cfg = config.aux.system.ui.desktops.hyprland;
in
{
options = {
aux.ui.desktops.hyprland.enable = lib.mkEnableOption (
aux.system.ui.desktops.hyprland.enable = lib.mkEnableOption (
lib.mdDoc "Enables the Hyprland desktop environment."
);
};
config = lib.mkIf cfg.enable {
aux.ui.desktops.enable = true;
aux.system.ui.desktops.enable = true;
programs.hyprland = {
enable = true;

6
system/modules/ui/desktops/kde.nix
View file

@ -7,18 +7,18 @@
}:
let
cfg = config.aux.ui.desktops.kde;
cfg = config.aux.system.ui.desktops.kde;
in
{
options = {
aux.ui.desktops.kde = {
aux.system.ui.desktops.kde = {
enable = lib.mkEnableOption (lib.mdDoc "Enables the KDE Desktop Environment.");
useX11 = lib.mkEnableOption (lib.mdDoc "Uses X11 instead of Wayland.");
};
};
config = lib.mkIf cfg.enable {
aux.ui.desktops.enable = true;
aux.system.ui.desktops.enable = true;
services = {
displayManager.sddm.enable = true;

6
system/modules/ui/desktops/xfce.nix
View file

@ -6,17 +6,17 @@
...
}:
let
cfg = config.aux.ui.desktops.xfce;
cfg = config.aux.system.ui.desktops.xfce;
in
{
options = {
aux.ui.desktops.xfce.enable = lib.mkEnableOption (
aux.system.ui.desktops.xfce.enable = lib.mkEnableOption (
lib.mdDoc "Enables the XFCE desktop environment."
);
};
config = lib.mkIf cfg.enable {
aux.ui.desktops.enable = true;
aux.system.ui.desktops.enable = true;
services.xserver = {
enable = true;