chore: add Docker Usage Instructions to README.md #1424
Conversation
containerman17
requested review from
ceyonur,
darioush and
a team
as code owners
containerman17
changed the title
|
LGTM |
|
|
||
| ### Updating | ||
|
|
||
| Run `docker stop avago; docker rm avago;` then start a new container with the latest version tag in your `docker run` command. |
There was a problem hiding this comment.
nit (or maybe && is more appropriate)
| Run `docker stop avago; docker rm avago;` then start a new container with the latest version tag in your `docker run` command. | |
| Run `docker stop avago; docker rm avago` then start a new container with the latest version tag in your `docker run` command. |
There was a problem hiding this comment.
I would keep ; for idempotency. It doesn’t make an actual difference since docker stop always returns zero, but ; makes a clear statement: "all commands will execute no matter what."
| - `AVAGO_HTTP_PORT` is set to `8080` instead of `9650` to avoid conflicts with the validator. | ||
| - `AVAGO_HTTP_ALLOWED_HOSTS` and `AVAGO_HTTP_HOST` are required to allow the RPC server to be accessed from outside. You'll need to secure it with HTTPS; Caddy is recommended. | ||
|
|
||
| RPC example uses another folder `~/.avalanchego_rpc` to avoid conflicts with the validator if you want to run both on the same machine. |
There was a problem hiding this comment.
curious is it common / recommended to run both on the same machine?
There was a problem hiding this comment.
I don’t see why not. It’s a trusted binary, so Docker-level isolation should be enough, as long as you have sufficient resources. Subnet-EVM without X and C chains doesn’t require much. Would I run it on the same machine for DFK? Probably not. But for 95% of other networks, especially on Fuji, I don’t see an issue.
Actually, that raises another question—why is it not recommended to run the same node as both a validator and a public RPC node?
Co-authored-by: Quentin McGaw <[email protected]> Signed-off-by: containerman17 <[email protected]>
Why this should be merged
The README.md currently lacks instructions on running subnet-evm using Docker. Adding a Docker section will help users set up and configure subnet-evm easily in containerized environments.
How this works
Added a new Run in Docker section to the README.md with brief instructions on configuration, data persistence, updating, networking, and example setups for both a Fuji subnet validator and RPC server.
How this was tested
I tested the examples manually.
Need to be documented?
No additional documentation is needed; all information is included in the updated README.md.
Need to update RELEASES.md?
No update to RELEASES.md is necessary since this is a documentation addition.