Clarify installation options and RPC nodes

trilitech · Nov 2, 2023 · 72ff2c2 · 72ff2c2
1 parent f5d58c4
commit 72ff2c2
Showing 1 changed file with 61 additions and 53 deletions.
diff --git a/docs/developing/octez-client/installing.md b/docs/developing/octez-client/installing.md
@@ -7,84 +7,92 @@ You can install the Octez client directly on your computer or use a Docker image
 
 ## Installing the Octez client locally
 
-You can install the Octez client on your computer by using your package manager:
+You can install the Octez client on your computer by using your package manager.
+Then, initialize it to use the RPC node of your choice:
 
-- For MacOS, run these commands:
+1. Install the client:
 
-  ```bash
-  brew tap serokell/tezos-packaging-stable https://github.com/serokell/tezos-packaging-stable.git
-  brew install tezos-client
-  ```
+   - For MacOS, run these commands:
 
-- For Ubuntu, Windows WSL, and Linux distributions that use `apt`, run these commands:
+      ```bash
+      brew tap serokell/tezos-packaging-stable https://github.com/serokell/tezos-packaging-stable.git
+      brew install tezos-client
+      ```
 
-  ```bash
-  REPO="ppa:serokell/tezos"
-  sudo add-apt-repository -y $REPO && sudo apt-get update
-  sudo apt-get install -y tezos-client
-  ```
+   - For Ubuntu, Windows WSL, and Linux distributions that use `apt`, run these commands:
 
-- For Fedora and Linux distributions that use Copr, run these commands:
+      ```bash
+      REPO="ppa:serokell/tezos"
+      sudo add-apt-repository -y $REPO && sudo apt-get update
+      sudo apt-get install -y tezos-client
+      ```
 
-  ```bash
-  REPO="@Serokell/Tezos"
-  dnf copr enable -y $REPO && dnf update -y
-  dnf install -y tezos-client
-  ```
+   - For Fedora and Linux distributions that use Copr, run these commands:
 
-For more local installation options, see [How to get Tezos](https://tezos.gitlab.io/introduction/howtoget.html) in the Octez documentation.
+      ```bash
+      REPO="@Serokell/Tezos"
+      dnf copr enable -y $REPO && dnf update -y
+      dnf install -y tezos-client
+      ```
 
-You can verify that the Octez client is installed by running this command:
+   For more local installation options, see [How to get Tezos](https://tezos.gitlab.io/introduction/howtoget.html) in the Octez documentation.
 
-```bash
-octez-client --version
-```
+1. Verify that the Octez client is installed by running this command:
 
-If you see a message with the version of Octez that you have installed, the Octez client is installed correctly.
-For help on Octez, run `octez-client --help` or see the [Octez documentation](http://tezos.gitlab.io/index.html).
+   ```bash
+   octez-client --version
+   ```
 
-## Using the Octez client in the Tezos Docker image
+   If you see a message with the version of Octez that you have installed, the Octez client is installed correctly.
+   For help on Octez, run `octez-client --help` or see the [Octez documentation](http://tezos.gitlab.io/index.html).
 
-The Tezos Docker image contains the latest version of the Octez client and the other Octez tools.
-To start a container from this image, run this command:
+1. Initialize the client's configuration file by running this command:
 
-```bash
-docker run -it --rm --entrypoint /bin/sh --name octez-container tezos/tezos:latest
-```
+   ```bash
+   octez-client config init
+   ```
 
-You can verify that the Octez client is available in the container by running this command:
+   This command creates a default configuration file in the location `$HOME/.tezos-client/config`.
 
-```bash
-octez-client --version
-```
+1. Set the RPC node to use:
 
-For a full list of Octez client commands, run `octez-client man`.
+   1. Get the URL of a public RPC node or a private node that you have access to.
+   For example, you can get the URL of a testnet node from https://teztnets.xyz/, such as `https://rpc.ghostnet.teztnets.xyz` for Ghostnet.
 
-## Configuring the Octez client
+   1. Set your Octez client to use this node by running this command on the command line, replacing the Ghostnet URL with the URL that you copied:
 
-After you install the Octez client, you can set the RPC node to use.
+      ```bash
+      octez-client --endpoint https://rpc.ghostnet.teztnets.xyz config update
+      ```
 
-For example, to use a testnet, follow these steps:
+      If you are using a testnet, Octez shows a warning that you are not using Mainnet.
+      You can hide this message by setting the `TEZOS_CLIENT_UNSAFE_DISABLE_DISCLAIMER` environment variable to "YES".
 
-1. On https://teztnets.xyz/, click the testnet to use, such as Ghostnet.
+   1. Verify that you are using the correct RPC URL by running this command:
 
-1. Copy the one of the testnet's public RPC endpoints, such as `https://rpc.ghostnet.teztnets.xyz`.
+      ```bash
+      octez-client config show
+      ```
 
-1. Set your Octez client to use this testnet by running this command on the command line, replacing the testnet RPC URL with the URL that you copied:
+      The response from Octez includes the URL of the RPC node that you are using.
 
-   ```bash
-   octez-client --endpoint https://rpc.ghostnet.teztnets.xyz config update
-   ```
+For a full list of Octez client commands, run `octez-client man`.
 
-   Octez shows a warning that you are using a testnet instead of mainnet.
-   You can hide this message by setting the `TEZOS_CLIENT_UNSAFE_DISABLE_DISCLAIMER` environment variable to "YES".
+## Using the Octez client in the Tezos Docker image
 
-1. Verify that you are using a testnet by running this command:
+The Tezos Docker image contains the latest version of the Octez client and the other Octez tools.
+To start a container from this image, run this command:
 
-   ```bash
-   octez-client config show
-   ```
+```bash
+docker run -it --rm --entrypoint /bin/sh --name octez-container tezos/tezos:latest
+```
+
+You can verify that the Octez client is available in the container by running this command:
+
+```bash
+octez-client --version
+```
 
-   The response from Octez includes the URL of the testnet.
+Then set the RPC node for the client as described above.
 
-The Octez client keeps its configuration data in the `$HOME/.tezos-client/config` file.
+For more information about using the Docker image, see [Using Docker Images And Docker-Compose](https://tezos.gitlab.io/introduction/howtoget.html#using-docker-images-and-docker-compose) in the Octez documentation.