Fork of https://github.com/fort-nix/nix-bitcoin

Go to file

Jonas Nick d5f7e818d7 Add README		2018-12-06 16:01:01 +00:00
modules	Cleanups	2018-12-06 15:59:41 +00:00
pkgs	Update nanopos	2018-12-06 15:58:41 +00:00
.gitignore	Add rpc user and password as secrets	2018-11-22 23:51:16 +00:00
configuration.nix	Cleanups	2018-12-06 15:59:41 +00:00
generate_secrets.sh	Allow operator to access liquid-cli	2018-12-03 22:33:21 +00:00
network-vbox.nix	Move deployment keys into network.nix	2018-12-06 11:33:13 +00:00
network.nix	Move deployment keys into network.nix	2018-12-06 11:33:13 +00:00
README.md	Add README	2018-12-06 16:01:01 +00:00

README.md

nix-bitcoin

A set of nix packages and nixos modules including profiles to easily install featureful Bitcoin nodes. Work in progress.

Profiles

nixbitcoin.nix provides the two profiles "minimal" and "all":

minimal
- bitcoind (pruned) with outbound connections through Tor and inbound connections through a hidden service
- clightning with outbound connections through Tor, not listening
- includes "nodeinfo" script which prints basic info about the node
- adds non-root user "operator" which has access to bitcoin-cli and lightning-cli
full
- adds clightning hidden service
- liquid-daemon
- lightning charge
- nanopos
- adds an index page using nginx to display node information and link to nanopos

The data directories can be found in /var/lib.

Installing profiles

The easiest way is to use the provided network.nix and configuration.nix with nixops. Once you've set up nixops first run ./generate_secrets.sh then continue with the deployment using nixops.

At the moment this relies on using the unstable nixpkgs channel. The "all" profile requires 15 GB of disk space and 2GB of memory.