nix-bitcoin

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

Go to file

Erik Arvstedt d24c029435 treewide: add `defaultText` (manual) This enables generating module option documentation. Add `defaultText` to options where the default value can't be evaluated during metadata generation.		2021-12-12 16:18:14 +01:00
ci	ci: use 'cachix watch-exec'	2021-02-07 22:45:37 +01:00
docs	add presets/bitcoind-remote.nix	2021-12-07 15:35:33 +01:00
examples	minor improvements	2021-11-28 21:18:40 +01:00
helper	makeShell: use old nix tooling	2021-12-07 15:35:33 +01:00
modules	treewide: add `defaultText` (manual)	2021-12-12 16:18:14 +01:00
pkgs	clightning-plugins: update prometheus-client version pin	2021-12-10 12:15:16 +00:00
test	tests: add TODO-EXTERNAL	2021-12-10 12:15:36 +00:00
.cirrus.yml	tests: remove pkgsUnstable	2021-11-28 19:16:21 +00:00
default.nix	simplify overlay.nix	2020-01-09 10:43:29 +01:00
flake.lock	update to NixOS 21.11	2021-12-08 12:38:00 +00:00
flake.nix	update to NixOS 21.11	2021-12-08 12:38:00 +00:00
LICENSE	Add license	2019-01-02 14:03:52 +00:00
overlay.nix	simplify overlay.nix	2020-01-09 10:43:29 +01:00
README.md	minor fixes	2021-12-07 15:35:33 +01:00
shell.nix	Clean up development shell.nix	2020-03-30 10:49:15 +02:00

README.md

nix-bitcoin is a collection of Nix packages and NixOS modules for easily installing full-featured Bitcoin nodes with an emphasis on security.

Overview

nix-bitcoin can be used for personal or merchant wallets, public infrastructure or for Bitcoin application backends. In all cases, the aim is to provide security and privacy by default. However, while nix-bitcoin is used in production today, it is still considered experimental.

nix-bitcoin nodes can be deployed on dedicated hardware, virtual machines or containers. The Nix packages and NixOS modules can be used independently and combined freely.

nix-bitcoin is built on top of Nix and NixOS which provide powerful abstractions to keep it highly customizable and maintainable. Testament to this are nix-bitcoin's robust security features and its potent test framework. However, running nix-bitcoin does not require any previous experience with the Nix ecosystem.

Get started

See the examples for an overview of all features.
To setup a new node from scratch, see the installation instructions.
To add nix-bitcoin to an existing NixOS configuration, see importable-configuration.nix and the Flake example.

Docs

Features

A configuration preset for setting up a secure node

All applications use Tor for outbound connections and support accepting inbound connections via onion services.

NixOS modules (src)

Application services
- bitcoind, with a default banlist against spy nodes
- clightning with support for announcing an onion service
  Available plugins:
  - clboss: automated C-Lightning Node Manager
  - helpme: walks you through setting up a fresh c-lightning node
  - monitor: helps you analyze the health of your peers and channels
  - prometheus: lightning node exporter for the prometheus timeseries server
  - rebalance: keeps your channels balanced
  - summary: print a nice summary of the node status
  - zmq: publishes notifications via ZeroMQ to configured endpoints
- lnd with support for announcing an onion service
  - Lightning Loop
  - Lightning Pool
  - charge-lnd: policy-based channel fee manager
  - lndconnect via a REST onion service
- Ride The Lightning: web interface for lnd and clightning
- spark-wallet
- electrs
- btcpayserver
- liquid
- JoinMarket
  - JoinMarket Orderbook Watcher
- bitcoin-core-hwi
Helper
- netns-isolation: isolates applications on the network-level via network namespaces
- nodeinfo: script which prints info about the node's services
- backups: duplicity backups of all your node's important files
- operator: adds non-root user operator who has access to client tools (e.g. bitcoin-cli, lightning-cli)

Security

Simplicity: Only services enabled in configuration.nix and their dependencies are installed, support for doas (sudo alternative), code is continuously reviewed and refined.
Integrity: The Nix package manager guarantees that all dependencies are exactly specified, packages can be built from source to reduce reliance on binary caches, nix-bitcoin merge commits are signed, all commits are approved by multiple nix-bitcoin developers, upstream packages are cryptographically verified where possible, we use this software ourselves.
Principle of Least Privilege: Services operate with least privileges; they each have their own user and are restricted further with systemd features, RPC whitelisting and netns-isolation. There's a non-root user operator to interact with the various services.
Defense-in-depth: nix-bitcoin supports a hardened kernel, services are confined through discretionary access control, Linux namespaces, dbus firewall and seccomp-bpf with continuous improvements.

Note that if the machine you're deploying from is insecure, there is nothing nix-bitcoin can do to protect itself.

Troubleshooting

If you are having problems with nix-bitcoin check the FAQ or submit an issue.
There's also a Matrix room at #general:nixbitcoin.org and a #nix-bitcoin IRC channel on libera.
We are always happy to help.