{"id":13558791,"url":"https://github.com/dokku/dokku-couchdb","last_synced_at":"2025-04-03T13:31:58.649Z","repository":{"id":3140268,"uuid":"44111013","full_name":"dokku/dokku-couchdb","owner":"dokku","description":"a couchdb plugin for dokku","archived":false,"fork":false,"pushed_at":"2024-10-23T10:32:36.000Z","size":501,"stargazers_count":26,"open_issues_count":1,"forks_count":15,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-10-30T00:56:05.653Z","etag":null,"topics":["couchdb","dokku","dokku-plugin","dokku-service","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/dokku.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},"funding":{"github":"dokku","open_collective":"dokku","patreon":"dokku"}},"created_at":"2015-10-12T14:03:36.000Z","updated_at":"2024-10-10T14:38:39.000Z","dependencies_parsed_at":"2023-07-05T19:18:17.256Z","dependency_job_id":"ad095e76-1323-4bd2-9ab6-caa3aa300bb9","html_url":"https://github.com/dokku/dokku-couchdb","commit_stats":{"total_commits":568,"total_committers":9,"mean_commits":"63.111111111111114","dds":"0.18133802816901412","last_synced_commit":"5cb92916c89e1d5615d8b912ce5dcd1bffe3d13b"},"previous_names":[],"tags_count":89,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dokku%2Fdokku-couchdb","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dokku%2Fdokku-couchdb/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dokku%2Fdokku-couchdb/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dokku%2Fdokku-couchdb/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dokku","download_url":"https://codeload.github.com/dokku/dokku-couchdb/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247009713,"owners_count":20868598,"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":["couchdb","dokku","dokku-plugin","dokku-service","paas"],"created_at":"2024-08-01T12:05:09.437Z","updated_at":"2025-04-03T13:31:58.641Z","avatar_url":"https://github.com/dokku.png","language":"Shell","funding_links":["https://github.com/sponsors/dokku","https://opencollective.com/dokku","https://patreon.com/dokku"],"categories":["Shell","others"],"sub_categories":[],"readme":"# dokku couchdb [![Build Status](https://img.shields.io/github/actions/workflow/status/dokku/dokku-couchdb/ci.yml?branch=master\u0026style=flat-square \"Build Status\")](https://github.com/dokku/dokku-couchdb/actions/workflows/ci.yml?query=branch%3Amaster) [![IRC Network](https://img.shields.io/badge/irc-libera-blue.svg?style=flat-square \"IRC Libera\")](https://webchat.libera.chat/?channels=dokku)\n\nOfficial couchdb plugin for dokku. Currently defaults to installing [couchdb 3.4.3](https://hub.docker.com/_/couchdb/).\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/dokku/dokku-couchdb.git --name couchdb\n```\n\n## Commands\n\n```\ncouchdb:app-links \u003capp\u003e                            # list all couchdb service links for a given app\ncouchdb:backup \u003cservice\u003e \u003cbucket-name\u003e [--use-iam] # create a backup of the couchdb service to an existing s3 bucket\ncouchdb: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 couchdb service\ncouchdb:backup-deauth \u003cservice\u003e                    # remove backup authentication for the couchdb service\ncouchdb:backup-schedule \u003cservice\u003e \u003cschedule\u003e \u003cbucket-name\u003e [--use-iam] # schedule a backup of the couchdb service\ncouchdb:backup-schedule-cat \u003cservice\u003e              # cat the contents of the configured backup cronfile for the service\ncouchdb:backup-set-encryption \u003cservice\u003e \u003cpassphrase\u003e # set encryption for all future backups of couchdb service\ncouchdb:backup-set-public-key-encryption \u003cservice\u003e \u003cpublic-key-id\u003e # set GPG Public Key encryption for all future backups of couchdb service\ncouchdb:backup-unschedule \u003cservice\u003e                # unschedule the backup of the couchdb service\ncouchdb:backup-unset-encryption \u003cservice\u003e          # unset encryption for future backups of the couchdb service\ncouchdb:backup-unset-public-key-encryption \u003cservice\u003e # unset GPG Public Key encryption for future backups of the couchdb service\ncouchdb:clone \u003cservice\u003e \u003cnew-service\u003e [--clone-flags...] # create container \u003cnew-name\u003e then copy data from \u003cname\u003e into \u003cnew-name\u003e\ncouchdb:connect \u003cservice\u003e                          # connect to the service via the couchdb connection tool\ncouchdb:create \u003cservice\u003e [--create-flags...]       # create a couchdb service\ncouchdb:destroy \u003cservice\u003e [-f|--force]             # delete the couchdb service/data/container if there are no links left\ncouchdb:enter \u003cservice\u003e                            # enter or run a command in a running couchdb service container\ncouchdb:exists \u003cservice\u003e                           # check if the couchdb service exists\ncouchdb:export \u003cservice\u003e                           # export a dump of the couchdb service database\ncouchdb:expose \u003cservice\u003e \u003cports...\u003e                # expose a couchdb service on custom host:port if provided (random port on the 0.0.0.0 interface if otherwise unspecified)\ncouchdb:import \u003cservice\u003e                           # import a dump into the couchdb service database\ncouchdb:info \u003cservice\u003e [--single-info-flag]        # print the service information\ncouchdb:link \u003cservice\u003e \u003capp\u003e [--link-flags...]     # link the couchdb service to the app\ncouchdb:linked \u003cservice\u003e \u003capp\u003e                     # check if the couchdb service is linked to an app\ncouchdb:links \u003cservice\u003e                            # list all apps linked to the couchdb service\ncouchdb:list                                       # list all couchdb services\ncouchdb:logs \u003cservice\u003e [-t|--tail] \u003ctail-num-optional\u003e # print the most recent log(s) for this service\ncouchdb:pause \u003cservice\u003e                            # pause a running couchdb service\ncouchdb:promote \u003cservice\u003e \u003capp\u003e                    # promote service \u003cservice\u003e as COUCHDB_URL in \u003capp\u003e\ncouchdb:restart \u003cservice\u003e                          # graceful shutdown and restart of the couchdb service container\ncouchdb:set \u003cservice\u003e \u003ckey\u003e \u003cvalue\u003e                # set or clear a property for a service\ncouchdb:start \u003cservice\u003e                            # start a previously stopped couchdb service\ncouchdb:stop \u003cservice\u003e                             # stop a running couchdb service\ncouchdb:unexpose \u003cservice\u003e                         # unexpose a previously exposed couchdb service\ncouchdb:unlink \u003cservice\u003e \u003capp\u003e                     # unlink the couchdb service from the app\ncouchdb: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 couchdb:help. Plugin help output in conjunction with any files in the `docs/` folder is used to generate the plugin documentation. Please consult the `couchdb:help` command for any undocumented commands.\n\n### Basic Usage\n\n### create a couchdb service\n\n```shell\n# usage\ndokku couchdb: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 couchdb docker container\n\nCreate a couchdb service named lollipop:\n\n```shell\ndokku couchdb:create lollipop\n```\n\nYou can also specify the image and image version to use for the service. It *must* be compatible with the couchdb image.\n\n```shell\nexport COUCHDB_IMAGE=\"couchdb\"\nexport COUCHDB_IMAGE_VERSION=\"${PLUGIN_IMAGE_VERSION}\"\ndokku couchdb:create lollipop\n```\n\nYou can also specify custom environment variables to start the couchdb service in semicolon-separated form.\n\n```shell\nexport COUCHDB_CUSTOM_ENV=\"USER=alpha;HOST=beta\"\ndokku couchdb:create lollipop\n```\n\n### print the service information\n\n```shell\n# usage\ndokku couchdb: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 couchdb:info lollipop\n```\n\nYou can also retrieve a specific piece of service info via flags:\n\n```shell\ndokku couchdb:info lollipop --config-dir\ndokku couchdb:info lollipop --data-dir\ndokku couchdb:info lollipop --dsn\ndokku couchdb:info lollipop --exposed-ports\ndokku couchdb:info lollipop --id\ndokku couchdb:info lollipop --internal-ip\ndokku couchdb:info lollipop --initial-network\ndokku couchdb:info lollipop --links\ndokku couchdb:info lollipop --post-create-network\ndokku couchdb:info lollipop --post-start-network\ndokku couchdb:info lollipop --service-root\ndokku couchdb:info lollipop --status\ndokku couchdb:info lollipop --version\n```\n\n### list all couchdb services\n\n```shell\n# usage\ndokku couchdb:list\n```\n\nList all services:\n\n```shell\ndokku couchdb:list\n```\n\n### print the most recent log(s) for this service\n\n```shell\n# usage\ndokku couchdb: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 couchdb:logs lollipop\n```\n\nBy default, logs will not be tailed, but you can do this with the --tail flag:\n\n```shell\ndokku couchdb: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 couchdb:logs lollipop --tail 5\n```\n\n### link the couchdb service to the app\n\n```shell\n# usage\ndokku couchdb: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 couchdb 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 couchdb: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_COUCHDB_LOLLIPOP_NAME=/lollipop/DATABASE\nDOKKU_COUCHDB_LOLLIPOP_PORT=tcp://172.17.0.1:5984\nDOKKU_COUCHDB_LOLLIPOP_PORT_5984_TCP=tcp://172.17.0.1:5984\nDOKKU_COUCHDB_LOLLIPOP_PORT_5984_TCP_PROTO=tcp\nDOKKU_COUCHDB_LOLLIPOP_PORT_5984_TCP_PORT=5984\nDOKKU_COUCHDB_LOLLIPOP_PORT_5984_TCP_ADDR=172.17.0.1\n```\n\nThe following will be set on the linked application by default:\n\n```\nCOUCHDB_URL=http://lollipop:SOME_PASSWORD@dokku-couchdb-lollipop:5984/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 couchdb:link other_service playground\n```\n\nIt is possible to change the protocol for `COUCHDB_URL` by setting the environment variable `COUCHDB_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 COUCHDB_DATABASE_SCHEME=http2\ndokku couchdb:link lollipop playground\n```\n\nThis will cause `COUCHDB_URL` to be set as:\n\n```\nhttp2://lollipop:SOME_PASSWORD@dokku-couchdb-lollipop:5984/lollipop\n```\n\n### unlink the couchdb service from the app\n\n```shell\n# usage\ndokku couchdb: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 couchdb service:\n\n\u003e NOTE: this will restart your app and unset related environment variables\n\n```shell\ndokku couchdb:unlink lollipop playground\n```\n\n### set or clear a property for a service\n\n```shell\n# usage\ndokku couchdb:set \u003cservice\u003e \u003ckey\u003e \u003cvalue\u003e\n```\n\nSet the network to attach after the service container is started:\n\n```shell\ndokku couchdb:set lollipop post-create-network custom-network\n```\n\nSet multiple networks:\n\n```shell\ndokku couchdb:set lollipop post-create-network custom-network,other-network\n```\n\nUnset the post-create-network value:\n\n```shell\ndokku couchdb: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 couchdb connection tool\n\n```shell\n# usage\ndokku couchdb:connect \u003cservice\u003e\n```\n\nConnect to the service via the couchdb 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 couchdb:connect lollipop\n```\n\n### enter or run a command in a running couchdb service container\n\n```shell\n# usage\ndokku couchdb: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 couchdb: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 couchdb:enter lollipop touch /tmp/test\n```\n\n### expose a couchdb 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 couchdb: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 couchdb:expose lollipop 5984\n```\n\nExpose the service on the service's normal ports, with the first on a specified ip adddress (127.0.0.1):\n\n```shell\ndokku couchdb:expose lollipop 127.0.0.1:5984\n```\n\n### unexpose a previously exposed couchdb service\n\n```shell\n# usage\ndokku couchdb:unexpose \u003cservice\u003e\n```\n\nUnexpose the service, removing access to it from the public interface (`0.0.0.0`):\n\n```shell\ndokku couchdb:unexpose lollipop\n```\n\n### promote service \u003cservice\u003e as COUCHDB_URL in \u003capp\u003e\n\n```shell\n# usage\ndokku couchdb:promote \u003cservice\u003e \u003capp\u003e\n```\n\nIf you have a couchdb service linked to an app and try to link another couchdb service another link environment variable will be generated automatically:\n\n```\nDOKKU_COUCHDB_BLUE_URL=http://other_service:ANOTHER_PASSWORD@dokku-couchdb-other-service:5984/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 couchdb:promote other_service playground\n```\n\nThis will replace `COUCHDB_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```\nCOUCHDB_URL=http://other_service:ANOTHER_PASSWORD@dokku-couchdb-other-service:5984/other_service\nDOKKU_COUCHDB_BLUE_URL=http://other_service:ANOTHER_PASSWORD@dokku-couchdb-other-service:5984/other_service\nDOKKU_COUCHDB_SILVER_URL=http://lollipop:SOME_PASSWORD@dokku-couchdb-lollipop:5984/lollipop\n```\n\n### start a previously stopped couchdb service\n\n```shell\n# usage\ndokku couchdb:start \u003cservice\u003e\n```\n\nStart the service:\n\n```shell\ndokku couchdb:start lollipop\n```\n\n### stop a running couchdb service\n\n```shell\n# usage\ndokku couchdb:stop \u003cservice\u003e\n```\n\nStop the service and removes the running container:\n\n```shell\ndokku couchdb:stop lollipop\n```\n\n### pause a running couchdb service\n\n```shell\n# usage\ndokku couchdb:pause \u003cservice\u003e\n```\n\nPause the running container for the service:\n\n```shell\ndokku couchdb:pause lollipop\n```\n\n### graceful shutdown and restart of the couchdb service container\n\n```shell\n# usage\ndokku couchdb:restart \u003cservice\u003e\n```\n\nRestart the service:\n\n```shell\ndokku couchdb:restart lollipop\n```\n\n### upgrade service \u003cservice\u003e to the specified versions\n\n```shell\n# usage\ndokku couchdb: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 couchdb docker container\n\nYou can upgrade an existing service to a new image or image-version:\n\n```shell\ndokku couchdb:upgrade lollipop\n```\n\n### Service Automation\n\nService scripting can be executed using the following commands:\n\n### list all couchdb service links for a given app\n\n```shell\n# usage\ndokku couchdb:app-links \u003capp\u003e\n```\n\nList all couchdb services that are linked to the `playground` app.\n\n```shell\ndokku couchdb: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 couchdb: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 couchdb docker container\n\nYou can clone an existing service to a new one:\n\n```shell\ndokku couchdb:clone lollipop lollipop-2\n```\n\n### check if the couchdb service exists\n\n```shell\n# usage\ndokku couchdb:exists \u003cservice\u003e\n```\n\nHere we check if the lollipop couchdb service exists.\n\n```shell\ndokku couchdb:exists lollipop\n```\n\n### check if the couchdb service is linked to an app\n\n```shell\n# usage\ndokku couchdb:linked \u003cservice\u003e \u003capp\u003e\n```\n\nHere we check if the lollipop couchdb service is linked to the `playground` app.\n\n```shell\ndokku couchdb:linked lollipop playground\n```\n\n### list all apps linked to the couchdb service\n\n```shell\n# usage\ndokku couchdb:links \u003cservice\u003e\n```\n\nList all apps linked to the `lollipop` couchdb service.\n\n```shell\ndokku couchdb: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 couchdb service database\n\n```shell\n# usage\ndokku couchdb:import \u003cservice\u003e\n```\n\nImport a datastore dump:\n\n```shell\ndokku couchdb:import lollipop \u003c data.dump\n```\n\n### export a dump of the couchdb service database\n\n```shell\n# usage\ndokku couchdb:export \u003cservice\u003e\n```\n\nBy default, datastore output is exported to stdout:\n\n```shell\ndokku couchdb:export lollipop\n```\n\nYou can redirect this output to a file:\n\n```shell\ndokku couchdb: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 couchdb service\n\n```shell\n# usage\ndokku couchdb: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 couchdb:backup-auth lollipop AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY\n```\n\nSetup s3 backup authentication with different region:\n\n```shell\ndokku couchdb: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 couchdb: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 couchdb: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 couchdb service\n\n```shell\n# usage\ndokku couchdb:backup-deauth \u003cservice\u003e\n```\n\nRemove s3 authentication:\n\n```shell\ndokku couchdb:backup-deauth lollipop\n```\n\n### create a backup of the couchdb service to an existing s3 bucket\n\n```shell\n# usage\ndokku couchdb: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 couchdb: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 couchdb:import lollipop \u003c backup-folder/export\n```\n\n### set encryption for all future backups of couchdb service\n\n```shell\n# usage\ndokku couchdb:backup-set-encryption \u003cservice\u003e \u003cpassphrase\u003e\n```\n\nSet the GPG-compatible passphrase for encrypting backups for backups:\n\n```shell\ndokku couchdb:backup-set-encryption lollipop\n```\n\n### set GPG Public Key encryption for all future backups of couchdb service\n\n```shell\n# usage\ndokku couchdb: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 couchdb:backup-set-public-key-encryption lollipop\n```\n\n### unset encryption for future backups of the couchdb service\n\n```shell\n# usage\ndokku couchdb:backup-unset-encryption \u003cservice\u003e\n```\n\nUnset the `GPG` encryption passphrase for backups:\n\n```shell\ndokku couchdb:backup-unset-encryption lollipop\n```\n\n### unset GPG Public Key encryption for future backups of the couchdb service\n\n```shell\n# usage\ndokku couchdb:backup-unset-public-key-encryption \u003cservice\u003e\n```\n\nUnset the `GPG` Public Key encryption for backups:\n\n```shell\ndokku couchdb:backup-unset-public-key-encryption lollipop\n```\n\n### schedule a backup of the couchdb service\n\n```shell\n# usage\ndokku couchdb: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 couchdb:backup-schedule lollipop \"0 3 * * *\" my-s3-bucket\n```\n\nSchedule a backup and authenticate via iam:\n\n```shell\ndokku couchdb: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 couchdb:backup-schedule-cat \u003cservice\u003e\n```\n\nCat the contents of the configured backup cronfile for the service:\n\n```shell\ndokku couchdb:backup-schedule-cat lollipop\n```\n\n### unschedule the backup of the couchdb service\n\n```shell\n# usage\ndokku couchdb:backup-unschedule \u003cservice\u003e\n```\n\nRemove the scheduled backup from cron:\n\n```shell\ndokku couchdb: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 `COUCHDB_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%2Fdokku%2Fdokku-couchdb","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdokku%2Fdokku-couchdb","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdokku%2Fdokku-couchdb/lists"}