Nix packaging for the STUMP USENET robomoderator
Set up USENET moderation services on modern systems.
Modify your Nix flake similarly to the following:
{
outputs = {…, stump}: { # add a parameter for the new input
nixosConfigurations = {
myUsenetModServer = nixpgs.lib.nixosSystem {
…
modules = [
stump.nixosModules.stump # options for STUMP
stump.nixosModules.webstump # options for WebSTUMP
{ # ┌───────────
services.stump.enable = true; # config of the STUMP options
services.webstump.enable = true; # config of the WebSTUMP options
} # └───────────
];
};
};
};
inputs.stump.url = "github:sellout/stump-nix"; # the reference to this repo
}We recommend the following steps to make working in this repository as easy as possible.
This is sort-of a catch-all for keeping your environment up-to-date. It regenerates files, wires up the project’s Git configuration, ensures the shells have the right packages configured the right way, enables checks & formatters, etc.
If you already have it installed on your system or once you’ve run direnv allow, you can instead use project-manager switch.
This command ensures that any work you do within this repository happens within a consistent reproducible environment. That environment provides various debugging tools, etc. When you leave this directory, you will leave that environment behind, so it doesn’t impact anything else on your system.
nix build will build the various packages that are part of this project.
nix develop will put you into an environment where the traditional build tooling works. If you also have direnv installed, then you should automatically be in that environment when you're in a directory in this project.
nix flake check will do a comprehensive check of the state of the repository (package-specific tests are usually run as part of nix build, but this covers formatting, consistency, and larger integration testing).
In the absolute, almost every change is a breaking change. This section describes how we mitigate that to offer minor updates and revisions.
Other projects similar to this one, and how they differ.