Skip to content

Commit

Permalink
Update docket image for archway node installation (#486)
Browse files Browse the repository at this point in the history
  • Loading branch information
@emperorjm
emperorjm authored May 28, 2024
1 parent 54f8287 commit adec2c2
Showing 1 changed file with 33 additions and 40 deletions.
73 changes: 33 additions & 40 deletions content/4.validators/1.running-a-node/2.install.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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 <a href="https://docs.docker.com/get-docker" target="_blank" title="Install Docker">Docker</a> (make sure to install it).

For this option you will need to have <a href="https://docs.docker.com/get-docker" target="_blank" title="Install Docker">Docker</a> installed.

::alert{variant="warning"}
For Linux users, it's recommended to run the Docker daemon in <a href="https://docs.docker.com/engine/security/rootless/" target="_blank" title="Docker Rootless mode">Rootless Mode</a>.
Expand All @@ -138,33 +137,25 @@ Warning
### Pull the docker image


You can pull the docker image from the following repositories:

- <a href="https://github.com/archway-network/archway/pkgs/container/archwayd" target="_blank">Production</a>

- <a href="https://github.com/archway-network/archway/pkgs/container/archwayd-debug" target="_blank">Development and Debugging</a>

Make sure to pull the docker image relative to the latest <a href="https://github.com/archway-network/archway/releases" target="_blank">release</a>.
You can pull the docker image from the following <a href="https://github.com/archway-network/archway/pkgs/container/archwayd-dev" target="_blank">repository</a>. Make sure to pull the docker image relative to the latest Archway <a href="https://github.com/archway-network/archway/releases" target="_blank">release</a>.


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


Expand All @@ -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
```

Expand All @@ -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
```

Expand All @@ -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$$"
```

::
Expand All @@ -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 <a href='https://github.com/archway-network/archway' target='_blank'>Archway repository</a>. Go to <a href='https://github.com/archway-network/archway/releases' target='_blank'>https://github.com/archway-network/archway/releases</a> to find the latest releases. You will then switch the **\<version-tag\>** below with the latest release version.
Expand Down Expand Up @@ -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.
```


Expand Down

0 comments on commit adec2c2

Please sign in to comment.