nix-bitcoin/README.md

72 lines
3.4 KiB
Markdown
Raw Normal View History

2018-12-06 08:01:01 -08:00
nix-bitcoin
===
2019-04-10 03:49:59 -07:00
Nix packages and nixos modules for easily installing Bitcoin nodes and higher layer protocols.
2019-01-26 09:53:58 -08:00
This is a work in progress - don't expect it to be bug free or secure.
2019-01-26 10:42:04 -08:00
2019-04-10 03:49:59 -07:00
The default configuration sets up a Bitcoin Core node and c-lightning. The user can enable spark-wallet in `configuration.nix` to make c-lightning accessible with a smartphone using spark-wallet.
A simple webpage shows the lightning nodeid and links to nanopos letting the user receive donations.
2019-01-26 10:42:04 -08:00
It also includes liquid-daemon.
2019-04-10 03:49:59 -07:00
Outbound peer-to-peer traffic is forced through Tor, and listening services are bound to onion addresses.
2019-01-26 10:42:04 -08:00
2019-01-26 14:11:16 -08:00
A demo installation is running at [http://6tr4dg3f2oa7slotdjp4syvnzzcry2lqqlcvqkfxdavxo6jsuxwqpxad.onion](http://6tr4dg3f2oa7slotdjp4syvnzzcry2lqqlcvqkfxdavxo6jsuxwqpxad.onion).
2019-04-10 03:49:59 -07:00
The following screen cast shows a fresh deployment of a nix-bitcoin node.
2019-01-26 14:16:26 -08:00
2019-01-26 14:19:17 -08:00
<p align="center">
<a href="https://asciinema.org/a/223630/?speed=2&autoplay=1"><img src="https://asciinema.org/a/223630.png" height="500"></a>
</p>
2019-01-26 14:16:26 -08:00
2018-12-06 08:01:01 -08:00
2019-04-10 03:49:59 -07:00
The goal is to make it easy to deploy a reasonably secure Bitcoin node with a usable wallet.
2019-01-26 10:42:04 -08:00
It should allow managing bitcoin (the currency) effectively and providing public infrastructure.
2019-04-10 03:49:59 -07:00
It should be a reproducible and extensible platform for applications building on Bitcoin.
2019-01-26 10:42:04 -08:00
2019-04-10 03:49:59 -07:00
Available modules
2018-12-06 08:01:01 -08:00
---
2019-04-10 03:49:59 -07:00
By default the `configuration.nix` provides:
* bitcoind (pruned) with outbound connections through Tor and inbound connections through a hidden
service. By default loaded with banlist of spy nodes.
2019-04-10 03:49:59 -07:00
* [clightning](https://github.com/ElementsProject/lightning) 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
In `configuration.nix` the user can enable:
* a clightning hidden service
* [liquid-daemon](https://github.com/blockstream/liquid)
* [lightning charge](https://github.com/ElementsProject/lightning-charge)
* [nanopos](https://github.com/ElementsProject/nanopos)
* an index page using nginx to display node information and link to nanopos
* [spark-wallet](https://github.com/shesek/spark-wallet)
* [electrs](https://github.com/romanz/electrs)
2018-12-06 08:01:01 -08:00
2019-01-26 10:42:04 -08:00
The data directories of the services can be found in `/var/lib` on the deployed machines.
2018-12-06 08:01:01 -08:00
2019-04-10 03:49:59 -07:00
Installation
2018-12-06 08:01:01 -08:00
---
The easiest way is to run `nix-shell` (on a Linux machine) in the nix-bitcoin directory and then create a [NixOps](https://nixos.org/nixops/manual/) deployment with the provided `network.nix` in the `network` directory.
Fix the FIXMEs in configuration.nix and deploy with nixops in nix-shell.
2019-04-10 03:49:59 -07:00
See [install.md](docs/install.md) for a detailed tutorial.
2019-04-10 03:49:59 -07:00
Hardware requirements
---
2019-04-10 03:49:59 -07:00
* Disk space: 300 GB (235GB for Bitcoin blockchain + some room)
* Bitcoin Core pruning is not supported at the moment because it's not supported by c-lightning. It's possible to use pruning but you need to know what you're doing.
* RAM: 2GB of memory
2019-01-26 09:53:58 -08:00
2019-04-10 03:49:59 -07:00
Tested hardware includes [pcengine's apu2c4](https://pcengines.ch/apu2c4.htm)
2019-01-02 06:56:57 -08:00
2019-04-10 03:49:59 -07:00
Usage
2019-01-02 06:56:57 -08:00
---
2019-04-10 03:49:59 -07:00
For usage instructions, such as how to connect to spark-wallet, electrs and the ssh Tor Hidden Service, see [usage.md](docs/usage.md).
2019-04-10 03:49:59 -07:00
Troubleshooting
2019-01-02 06:56:57 -08:00
---
2019-04-10 03:49:59 -07:00
If you are having problems with nix-bitcoin check the [FAQ](docs/faq.md) or submit an issue. We are always happy to help.
2019-01-02 06:56:57 -08:00
2019-04-10 03:49:59 -07:00
Docs
2019-02-24 06:52:02 -08:00
---
2019-04-10 03:49:59 -07:00
* [FAQ](docs/faq.md)
* [Install instructions](docs/install.md)
* [Usage instructions](docs/usage.md)