Skip to content

README update for container check step #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 6 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ If you need a server, you can rent one from Hetzner. Additionally, if you sign u
[Visual Studio Code Download Page](https://code.visualstudio.com/)

- Once downloaded, follow the installation wizard to install Visual Studio Code.

2. **Install the SSH Extension:**

- Open Visual Studio Code.
- Click on the `Extensions` icon in the left sidebar.
- Type `Remote - SSH` in the search bar and install the extension developed by Microsoft.
Expand All @@ -36,12 +36,11 @@ If you need a server, you can rent one from Hetzner. Additionally, if you sign u
- Enter your password or SSH key to complete the connection.

**Note:** Replace `ip_address` with the actual IP address of your server.

2. **Verify the Connection:**

- If the connection is successful, the name of the connected server will appear in the lower-left corner of the Visual Studio Code window.

3. **Open the Terminal:**

- After connecting to the server in Visual Studio Code, you can open the terminal by clicking on `Terminal` > `New Terminal` in the top menu.
- Alternatively, you can open the terminal by pressing `Ctrl+` (Control key and the backtick key, located below the ESC key).

Expand All @@ -56,19 +55,16 @@ After successfully connecting to the server, execute these commands on the serve
```sh
sudo apt update
```

2. **Install Docker:**

```sh
sudo apt install docker.io
```

3. **Verify Docker Service is Running:**

```sh
sudo systemctl status docker
```

4. **Verify Docker Installation:**

```sh
Expand All @@ -82,14 +78,13 @@ After successfully connecting to the server, execute these commands on the serve
```sh
sudo curl -L "https://github.com/docker/compose/releases/download/1.29.2/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
```

2. **Give Execute Permission to Docker Compose:**

```sh
sudo chmod +x /usr/local/bin/docker-compose
```

3. **Verify Installation:**

```sh
docker-compose --version
```
Expand All @@ -101,35 +96,31 @@ After successfully connecting to the server, execute these commands on the serve
```sh
sudo apt install git
```

2. **Clone the Repository:**

```sh
git clone https://github.com/matter-labs/zksync-era.git
```

3. **Navigate to the Cloned Directories:**

```sh
cd zksync-era/docs/guides/external-node
cd docker-compose-examples
```

4. **Start the Node Using Docker Compose:**

```sh
docker-compose -f mainnet-external-node-docker-compose.yml up -d
```

5. **Verify Running Containers:**

```sh
docker ps
```

This command lists currently running Docker containers. You should see the containers related to the `zkSync Era` node.

This command lists currently running Docker containers. You should see the containers related to the `zkSync Era` node. if matterlabs/external-node container does not start in first run, try to rerun command in step 4.
6. **View and Follow the Last 100 Logs:**

```sh
docker logs -f --tail 100 docker-compose-examples-external-node-1
```
Expand All @@ -151,7 +142,6 @@ After running Docker, you can access a dashboard on port 3000. To view this dash
- Click on the `PORTS` section in the bottom right corner of Visual Studio Code.
- Select `Forward Port...` from the menu.
- Enter `3000` for the port number and press Enter.

2. **Access the Dashboard:**

- Open your web browser and go to `http://localhost:3000/d/0/external-node`.
Expand All @@ -166,8 +156,8 @@ This step allows you to easily view the dashboard of the application running on
```sh
docker logs <container_id>
```

- **Stop the Node:**

```sh
docker-compose -f mainnet-external-node-docker-compose.yml down
```