Replace upstream's README with a short one for this fork, and add docs/fork-maintenance.md describing what was removed and how to maintain the rest. Keeps helper/update-fixed-output-derivation.sh for pkgs/mempool/generate.sh. There is no test suite. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
61 lines
1.9 KiB
Markdown
61 lines
1.9 KiB
Markdown
# nix-bitcoin (satstack fork)
|
|
|
|
NixOS modules for a Bitcoin node running **bitcoind, lnd, electrs and
|
|
mempool**, with Tor onion services and host-generated secrets.
|
|
|
|
This is a trimmed fork of [fort-nix/nix-bitcoin](https://github.com/fort-nix/nix-bitcoin),
|
|
which was archived in August 2026. Everything squirtle doesn't use has
|
|
been removed. See [docs/fork-maintenance.md](docs/fork-maintenance.md) for
|
|
what was cut, what's left, and the per-release checklist.
|
|
|
|
## Usage
|
|
|
|
```nix
|
|
# flake.nix
|
|
inputs.nix-bitcoin = {
|
|
url = "git+ssh://gitea@gitea.satstack.dev/pleb/nix-bitcoin.git";
|
|
inputs.nixpkgs.follows = "nixpkgs";
|
|
};
|
|
|
|
# in a nixosSystem's modules
|
|
inputs.nix-bitcoin.nixosModules.default
|
|
```
|
|
|
|
```nix
|
|
{
|
|
nix-bitcoin = {
|
|
generateSecrets = true; # writes /etc/nix-bitcoin-secrets on the host
|
|
operator = { enable = true; name = "alice"; };
|
|
nodeinfo.enable = true;
|
|
onionServices.bitcoind.public = true;
|
|
};
|
|
|
|
services.tor = { enable = true; client.enable = true; };
|
|
|
|
services.bitcoind = { enable = true; tor.proxy = true; };
|
|
services.lnd.enable = true;
|
|
services.electrs.enable = true;
|
|
services.mempool.enable = true; # also enables electrs
|
|
}
|
|
```
|
|
|
|
Packages come from the consumer's nixpkgs (`pkgs.bitcoind`, `pkgs.lnd`,
|
|
`pkgs.electrs`, `pkgs.lndinit`). The only package built here is mempool
|
|
(`pkgs/mempool/`).
|
|
|
|
## What's in the repo
|
|
|
|
| Path | Contents |
|
|
|---|---|
|
|
| `modules/` | `bitcoind`, `lnd`, `electrs`, `mempool`, plus `secrets/`, `operator`, `security`, `onion-services`, `onion-addresses`, `nodeinfo` |
|
|
| `pkgs/mempool/` | mempool backend, frontend, rust-gbt and nginx config. `generate.sh` bumps the version and refreshes hashes |
|
|
| `pkgs/lib.nix` | systemd hardening and Tor helpers shared by the modules |
|
|
|
|
There is no test suite. Build squirtle in nix-pleb before switching,
|
|
and roll back (`nixos-rebuild switch --rollback`) if a service fails at
|
|
runtime.
|
|
|
|
## License
|
|
|
|
MIT, see [LICENSE](LICENSE).
|