{"id":29026333,"url":"https://github.com/bixoto/dokku-dolt","last_synced_at":"2025-10-17T20:36:03.471Z","repository":{"id":300262177,"uuid":"1005675904","full_name":"Bixoto/dokku-dolt","owner":"Bixoto","description":"[WIP] a dolt plugin for dokku","archived":false,"fork":false,"pushed_at":"2025-06-20T17:38:00.000Z","size":705,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-06-20T18:36:51.323Z","etag":null,"topics":["dokku","dokku-plugin","dokku-service","dolt","paas"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Bixoto.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-06-20T16:05:40.000Z","updated_at":"2025-06-20T17:38:50.000Z","dependencies_parsed_at":"2025-06-20T18:49:29.180Z","dependency_job_id":null,"html_url":"https://github.com/Bixoto/dokku-dolt","commit_stats":null,"previous_names":["bixoto/dokku-dolt"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Bixoto/dokku-dolt","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Bixoto%2Fdokku-dolt","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Bixoto%2Fdokku-dolt/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Bixoto%2Fdokku-dolt/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Bixoto%2Fdokku-dolt/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Bixoto","download_url":"https://codeload.github.com/Bixoto/dokku-dolt/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Bixoto%2Fdokku-dolt/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262008722,"owners_count":23244242,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["dokku","dokku-plugin","dokku-service","dolt","paas"],"created_at":"2025-06-26T05:30:49.991Z","updated_at":"2025-10-17T20:36:03.356Z","avatar_url":"https://github.com/Bixoto.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# dokku dolt [![Build Status](https://img.shields.io/github/actions/workflow/status/bixoto/dokku-dolt/ci.yml?branch=master\u0026style=flat-square \"Build Status\")](https://github.com/bixoto/dokku-dolt/actions/workflows/ci.yml?query=branch%3Amaster)\n\nUnofficial dolt plugin for dokku forked from the [mysql plugin](https://github.com/dokku/dokku-mysql). Currently defaults to installing [dolthub/dolt-sql-server 1.55.2](https://hub.docker.com/r/dolthub/dolt-sql-server/).\n\n**WORK IN PROGRESS -- NOT READY FOR PRODUCTION**\n\n## Requirements\n\n- dokku 0.19.x+\n- docker 1.8.x\n\n## Installation\n\n```shell\n# on 0.19.x+\nsudo dokku plugin:install https://github.com/bixoto/dokku-dolt.git --name dolt\n```\n\n## Commands\n\n```\ndolt:app-links \u003capp\u003e                               # list all dolt service links for a given app\ndolt:backup \u003cservice\u003e \u003cbucket-name\u003e [--use-iam]    # create a backup of the dolt service to an existing s3 bucket\ndolt:backup-auth \u003cservice\u003e \u003caws-access-key-id\u003e \u003caws-secret-access-key\u003e \u003caws-default-region\u003e \u003caws-signature-version\u003e \u003cendpoint-url\u003e # set up authentication for backups on the dolt service\ndolt:backup-deauth \u003cservice\u003e                       # remove backup authentication for the dolt service\ndolt:backup-schedule \u003cservice\u003e \u003cschedule\u003e \u003cbucket-name\u003e [--use-iam] # schedule a backup of the dolt service\ndolt:backup-schedule-cat \u003cservice\u003e                 # cat the contents of the configured backup cronfile for the service\ndolt:backup-set-encryption \u003cservice\u003e \u003cpassphrase\u003e  # set encryption for all future backups of dolt service\ndolt:backup-set-public-key-encryption \u003cservice\u003e \u003cpublic-key-id\u003e # set GPG Public Key encryption for all future backups of dolt service\ndolt:backup-unschedule \u003cservice\u003e                   # unschedule the backup of the dolt service\ndolt:backup-unset-encryption \u003cservice\u003e             # unset encryption for future backups of the dolt service\ndolt:backup-unset-public-key-encryption \u003cservice\u003e  # unset GPG Public Key encryption for future backups of the dolt service\ndolt:clone \u003cservice\u003e \u003cnew-service\u003e [--clone-flags...] # create container \u003cnew-name\u003e then copy data from \u003cname\u003e into \u003cnew-name\u003e\ndolt:connect \u003cservice\u003e                             # connect to the service via the dolt connection tool\ndolt:create \u003cservice\u003e [--create-flags...]          # create a dolt service\ndolt:destroy \u003cservice\u003e [-f|--force]                # delete the dolt service/data/container if there are no links left\ndolt:enter \u003cservice\u003e                               # enter or run a command in a running dolt service container\ndolt:exists \u003cservice\u003e                              # check if the dolt service exists\ndolt:export \u003cservice\u003e                              # export a dump of the dolt service database\ndolt:expose \u003cservice\u003e \u003cports...\u003e                   # expose a dolt service on custom host:port if provided (random port on the 0.0.0.0 interface if otherwise unspecified)\ndolt:import \u003cservice\u003e                              # import a dump into the dolt service database\ndolt:info \u003cservice\u003e [--single-info-flag]           # print the service information\ndolt:link \u003cservice\u003e \u003capp\u003e [--link-flags...]        # link the dolt service to the app\ndolt:linked \u003cservice\u003e \u003capp\u003e                        # check if the dolt service is linked to an app\ndolt:links \u003cservice\u003e                               # list all apps linked to the dolt service\ndolt:list                                          # list all dolt services\ndolt:logs \u003cservice\u003e [-t|--tail] \u003ctail-num-optional\u003e # print the most recent log(s) for this service\ndolt:pause \u003cservice\u003e                               # pause a running dolt service\ndolt:promote \u003cservice\u003e \u003capp\u003e                       # promote service \u003cservice\u003e as DATABASE_URL in \u003capp\u003e\ndolt:restart \u003cservice\u003e                             # graceful shutdown and restart of the dolt service container\ndolt:set \u003cservice\u003e \u003ckey\u003e \u003cvalue\u003e                   # set or clear a property for a service\ndolt:start \u003cservice\u003e                               # start a previously stopped dolt service\ndolt:stop \u003cservice\u003e                                # stop a running dolt service\ndolt:unexpose \u003cservice\u003e                            # unexpose a previously exposed dolt service\ndolt:unlink \u003cservice\u003e \u003capp\u003e                        # unlink the dolt service from the app\ndolt:upgrade \u003cservice\u003e [--upgrade-flags...]        # upgrade service \u003cservice\u003e to the specified versions\n```\n\n## Usage\n\nHelp for any commands can be displayed by specifying the command as an argument to dolt:help. Plugin help output in conjunction with any files in the `docs/` folder is used to generate the plugin documentation. Please consult the `dolt:help` command for any undocumented commands.\n\n### Basic Usage\n\n### create a dolt service\n\n```shell\n# usage\ndokku dolt:create \u003cservice\u003e [--create-flags...]\n```\n\nflags:\n\n- `-c|--config-options \"--args --go=here\"`: extra arguments to pass to the container create command (default: `None`)\n- `-C|--custom-env \"USER=alpha;HOST=beta\"`: semi-colon delimited environment variables to start the service with\n- `-i|--image IMAGE`: the image name to start the service with\n- `-I|--image-version IMAGE_VERSION`: the image version to start the service with\n- `-m|--memory MEMORY`: container memory limit in megabytes (default: unlimited)\n- `-N|--initial-network INITIAL_NETWORK`: the initial network to attach the service to\n- `-p|--password PASSWORD`: override the user-level service password\n- `-P|--post-create-network NETWORKS`: a comma-separated list of networks to attach the service container to after service creation\n- `-r|--root-password PASSWORD`: override the root-level service password\n- `-S|--post-start-network NETWORKS`: a comma-separated list of networks to attach the service container to after service start\n- `-s|--shm-size SHM_SIZE`: override shared memory size for dolt docker container\n\nCreate a dolt service named lollipop:\n\n```shell\ndokku dolt:create lollipop\n```\n\nYou can also specify the image and image version to use for the service. It *must* be compatible with the dolthub/dolt-sql-server image.\n\n```shell\nexport DOLT_IMAGE=\"dolthub/dolt-sql-server\"\nexport DOLT_IMAGE_VERSION=\"${PLUGIN_IMAGE_VERSION}\"\ndokku dolt:create lollipop\n```\n\nYou can also specify custom environment variables to start the dolt service in semicolon-separated form.\n\n```shell\nexport DOLT_CUSTOM_ENV=\"USER=alpha;HOST=beta\"\ndokku dolt:create lollipop\n```\n\n### print the service information\n\n```shell\n# usage\ndokku dolt:info \u003cservice\u003e [--single-info-flag]\n```\n\nflags:\n\n- `--config-dir`: show the service configuration directory\n- `--data-dir`: show the service data directory\n- `--dsn`: show the service DSN\n- `--exposed-ports`: show service exposed ports\n- `--id`: show the service container id\n- `--internal-ip`: show the service internal ip\n- `--initial-network`: show the initial network being connected to\n- `--links`: show the service app links\n- `--post-create-network`: show the networks to attach to after service container creation\n- `--post-start-network`: show the networks to attach to after service container start\n- `--service-root`: show the service root directory\n- `--status`: show the service running status\n- `--version`: show the service image version\n\nGet connection information as follows:\n\n```shell\ndokku dolt:info lollipop\n```\n\nYou can also retrieve a specific piece of service info via flags:\n\n```shell\ndokku dolt:info lollipop --config-dir\ndokku dolt:info lollipop --data-dir\ndokku dolt:info lollipop --dsn\ndokku dolt:info lollipop --exposed-ports\ndokku dolt:info lollipop --id\ndokku dolt:info lollipop --internal-ip\ndokku dolt:info lollipop --initial-network\ndokku dolt:info lollipop --links\ndokku dolt:info lollipop --post-create-network\ndokku dolt:info lollipop --post-start-network\ndokku dolt:info lollipop --service-root\ndokku dolt:info lollipop --status\ndokku dolt:info lollipop --version\n```\n\n### list all dolt services\n\n```shell\n# usage\ndokku dolt:list\n```\n\nList all services:\n\n```shell\ndokku dolt:list\n```\n\n### print the most recent log(s) for this service\n\n```shell\n# usage\ndokku dolt:logs \u003cservice\u003e [-t|--tail] \u003ctail-num-optional\u003e\n```\n\nflags:\n\n- `-t|--tail [\u003ctail-num\u003e]`: do not stop when end of the logs are reached and wait for additional output\n\nYou can tail logs for a particular service:\n\n```shell\ndokku dolt:logs lollipop\n```\n\nBy default, logs will not be tailed, but you can do this with the --tail flag:\n\n```shell\ndokku dolt:logs lollipop --tail\n```\n\nThe default tail setting is to show all logs, but an initial count can also be specified:\n\n```shell\ndokku dolt:logs lollipop --tail 5\n```\n\n### link the dolt service to the app\n\n```shell\n# usage\ndokku dolt:link \u003cservice\u003e \u003capp\u003e [--link-flags...]\n```\n\nflags:\n\n- `-a|--alias \"BLUE_DATABASE\"`: an alternative alias to use for linking to an app via environment variable\n- `-q|--querystring \"pool=5\"`: ampersand delimited querystring arguments to append to the service link\n- `-n|--no-restart \"false\"`: whether or not to restart the app on link (default: true)\n\nA dolt service can be linked to a container. This will use native docker links via the docker-options plugin. Here we link it to our `playground` app.\n\n\u003e NOTE: this will restart your app\n\n```shell\ndokku dolt:link lollipop playground\n```\n\nThe following environment variables will be set automatically by docker (not on the app itself, so they won’t be listed when calling dokku config):\n\n```\nDOKKU_DOLT_LOLLIPOP_NAME=/lollipop/DATABASE\nDOKKU_DOLT_LOLLIPOP_PORT=tcp://172.17.0.1:3306\nDOKKU_DOLT_LOLLIPOP_PORT_3306_TCP=tcp://172.17.0.1:3306\nDOKKU_DOLT_LOLLIPOP_PORT_3306_TCP_PROTO=tcp\nDOKKU_DOLT_LOLLIPOP_PORT_3306_TCP_PORT=3306\nDOKKU_DOLT_LOLLIPOP_PORT_3306_TCP_ADDR=172.17.0.1\n```\n\nThe following will be set on the linked application by default:\n\n```\nDATABASE_URL=mysql://mysql:SOME_PASSWORD@dokku-dolt-lollipop:3306/lollipop\n```\n\nThe host exposed here only works internally in docker containers. If you want your container to be reachable from outside, you should use the `expose` subcommand. Another service can be linked to your app:\n\n```shell\ndokku dolt:link other_service playground\n```\n\nIt is possible to change the protocol for `DATABASE_URL` by setting the environment variable `DOLT_DATABASE_SCHEME` on the app. Doing so will after linking will cause the plugin to think the service is not linked, and we advise you to unlink before proceeding.\n\n```shell\ndokku config:set playground DOLT_DATABASE_SCHEME=mysql2\ndokku dolt:link lollipop playground\n```\n\nThis will cause `DATABASE_URL` to be set as:\n\n```\nmysql2://mysql:SOME_PASSWORD@dokku-dolt-lollipop:3306/lollipop\n```\n\n### unlink the dolt service from the app\n\n```shell\n# usage\ndokku dolt:unlink \u003cservice\u003e \u003capp\u003e\n```\n\nflags:\n\n- `-n|--no-restart \"false\"`: whether or not to restart the app on unlink (default: true)\n\nYou can unlink a dolt service:\n\n\u003e NOTE: this will restart your app and unset related environment variables\n\n```shell\ndokku dolt:unlink lollipop playground\n```\n\n### set or clear a property for a service\n\n```shell\n# usage\ndokku dolt:set \u003cservice\u003e \u003ckey\u003e \u003cvalue\u003e\n```\n\nSet the network to attach after the service container is started:\n\n```shell\ndokku dolt:set lollipop post-create-network custom-network\n```\n\nSet multiple networks:\n\n```shell\ndokku dolt:set lollipop post-create-network custom-network,other-network\n```\n\nUnset the post-create-network value:\n\n```shell\ndokku dolt:set lollipop post-create-network\n```\n\n### Service Lifecycle\n\nThe lifecycle of each service can be managed through the following commands:\n\n### connect to the service via the dolt connection tool\n\n```shell\n# usage\ndokku dolt:connect \u003cservice\u003e\n```\n\nConnect to the service via the dolt connection tool:\n\n\u003e NOTE: disconnecting from ssh while running this command may leave zombie processes due to moby/moby#9098\n\n```shell\ndokku dolt:connect lollipop\n```\n\n### enter or run a command in a running dolt service container\n\n```shell\n# usage\ndokku dolt:enter \u003cservice\u003e\n```\n\nA bash prompt can be opened against a running service. Filesystem changes will not be saved to disk.\n\n\u003e NOTE: disconnecting from ssh while running this command may leave zombie processes due to moby/moby#9098\n\n```shell\ndokku dolt:enter lollipop\n```\n\nYou may also run a command directly against the service. Filesystem changes will not be saved to disk.\n\n```shell\ndokku dolt:enter lollipop touch /tmp/test\n```\n\n### expose a dolt service on custom host:port if provided (random port on the 0.0.0.0 interface if otherwise unspecified)\n\n```shell\n# usage\ndokku dolt:expose \u003cservice\u003e \u003cports...\u003e\n```\n\nExpose the service on the service's normal ports, allowing access to it from the public interface (`0.0.0.0`):\n\n```shell\ndokku dolt:expose lollipop 3306\n```\n\nExpose the service on the service's normal ports, with the first on a specified ip address (127.0.0.1):\n\n```shell\ndokku dolt:expose lollipop 127.0.0.1:3306\n```\n\n### unexpose a previously exposed dolt service\n\n```shell\n# usage\ndokku dolt:unexpose \u003cservice\u003e\n```\n\nUnexpose the service, removing access to it from the public interface (`0.0.0.0`):\n\n```shell\ndokku dolt:unexpose lollipop\n```\n\n### promote service \u003cservice\u003e as DATABASE_URL in \u003capp\u003e\n\n```shell\n# usage\ndokku dolt:promote \u003cservice\u003e \u003capp\u003e\n```\n\nIf you have a dolt service linked to an app and try to link another dolt service another link environment variable will be generated automatically:\n\n```\nDOKKU_DATABASE_BLUE_URL=mysql://other_service:ANOTHER_PASSWORD@dokku-dolt-other-service:3306/other_service\n```\n\nYou can promote the new service to be the primary one:\n\n\u003e NOTE: this will restart your app\n\n```shell\ndokku dolt:promote other_service playground\n```\n\nThis will replace `DATABASE_URL` with the url from other_service and generate another environment variable to hold the previous value if necessary. You could end up with the following for example:\n\n```\nDATABASE_URL=mysql://other_service:ANOTHER_PASSWORD@dokku-dolt-other-service:3306/other_service\nDOKKU_DATABASE_BLUE_URL=mysql://other_service:ANOTHER_PASSWORD@dokku-dolt-other-service:3306/other_service\nDOKKU_DATABASE_SILVER_URL=mysql://lollipop:SOME_PASSWORD@dokku-dolt-lollipop:3306/lollipop\n```\n\n### start a previously stopped dolt service\n\n```shell\n# usage\ndokku dolt:start \u003cservice\u003e\n```\n\nStart the service:\n\n```shell\ndokku dolt:start lollipop\n```\n\n### stop a running dolt service\n\n```shell\n# usage\ndokku dolt:stop \u003cservice\u003e\n```\n\nStop the service and removes the running container:\n\n```shell\ndokku dolt:stop lollipop\n```\n\n### pause a running dolt service\n\n```shell\n# usage\ndokku dolt:pause \u003cservice\u003e\n```\n\nPause the running container for the service:\n\n```shell\ndokku dolt:pause lollipop\n```\n\n### graceful shutdown and restart of the dolt service container\n\n```shell\n# usage\ndokku dolt:restart \u003cservice\u003e\n```\n\nRestart the service:\n\n```shell\ndokku dolt:restart lollipop\n```\n\n### upgrade service \u003cservice\u003e to the specified versions\n\n```shell\n# usage\ndokku dolt:upgrade \u003cservice\u003e [--upgrade-flags...]\n```\n\nflags:\n\n- `-c|--config-options \"--args --go=here\"`: extra arguments to pass to the container create command (default: `None`)\n- `-C|--custom-env \"USER=alpha;HOST=beta\"`: semi-colon delimited environment variables to start the service with\n- `-i|--image IMAGE`: the image name to start the service with\n- `-I|--image-version IMAGE_VERSION`: the image version to start the service with\n- `-N|--initial-network INITIAL_NETWORK`: the initial network to attach the service to\n- `-P|--post-create-network NETWORKS`: a comma-separated list of networks to attach the service container to after service creation\n- `-R|--restart-apps \"true\"`: whether or not to force an app restart (default: false)\n- `-S|--post-start-network NETWORKS`: a comma-separated list of networks to attach the service container to after service start\n- `-s|--shm-size SHM_SIZE`: override shared memory size for dolt docker container\n\nYou can upgrade an existing service to a new image or image-version:\n\n```shell\ndokku dolt:upgrade lollipop\n```\n\n### Service Automation\n\nService scripting can be executed using the following commands:\n\n### list all dolt service links for a given app\n\n```shell\n# usage\ndokku dolt:app-links \u003capp\u003e\n```\n\nList all dolt services that are linked to the `playground` app.\n\n```shell\ndokku dolt:app-links playground\n```\n\n### create container \u003cnew-name\u003e then copy data from \u003cname\u003e into \u003cnew-name\u003e\n\n```shell\n# usage\ndokku dolt:clone \u003cservice\u003e \u003cnew-service\u003e [--clone-flags...]\n```\n\nflags:\n\n- `-c|--config-options \"--args --go=here\"`: extra arguments to pass to the container create command (default: `None`)\n- `-C|--custom-env \"USER=alpha;HOST=beta\"`: semi-colon delimited environment variables to start the service with\n- `-i|--image IMAGE`: the image name to start the service with\n- `-I|--image-version IMAGE_VERSION`: the image version to start the service with\n- `-m|--memory MEMORY`: container memory limit in megabytes (default: unlimited)\n- `-N|--initial-network INITIAL_NETWORK`: the initial network to attach the service to\n- `-p|--password PASSWORD`: override the user-level service password\n- `-P|--post-create-network NETWORKS`: a comma-separated list of networks to attach the service container to after service creation\n- `-r|--root-password PASSWORD`: override the root-level service password\n- `-S|--post-start-network NETWORKS`: a comma-separated list of networks to attach the service container to after service start\n- `-s|--shm-size SHM_SIZE`: override shared memory size for dolt docker container\n\nYou can clone an existing service to a new one:\n\n```shell\ndokku dolt:clone lollipop lollipop-2\n```\n\n### check if the dolt service exists\n\n```shell\n# usage\ndokku dolt:exists \u003cservice\u003e\n```\n\nHere we check if the lollipop dolt service exists.\n\n```shell\ndokku dolt:exists lollipop\n```\n\n### check if the dolt service is linked to an app\n\n```shell\n# usage\ndokku dolt:linked \u003cservice\u003e \u003capp\u003e\n```\n\nHere we check if the lollipop dolt service is linked to the `playground` app.\n\n```shell\ndokku dolt:linked lollipop playground\n```\n\n### list all apps linked to the dolt service\n\n```shell\n# usage\ndokku dolt:links \u003cservice\u003e\n```\n\nList all apps linked to the `lollipop` dolt service.\n\n```shell\ndokku dolt:links lollipop\n```\n\n### Data Management\n\nThe underlying service data can be imported and exported with the following commands:\n\n### import a dump into the dolt service database\n\n```shell\n# usage\ndokku dolt:import \u003cservice\u003e\n```\n\nImport a datastore dump:\n\n```shell\ndokku dolt:import lollipop \u003c data.dump\n```\n\n### export a dump of the dolt service database\n\n```shell\n# usage\ndokku dolt:export \u003cservice\u003e\n```\n\nBy default, datastore output is exported to stdout:\n\n```shell\ndokku dolt:export lollipop\n```\n\nYou can redirect this output to a file:\n\n```shell\ndokku dolt:export lollipop \u003e data.dump\n```\n\n### Backups\n\nDatastore backups are supported via AWS S3 and S3 compatible services like [minio](https://github.com/minio/minio).\n\nYou may skip the `backup-auth` step if your dokku install is running within EC2 and has access to the bucket via an IAM profile. In that case, use the `--use-iam` option with the `backup` command.\n\nBackups can be performed using the backup commands:\n\n### set up authentication for backups on the dolt service\n\n```shell\n# usage\ndokku dolt:backup-auth \u003cservice\u003e \u003caws-access-key-id\u003e \u003caws-secret-access-key\u003e \u003caws-default-region\u003e \u003caws-signature-version\u003e \u003cendpoint-url\u003e\n```\n\nSetup s3 backup authentication:\n\n```shell\ndokku dolt:backup-auth lollipop AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY\n```\n\nSetup s3 backup authentication with different region:\n\n```shell\ndokku dolt:backup-auth lollipop AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY AWS_REGION\n```\n\nSetup s3 backup authentication with different signature version and endpoint:\n\n```shell\ndokku dolt:backup-auth lollipop AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY AWS_REGION AWS_SIGNATURE_VERSION ENDPOINT_URL\n```\n\nMore specific example for minio auth:\n\n```shell\ndokku dolt:backup-auth lollipop MINIO_ACCESS_KEY_ID MINIO_SECRET_ACCESS_KEY us-east-1 s3v4 https://YOURMINIOSERVICE\n```\n\n### remove backup authentication for the dolt service\n\n```shell\n# usage\ndokku dolt:backup-deauth \u003cservice\u003e\n```\n\nRemove s3 authentication:\n\n```shell\ndokku dolt:backup-deauth lollipop\n```\n\n### create a backup of the dolt service to an existing s3 bucket\n\n```shell\n# usage\ndokku dolt:backup \u003cservice\u003e \u003cbucket-name\u003e [--use-iam]\n```\n\nflags:\n\n- `-u|--use-iam`: use the IAM profile associated with the current server\n\nBackup the `lollipop` service to the `my-s3-bucket` bucket on `AWS`:`\n\n```shell\ndokku dolt:backup lollipop my-s3-bucket --use-iam\n```\n\nRestore a backup file (assuming it was extracted via `tar -xf backup.tgz`):\n\n```shell\ndokku dolt:import lollipop \u003c backup-folder/export\n```\n\n### set encryption for all future backups of dolt service\n\n```shell\n# usage\ndokku dolt:backup-set-encryption \u003cservice\u003e \u003cpassphrase\u003e\n```\n\nSet the GPG-compatible passphrase for encrypting backups for backups:\n\n```shell\ndokku dolt:backup-set-encryption lollipop\n```\n\n### set GPG Public Key encryption for all future backups of dolt service\n\n```shell\n# usage\ndokku dolt:backup-set-public-key-encryption \u003cservice\u003e \u003cpublic-key-id\u003e\n```\n\nSet the `GPG` Public Key for encrypting backups:\n\n```shell\ndokku dolt:backup-set-public-key-encryption lollipop\n```\n\n### unset encryption for future backups of the dolt service\n\n```shell\n# usage\ndokku dolt:backup-unset-encryption \u003cservice\u003e\n```\n\nUnset the `GPG` encryption passphrase for backups:\n\n```shell\ndokku dolt:backup-unset-encryption lollipop\n```\n\n### unset GPG Public Key encryption for future backups of the dolt service\n\n```shell\n# usage\ndokku dolt:backup-unset-public-key-encryption \u003cservice\u003e\n```\n\nUnset the `GPG` Public Key encryption for backups:\n\n```shell\ndokku dolt:backup-unset-public-key-encryption lollipop\n```\n\n### schedule a backup of the dolt service\n\n```shell\n# usage\ndokku dolt:backup-schedule \u003cservice\u003e \u003cschedule\u003e \u003cbucket-name\u003e [--use-iam]\n```\n\nflags:\n\n- `-u|--use-iam`: use the IAM profile associated with the current server\n\nSchedule a backup:\n\n\u003e 'schedule' is a crontab expression, eg. \"0 3 * * *\" for each day at 3am\n\n```shell\ndokku dolt:backup-schedule lollipop \"0 3 * * *\" my-s3-bucket\n```\n\nSchedule a backup and authenticate via iam:\n\n```shell\ndokku dolt:backup-schedule lollipop \"0 3 * * *\" my-s3-bucket --use-iam\n```\n\n### cat the contents of the configured backup cronfile for the service\n\n```shell\n# usage\ndokku dolt:backup-schedule-cat \u003cservice\u003e\n```\n\nCat the contents of the configured backup cronfile for the service:\n\n```shell\ndokku dolt:backup-schedule-cat lollipop\n```\n\n### unschedule the backup of the dolt service\n\n```shell\n# usage\ndokku dolt:backup-unschedule \u003cservice\u003e\n```\n\nRemove the scheduled backup from cron:\n\n```shell\ndokku dolt:backup-unschedule lollipop\n```\n\n### Disabling `docker image pull` calls\n\nIf you wish to disable the `docker image pull` calls that the plugin triggers, you may set the `DOLT_DISABLE_PULL` environment variable to `true`. Once disabled, you will need to pull the service image you wish to deploy as shown in the `stderr` output.\n\nPlease ensure the proper images are in place when `docker image pull` is disabled.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbixoto%2Fdokku-dolt","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbixoto%2Fdokku-dolt","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbixoto%2Fdokku-dolt/lists"}