From 20e976a6f6175f14734793bc25c6227175615baa Mon Sep 17 00:00:00 2001 From: David Boreham Date: Mon, 4 Sep 2023 12:08:09 -0600 Subject: [PATCH] Update port mapping documentation --- app/data/stacks/mainnet-eth/README.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/app/data/stacks/mainnet-eth/README.md b/app/data/stacks/mainnet-eth/README.md index 23c8d325..42787d20 100644 --- a/app/data/stacks/mainnet-eth/README.md +++ b/app/data/stacks/mainnet-eth/README.md @@ -73,7 +73,7 @@ After deleting the volumes, any subsequent re-start will begin chain sync from c ## Ports It is usually necessary to expose certain container ports on one or more the host's addresses to allow incoming connections. -Any ports defined in the Docker compose file are exposed by default with random port assignments, but the values can be +Any ports defined in the Docker compose file are exposed by default with random port assignments, bound to "any" interface (IP address 0.0.0.0), but the port mappings can be customized by editing the "spec" file generated by `laconic-so deploy init`. In this example, ports `8545` and `5052` have been assigned to a specific addresses/port combination on the host, while @@ -92,7 +92,15 @@ volumes: mainnet_eth_geth_1_data: ./data/mainnet_eth_geth_1_data mainnet_eth_lighthouse_1_data: ./data/mainnet_eth_lighthouse_1_data ``` - +In addition, a stack-wide port mapping "recipe" can be applied at the time the +`laconic-so deploy init` command is run, by supplying the desired recipe with the `--map-ports-to-host` option. The following recipies are supported: +| Recipe | Host Port Mapping | +|--------|-------------------| +| any-variable-random | Bind to 0.0.0.0 using a random port assigned at start time (default) | +| localhost-same | Bind to 127.0.0.1 using the same port number as exposed by the containers | +| any-same | Bind to 0.0.0.0 using the same port number as exposed by the containers | +| localhost-fixed-random | Bind to 127.0.0.1 using a random port number selected at the time the command is run (not checked for already in use)| +| any-fixed-random | Bind to 0.0.0.0 using a random port number selected at the time the command is run (not checked for already in use) | ## Data volumes Container data volumes are bind-mounted to specified paths in the host filesystem. The default setup (generated by `laconic-so deploy init`) places the volumes in the `./data` subdirectory of the deployment directory: