Skip to content

Commit

Permalink
docs(website): add windows guidance and remove sudo (#14806)
Browse files Browse the repository at this point in the history
  • Loading branch information
dionysuzx authored and KorbinianK committed Oct 2, 2023
1 parent e23c267 commit 7367f01
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 7 deletions.
3 changes: 2 additions & 1 deletion packages/website/pages/docs/guides/run-a-sepolia-node.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ This guide will help you get a Sepolia archive node up and running.

- [Docker](https://docs.docker.com/engine/install/) is installed and **running**.
- [Git](https://github.com/git-guides/install-git/) is installed.
- If using Windows, you should install [Git BASH](https://gitforwindows.org/) or [WSL](https://learn.microsoft.com/en-us/windows/wsl/install) to use as your terminal.
- As of `2023-06-21` a full archive node sync takes **326 GB** with geth + lighthouse. Consult the hardware requirements of the execution + consensus clients you are using.

## Steps
Expand Down Expand Up @@ -54,7 +55,7 @@ Complete the [eth-docker quickstart](https://eth-docker.net/Usage/QuickStart/).
After setting up the config, start the Execution Layer and Consensus Layer clients with admin permission

```bash
sudo ./ethd up
./ethd up
```

### Check your connection
Expand Down
9 changes: 7 additions & 2 deletions packages/website/pages/docs/guides/run-a-taiko-node.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ This guide will help you start up a Taiko RPC node using [simple-taiko-node](htt

- [Docker](https://docs.docker.com/engine/install/) is installed and **running**.
- [Git](https://github.com/git-guides/install-git/) is installed.
- If using Windows, you should install [Git BASH](https://gitforwindows.org/) or [WSL](https://learn.microsoft.com/en-us/windows/wsl/install) to use as your terminal.
- Meet the [Geth minimum hardware requirements](https://github.com/ethereum/go-ethereum#hardware-requirements) except for the storage requirement because Taiko nodes will require less storage. As of `2023-09-18` a node uses less than **10 GB**. **100 GB** should be future proof enough if you intend to run your node for a while.

## Steps
Expand Down Expand Up @@ -145,9 +146,11 @@ Take a look at the comments above these values in the `.env.sample` to see how t
Make sure Docker is running and then run the following command to start the node:

```sh
sudo docker compose up -d
docker compose up -d
```

> Note: You may need to use `sudo docker compose up -d` if you are not in the `docker` group.
### Verify node is running

#### Check with the node dashboard
Expand Down Expand Up @@ -193,9 +196,11 @@ curl http://localhost:8547 \
3. If the blockNumber response value is `0` or not growing, check the Taiko L2 logs here:

```bash
sudo docker compose logs -f
docker compose logs -f
```

> Note: You may need to use `sudo docker compose logs -f` if you are not in the `docker` group.
### Operate the node

You can find all node operations (eg. stop node, update node, remove node, view logs) in the [Node runner manual](/docs/manuals/node-runner-manual).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ This block has been proven by someone else, but it's not verified yet, you can i
#### `error: "failed to propose transactions: unable to find prover"`

The proposer is not able to connect with a prover. By default, the prover endpoint is local so check your local prover first.
If you are not running a local prover, select another prover from the [prover market](/docs/reference/prover-market-page). Note: you may need to switch provers if
If you are not running a local prover, select another prover from the [prover market](/docs/reference/prover-market-page). Note: you may need to switch provers if
your selected prover hits its max capacity.

#### `Fatal: Failed to register the Ethereum service: database contains incompatible genesis`
Expand Down Expand Up @@ -165,7 +165,7 @@ docker compose -f ./docker-compose.l3.yml --env-file .env.l3 up -d

#### `dial tcp: connect: connection refused`

This means that you are not able to connect to the RPC endpoint. Check if you have a firewall up and that you are allowing those ports. For Ubuntu, this would be checked with "sudo ufw status".
This means that you are not able to connect to the RPC endpoint. Check if you have a firewall up and that you are allowing those ports. For Ubuntu, this would be checked with `sudo ufw status`.

#### `WARNING: Found orphan containers`

Expand All @@ -177,5 +177,5 @@ You can safely ignore this "warn" level message, it simply means you just ignore

#### `PROPOSE_BLOCK_TX_GAS_TIP_CAP: parameter not set`

A flag might not be set in your .env file.
Copy the default .env file, then reset your RPC node and proposer with the updated flag values.
A flag might not be set in your .env file.
Copy the default .env file, then reset your RPC node and proposer with the updated flag values.

0 comments on commit 7367f01

Please sign in to comment.