Jonas Nick 0ac9d6f4c8
Merge fort-nix/nix-bitcoin#450: Misc. improvements
d959d5b5581a02b6faef30f876489ca1cf89c564 secure-node: don't set `nix-bitcoin.secretsDir` (Erik Arvstedt)
7b0c3d48c9f347a2738a282ec3b813e35c2612ad docs/services.md: link to clightning plugin list (Erik Arvstedt)
7402212263c332a933fe46131583d8f9c3ad5b63 examples/configuration.nix: disable `passwordAuthentication` (Erik Arvstedt)
e093bb64d98e7851e54acb188f8d3be7b8c33582 examples/configuration.nix: fix links to `docs/services.md` (Erik Arvstedt)
d41a550355379461fe2a20961dea9837f186ad49 fetch-release: export GNUPGHOME (Erik Arvstedt)
397b372cf36f3f5d79dbe1f301b61437eeea0144 bitcoind: improve option `rpc.users` (Erik Arvstedt)
679e7b6544f83ef77af40f09cfb8d6e664be2378 bitcoind: remove unneeded tmpfile rule (Erik Arvstedt)
98f419233f0b90d764efdb212db0551044d3faad bitcoind: don't log timestamps (Erik Arvstedt)
6f8b4d9ebe00e7b62ce5bff1fb3a9573d976b721 flake: optimize nixpkgs importing (Erik Arvstedt)
16e2d4c8b714f3861405bb610694a0e3dc6a7ee9 flake: remove unneeded indirection in legacyPackages (Erik Arvstedt)

Pull request description:

ACKs for top commit:
  jonasnick:
    ACK d959d5b5581a02b6faef30f876489ca1cf89c564

Tree-SHA512: e62fcf36ac77df62b9f86279d0ebac807525d188cbf1ee5c13cf1406b3caadad0f2df7527b0c8713259cbc6d5cdfa006f01e90d5377f974213f204a2f85a8ae6
2022-02-06 17:00:59 +00:00
2022-02-05 21:33:54 +01:00
2022-01-24 11:54:52 +00:00
2022-01-27 14:56:41 +01:00
2020-01-09 10:43:29 +01:00
2022-01-27 14:56:41 +01:00
2022-02-03 20:47:25 +01:00
2019-01-02 14:03:52 +00:00
2020-01-09 10:43:29 +01:00
2021-12-07 15:35:33 +01:00
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

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

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

Languages
Nix 84.4%
Shell 11.7%
Python 3.5%
C 0.4%