xenia 8ae77094e6 | ||
---|---|---|
lib | ||
modules/ghidra-server | ||
pkgs | ||
support | ||
.gitignore | ||
LICENSE.txt | ||
README.md | ||
TODO.md | ||
default.nix | ||
flake.lock | ||
flake.nix | ||
module.nix | ||
overlay.nix |
README.md
Table of Contents
- dragnpkgs
- usage
- options documentation
- services.ghidra-server
- services.ghidra-server.enable
- services.ghidra-server.enableAdminCli
- services.ghidra-server.{package, jdkPackage} (ghidra_headless, openjdk17_headless)
- services.ghidra-server.host
- services.ghidra-server.basePort (13100)
- services.ghidra-server.directory (ghidra-server)
- services.ghidra-server.{user,group} (ghidra)
- more coming soon(tm)
- packages documentation
- ghidra_headless
- ghidra
- kicad
- ocamlPackages.ppx_unicode
- ocamlPackages.xlog
- python312Packages.feedvalidator or feedvalidator
- outer-wilds-text-adventure
- lib documentation
- development
- licensing
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. the modules require the overlay
non-flake
{config, lib, pkgs, ...}:
{
imports = [
/path/to/dragnpkgs/module.nix
];
nixpkgs.overlays = [ (import /path/to/dragnpkgs/overlay.nix) ];
}
for standalone nix on other distros, use ~/.config/nixpkgs/overlays.nix
to enable the dragnpkgs
overlay
[ (import <dragnpkgs/overlay.nix>) ]
flake
for flake usage, point your nixpkgs
to this repo
{
inputs = {
# for nixos-24.05
nixpkgs.url = "git+https://git.lain.faith/haskal/dragnpkgs.git?ref=nixos-24.05";
# for nixos-unstable
nixpkgs.url = "git+https://git.lain.faith/haskal/dragnpkgs.git?ref=main";
};
}
note that overriding inputs to the flake won't necessarily work because of the way nixpkgs registers
itself with the system. this requires really annoying hacks to get working at all. if you want to
depend on dragnpkgs
with a different version of nixpkgs
(ie not 24.05 or unstable), clone the
repo and recreate flake.lock
. aren't flakes so cool and fun!!!!
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 locatedsubdir
, 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 moduleslib/
: library functions (ie functions that get added to the overlay) go heremodules/
: NixOS modules go herepkgs/
: packages that get added to the overlay go heresupport/
: 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