docs: add a note as to how to specify an interface/ip to bind on when exposing a service

Closes dokku/dokku-mongo#128
This commit is contained in:
Jose Diaz-Gonzalez
2021-09-12 07:09:53 -04:00
parent e09524029e
commit f1d7100475
2 changed files with 11 additions and 3 deletions

View File

@@ -34,7 +34,7 @@ mongo:destroy <service> [-f|--force] # delete the mongo service/da
mongo:enter <service> # enter or run a command in a running mongo service container
mongo:exists <service> # check if the mongo service exists
mongo:export <service> # export a dump of the mongo service database
mongo:expose <service> <ports...> # expose a mongo service on custom port if provided (random port otherwise)
mongo:expose <service> <ports...> # expose a mongo service on custom host:port if provided (random port on the 0.0.0.0 interface if otherwise unspecified)
mongo:import <service> # import a dump into the mongo service database
mongo:info <service> [--single-info-flag] # print the service information
mongo:link <service> <app> [--link-flags...] # link the mongo service to the app
@@ -277,7 +277,7 @@ You may also run a command directly against the service. Filesystem changes will
dokku mongo:enter lolipop touch /tmp/test
```
### expose a mongo service on custom port if provided (random port otherwise)
### expose a mongo service on custom host:port if provided (random port on the 0.0.0.0 interface if otherwise unspecified)
```shell
# usage
@@ -290,6 +290,12 @@ Expose the service on the service's normal ports, allowing access to it from the
dokku mongo:expose lolipop 27017 27018 27019 28017
```
Expose the service on the service's normal ports, with the first on a specified ip adddress (127.0.0.1):
```shell
dokku mongo:expose lolipop 127.0.0.1:27017 27018 27019 28017
```
### unexpose a previously exposed mongo service
```shell

View File

@@ -8,9 +8,11 @@ source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
service-expose-cmd() {
#E expose the service on the service's normal ports, allowing access to it from the public interface (0.0.0.0)
#E dokku $PLUGIN_COMMAND_PREFIX:expose lolipop ${PLUGIN_DATASTORE_PORTS[@]}
#E expose the service on the service's normal ports, with the first on a specified ip adddress (127.0.0.1)
#E dokku $PLUGIN_COMMAND_PREFIX:expose lolipop 127.0.0.1:${PLUGIN_DATASTORE_PORTS[@]}
#A service, service to run command against
#A ports, a list of ports to run against
declare desc="expose a $PLUGIN_SERVICE service on custom port if provided (random port otherwise)"
declare desc="expose a $PLUGIN_SERVICE service on custom host:port if provided (random port on the 0.0.0.0 interface if otherwise unspecified)"
local cmd="$PLUGIN_COMMAND_PREFIX:expose" argv=("$@")
[[ ${argv[0]} == "$cmd" ]] && shift 1
declare SERVICE="$1" PORTS_LIST=("${@:2}")