Go to file
Jonas Nick 2e537fbf99
Merge fort-nix/nix-bitcoin#477: Add standalone clightning-rest service, add lndconnect-onion for clightning
8e1ad6e3a8 docs/services: update Zeus usage section, add clightning (Erik Arvstedt)
20c0194ade readme: add hint about github table of contents button (Erik Arvstedt)
e2fee4bf1a lnd-rest-onion-service.nix: move to lndconnect-onion.nix, add clightning support (Erik Arvstedt)
acf5fe69ad add standalone `clightning-rest` service (Erik Arvstedt)
c30aa33c15 cl-rest: rename pkg to clightning-rest (Erik Arvstedt)

Pull request description:

ACKs for top commit:
  jonasnick:
    ACK 8e1ad6e3a8

Tree-SHA512: 7d70648aa404fd9b452b6b015c68f72f24f284aae69f4d7df6e94167864d28aae0fca5642c9f6f469ce3ad9a2fd441d6b2de0a0178cc5b0c88ef1cd14bc3d104
2022-05-06 14:39:10 +00:00
docs docs/services: update Zeus usage section, add clightning 2022-05-06 16:26:40 +02:00
examples lnd-rest-onion-service.nix: move to lndconnect-onion.nix, add clightning support 2022-05-06 16:26:40 +02:00
helper makeShell: use actual system configuration in generate-secrets 2022-02-12 21:33:23 +01:00
modules lnd-rest-onion-service.nix: move to lndconnect-onion.nix, add clightning support 2022-05-06 16:26:40 +02:00
pkgs cl-rest: rename pkg to clightning-rest 2022-05-06 16:24:59 +02:00
test lnd-rest-onion-service.nix: move to lndconnect-onion.nix, add clightning support 2022-05-06 16:26:40 +02:00
.cirrus.yml ci: update container image for modules tests 2021-12-15 15:44:56 +01:00
default.nix simplify overlay.nix 2020-01-09 10:43:29 +01:00
flake.lock update nixpkgs{,-unstable} 2022-05-06 13:35:32 +00:00
flake.nix flake: optimize nixpkgs importing 2022-02-03 20:47:25 +01: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 readme: add hint about github table of contents button 2022-05-06 16:26:40 +02:00
SECURITY.md Add SECURITY.md 2022-03-30 12:36:45 +00:00
shell.nix Clean up development shell.nix 2020-03-30 10:49:15 +02:00

nix-bitcoin logo


CirrusCI status GitHub tag (latest SemVer) GitHub commit activity GitHub contributors GitHub downloads


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

Docs

Hint: To show a table of contents, click the button (Github TOC button) in the top left corner of the documents.

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)

Security

See SECURITY.md for the security policy and how to report a vulnerability.

nix-bitcoin aims to achieve a high degree of security by building on the following principles:

  • 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.