2018-11-13 15:44:54 -08:00
|
|
|
|
# Edit this configuration file to define what should be installed on
|
|
|
|
|
# your system. Help is available in the configuration.nix(5) man page
|
|
|
|
|
# and in the NixOS manual (accessible by running ‘nixos-help’).
|
|
|
|
|
|
2020-02-23 11:30:32 -08:00
|
|
|
|
{ config, pkgs, lib, ... }: {
|
2019-04-14 11:38:34 -07:00
|
|
|
|
imports = [
|
2020-04-07 13:47:32 -07:00
|
|
|
|
<nix-bitcoin/modules/presets/secure-node.nix>
|
2020-02-26 08:11:20 -08:00
|
|
|
|
|
2020-02-26 08:11:21 -08:00
|
|
|
|
# FIXME: The hardened kernel profile improves security but
|
|
|
|
|
# decreases performance by ~50%.
|
|
|
|
|
# Turn it off when not needed.
|
2020-12-16 09:57:57 -08:00
|
|
|
|
<nix-bitcoin/modules/presets/hardened.nix>
|
2019-04-27 05:19:56 -07:00
|
|
|
|
|
2018-12-28 05:44:32 -08:00
|
|
|
|
# FIXME: Uncomment next line to import your hardware configuration. If so,
|
|
|
|
|
# add the hardware configuration file to the same directory as this file.
|
2019-01-02 06:56:57 -08:00
|
|
|
|
# This is not needed when deploying to a virtual box.
|
2018-12-10 15:24:47 -08:00
|
|
|
|
#./hardware-configuration.nix
|
2018-12-06 07:59:41 -08:00
|
|
|
|
];
|
2019-04-12 01:47:49 -07:00
|
|
|
|
# FIXME: Enable modules by uncommenting their respective line. Disable
|
2020-04-07 13:47:34 -07:00
|
|
|
|
# modules by commenting out their respective line.
|
2019-04-12 02:01:40 -07:00
|
|
|
|
|
2020-02-23 11:30:32 -08:00
|
|
|
|
### BITCOIND
|
|
|
|
|
# Bitcoind is enabled by default if nix-bitcoin is enabled
|
|
|
|
|
#
|
2020-06-02 06:12:04 -07:00
|
|
|
|
# Enable this option to set pruning to a specified MiB value.
|
|
|
|
|
# clightning is compatible with pruning. See
|
|
|
|
|
# https://github.com/ElementsProject/lightning/#pruning for more information.
|
|
|
|
|
# LND and electrs are not compatible with pruning.
|
2020-06-07 04:40:25 -07:00
|
|
|
|
# services.bitcoind.prune = 100000;
|
2020-02-23 11:30:32 -08:00
|
|
|
|
#
|
2021-01-30 01:47:06 -08:00
|
|
|
|
# Set this to accounce the onion service address to peers.
|
|
|
|
|
# The onion service allows accepting incoming connections via Tor.
|
|
|
|
|
# nix-bitcoin.onionServices.bitcoind.public = true;
|
|
|
|
|
#
|
2020-02-23 11:30:32 -08:00
|
|
|
|
# You can add options that are not defined in modules/bitcoind.nix as follows
|
|
|
|
|
# services.bitcoind.extraConfig = ''
|
|
|
|
|
# maxorphantx=110
|
|
|
|
|
# '';
|
|
|
|
|
|
2019-04-12 02:01:40 -07:00
|
|
|
|
### CLIGHTNING
|
2019-04-12 01:47:49 -07:00
|
|
|
|
# Enable this module to use clightning, a Lightning Network implementation
|
|
|
|
|
# in C.
|
|
|
|
|
services.clightning.enable = true;
|
2021-01-14 04:24:20 -08:00
|
|
|
|
#
|
|
|
|
|
# Set this to create an onion service by which clightning can accept incoming connections
|
|
|
|
|
# via Tor.
|
|
|
|
|
# The onion service is automatically announced to peers.
|
|
|
|
|
# nix-bitcoin.onionServices.clightning.public = true;
|
|
|
|
|
#
|
2020-11-18 18:01:45 -08:00
|
|
|
|
# == Plugins
|
|
|
|
|
# See ../docs/usage.md for the list of available plugins.
|
|
|
|
|
# services.clightning.plugins.prometheus.enable = true;
|
2019-04-12 02:01:40 -07:00
|
|
|
|
|
2019-08-05 01:44:38 -07:00
|
|
|
|
### LND
|
2020-08-04 00:54:01 -07:00
|
|
|
|
# Uncomment the following line in order to enable lnd, a lightning
|
|
|
|
|
# implementation written in Go. In order to avoid collisions with clightning
|
2021-01-14 04:24:04 -08:00
|
|
|
|
# you must disable clightning or change the services.clightning.port or
|
2021-01-14 04:24:03 -08:00
|
|
|
|
# services.lnd.port to a port other than 9735.
|
2020-06-15 03:21:18 -07:00
|
|
|
|
# services.lnd.enable = true;
|
2021-01-14 04:24:21 -08:00
|
|
|
|
#
|
|
|
|
|
# Set this to create an onion service by which lnd can accept incoming connections
|
|
|
|
|
# via Tor.
|
|
|
|
|
# The onion service is automatically announced to peers.
|
|
|
|
|
# nix-bitcoin.onionServices.lnd.public = true;
|
|
|
|
|
#
|
2021-02-03 13:44:43 -08:00
|
|
|
|
# Set this to create an lnd REST onion service.
|
|
|
|
|
# Adds binary `lndconnect-rest-onion` to the system environment.
|
|
|
|
|
# This binary generates QR codes or URIs for connecting applications to lnd via the
|
|
|
|
|
# REST onion service.
|
|
|
|
|
# services.lnd.restOnionService.enable = true;
|
|
|
|
|
#
|
2019-08-24 16:24:26 -07:00
|
|
|
|
## WARNING
|
|
|
|
|
# If you use lnd, you should manually backup your wallet mnemonic
|
|
|
|
|
# seed. This will allow you to recover on-chain funds. You can run the
|
|
|
|
|
# following command after the lnd service starts:
|
2019-08-05 01:44:38 -07:00
|
|
|
|
# nixops scp --from bitcoin-node /secrets/lnd-seed-mnemonic ./secrets/lnd-seed-mnemonic
|
2019-08-24 16:24:26 -07:00
|
|
|
|
# You should also backup your channel state after opening new channels.
|
|
|
|
|
# This will allow you to recover off-chain funds, by force-closing channels.
|
|
|
|
|
# nixops scp --from bitcoin-node /var/lib/lnd/chain/bitcoin/mainnet/channel.backup /my-backup-path/channel.backup
|
2019-08-05 01:44:38 -07:00
|
|
|
|
|
2019-04-12 02:01:40 -07:00
|
|
|
|
### SPARK WALLET
|
|
|
|
|
# Enable this module to use spark-wallet, a minimalistic wallet GUI for
|
|
|
|
|
# c-lightning, accessible over the web or through mobile and desktop apps.
|
2020-10-18 05:49:20 -07:00
|
|
|
|
# Automatically enables clightning.
|
2019-04-12 02:01:40 -07:00
|
|
|
|
# services.spark-wallet.enable = true;
|
|
|
|
|
|
|
|
|
|
### ELECTRS
|
|
|
|
|
# Enable this module to use electrs, an efficient re-implementation of
|
2020-06-02 06:12:48 -07:00
|
|
|
|
# Electrum Server in Rust.
|
2019-04-12 02:01:40 -07:00
|
|
|
|
# services.electrs.enable = true;
|
2020-04-24 07:21:12 -07:00
|
|
|
|
# If you have more than 8GB memory, enable this option so electrs will
|
2020-06-02 06:12:48 -07:00
|
|
|
|
# sync faster. Only available if hardware wallets are disabled.
|
2019-08-07 04:03:34 -07:00
|
|
|
|
# services.electrs.high-memory = true;
|
2019-04-12 02:01:40 -07:00
|
|
|
|
|
2020-08-12 07:47:56 -07:00
|
|
|
|
### BTCPayServer
|
|
|
|
|
# Enable this module to use BTCPayServer, a self-hosted, open-source
|
|
|
|
|
# cryptocurrency payment processor.
|
|
|
|
|
# Privacy Warning: BTCPayServer currently looks up price rates without
|
|
|
|
|
# proxying them through Tor. This means an outside observer can correlate
|
|
|
|
|
# your BTCPayServer usage, like invoice creation times, with your IP address.
|
|
|
|
|
# services.btcpayserver.enable = true;
|
|
|
|
|
# Enable this option to connect BTCPayServer to clightning.
|
|
|
|
|
# services.btcpayserver.lightningBackend = "clightning";
|
|
|
|
|
# Enable this option to connect BTCPayServert to lnd.
|
|
|
|
|
# services.btcpayserver.lightningBackend = "lnd";
|
2020-10-18 05:49:20 -07:00
|
|
|
|
# The lightning backend service automatically enabled.
|
2020-08-12 07:47:56 -07:00
|
|
|
|
# Afterwards you need to go into Store > General Settings > Lightning Nodes
|
|
|
|
|
# and click to use "the internal lightning node of this BTCPay Server".
|
2021-01-14 04:24:24 -08:00
|
|
|
|
#
|
|
|
|
|
# Set this to create an onion service to make the btcpayserver web interface
|
|
|
|
|
# accessible via Tor.
|
|
|
|
|
# Security WARNING: Create a btcpayserver administrator account before allowing
|
|
|
|
|
# public access to the web interface.
|
|
|
|
|
# nix-bitcoin.onionServices.btcpayserver.enable = true;
|
2020-08-12 07:47:56 -07:00
|
|
|
|
|
2019-04-12 02:01:40 -07:00
|
|
|
|
### LIQUIDD
|
2019-08-05 08:11:27 -07:00
|
|
|
|
# Enable this module to use Liquid, a sidechain for an inter-exchange
|
2019-04-12 02:01:40 -07:00
|
|
|
|
# settlement network linking together cryptocurrency exchanges and
|
2019-08-05 08:11:27 -07:00
|
|
|
|
# institutions around the world. Liquid is accessed with the elements-cli
|
|
|
|
|
# tool run as user operator.
|
2019-08-06 04:55:19 -07:00
|
|
|
|
# services.liquidd.enable = true;
|
2019-04-12 02:01:40 -07:00
|
|
|
|
|
2019-04-14 09:55:40 -07:00
|
|
|
|
### RECURRING-DONATIONS
|
2019-04-21 17:38:46 -07:00
|
|
|
|
# Enable this module to send recurring donations. This is EXPERIMENTAL; it's
|
|
|
|
|
# not guaranteed that payments are succeeding or that you will notice payment
|
2020-10-18 05:49:20 -07:00
|
|
|
|
# failure.
|
|
|
|
|
# Automatically enables clightning.
|
2019-04-14 09:55:40 -07:00
|
|
|
|
# services.recurring-donations.enable = true;
|
|
|
|
|
# Specify the receivers of the donations. By default donations are every
|
2019-04-22 10:39:15 -07:00
|
|
|
|
# Monday at a randomized time. Check `journalctl -eu recurring-donations` or
|
|
|
|
|
# `lightning-cli listpayments` for successful lightning donations.
|
2019-04-14 09:55:40 -07:00
|
|
|
|
# services.recurring-donations.tallycoin = {
|
2019-04-22 10:39:15 -07:00
|
|
|
|
# "<receiver name>" = <amount you wish to donate in sat>"
|
|
|
|
|
# "<additional receiver name>" = <amount you wish to donate in sat>;
|
2019-04-14 09:55:40 -07:00
|
|
|
|
# "djbooth007" = 1000;
|
|
|
|
|
# };
|
|
|
|
|
|
2019-04-29 13:39:25 -07:00
|
|
|
|
### Hardware wallets
|
|
|
|
|
# Enable this module to allow using hardware wallets. See https://github.com/bitcoin-core/HWI
|
2020-06-02 06:12:48 -07:00
|
|
|
|
# for more information. Only available if electrs.high-memory is disabled.
|
2019-04-29 13:39:25 -07:00
|
|
|
|
# Ledger must be initialized through the official ledger live app and the Bitcoin app must
|
|
|
|
|
# be installed and running on the device.
|
|
|
|
|
# services.hardware-wallets.ledger = true;
|
2019-05-13 08:13:23 -07:00
|
|
|
|
# Trezor can be initialized with the trezorctl command in nix-bitcoin. More information in
|
|
|
|
|
# `docs/usage.md`.
|
2019-04-29 13:39:25 -07:00
|
|
|
|
# services.hardware-wallets.trezor = true;
|
|
|
|
|
|
2020-05-29 03:53:35 -07:00
|
|
|
|
### netns-isolation (EXPERIMENTAL)
|
|
|
|
|
# Enable this module to use Network Namespace Isolation. This feature places
|
|
|
|
|
# every service in its own network namespace and only allows truly necessary
|
|
|
|
|
# connections between network namespaces, making sure services are isolated on
|
|
|
|
|
# a network-level as much as possible.
|
|
|
|
|
# nix-bitcoin.netns-isolation.enable = true;
|
|
|
|
|
|
2020-07-07 07:22:17 -07:00
|
|
|
|
### lightning-loop
|
|
|
|
|
# Enable this module to use lightninglab's non-custodial off/on chain bridge.
|
|
|
|
|
# loopd (lightning-loop daemon) will be started automatically. Users can
|
|
|
|
|
# interact with off/on chain bridge using `loop in` and `loop out`.
|
2020-10-18 05:49:20 -07:00
|
|
|
|
# Automatically enables lnd.
|
2020-07-07 07:22:17 -07:00
|
|
|
|
# services.lightning-loop.enable = true;
|
|
|
|
|
|
2021-03-01 01:59:23 -08:00
|
|
|
|
### lightning-pool
|
|
|
|
|
# Enable this module to use Lightning Lab's non-custodial batched uniform
|
|
|
|
|
# clearing-price auction for Lightning Channel Leases.
|
|
|
|
|
# Use the `pool` command to interact with the lightning-pool service.
|
|
|
|
|
# Automatically enables lnd.
|
|
|
|
|
# services.lightning-pool.enable = true;
|
|
|
|
|
#
|
|
|
|
|
# lightning-pool requires that lnd has a publicly reachable address.
|
|
|
|
|
# Set this to create a public onion service for lnd.
|
|
|
|
|
# nix-bitcoin.onionServices.lnd.public = true;
|
|
|
|
|
|
2020-06-11 04:39:17 -07:00
|
|
|
|
### Backups
|
|
|
|
|
# Enable this module to use nix-bitcoin's own backups module. By default, it
|
|
|
|
|
# uses duplicity to incrementally back up all important files in /var/lib to
|
|
|
|
|
# /var/lib/localBackups once a day.
|
|
|
|
|
# services.backups.enable = true;
|
|
|
|
|
# You can pull the localBackups folder with
|
|
|
|
|
# `nixops scp --from bitcoin-node /var/lib/localBackups /my-backup-path/`
|
|
|
|
|
# Alternatively, you can also set a remote target url, for example
|
|
|
|
|
# services.backups.destination = "sftp://user@host[:port]/[relative|/absolute]_path";
|
|
|
|
|
# Supply the sftp password by appending the FTP_PASSWORD environment variable
|
|
|
|
|
# to secrets/backup-encryption-env like so
|
|
|
|
|
# `echo "FTP_PASSWORD=<password>" >> secrets/backup-encryption-env`
|
|
|
|
|
# You many also need to set a ssh host and publickey with
|
|
|
|
|
# programs.ssh.knownHosts."host" = {
|
|
|
|
|
# hostNames = [ "host" ];
|
|
|
|
|
# publicKey = "<ssh public from `ssh-keyscan`>";
|
|
|
|
|
# };
|
|
|
|
|
# If you also want to backup bulk data like the Bitcoin & Liquid blockchains
|
|
|
|
|
# and electrs data directory, enable
|
|
|
|
|
# services.backups.with-bulk-data = true;
|
|
|
|
|
|
2020-04-23 09:18:47 -07:00
|
|
|
|
### JOINMARKET
|
|
|
|
|
# Enable this module to allow using JoinMarket's user interactive scripts (including
|
|
|
|
|
# tumbler.py).
|
|
|
|
|
# Note: JoinMarket has full access to bitcoind, including its wallet functionality.
|
|
|
|
|
# services.joinmarket.enable = true;
|
|
|
|
|
# Enable this option to enable the JoinMarket Yield Generator Bot. You will be able to
|
|
|
|
|
# earn sats by providing CoinJoin liquidity. This makes it impossible to use other
|
|
|
|
|
# scripts that access your wallet.
|
|
|
|
|
# services.joinmarket.yieldgenerator.enable = true;
|
2021-01-17 04:24:57 -08:00
|
|
|
|
# Enable this option to enable the JoinMarket order book watcher.
|
|
|
|
|
# services.joinmarket-ob-watcher.enable = true;
|
2020-04-23 09:18:47 -07:00
|
|
|
|
|
2019-01-01 11:16:24 -08:00
|
|
|
|
# FIXME: Define your hostname.
|
|
|
|
|
networking.hostName = "nix-bitcoin";
|
|
|
|
|
time.timeZone = "UTC";
|
|
|
|
|
|
2018-12-28 05:44:32 -08:00
|
|
|
|
# FIXME: Add your SSH pubkey
|
2019-01-01 11:16:24 -08:00
|
|
|
|
services.openssh.enable = true;
|
2018-12-28 05:44:32 -08:00
|
|
|
|
users.users.root = {
|
|
|
|
|
openssh.authorizedKeys.keys = [ "" ];
|
|
|
|
|
};
|
|
|
|
|
|
2019-01-01 11:16:24 -08:00
|
|
|
|
# FIXME: add packages you need in your system
|
|
|
|
|
environment.systemPackages = with pkgs; [
|
|
|
|
|
vim
|
|
|
|
|
];
|
|
|
|
|
|
2019-01-15 15:07:32 -08:00
|
|
|
|
# FIXME: Add custom options (like boot options, output of
|
|
|
|
|
# nixos-generate-config, etc.):
|
2018-12-28 05:44:32 -08:00
|
|
|
|
|
2019-01-01 11:16:24 -08:00
|
|
|
|
# This value determines the NixOS release with which your system is to be
|
|
|
|
|
# compatible, in order to avoid breaking some software such as database
|
|
|
|
|
# servers. You should change this only after NixOS release notes say you
|
|
|
|
|
# should.
|
|
|
|
|
system.stateVersion = "18.09"; # Did you read the comment?
|
2020-10-12 04:33:48 -07:00
|
|
|
|
|
|
|
|
|
# The nix-bitcoin release version that your config is compatible with.
|
|
|
|
|
# When upgrading to a backwards-incompatible release, nix-bitcoin will display an
|
|
|
|
|
# an error and provide hints for migrating your config to the new release.
|
2021-01-14 04:24:24 -08:00
|
|
|
|
nix-bitcoin.configVersion = "0.0.30";
|
2018-11-13 15:44:54 -08:00
|
|
|
|
}
|