From c120196be0061bc27f071a2d5058c8af2337dcd2 Mon Sep 17 00:00:00 2001 From: serinko <97586125+serinko@users.noreply.github.com> Date: Wed, 26 Jul 2023 12:55:05 +0200 Subject: [PATCH] operators-guide: incorporated PR #3656 --- documentation/operators/src/nodes/gateway-setup.md | 1 + documentation/operators/src/nodes/maintenance.md | 14 ++++++++++++++ .../operators/src/nodes/mix-node-setup.md | 2 ++ .../operators/src/nodes/network-requester-setup.md | 2 ++ 4 files changed, 19 insertions(+) diff --git a/documentation/operators/src/nodes/gateway-setup.md b/documentation/operators/src/nodes/gateway-setup.md index dd5c65e2ad..cdc72700e2 100644 --- a/documentation/operators/src/nodes/gateway-setup.md +++ b/documentation/operators/src/nodes/gateway-setup.md @@ -45,6 +45,7 @@ You can also check the various arguments required for individual commands with: ``` ./nym-gateway --help ``` +> Adding `--no-banner` startup flag will prevent Nym banner being printed even if run in tty environment. ### Initialising your gateway To check available configuration options use: diff --git a/documentation/operators/src/nodes/maintenance.md b/documentation/operators/src/nodes/maintenance.md index 1ac31c959c..d4884bad84 100644 --- a/documentation/operators/src/nodes/maintenance.md +++ b/documentation/operators/src/nodes/maintenance.md @@ -4,6 +4,20 @@ TODO - [x] Compare mixnode, gateway, NR steps and validator of upgrading and automation and make a generic page - this one - for all of them with additional notes for particular nodes ---> +## Useful commands + +> Adding `--no-banner` startup flag will prevent Nym banner being printed even if run in tty environment. + +**build-info** + +A `build-info` command prints the build information like commit hash, rust version, binary version just like what command `--version` does. However, you can also specify an `--output=json` flag that will format the whole output as a json, making it an order of magnitude easier to parse. + +For example `./target/debug/nym-network-requester --no-banner build-info --output json` will return: + +``` +{"binary_name":"nym-network-requester","build_timestamp":"2023-07-24T15:38:37.00657Z","build_version":"1.1.23","commit_sha":"c70149400206dce24cf20babb1e64f22202672dd","commit_timestamp":"2023-07-24T14:45:45Z","commit_branch":"feature/simplify-cli-parsing","rustc_version":"1.71.0","rustc_channel":"stable","cargo_profile":"debug"} +``` + ## Upgrading your node > The process is the similar for mixnode, gateway and network requester. In the following steps we use a placeholder `` in the commands, please change it for the type of node you want to upgrade. Any particularities for the given type of node are included. diff --git a/documentation/operators/src/nodes/mix-node-setup.md b/documentation/operators/src/nodes/mix-node-setup.md index 435f560a59..8797c13056 100644 --- a/documentation/operators/src/nodes/mix-node-setup.md +++ b/documentation/operators/src/nodes/mix-node-setup.md @@ -67,6 +67,8 @@ You can also check the various arguments required for individual commands with: ./nym-mixnode --help ``` +> Adding `--no-banner` startup flag will prevent Nym banner being printed even if run in tty environment. + ### Initialising your mix node To check available configuration options for initializing your node use: diff --git a/documentation/operators/src/nodes/network-requester-setup.md b/documentation/operators/src/nodes/network-requester-setup.md index 1f5e5eee0c..33dc3c7c90 100644 --- a/documentation/operators/src/nodes/network-requester-setup.md +++ b/documentation/operators/src/nodes/network-requester-setup.md @@ -107,6 +107,8 @@ You can check the required parameters for available commands by running: ./nym-network-requester --help ``` +> Adding `--no-banner` startup flag will prevent Nym banner being printed even if run in tty environment. + ## Initializing and running your network requester The network-requester needs to be initialized before it can be run. This is required for the embedded nym-client to connect successfully to the mixnet. We want to specify an `` using the `--id` command and give it a value of your choice. The following command will achieve that: