From d72d040717a2797da44c51046defb26c8e7b6345 Mon Sep 17 00:00:00 2001 From: Hernando Castano Date: Fri, 21 Jul 2023 16:52:38 -0400 Subject: [PATCH 1/9] Use `latest` tag in README instructions --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 9ab4a6a..a272901 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ devnet node for testing without depending on the network or service. ## To run the docker image from ghcr.io ```bash -docker run --platform linux/amd64 -p 26657:26657 -p 26659:26659 ghcr.io/rollkit/local-celestia-devnet:v0.8.2 +docker run --platform linux/amd64 -p 26657:26657 -p 26659:26659 ghcr.io/rollkit/local-celestia-devnet:latest ``` ## To build and run the docker image From 4c60fafd2fff66e364e54eee5f8d84a60046a353 Mon Sep 17 00:00:00 2001 From: Hernando Castano Date: Fri, 21 Jul 2023 16:54:00 -0400 Subject: [PATCH 2/9] Forward ports to match those `exposed` in Dockerfile --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index a272901..c22b6f5 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ devnet node for testing without depending on the network or service. ## To run the docker image from ghcr.io ```bash -docker run --platform linux/amd64 -p 26657:26657 -p 26659:26659 ghcr.io/rollkit/local-celestia-devnet:latest +docker run --platform linux/amd64 -p 26657:26657 -p 26658:26658 -p 26659:26659 -p 9090:9090 ghcr.io/rollkit/local-celestia-devnet:latest ``` ## To build and run the docker image @@ -32,7 +32,7 @@ docker build . -t celestia-local-devnet To run the docker container: ```bash -docker run --platform linux/amd64 -p 26657:26657 -p 26659:26659 celestia-local-devnet +docker run --platform linux/amd64 -p 26657:26657 -p 26658:26658 -p 26659:26659 -p 9090:9090 celestia-local-devnet ``` Test that the RPC server is up: From 0187c4e9f7c289a1529e546e198be9e1876edda3 Mon Sep 17 00:00:00 2001 From: Hernando Castano Date: Fri, 21 Jul 2023 16:54:53 -0400 Subject: [PATCH 3/9] Split long command over a few lines --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c22b6f5..e5138a2 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,9 @@ devnet node for testing without depending on the network or service. ## To run the docker image from ghcr.io ```bash -docker run --platform linux/amd64 -p 26657:26657 -p 26658:26658 -p 26659:26659 -p 9090:9090 ghcr.io/rollkit/local-celestia-devnet:latest +docker run --platform linux/amd64 \ + -p 26657:26657 -p 26658:26658 -p 26659:26659 -p 9090:9090 \ + ghcr.io/rollkit/local-celestia-devnet:latest ``` ## To build and run the docker image @@ -32,7 +34,9 @@ docker build . -t celestia-local-devnet To run the docker container: ```bash -docker run --platform linux/amd64 -p 26657:26657 -p 26658:26658 -p 26659:26659 -p 9090:9090 celestia-local-devnet +docker run --platform linux/amd64 \ + -p 26657:26657 -p 26658:26658 -p 26659:26659 -p 9090:9090 \ + celestia-local-devnet ``` Test that the RPC server is up: From cd1fb97c799a6708df7d489124c913a95833c19f Mon Sep 17 00:00:00 2001 From: Hernando Castano Date: Fri, 21 Jul 2023 16:55:21 -0400 Subject: [PATCH 4/9] Capitalize the spelling of "Docker" --- README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index e5138a2..43614a7 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,17 @@ # Local Celestia Devnet -This repo provides a docker image that allows developers to spin up a local +This repo provides a Docker image that allows developers to spin up a local devnet node for testing without depending on the network or service. -## To run the docker image from ghcr.io +## To run the Docker image from ghcr.io ```bash -docker run --platform linux/amd64 \ +Docker run --platform linux/amd64 \ -p 26657:26657 -p 26658:26658 -p 26659:26659 -p 9090:9090 \ ghcr.io/rollkit/local-celestia-devnet:latest ``` -## To build and run the docker image +## To build and run the Docker image First, clone the repository: @@ -25,16 +25,16 @@ Change into the directory: cd local-celestia-devnet/ ``` -To build the docker image: +To build the Docker image: ```bash -docker build . -t celestia-local-devnet +Docker build . -t celestia-local-devnet ``` -To run the docker container: +To run the Docker container: ```bash -docker run --platform linux/amd64 \ +Docker run --platform linux/amd64 \ -p 26657:26657 -p 26658:26658 -p 26659:26659 -p 9090:9090 \ celestia-local-devnet ``` From d8146aab4224550b6911062cfe98c449d45b6506 Mon Sep 17 00:00:00 2001 From: Hernando Castano Date: Mon, 31 Jul 2023 12:10:13 -0400 Subject: [PATCH 5/9] Fix Docker spelling in Bash commands --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 43614a7..3545ffe 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ devnet node for testing without depending on the network or service. ## To run the Docker image from ghcr.io ```bash -Docker run --platform linux/amd64 \ +docker run --platform linux/amd64 \ -p 26657:26657 -p 26658:26658 -p 26659:26659 -p 9090:9090 \ ghcr.io/rollkit/local-celestia-devnet:latest ``` @@ -28,13 +28,13 @@ cd local-celestia-devnet/ To build the Docker image: ```bash -Docker build . -t celestia-local-devnet +docker build . -t celestia-local-devnet ``` To run the Docker container: ```bash -Docker run --platform linux/amd64 \ +docker run --platform linux/amd64 \ -p 26657:26657 -p 26658:26658 -p 26659:26659 -p 9090:9090 \ celestia-local-devnet ``` From 77e92b8ab3768f74dd0cba620cb5928b3540a61f Mon Sep 17 00:00:00 2001 From: Hernando Castano Date: Mon, 31 Jul 2023 12:10:40 -0400 Subject: [PATCH 6/9] Remove `--platform` flag --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 3545ffe..873994f 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ devnet node for testing without depending on the network or service. ## To run the Docker image from ghcr.io ```bash -docker run --platform linux/amd64 \ +docker run \ -p 26657:26657 -p 26658:26658 -p 26659:26659 -p 9090:9090 \ ghcr.io/rollkit/local-celestia-devnet:latest ``` @@ -34,7 +34,7 @@ docker build . -t celestia-local-devnet To run the Docker container: ```bash -docker run --platform linux/amd64 \ +docker run \ -p 26657:26657 -p 26658:26658 -p 26659:26659 -p 9090:9090 \ celestia-local-devnet ``` From 96849d723cebbf5feea8b79fb6de3555e47db38c Mon Sep 17 00:00:00 2001 From: Hernando Castano Date: Mon, 31 Jul 2023 12:32:00 -0400 Subject: [PATCH 7/9] Add section with exposed ports --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index 873994f..c026ac2 100644 --- a/README.md +++ b/README.md @@ -44,3 +44,17 @@ Test that the RPC server is up: ```bash curl -X GET http://127.0.0.1:26659/head ``` + +## Exposed Ports + +| Port | Protocol | Address | Description | +|-------|----------|-----------|-------------| +| 26657 | HTTP | 127.0.0.1 | RPC | +| 26658 | HTTP | 127.0.0.1 | RPC | +| 26659 | HTTP | 127.0.0.1 | REST | +| 9090 | HTTP | 0.0.0.0 | gRPC | + +You can also find a section on port usage in the +[`celestia-app` tutorial](https://docs.celestia.org/nodes/celestia-app/#ports) +and the node +[troubleshooting section](https://docs.celestia.org/nodes/celestia-node-troubleshooting/#ports). From bcb7cd2b2de86da495c6ec74a64d6c51acc10c38 Mon Sep 17 00:00:00 2001 From: Hernando Castano Date: Mon, 31 Jul 2023 12:37:29 -0400 Subject: [PATCH 8/9] Mention HTTP gateway over RPC server --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c026ac2..6dda088 100644 --- a/README.md +++ b/README.md @@ -39,7 +39,7 @@ docker run \ celestia-local-devnet ``` -Test that the RPC server is up: +Test that the HTTP gateway server is up: ```bash curl -X GET http://127.0.0.1:26659/head From f6d9216f208cb57ddcb953795a843e8eee6816cc Mon Sep 17 00:00:00 2001 From: Hernando Castano Date: Tue, 1 Aug 2023 10:59:15 -0400 Subject: [PATCH 9/9] Add "Node Type" to port table --- README.md | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 6dda088..0a2b7af 100644 --- a/README.md +++ b/README.md @@ -47,14 +47,17 @@ curl -X GET http://127.0.0.1:26659/head ## Exposed Ports -| Port | Protocol | Address | Description | -|-------|----------|-----------|-------------| -| 26657 | HTTP | 127.0.0.1 | RPC | -| 26658 | HTTP | 127.0.0.1 | RPC | -| 26659 | HTTP | 127.0.0.1 | REST | -| 9090 | HTTP | 0.0.0.0 | gRPC | +| Port | Protocol | Address | Description | Node Type | +|-------|----------|-----------|-------------|-----------------------------------------| +| 26657 | HTTP | 127.0.0.1 | RPC | Consensus (e.g `celestia-app`) | +| 26658 | HTTP | 127.0.0.1 | RPC | Data Availability (e.g `celestia-node`) | +| 26659 | HTTP | 127.0.0.1 | REST | Data Availability (e.g `celestia-node`) | +| 9090 | HTTP | 0.0.0.0 | gRPC | Consensus (e.g `celestia-app`) | You can also find a section on port usage in the [`celestia-app` tutorial](https://docs.celestia.org/nodes/celestia-app/#ports) and the node [troubleshooting section](https://docs.celestia.org/nodes/celestia-node-troubleshooting/#ports). + +For information about the different node types, see +[here](https://docs.celestia.org/nodes/overview/).