dokku/dokku-redis
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: fix the variable reference for plugins where the alias does not match the variable

Browse Source 
Closes dokku/dokku-postgres#199
This commit is contained in:
Jose Diaz-Gonzalez
2021-09-12 22:55:02 -04:00
parent 9cb2f75469
commit cb5aa08986
2 changed files with 17 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

@@ -18,14 +18,14 @@ sudo dokku plugin:install https://github.com/dokku/dokku-redis.git redis
``` ```
redis:app-links <app> # list all redis service links for a given app redis:app-links <app> # list all redis service links for a given app
redis:backup <service> <bucket-name> [--use-iam] # creates a backup of the redis service to an existing s3 bucket redis:backup <service> <bucket-name> [--use-iam] # create a backup of the redis service to an existing s3 bucket
redis:backup-auth <service> <aws-access-key-id> <aws-secret-access-key> <aws-default-region> <aws-signature-version> <endpoint-url> # sets up authentication for backups on the redis service redis:backup-auth <service> <aws-access-key-id> <aws-secret-access-key> <aws-default-region> <aws-signature-version> <endpoint-url> # set up authentication for backups on the redis service
redis:backup-deauth <service> # removes backup authentication for the redis service redis:backup-deauth <service> # remove backup authentication for the redis service
redis:backup-schedule <service> <schedule> <bucket-name> [--use-iam] # schedules a backup of the redis service redis:backup-schedule <service> <schedule> <bucket-name> [--use-iam] # schedule a backup of the redis service
redis:backup-schedule-cat <service> # cat the contents of the configured backup cronfile for the service redis:backup-schedule-cat <service> # cat the contents of the configured backup cronfile for the service
redis:backup-set-encryption <service> <passphrase> # sets encryption for all future backups of redis service redis:backup-set-encryption <service> <passphrase> # set encryption for all future backups of redis service
redis:backup-unschedule <service> # unschedules the backup of the redis service redis:backup-unschedule <service> # unschedule the backup of the redis service
redis:backup-unset-encryption <service> # unsets encryption for future backups of the redis service redis:backup-unset-encryption <service> # unset encryption for future backups of the redis service
redis:clone <service> <new-service> [--clone-flags...] # create container <new-name> then copy data from <name> into <new-name> redis:clone <service> <new-service> [--clone-flags...] # create container <new-name> then copy data from <name> into <new-name>
redis:connect <service> # connect to the service via the redis connection tool redis:connect <service> # connect to the service via the redis connection tool
redis:create <service> [--create-flags...] # create a redis service redis:create <service> [--create-flags...] # create a redis service
@@ -522,7 +522,7 @@ You may skip the `backup-auth` step if your dokku install is running within EC2
Backups can be performed using the backup commands: Backups can be performed using the backup commands:
### sets up authentication for backups on the redis service ### set up authentication for backups on the redis service
```shell ```shell
# usage # usage
@@ -553,7 +553,7 @@ More specific example for minio auth:
dokku redis:backup-auth lolipop MINIO_ACCESS_KEY_ID MINIO_SECRET_ACCESS_KEY us-east-1 s3v4 https://YOURMINIOSERVICE dokku redis:backup-auth lolipop MINIO_ACCESS_KEY_ID MINIO_SECRET_ACCESS_KEY us-east-1 s3v4 https://YOURMINIOSERVICE
``` ```
### removes backup authentication for the redis service ### remove backup authentication for the redis service
```shell ```shell
# usage # usage
@@ -566,7 +566,7 @@ Remove s3 authentication:
dokku redis:backup-deauth lolipop dokku redis:backup-deauth lolipop
``` ```
### creates a backup of the redis service to an existing s3 bucket ### create a backup of the redis service to an existing s3 bucket
```shell ```shell
# usage # usage
@@ -589,7 +589,7 @@ Restore a backup file (assuming it was extracted via `tar -xf backup.tgz`):
dokku redis:import lolipop < backup-folder/export dokku redis:import lolipop < backup-folder/export
``` ```
### sets encryption for all future backups of redis service ### set encryption for all future backups of redis service
```shell ```shell
# usage # usage
@@ -602,7 +602,7 @@ Set the GPG-compatible passphrase for encrypting backups for backups:
dokku redis:backup-set-encryption lolipop dokku redis:backup-set-encryption lolipop
``` ```
### unsets encryption for future backups of the redis service ### unset encryption for future backups of the redis service
```shell ```shell
# usage # usage
@@ -615,7 +615,7 @@ Unset the `GPG` encryption passphrase for backups:
dokku redis:backup-unset-encryption lolipop dokku redis:backup-unset-encryption lolipop
``` ```
### schedules a backup of the redis service ### schedule a backup of the redis service
```shell ```shell
# usage # usage
@@ -653,7 +653,7 @@ Cat the contents of the configured backup cronfile for the service:
dokku redis:backup-schedule-cat lolipop dokku redis:backup-schedule-cat lolipop
``` ```
### unschedules the backup of the redis service ### unschedule the backup of the redis service
```shell ```shell
# usage # usage

6
subcommands/create
View File

@@ -10,12 +10,12 @@ service-create-cmd() {
#E dokku $PLUGIN_COMMAND_PREFIX:create lolipop #E dokku $PLUGIN_COMMAND_PREFIX:create lolipop
#E you can also specify the image and image version to use for the service. #E you can also specify the image and image version to use for the service.
#E it *must* be compatible with the ${PLUGIN_IMAGE} image. #E it *must* be compatible with the ${PLUGIN_IMAGE} image.
#E export ${PLUGIN_DEFAULT_ALIAS}_IMAGE="${PLUGIN_IMAGE}" #E export ${PLUGIN_VARIABLE}_IMAGE="${PLUGIN_IMAGE}"
#E export ${PLUGIN_DEFAULT_ALIAS}_IMAGE_VERSION="${PLUGIN_IMAGE_VERSION}" #E export ${PLUGIN_VARIABLE}_IMAGE_VERSION="${PLUGIN_IMAGE_VERSION}"
#E dokku $PLUGIN_COMMAND_PREFIX:create lolipop #E dokku $PLUGIN_COMMAND_PREFIX:create lolipop
#E you can also specify custom environment variables to start #E you can also specify custom environment variables to start
#E the ${PLUGIN_COMMAND_PREFIX} service in semi-colon separated form. #E the ${PLUGIN_COMMAND_PREFIX} service in semi-colon separated form.
#E export ${PLUGIN_DEFAULT_ALIAS}_CUSTOM_ENV="USER=alpha;HOST=beta" #E export ${PLUGIN_VARIABLE}_CUSTOM_ENV="USER=alpha;HOST=beta"
#E dokku $PLUGIN_COMMAND_PREFIX:create lolipop #E dokku $PLUGIN_COMMAND_PREFIX:create lolipop
#A service, service to run command against #A service, service to run command against
#F -c|--config-options "--args --go=here", extra arguments to pass to the container create command #F -c|--config-options "--args --go=here", extra arguments to pass to the container create command