2022-06-01 19:35:50 +00:00
|
|
|
## Examples
|
2020-12-24 10:29:14 +00:00
|
|
|
|
|
|
|
|
The easiest way to try out nix-bitcoin is to use one of the provided examples.
|
|
|
|
|
|
2022-06-01 19:35:50 +00:00
|
|
|
### Flakes-based quick start
|
|
|
|
|
|
|
|
|
|
If you use a Flakes-enabled version of Nix, run the following command to start a minimal
|
|
|
|
|
nix-bitcoin QEMU VM:
|
|
|
|
|
```bash
|
|
|
|
|
nix run github:fort-nix/nix-bitcoin/release
|
|
|
|
|
```
|
|
|
|
|
The VM (defined in [flake.nix](../flake.nix)) runs in the terminal and has `bitcoind`
|
|
|
|
|
and `clightning` installed.\
|
|
|
|
|
It leaves no traces (outside of `/nix/store`) on the host system.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### More examples
|
|
|
|
|
|
|
|
|
|
Clone this repo and enter the examples shell:
|
2020-12-24 10:29:14 +00:00
|
|
|
```bash
|
|
|
|
|
git clone https://github.com/fort-nix/nix-bitcoin
|
|
|
|
|
cd nix-bitcoin/examples/
|
|
|
|
|
nix-shell
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
The following example scripts set up a nix-bitcoin node according to [`configuration.nix`](configuration.nix) and then
|
|
|
|
|
shut down immediately. They leave no traces (outside of `/nix/store`) on the host system.\
|
2021-01-14 12:24:24 +00:00
|
|
|
By default, [`configuration.nix`](configuration.nix) enables `bitcoind` and `clightning`.
|
2020-12-24 10:29:14 +00:00
|
|
|
|
|
|
|
|
- [`./deploy-container.sh`](deploy-container.sh) creates a [NixOS container](https://github.com/erikarvstedt/extra-container).\
|
|
|
|
|
This is the fastest way to set up a node.\
|
|
|
|
|
Requires: [Nix](https://nixos.org/), a systemd-based Linux distro and root privileges
|
|
|
|
|
|
|
|
|
|
- [`./deploy-qemu-vm.sh`](deploy-qemu-vm.sh) creates a QEMU VM.\
|
2021-09-25 19:43:31 +00:00
|
|
|
Requires: [Nix](https://nixos.org/nix/), Linux
|
2020-12-24 10:29:14 +00:00
|
|
|
|
2021-03-10 13:08:40 +00:00
|
|
|
- [`./deploy-krops.sh`](deploy-krops.sh) creates a QEMU VM and deploys a
|
|
|
|
|
nix-bitcoin configuration to it using [krops](https://github.com/krebs/krops).\
|
2021-09-25 19:43:31 +00:00
|
|
|
Requires: [Nix](https://nixos.org/nix/), Linux
|
2021-03-10 13:08:40 +00:00
|
|
|
|
2020-12-24 10:29:14 +00:00
|
|
|
- [`./deploy-container-minimal.sh`](deploy-container-minimal.sh) creates a
|
2021-09-23 14:51:34 +00:00
|
|
|
container defined by [importable-configuration.nix](importable-configuration.nix).\
|
|
|
|
|
You can copy and import this file to use nix-bitcoin in an existing NixOS configuration.\
|
|
|
|
|
The configuration doesn't use the [secure-node.nix](../modules/presets/secure-node.nix) preset.\
|
2020-12-24 10:29:14 +00:00
|
|
|
Requires: [Nix](https://nixos.org/), a systemd-based Linux distro and root privileges
|
|
|
|
|
|
|
|
|
|
Run the examples with option `--interactive` or `-i` to start a shell for interacting with
|
|
|
|
|
the node:
|
|
|
|
|
```bash
|
|
|
|
|
./deploy-qemu-vm.sh -i
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Tests
|
2023-01-15 19:27:50 +00:00
|
|
|
The [nix-bitcoin test suite](../test/README.md) is also useful for exploring features.
|
2022-10-22 17:37:58 +00:00
|
|
|
|
2021-08-15 09:28:33 +00:00
|
|
|
### Real-world example
|
|
|
|
|
Check the [server repo](https://github.com/fort-nix/nixbitcoin.org) for https://nixbitcoin.org
|
2023-01-20 12:45:09 +00:00
|
|
|
to see the configuration of a Flakes-based nix-bitcoin node that's used in production.
|
2021-08-15 09:28:33 +00:00
|
|
|
|
|
|
|
|
The commands in `shell.nix` allow you to locally run the node in a VM or container.
|
2021-08-16 08:42:07 +00:00
|
|
|
|
|
|
|
|
### Flakes
|
|
|
|
|
|
|
|
|
|
Flakes make it easy to include `nix-bitcoin` in an existing NixOS config.
|
|
|
|
|
The [flakes example](./flakes/flake.nix) shows how to use `nix-bitcoin` as an input to a system flake.
|
