From 1625c405d5e034545e19c7149669e2a524f4dd52 Mon Sep 17 00:00:00 2001 From: yasin soyaslan Date: Sun, 9 Jun 2024 14:54:01 +0100 Subject: [PATCH] README update for container check step --- README.md | 22 ++++++---------------- 1 file changed, 6 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index a0d5f87..ff0c79b 100644 --- a/README.md +++ b/README.md @@ -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. @@ -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). @@ -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 @@ -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 ``` @@ -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 ``` @@ -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`. @@ -166,8 +156,8 @@ This step allows you to easily view the dashboard of the application running on ```sh docker logs ``` - - **Stop the Node:** + ```sh docker-compose -f mainnet-external-node-docker-compose.yml down ```