personal nixos repo
Go to file
xenia 82e912d572 oops 3 2024-10-21 17:48:14 -04:00
lib oop 2024-09-20 13:22:36 -04:00
modules/ghidra-server WIP: ghidra 2024-10-10 23:08:24 -04:00
pkgs WIP new ghidra 2 2024-10-21 16:30:26 -04:00
support create documentation rendering derivation 2024-04-09 17:24:56 -04:00
.gitignore try 2 2024-10-21 17:31:19 -04:00
LICENSE.txt add readme and license 2024-04-07 18:28:42 -04:00
README.md add hpc stuff 2024-09-14 15:56:09 -04:00
TODO.md WIP: ghidra 2024-10-10 23:08:24 -04:00
default.nix oops 3 2024-10-21 17:48:14 -04:00
flake.lock try 2 2024-10-21 17:31:19 -04:00
flake.nix oops 2 2024-10-21 17:44:09 -04:00
module.nix introduce flake that exports nixpkgs with overlays 2024-10-21 16:59:17 -04:00
overlay.nix introduce flake that exports nixpkgs with overlays 2024-10-21 16:59:17 -04:00

README.md

Table of Contents

dragnpkgs

this is my personal nixos modules and packages repository. while it was designed for my own use, it's also intended to be flexible and reusable enough for general purpose usage. i might consider upstreaming into nixpkgs if there is sufficient interest

usage

dragnpkgs provides a set of nixos modules and a nixpkgs overlay containing custom packages (automatically applied). to use, import the top-level module into your system configuration, eg

{config, lib, pkgs, ...}:
{
  imports = [
    path/to/dragnpkgs
  ];
}

alternatively, add it as a nix channel

nix-channel --add https://git.lain.faith/haskal/dragnpkgs/archive/main.tar.gz dragnpkgs

then in system config

{config, lib, pkgs, ...}:
{
  imports = [
    <dragnpkgs>
  ];
}

for standalone nix on other distros, use ~/.config/nixpkgs/overlays.nix to enable the dragnpkgs overlay

(import <dragnpkgs> {}).nixpkgs.overlays

options documentation

documentation for options provided by dragnpkgs

services.ghidra-server

the shared project server for ghidra

example usage:

services.ghidra-server = {
  enable = true;
  host = "your.domain.or.ip";
};

services.ghidra-server.enable

enables the ghidra server service

services.ghidra-server.enableAdminCli

adds a system package for the CLI tool ghidra-svrAdmin, which allows anyone in the ghidra group to administer the server (this corresponds to the server/svrAdmin tool in the stock ghidra distribution)

services.ghidra-server.{package, jdkPackage} (ghidra_headless, openjdk17_headless)

allows overriding the ghidra package and jdk package used for the server

services.ghidra-server.host

the server hostname or IP; this is typically required (by java RMI) for correct operation

services.ghidra-server.basePort (13100)

the server will use 3 consecutive TCP ports starting from this port

services.ghidra-server.directory (ghidra-server)

the root directory for server files, as a subdirectory of /var/lib. this is needed because this option is passed to systemd StateDirectory=

services.ghidra-server.{user,group} (ghidra)

the service user and group

more coming soon(tm)

packages documentation

ghidra_headless

a variant of ghidra built with a headless openjdk, intended to reduce closure size for server operation

ghidra

preview version of ghidra with my nix patches

kicad

preview version of kicad with my patches

ocamlPackages.ppx_unicode

opinionated ppx for string literals: https://git.lain.faith/haskal/ppx_unicode

ocamlPackages.xlog

logging for cats, in ocaml: https://git.lain.faith/haskal/xlog

python312Packages.feedvalidator or feedvalidator

the W3C atom/RSS feed validator library, https://github.com/w3c/feedvalidator

this package comes with an additional CLI bin, feedvalidator, which is a simple wrapper around the library that enables CLI usage

usage

usage: feedvalidator [-h] [-b BASE] file

W3C feedvalidator

positional arguments:
  file                  File to validate

options:
  -h, --help            show this help message and exit
  -b BASE, --base BASE  Base URL of document

example

feedvalidator --base "https://my-base-url/atom.xml" path/to/atom.xml

outer-wilds-text-adventure

nix packaging for the Outer Wilds text adventure game. it should work by default on NixOS. if using the nix package manager on a non-NixOS computer, you also need the following when using pipewire or another ALSA plugin that lives in a separate package

export ALSA_PLUGIN_DIR=$(nix eval -f '<nixpkgs>' --raw pipewire)/lib/alsa-lib

lib documentation

fetchFromSteam

a fetcher that downloads binaries from Steam using DepotDownloader. this is intended for game servers that are distributed via Steam. use SteamDB to get the needed IDs.

Usage:

pkgs.fetchFromSteam {
  name = "..."; # optional
  appId = "...";
  depot = {
    depotId = "...";
    manifestId = "...";
    beta = "..."; # optional
  };

  additionalDepots = [
    # same format as the main `depot`
    # use this to include eg the steamworks redistributable depot
  ];

  hash = pkgs.lib.fakeHash;
}

fetchb4

A fetcher that uses b4 to download patchsets from https://lore.kernel.org so that they can be applied in boot.kernelPatches

Usage:

pkgs.fetchb4 {
  msgid = "2024042069.1337-example@example";
  hash = pkgs.lib.fakeHash;

  # optional args
  version = "3"; # default: latest
  single_message = true; # default: false
}

note that not specifying a version may make cause future invocations to return different output if a newer version is sent to the thread

mkNginxServer

creates a shell script that launches nginx in the foreground as the current user. the nginx is configured to run an http server on localhost:8080 with the given siteConfig

example:

pkgs.mkNginxServer {
  siteConfig = ''
    location / {
      root path/to/development_site_root;
      error_page 404 /404.html;
    }
  '';
}

gitSource

for development package nix files, computes the source set of files tracked by git at the given root path

arguments:

  • root: the root of the git repo, where .git is located
  • subdir, optional: a subdirectory within the git repo. if provided, only files in this subdirectory will go into the final source set

example:

stdenv.mkDerivation {
  # ...
  src = gitSource { root = ./.; };
}

makeSquashFs

builds a squashfs image from the given derivations

example

makeSquashFs {
  filename = "my-image"; # optional
  storeContents = [ foo bar ];
}

makeHpcDist

create a packaged nix distribution with the given packages in it for weird HPC systems. go read the source to find out what it does; i don't recommend using this if you're not me

development

structure of this repo

  • default.nix: the top level NixOS module, which can also be interpreted as a plain nix file outside of NixOS for access to just the nixpkgs overlay. this contains all definitions for packages, library functions, and NixOS modules
  • lib/: library functions (ie functions that get added to the overlay) go here
  • modules/: NixOS modules go here
  • pkgs/: packages that get added to the overlay go here
  • support/: WIP support tools (eg generating documentation)

licensing

this repository is NOT licensed under a "standard" FOSS license. instead, it uses CC-BY-NC-SA 4.0. this means, in particular that commercial use is forbidden. if you are, for whatever reason, interested in using this code commercially, please contact me