Merge #157: Minor example improvements

7ffbe83de3 README: add links to example scripts (Erik Arvstedt)
ade3f84317 examples: add shell session snippets (Erik Arvstedt)

Pull request description:

ACKs for top commit:
  nixbitcoin:
    ACK 7ffbe83

Tree-SHA512: d59bf0553e7c7d224f5c39a94de675c11386dd9b664d62984582d02b866b72aad7e7a443ea8b07e5e2c6c838b80b796f12f184d815dca4d7b8fabd4be7283ebc
This commit is contained in:
Jonas Nick 2020-04-18 18:58:41 +00:00
commit 57752ffe4e
No known key found for this signature in database
GPG Key ID: 4861DBF262123605
4 changed files with 12 additions and 3 deletions

View File

@ -37,14 +37,14 @@ nix-shell
The following example scripts set up a nix-bitcoin node according to `examples/configuration.nix` and then The following example scripts set up a nix-bitcoin node according to `examples/configuration.nix` and then
shut down immediately. They leave no traces (outside of `/nix/store`) on the host system. shut down immediately. They leave no traces (outside of `/nix/store`) on the host system.
- `./deploy-container.sh` creates a [NixOS container](https://github.com/erikarvstedt/extra-container).\ - [`./deploy-container.sh`](examples/deploy-container.sh) creates a [NixOS container](https://github.com/erikarvstedt/extra-container).\
This is the fastest way to set up a node.\ This is the fastest way to set up a node.\
Requires: [NixOS](https://nixos.org/) Requires: [NixOS](https://nixos.org/)
- `./deploy-qemu-vm.sh` creates a QEMU VM.\ - [`./deploy-qemu-vm.sh`](examples/deploy-qemu-vm.sh) creates a QEMU VM.\
Requires: [Nix](https://nixos.org/nix/) Requires: [Nix](https://nixos.org/nix/)
- `./deploy-nixops.sh` creates a VirtualBox VM via [NixOps](https://github.com/NixOS/nixops).\ - [`./deploy-nixops.sh`](examples/deploy-nixops.sh) creates a VirtualBox VM via [NixOps](https://github.com/NixOS/nixops).\
NixOps can be used to deploy to various other backends like cloud providers.\ NixOps can be used to deploy to various other backends like cloud providers.\
Requires: [Nix](https://nixos.org/nix/), [VirtualBox](https://www.virtualbox.org) Requires: [Nix](https://nixos.org/nix/), [VirtualBox](https://www.virtualbox.org)

View File

@ -80,4 +80,7 @@ echo
echo "Bitcoind data dir:" echo "Bitcoind data dir:"
sudo ls -al /var/lib/containers/demo-node/var/lib/bitcoind sudo ls -al /var/lib/containers/demo-node/var/lib/bitcoind
# Uncomment to start a shell session here
# export -f c; bash -li
# Cleanup happens at exit (see above) # Cleanup happens at exit (see above)

View File

@ -38,4 +38,7 @@ nixops deploy -d bitcoin-node
# Connect to node # Connect to node
nixops ssh bitcoin-node systemctl status bitcoind nixops ssh bitcoin-node systemctl status bitcoind
# Uncomment to start a shell session here
# bash -li
# Cleanup happens at exit (see above) # Cleanup happens at exit (see above)

View File

@ -90,4 +90,7 @@ echo
echo "Node info:" echo "Node info:"
c nodeinfo c nodeinfo
# Uncomment to start a shell session here
# export -f c; bash -li
# Cleanup happens at exit (see above) # Cleanup happens at exit (see above)