From adec2c22c800467351cf47b68c21d3dfd16c0c3f Mon Sep 17 00:00:00 2001 From: Adrian Thompson Date: Tue, 28 May 2024 16:47:20 -0500 Subject: [PATCH] Update docket image for archway node installation (#486) --- .../1.running-a-node/2.install.md | 73 +++++++++---------- 1 file changed, 33 insertions(+), 40 deletions(-) diff --git a/content/4.validators/1.running-a-node/2.install.md b/content/4.validators/1.running-a-node/2.install.md index 0b4fcbc9..c47a9055 100644 --- a/content/4.validators/1.running-a-node/2.install.md +++ b/content/4.validators/1.running-a-node/2.install.md @@ -125,8 +125,7 @@ sudo mv archwayd_linux_amd64 /usr/local/bin/archwayd ## Use the archwayd docker image -As an alternative, you can also use Docker (make sure to install it). - +For this option you will need to have Docker installed. ::alert{variant="warning"} For Linux users, it's recommended to run the Docker daemon in Rootless Mode. @@ -138,33 +137,25 @@ Warning ### Pull the docker image -You can pull the docker image from the following repositories: - -- Production - -- Development and Debugging - -Make sure to pull the docker image relative to the latest release. +You can pull the docker image from the following repository. Make sure to pull the docker image relative to the latest Archway release. -For example, to connect to the Tromphe mainnet or Constantine testnet, issue the following command: +For example, to connect to the Tromphe (mainnet or Constantine (testnet), issue the following command: ::highlight-card ```bash -docker pull ghcr.io/archway-network/archwayd:$$archwayVersion$$ +docker pull ghcr.io/archway-network/archwayd-dev:$$archwayVersion$$ ``` :: ::alert{variant="info"} -Make sure to always use the image tag that points to the network you want to connect. +Make sure to always use the image tag that is being used on the network you want to connect to. #title Info :: - - ### Set up the PATH @@ -175,7 +166,7 @@ By default, the Docker image runs the `archwayd` binary, so you should specify t ```bash docker run --rm -it \ -v ~/.archway:/root/.archway \ - ghcr.io/archway-network/archwayd:$$archwayVersion$$ \ + ghcr.io/archway-network/archwayd-dev:$$archwayVersion$$ \ keys add test-key ``` @@ -188,7 +179,7 @@ And then list all keys: ```bash docker run --rm -it \ -v ~/.archway:/root/.archway \ - ghcr.io/archway-network/archwayd:$$archwayVersion$$ \ + ghcr.io/archway-network/archwayd-dev:$$archwayVersion$$ \ keys list ``` @@ -206,7 +197,7 @@ To simplify using the Docker container, you can set an alias with the home path ::highlight-card ```bash -alias archwayd="docker run --rm -it -v ~/.archway:/root/.archway ghcr.io/archway-network/archwayd:$$archwayVersion$$" +alias archwayd="docker run --rm -it -v ~/.archway:/root/.archway ghcr.io/archway-network/archwayd-dev:$$archwayVersion$$" ``` :: @@ -216,13 +207,14 @@ Info :: After setting the alias with the above tip, you can use the other **archwayd** commands without typing the verbose Docker run command. + For the sake of comprehensive documentation, the full Docker command is shown. Just remember that by setting the alias you can simply use **archwayd** instead of the Docker command. ## Build archwayd from source (not recommended) -If you cannot use the pre-built binary or the docker image, you can build the binary yourself. +If you cannot use the pre-built binary or the docker image, you can build the binary yourself. This might be the ideal solution for users on MacOS running M1/M2 chips if they are not willing to utilize our Docker solution above. ### Clone the repository Alternatively, you can clone the source code from the Archway repository. Go to https://github.com/archway-network/archway/releases to find the latest releases. You will then switch the **\** below with the latest release version. @@ -325,37 +317,38 @@ archwayd The following information should be shown: ```bash +Archway Daemon (server) + Usage: - archway [command] + archwayd [command] Available Commands: - add-genesis-account Add a genesis account to genesis.json - collect-gentxs Collect genesis txs and output a genesis.json file - config Create or query an application CLI configuration file - debug Tool for helping with debugging your application - ensure-binary ensures the binary is correctly built - export Export state to JSON - gentx Generate a genesis tx carrying a self delegation - help Help about any command - init Initialize private validator, p2p, genesis, and application configuration files - keys Manage your application's keys - query Querying subcommands - rollback rollback cosmos-sdk and tendermint state by one height - start Run the full node - status Query remote node for status - tendermint Tendermint subcommands - tx Transactions subcommands - validate-genesis validates the genesis file at the default location or at the location passed as an arg - version Print the application binary version information + config Create or query an application CLI configuration file + debug Tool for helping with debugging your application + ensure-binary ensures the binary is correctly built + export Export state to JSON + genesis Application's genesis-related subcommands + help Help about any command + init Initialize private validator, p2p, genesis, and application configuration files + keys Manage your application's keys + query Querying subcommands + rollback rollback cosmos-sdk and tendermint state by one height + rosetta spin up a rosetta server + start Run the full node + status Query remote node for status + tendermint Tendermint subcommands + tx Transactions subcommands + version Print the application binary version information Flags: - -h, --help help for archway - --home string directory for config and data (default "/home/usuario/.archway") + -h, --help help for archwayd + --home string directory for config and data (default "/Users/adrianthompson/.archway") --log_format string The logging format (json|plain) (default "plain") --log_level string The logging level (trace|debug|info|warn|error|fatal|panic) (default "info") + --log_no_color Disable colored logs --trace print out full stack trace on errors -Use "archway [command] --help" for more information about a command. +Use "archwayd [command] --help" for more information about a command. ```