From 8e0c6266af95bb1a4307355b9f4d22e7c0003938 Mon Sep 17 00:00:00 2001 From: Paul Brinkmeier Date: Sat, 18 Nov 2023 05:28:33 +0100 Subject: [PATCH] Add gilgamesh NixOS config and spigot-server package --- nix/gilgamesh/README.md | 12 +++ nix/gilgamesh/configuration.nix | 110 +++++++++++++++++++++++ nix/gilgamesh/deploy.sh | 3 + nix/gilgamesh/hardware-configuration.nix | 33 +++++++ nix/gilgamesh/spigot.nix | 55 ++++++++++++ nix/packages/.gitignore | 1 + nix/packages/README.md | 11 +++ nix/packages/spigot-server.nix | 27 ++++++ 8 files changed, 252 insertions(+) create mode 100644 nix/gilgamesh/README.md create mode 100644 nix/gilgamesh/configuration.nix create mode 100755 nix/gilgamesh/deploy.sh create mode 100644 nix/gilgamesh/hardware-configuration.nix create mode 100644 nix/gilgamesh/spigot.nix create mode 100644 nix/packages/.gitignore create mode 100644 nix/packages/README.md create mode 100644 nix/packages/spigot-server.nix diff --git a/nix/gilgamesh/README.md b/nix/gilgamesh/README.md new file mode 100644 index 0000000..d928acc --- /dev/null +++ b/nix/gilgamesh/README.md @@ -0,0 +1,12 @@ +# `gilgamesh` + +> Old Thinkpad running a Minecraft server. + +## TODO + +- Figure out if there's some more powersaving options +- Add some doc for initial setup + - Install NixOS according to the official guide + - Check out this repo, build this `configuration.nix` + - Afterwards: Just build it locally then deploy +- Use Flakes, add doc for `./deploy.sh` diff --git a/nix/gilgamesh/configuration.nix b/nix/gilgamesh/configuration.nix new file mode 100644 index 0000000..6807c90 --- /dev/null +++ b/nix/gilgamesh/configuration.nix @@ -0,0 +1,110 @@ +{ config, pkgs, lib, ... }: +{ + imports = + [ # Include the results of the hardware scan. + ./hardware-configuration.nix + ./spigot.nix + ]; + + # Use the GRUB 2 boot loader. + boot.loader.grub.enable = true; + # boot.loader.grub.efiSupport = true; + # boot.loader.grub.efiInstallAsRemovable = true; + # boot.loader.efi.efiSysMountPoint = "/boot/efi"; + # Define on which hard drive you want to install Grub. + boot.loader.grub.device = "/dev/sda"; + + networking.hostName = "gilgamesh"; # Define your hostname. + # Pick only one of the below networking options. + # networking.wireless.enable = true; # Enables wireless support via wpa_supplicant. + # networking.networkmanager.enable = true; # Easiest to use and most distros use this by default. + + # Set your time zone. + time.timeZone = "Europe/Berlin"; + + # Configure network proxy if necessary + # networking.proxy.default = "http://user:password@proxy:port/"; + # networking.proxy.noProxy = "127.0.0.1,localhost,internal.domain"; + + # Select internationalisation properties. + i18n.defaultLocale = "en_US.UTF-8"; + console = { + font = "Lat2-Terminus16"; + keyMap = "de-latin1"; + }; + + # Define a user account. Don't forget to set a password with ‘passwd’. + users.users.paul = { + isNormalUser = true; + extraGroups = [ "wheel" ]; # Enable ‘sudo’ for the user. + openssh.authorizedKeys.keys = [ + "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIIMFqREiw3EareYXntIrm1/numKDo113zx1WMOFO69LJ paul" + ]; + # packages = with pkgs; []; + }; + + # Users in group wheel may sudo without password + security.sudo.wheelNeedsPassword = false; + + # Users in group wheel are special friends of the Nix daemon + nix.settings.trusted-users = [ + "@wheel" + ]; + + # List packages installed in system profile. To search, run: + # $ nix search wget + environment.systemPackages = with pkgs; [ + vim + ]; + + # List services that you want to enable: + + # Enable the OpenSSH daemon. + services.openssh = { + enable = true; + settings = { + PasswordAuthentication = false; + KbdInteractiveAuthentication = false; + }; + }; + + # Enable Avahi for mDNS (advertise hostname in LAN) + services.avahi = { + enable = true; + nssmdns = true; + }; + + services.spigot = { + enable = true; + }; + + # TODO: ddclient + a nice domain + + # Open ports in the firewall. + # networking.firewall.allowedTCPPorts = [ ... ]; + # networking.firewall.allowedUDPPorts = [ ... ]; + # Or disable the firewall altogether. + # TODO: Only enable minecraft outside + networking.firewall.enable = false; + + # TODO: Backups + + # Practical hardware options + services.logind.lidSwitch = "ignore"; + powerManagement.cpuFreqGovernor = lib.mkDefault "powersave"; + + # Copy the NixOS configuration file and link it from the resulting system + # (/run/current-system/configuration.nix). This is useful in case you + # accidentally delete configuration.nix. + # system.copySystemConfiguration = true; + + # This value determines the NixOS release from which the default + # settings for stateful data, like file locations and database versions + # on your system were taken. It's perfectly fine and recommended to leave + # this value at the release version of the first install of this system. + # Before changing this value read the documentation for this option + # (e.g. man configuration.nix or on https://nixos.org/nixos/options.html). + system.stateVersion = "23.05"; # Did you read the comment? + +} + diff --git a/nix/gilgamesh/deploy.sh b/nix/gilgamesh/deploy.sh new file mode 100755 index 0000000..a3c7a07 --- /dev/null +++ b/nix/gilgamesh/deploy.sh @@ -0,0 +1,3 @@ +#!/usr/bin/env bash + +nixos-rebuild -I nixos-config=configuration.nix --target-host 192.168.0.206 --use-remote-sudo switch diff --git a/nix/gilgamesh/hardware-configuration.nix b/nix/gilgamesh/hardware-configuration.nix new file mode 100644 index 0000000..d135fe8 --- /dev/null +++ b/nix/gilgamesh/hardware-configuration.nix @@ -0,0 +1,33 @@ +# Do not modify this file! It was generated by ‘nixos-generate-config’ +# and may be overwritten by future invocations. Please make changes +# to /etc/nixos/configuration.nix instead. +{ config, lib, pkgs, modulesPath, ... }: + +{ + imports = + [ (modulesPath + "/installer/scan/not-detected.nix") + ]; + + boot.initrd.availableKernelModules = [ "ehci_pci" "ahci" "usb_storage" "sd_mod" "sdhci_pci" ]; + boot.initrd.kernelModules = [ ]; + boot.kernelModules = [ "kvm-intel" ]; + boot.extraModulePackages = [ ]; + + fileSystems."/" = + { device = "/dev/disk/by-label/NIXROOT"; + fsType = "ext4"; + }; + + swapDevices = [ ]; + + # Enables DHCP on each ethernet and wireless interface. In case of scripted networking + # (the default) this is the recommended approach. When using systemd-networkd it's + # still possible to use this option, but it's recommended to use it in conjunction + # with explicit per-interface declarations with `networking.interfaces..useDHCP`. + networking.useDHCP = lib.mkDefault true; + # networking.interfaces.enp0s25.useDHCP = lib.mkDefault true; + # networking.interfaces.wlp3s0.useDHCP = lib.mkDefault true; + + nixpkgs.hostPlatform = lib.mkDefault "x86_64-linux"; + hardware.cpu.intel.updateMicrocode = lib.mkDefault config.hardware.enableRedistributableFirmware; +} diff --git a/nix/gilgamesh/spigot.nix b/nix/gilgamesh/spigot.nix new file mode 100644 index 0000000..511677e --- /dev/null +++ b/nix/gilgamesh/spigot.nix @@ -0,0 +1,55 @@ +{ config, lib, pkgs, ... }: +with lib; +let + spigot-server = pkgs.callPackage ../packages/spigot-server.nix {}; + cfg = config.services.spigot; + name = "spigot"; + StateDirectory = "spigot-server"; +in { + options = { + services.spigot = { + enable = mkOption { + type = types.bool; + default = false; + description = '' + Whether to turn on the Spigot Minecraft server. + ''; + }; + + user = mkOption { + type = types.str; + default = name; + description = '' + The user account and group that Spigot runs as. + ''; + }; + }; + }; + + config = mkIf cfg.enable { + users.users = { + ${name} = { + isSystemUser = true; + group = name; + description = "Spigot Minecraft server user"; + }; + }; + users.groups = { + ${name} = { + }; + }; + + systemd.services.spigot-server = rec { + description = "Spigot Minecraft server"; + wantedBy = [ "multi-user.target" ]; + after = [ "network.target" ]; + serviceConfig = { + User = "${cfg.user}"; + + inherit StateDirectory; + WorkingDirectory = "/var/lib/${StateDirectory}"; + ExecStart = "${spigot-server}/bin/spigot-server"; + }; + }; + }; +} diff --git a/nix/packages/.gitignore b/nix/packages/.gitignore new file mode 100644 index 0000000..04060b1 --- /dev/null +++ b/nix/packages/.gitignore @@ -0,0 +1 @@ +spigot-1.20.1.jar diff --git a/nix/packages/README.md b/nix/packages/README.md new file mode 100644 index 0000000..7015203 --- /dev/null +++ b/nix/packages/README.md @@ -0,0 +1,11 @@ +# Packages + +## `spigot-server` + +In order to build `spigot-server.nix` you'll need a copy of the Spigot JAR. +For licensing reasons I won't check it into Git. +Just drop `spigot-${version}.jar` into this folder and change the `version = ` line in `spigot-server.nix` accordingly. + +## TODO + +- Make some more stuff in `spigot-server.nix` configurable diff --git a/nix/packages/spigot-server.nix b/nix/packages/spigot-server.nix new file mode 100644 index 0000000..5bf7708 --- /dev/null +++ b/nix/packages/spigot-server.nix @@ -0,0 +1,27 @@ +{ + makeWrapper, + stdenv, + # Runtime Dependencies + jre +}: +let + # Copied from some forum thread without much thought. + # Let's see if they work out. + javaFlags = "-Xmx5G -XX:+UseG1GC -XX:+UnlockExperimentalVMOptions -XX:MaxGCPauseMillis=50 -XX:+DisableExplicitGC -XX:TargetSurvivorRatio=90 -XX:G1NewSizePercent=50 -XX:G1MaxNewSizePercent=80 -XX:InitiatingHeapOccupancyPercent=10 -XX:G1MixedGCLiveThresholdPercent=50"; +in stdenv.mkDerivation rec { + pname = "spigot-server"; + version = "1.20.1"; + src = ./spigot-${version}.jar; + + nativeBuildInputs = [ makeWrapper ]; + + buildCommand = '' + install -Dm644 $src $out/lib/spigot-${version}.jar + + mkdir -p $out/bin + makeWrapper ${jre}/bin/java $out/bin/spigot-server \ + --argv0 spigot-server \ + --add-flags "${javaFlags}" \ + --add-flags "-jar $out/lib/spigot-${version}.jar" + ''; +}