Merge fort-nix/nix-bitcoin#637: Misc. improvements

27e52fc565 dev-scenarios: fix comment (Erik Arvstedt)
7dcf307925 flake-info-sandboxed: clarify that sandbox is offline (Erik Arvstedt)
c22365d4a2 minimal-vm.nix: improve login text (Erik Arvstedt)
32ce2b567c examples/README: make relative location of configuration.nix explicit (Erik Arvstedt)
8303a65f0c configuration.nix: add nodeinfo (Erik Arvstedt)
073161b044 secrets: add comment (Erik Arvstedt)

Pull request description:

ACKs for top commit:
  jonasnick:
    ACK 27e52fc565

Tree-SHA512: a5015183db39fb1b32af08e187029db049f53e7df8ec00d8c3ee4393b20f1318e99cd4696ecd48ecacdfefca0f1200df5602ec14f7123291ac983ae382cac41d

dev/dev-scenarios.nix

@@ -37,7 +37,7 @@ with lib;
         extraConfig.Settings.themeColor = "INDIGO";
       };
       # nodes.lnd.enable = false;
-      # services.rtl.nodes.reverseOrder = true;
+      # nodes.reverseOrder = true;
       nightTheme = true;
       extraCurrency = "CHF";
     };

examples/README.md

@@ -23,9 +23,9 @@ cd nix-bitcoin/examples/
 nix-shell
 ```
 
-The following example scripts set up a nix-bitcoin node according to [`configuration.nix`](configuration.nix) and then
+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.\
-By default, [`configuration.nix`](configuration.nix) enables `bitcoind` and `clightning`.
+By default, [`./configuration.nix`](configuration.nix) enables `bitcoind` and `clightning`.
 
 - [`./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.\

examples/configuration.nix

@@ -230,6 +230,12 @@
   # Set this to enable the JoinMarket order book watcher.
   # services.joinmarket-ob-watcher.enable = true;
 
+  ### Nodeinfo
+  # Set this to add command `nodeinfo` to the system environment.
+  # It shows info about running services like onion addresses and local addresses.
+  # It is enabled by default when importing `secure-node.nix`.
+  # nix-bitcoin.nodeinfo.enable = true;
+
   ### Backups
   # Set this to enable nix-bitcoin's own backup service. By default, it
   # uses duplicity to incrementally back up all important files in /var/lib to

examples/qemu-vm/minimal-vm.nix

@@ -40,10 +40,11 @@ rec {
 
         Welcome to nix-bitcoin!
         To explore running services, try the following commands:
-        - nodeinfo
+          nodeinfo
-        - systemctl status bitcoind
+          systemctl status bitcoind
-        - systemctl status clightning
+          systemctl status clightning
-        - lightning-cli getinfo
+          bitcoin-cli -getinfo
+          lightning-cli getinfo
       '';
 
       # Power off VM when the user exits the shell

modules/secrets/secrets.nix

@@ -80,6 +80,7 @@ let
         rpcauth = pkgs.writers.writeBash "rpcauth" ''
           exec ${pkgs.python3}/bin/python ${rpcauthSrc} "$@"
         '';
+      # Writes secrets to PWD
       in pkgs.writers.writeBash "generate-secrets" ''
         set -euo pipefail
 

test/nixos-search/flake-info-sandboxed.sh

@@ -1,7 +1,7 @@
 #!/usr/bin/env bash
 set -euo pipefail
 
-# Run flake-info for the nix-bitcoin flake in a sandbox:
+# Run flake-info for the nix-bitcoin flake in an offline sandbox:
 # - Adds a consistent, reproducible runtime environment
 # - Removes the need to trust the flake-info binary
 #