diff --git a/README.md b/README.md index 1a4ab8e..6c3692b 100644 --- a/README.md +++ b/README.md @@ -64,9 +64,9 @@ flags: - `-m|--memory MEMORY`: container memory limit in megabytes (default: unlimited) - `-N|--initial-network INITIAL_NETWORK`: the initial network to attach the service to - `-p|--password PASSWORD`: override the user-level service password -- `-P|--post-create-network NETWORKS`: a comman-separated list of networks to attach the service container to after service creation +- `-P|--post-create-network NETWORKS`: a comma-separated list of networks to attach the service container to after service creation - `-r|--root-password PASSWORD`: override the root-level service password -- `-S|--post-start-network NETWORKS`: a comman-separated list of networks to attach the service container to after service start +- `-S|--post-start-network NETWORKS`: a comma-separated list of networks to attach the service container to after service start - `-s|--shm-size SHM_SIZE`: override shared memory size for typesense docker container Create a typesense service named lollipop: @@ -75,7 +75,7 @@ Create a typesense service named lollipop: dokku typesense:create lollipop ``` -You can also specify the image and image version to use for the service. It *must* be compatible with the typesense/typesense image. +You can also specify the image and image version to use for the service. It _must_ be compatible with the typesense/typesense image. ```shell export TYPESENSE_IMAGE="typesense/typesense" @@ -141,7 +141,7 @@ dokku typesense:info lollipop --version ```shell # usage -dokku typesense:list +dokku typesense:list ``` List all services: @@ -432,9 +432,9 @@ flags: - `-i|--image IMAGE`: the image name to start the service with - `-I|--image-version IMAGE_VERSION`: the image version to start the service with - `-N|--initial-network INITIAL_NETWORK`: the initial network to attach the service to -- `-P|--post-create-network NETWORKS`: a comman-separated list of networks to attach the service container to after service creation +- `-P|--post-create-network NETWORKS`: a comma-separated list of networks to attach the service container to after service creation - `-R|--restart-apps "true"`: whether or not to force an app restart (default: false) -- `-S|--post-start-network NETWORKS`: a comman-separated list of networks to attach the service container to after service start +- `-S|--post-start-network NETWORKS`: a comma-separated list of networks to attach the service container to after service start - `-s|--shm-size SHM_SIZE`: override shared memory size for typesense docker container You can upgrade an existing service to a new image or image-version: @@ -476,9 +476,9 @@ flags: - `-m|--memory MEMORY`: container memory limit in megabytes (default: unlimited) - `-N|--initial-network INITIAL_NETWORK`: the initial network to attach the service to - `-p|--password PASSWORD`: override the user-level service password -- `-P|--post-create-network NETWORKS`: a comman-separated list of networks to attach the service container to after service creation +- `-P|--post-create-network NETWORKS`: a comma-separated list of networks to attach the service container to after service creation - `-r|--root-password PASSWORD`: override the root-level service password -- `-S|--post-start-network NETWORKS`: a comman-separated list of networks to attach the service container to after service start +- `-S|--post-start-network NETWORKS`: a comma-separated list of networks to attach the service container to after service start - `-s|--shm-size SHM_SIZE`: override shared memory size for typesense docker container You can clone an existing service to a new one: @@ -525,6 +525,7 @@ List all apps linked to the `lollipop` typesense service. ```shell dokku typesense:links lollipop ``` + ### Backups Datastore backups are supported via AWS S3 and S3 compatible services like [minio](https://github.com/minio/minio). diff --git a/subcommands/clone b/subcommands/clone index eb10519..b9d99a3 100755 --- a/subcommands/clone +++ b/subcommands/clone @@ -17,9 +17,9 @@ service-clone-cmd() { #F -m|--memory MEMORY, container memory limit in megabytes (default: unlimited) #F -N|--initial-network INITIAL_NETWORK, the initial network to attach the service to #F -p|--password PASSWORD, override the user-level service password - #F -P|--post-create-network NETWORKS, a comman-separated list of networks to attach the service container to after service creation + #F -P|--post-create-network NETWORKS, a comma-separated list of networks to attach the service container to after service creation #F -r|--root-password PASSWORD, override the root-level service password - #F -S|--post-start-network NETWORKS, a comman-separated list of networks to attach the service container to after service start + #F -S|--post-start-network NETWORKS, a comma-separated list of networks to attach the service container to after service start #F -s|--shm-size SHM_SIZE, override shared memory size for $PLUGIN_COMMAND_PREFIX docker container declare desc="create container then copy data from into " local cmd="$PLUGIN_COMMAND_PREFIX:clone" argv=("$@") diff --git a/subcommands/create b/subcommands/create index 87135e5..1192b59 100755 --- a/subcommands/create +++ b/subcommands/create @@ -25,9 +25,9 @@ service-create-cmd() { #F -m|--memory MEMORY, container memory limit in megabytes (default: unlimited) #F -N|--initial-network INITIAL_NETWORK, the initial network to attach the service to #F -p|--password PASSWORD, override the user-level service password - #F -P|--post-create-network NETWORKS, a comman-separated list of networks to attach the service container to after service creation + #F -P|--post-create-network NETWORKS, a comma-separated list of networks to attach the service container to after service creation #F -r|--root-password PASSWORD, override the root-level service password - #F -S|--post-start-network NETWORKS, a comman-separated list of networks to attach the service container to after service start + #F -S|--post-start-network NETWORKS, a comma-separated list of networks to attach the service container to after service start #F -s|--shm-size SHM_SIZE, override shared memory size for $PLUGIN_COMMAND_PREFIX docker container declare desc="create a $PLUGIN_SERVICE service" local cmd="$PLUGIN_COMMAND_PREFIX:create" argv=("$@") diff --git a/subcommands/upgrade b/subcommands/upgrade index 93352c1..3eeccde 100755 --- a/subcommands/upgrade +++ b/subcommands/upgrade @@ -15,9 +15,9 @@ service-upgrade-cmd() { #F -i|--image IMAGE, the image name to start the service with #F -I|--image-version IMAGE_VERSION, the image version to start the service with #F -N|--initial-network INITIAL_NETWORK, the initial network to attach the service to - #F -P|--post-create-network NETWORKS, a comman-separated list of networks to attach the service container to after service creation + #F -P|--post-create-network NETWORKS, a comma-separated list of networks to attach the service container to after service creation #F -R|--restart-apps "true", whether or not to force an app restart (default: false) - #F -S|--post-start-network NETWORKS, a comman-separated list of networks to attach the service container to after service start + #F -S|--post-start-network NETWORKS, a comma-separated list of networks to attach the service container to after service start #F -s|--shm-size SHM_SIZE, override shared memory size for $PLUGIN_COMMAND_PREFIX docker container declare desc="upgrade service to the specified versions" local cmd="$PLUGIN_COMMAND_PREFIX:upgrade" argv=("$@")