{"id":21274802,"url":"https://github.com/maayanlab/dokku-neo4j","last_synced_at":"2025-09-13T21:21:53.169Z","repository":{"id":47374736,"uuid":"514299389","full_name":"MaayanLab/dokku-neo4j","owner":"MaayanLab","description":"An updated neo4j plugin for dokku","archived":false,"fork":false,"pushed_at":"2024-07-24T17:37:12.000Z","size":221,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":5,"default_branch":"main","last_synced_at":"2024-07-25T00:06:54.172Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/MaayanLab.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-07-15T14:29:37.000Z","updated_at":"2024-07-24T17:37:16.000Z","dependencies_parsed_at":"2022-08-29T21:52:28.150Z","dependency_job_id":null,"html_url":"https://github.com/MaayanLab/dokku-neo4j","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MaayanLab%2Fdokku-neo4j","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MaayanLab%2Fdokku-neo4j/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MaayanLab%2Fdokku-neo4j/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MaayanLab%2Fdokku-neo4j/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MaayanLab","download_url":"https://codeload.github.com/MaayanLab/dokku-neo4j/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225703534,"owners_count":17510919,"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":[],"created_at":"2024-11-21T09:25:39.595Z","updated_at":"2024-11-21T09:25:40.094Z","avatar_url":"https://github.com/MaayanLab.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# dokku-neo4j\n\nA neo4j plugin for [Dokku](https://dokku.com/).\n\nBased off of the [official postgres plugin for dokku](https://github.com/dokku/dokku-postgres). Currently defaults to installing [neo4j 4.4.8 community edition](https://hub.docker.com/_/neo4j/).\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/maayanlab/dokku-neo4j.git neo4j\n```\n\n## Commands\n\n```\nneo4j:app-links \u003capp\u003e                           # list all neo4j service links for a given app\nneo4j:backup \u003cservice\u003e \u003cbucket-name\u003e [--use-iam] # create a backup of the neo4j service to an existing s3 bucket\nneo4j: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 neo4j service\nneo4j:backup-deauth \u003cservice\u003e                   # remove backup authentication for the neo4j service\nneo4j:backup-schedule \u003cservice\u003e \u003cschedule\u003e \u003cbucket-name\u003e [--use-iam] # schedule a backup of the neo4j service\nneo4j:backup-schedule-cat \u003cservice\u003e             # cat the contents of the configured backup cronfile for the service\nneo4j:backup-set-encryption \u003cservice\u003e \u003cpassphrase\u003e # set encryption for all future backups of neo4j service\nneo4j:backup-unschedule \u003cservice\u003e               # unschedule the backup of the neo4j service\nneo4j:backup-unset-encryption \u003cservice\u003e         # unset encryption for future backups of the neo4j service\nneo4j:clone \u003cservice\u003e \u003cnew-service\u003e [--clone-flags...] # create container \u003cnew-name\u003e then copy data from \u003cname\u003e into \u003cnew-name\u003e\nneo4j:connect \u003cservice\u003e                         # connect to the service via the neo4j connection tool\nneo4j:create \u003cservice\u003e [--create-flags...]      # create a neo4j service\nneo4j:destroy \u003cservice\u003e [-f|--force]            # delete the neo4j service/data/container if there are no links left\nneo4j:enter \u003cservice\u003e                           # enter or run a command in a running neo4j service container\nneo4j:exists \u003cservice\u003e                          # check if the neo4j service exists\nneo4j:export \u003cservice\u003e                          # export a dump of the neo4j service database\nneo4j:expose \u003cservice\u003e \u003cports...\u003e               # expose a neo4j service on custom host:port if provided (random port on the 0.0.0.0 interface if otherwise unspecified)\nneo4j:import \u003cservice\u003e                          # import a dump into the neo4j service database\nneo4j:info \u003cservice\u003e [--single-info-flag]       # print the service information\nneo4j:link \u003cservice\u003e \u003capp\u003e [--link-flags...]    # link the neo4j service to the app\nneo4j:linked \u003cservice\u003e \u003capp\u003e                    # check if the neo4j service is linked to an app\nneo4j:links \u003cservice\u003e                           # list all apps linked to the neo4j service\nneo4j:list                                      # list all neo4j services\nneo4j:logs \u003cservice\u003e [-t|--tail] \u003ctail-num-optional\u003e # print the most recent log(s) for this service\nneo4j:promote \u003cservice\u003e \u003capp\u003e                   # promote service \u003cservice\u003e as NEO4J_URL in \u003capp\u003e\nneo4j:restart \u003cservice\u003e                         # graceful shutdown and restart of the neo4j service container\nneo4j:start \u003cservice\u003e                           # start a previously stopped neo4j service\nneo4j:stop \u003cservice\u003e                            # stop a running neo4j service\nneo4j:unexpose \u003cservice\u003e                        # unexpose a previously exposed neo4j service\nneo4j:unlink \u003cservice\u003e \u003capp\u003e                    # unlink the neo4j service from the app\nneo4j: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 neo4j:help. Plugin help output in conjunction with any files in the `docs/` folder is used to generate the plugin documentation. Please consult the `neo4j:help` command for any undocumented commands.\n\n### Basic Usage\n\n### create a neo4j service\n\n```shell\n# usage\ndokku neo4j: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- `-p|--password PASSWORD`: override the user-level service password\n- `-r|--root-password PASSWORD`: override the root-level service password\n- `-s|--shm-size SHM_SIZE`: override shared memory size for neo4j docker container\n\nCreate a neo4j service named lollipop:\n\n```shell\ndokku neo4j:create lollipop\n```\n\nYou can also specify the image and image version to use for the service. It *must* be compatible with the neo4j image.\n\n```shell\nexport NEO4J_IMAGE=\"neo4j\"\nexport NEO4J_IMAGE_VERSION=\"${PLUGIN_IMAGE_VERSION}\"\ndokku neo4j:create lollipop\n```\n\nYou can also specify custom environment variables to start the neo4j service in semi-colon separated form.\n\n```shell\nexport NEO4J_CUSTOM_ENV=\"USER=alpha;HOST=beta\"\ndokku neo4j:create lollipop\n```\n\n### print the service information\n\n```shell\n# usage\ndokku neo4j: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- `--links`: show the service app links\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 neo4j:info lollipop\n```\n\nYou can also retrieve a specific piece of service info via flags:\n\n```shell\ndokku neo4j:info lollipop --config-dir\ndokku neo4j:info lollipop --data-dir\ndokku neo4j:info lollipop --dsn\ndokku neo4j:info lollipop --exposed-ports\ndokku neo4j:info lollipop --id\ndokku neo4j:info lollipop --internal-ip\ndokku neo4j:info lollipop --links\ndokku neo4j:info lollipop --service-root\ndokku neo4j:info lollipop --status\ndokku neo4j:info lollipop --version\n```\n\n### list all neo4j services\n\n```shell\n# usage\ndokku neo4j:list \n```\n\nList all services:\n\n```shell\ndokku neo4j:list\n```\n\n### print the most recent log(s) for this service\n\n```shell\n# usage\ndokku neo4j: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 neo4j:logs lollipop\n```\n\nBy default, logs will not be tailed, but you can do this with the --tail flag:\n\n```shell\ndokku neo4j: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 neo4j:logs lollipop --tail 5\n```\n\n### link the neo4j service to the app\n\n```shell\n# usage\ndokku neo4j: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\nA neo4j 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 neo4j: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_NEO4J_LOLLIPOP_NAME=/lollipop/DATABASE\nDOKKU_NEO4J_LOLLIPOP_PORT=tcp://172.17.0.1:7687\nDOKKU_NEO4J_LOLLIPOP_PORT_7687_TCP=tcp://172.17.0.1:7687\nDOKKU_NEO4J_LOLLIPOP_PORT_7687_TCP_PROTO=tcp\nDOKKU_NEO4J_LOLLIPOP_PORT_7687_TCP_PORT=7687\nDOKKU_NEO4J_LOLLIPOP_PORT_7687_TCP_ADDR=172.17.0.1\n```\n\nThe following will be set on the linked application by default:\n\n```\nNEO4J_URL=neo4j://lollipop:SOME_PASSWORD@dokku-neo4j-lollipop:7687/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 neo4j:link other_service playground\n```\n\nIt is possible to change the protocol for `NEO4J_URL` by setting the environment variable `NEO4J_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 NEO4J_DATABASE_SCHEME=neo4j2\ndokku neo4j:link lollipop playground\n```\n\nThis will cause `NEO4J_URL` to be set as:\n\n```\nneo4j2://lollipop:SOME_PASSWORD@dokku-neo4j-lollipop:7687/lollipop\n```\n\n### unlink the neo4j service from the app\n\n```shell\n# usage\ndokku neo4j:unlink \u003cservice\u003e \u003capp\u003e\n```\n\nYou can unlink a neo4j service:\n\n\u003e NOTE: this will restart your app and unset related environment variables\n\n```shell\ndokku neo4j:unlink lollipop playground\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 neo4j connection tool\n\n```shell\n# usage\ndokku neo4j:connect \u003cservice\u003e\n```\n\nConnect to the service via the neo4j 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 neo4j:connect lollipop\n```\n\n### enter or run a command in a running neo4j service container\n\n```shell\n# usage\ndokku neo4j: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 neo4j: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 neo4j:enter lollipop touch /tmp/test\n```\n\n### expose a neo4j 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 neo4j: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 neo4j:expose lollipop 7687\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 neo4j:expose lollipop 127.0.0.1:7687\n```\n\n### unexpose a previously exposed neo4j service\n\n```shell\n# usage\ndokku neo4j:unexpose \u003cservice\u003e\n```\n\nUnexpose the service, removing access to it from the public interface (`0.0.0.0`):\n\n```shell\ndokku neo4j:unexpose lollipop\n```\n\n### promote service \u003cservice\u003e as NEO4J_URL in \u003capp\u003e\n\n```shell\n# usage\ndokku neo4j:promote \u003cservice\u003e \u003capp\u003e\n```\n\nIf you have a neo4j service linked to an app and try to link another neo4j service another link environment variable will be generated automatically:\n\n```\nDOKKU_DATABASE_BLUE_URL=neo4j://other_service:ANOTHER_PASSWORD@dokku-neo4j-other-service:7687/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 neo4j:promote other_service playground\n```\n\nThis will replace `NEO4J_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```\nNEO4J_URL=neo4j://other_service:ANOTHER_PASSWORD@dokku-neo4j-other-service:7687/other_service\nDOKKU_DATABASE_BLUE_URL=neo4j://other_service:ANOTHER_PASSWORD@dokku-neo4j-other-service:7687/other_service\nDOKKU_DATABASE_SILVER_URL=neo4j://lollipop:SOME_PASSWORD@dokku-neo4j-lollipop:7687/lollipop\n```\n\n### start a previously stopped neo4j service\n\n```shell\n# usage\ndokku neo4j:start \u003cservice\u003e\n```\n\nStart the service:\n\n```shell\ndokku neo4j:start lollipop\n```\n\n### stop a running neo4j service\n\n```shell\n# usage\ndokku neo4j:stop \u003cservice\u003e\n```\n\nStop the service and the running container:\n\n```shell\ndokku neo4j:stop lollipop\n```\n\n### graceful shutdown and restart of the neo4j service container\n\n```shell\n# usage\ndokku neo4j:restart \u003cservice\u003e\n```\n\nRestart the service:\n\n```shell\ndokku neo4j:restart lollipop\n```\n\n### upgrade service \u003cservice\u003e to the specified versions\n\n```shell\n# usage\ndokku neo4j: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- `-R|--restart-apps \"true\"`: whether to force an app restart\n- `-s|--shm-size SHM_SIZE`: override shared memory size for neo4j docker container\n\nYou can upgrade an existing service to a new image or image-version:\n\n```shell\ndokku neo4j:upgrade lollipop\n```\n\nNeo4j does not handle upgrading data for major versions automatically (eg. 11 =\u003e 12). Upgrades should be done manually. Users are encouraged to upgrade to the latest minor release for their neo4j version before performing a major upgrade.\n\nWhile there are many ways to upgrade a neo4j database, for safety purposes, it is recommended that an upgrade is performed by exporting the data from an existing database and importing it into a new database. This also allows testing to ensure that applications interact with the database correctly after the upgrade, and can be used in a staging environment.\n\nThe following is an example of how to upgrade a neo4j database named `lollipop-11` from 11.13 to 12.8.\n\n```shell\n# stop any linked apps\ndokku ps:stop linked-app\n\n# export the database contents\ndokku neo4j:export lollipop-11 \u003e /tmp/lollipop-11.export\n\n# create a new database at the desired version\ndokku neo4j:create lollipop-12 --image-version 12.8\n\n# import the export file\ndokku neo4j:import lollipop-12 \u003c /tmp/lollipop-11.export\n\n# run any sql tests against the new database to verify the import went smoothly\n\n# unlink the old database from your apps\ndokku neo4j:unlink lollipop-11 linked-app\n\n# link the new database to your apps\ndokku neo4j:link lollipop-12 linked-app\n\n# start the linked apps again\ndokku ps:start linked-app\n```\n\n### Service Automation\n\nService scripting can be executed using the following commands:\n\n### list all neo4j service links for a given app\n\n```shell\n# usage\ndokku neo4j:app-links \u003capp\u003e\n```\n\nList all neo4j services that are linked to the `playground` app.\n\n```shell\ndokku neo4j: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 neo4j: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- `-p|--password PASSWORD`: override the user-level service password\n- `-r|--root-password PASSWORD`: override the root-level service password\n- `-s|--shm-size SHM_SIZE`: override shared memory size for neo4j docker container\n\nYou can clone an existing service to a new one:\n\n```shell\ndokku neo4j:clone lollipop lollipop-2\n```\n\n### check if the neo4j service exists\n\n```shell\n# usage\ndokku neo4j:exists \u003cservice\u003e\n```\n\nHere we check if the lollipop neo4j service exists.\n\n```shell\ndokku neo4j:exists lollipop\n```\n\n### check if the neo4j service is linked to an app\n\n```shell\n# usage\ndokku neo4j:linked \u003cservice\u003e \u003capp\u003e\n```\n\nHere we check if the lollipop neo4j service is linked to the `playground` app.\n\n```shell\ndokku neo4j:linked lollipop playground\n```\n\n### list all apps linked to the neo4j service\n\n```shell\n# usage\ndokku neo4j:links \u003cservice\u003e\n```\n\nList all apps linked to the `lollipop` neo4j service.\n\n```shell\ndokku neo4j: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 neo4j service database\n\n```shell\n# usage\ndokku neo4j:import \u003cservice\u003e\n```\n\nImport a datastore dump:\n\n```shell\ndokku neo4j:import lollipop \u003c data.dump\n```\n\n### export a dump of the neo4j service database\n\n```shell\n# usage\ndokku neo4j:export \u003cservice\u003e\n```\n\nBy default, datastore output is exported to stdout:\n\n```shell\ndokku neo4j:export lollipop\n```\n\nYou can redirect this output to a file:\n\n```shell\ndokku neo4j:export lollipop \u003e data.dump\n```\n\nNote that the export will result in a file containing the binary neo4j export data. It can be converted to plain text using `neo4j-admin load` as follows\n\n```shell\nneo4j-admin load data.dump -f plain.sql\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 neo4j service\n\n```shell\n# usage\ndokku neo4j: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 neo4j:backup-auth lollipop AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY\n```\n\nSetup s3 backup authentication with different region:\n\n```shell\ndokku neo4j: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 neo4j: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 neo4j: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 neo4j service\n\n```shell\n# usage\ndokku neo4j:backup-deauth \u003cservice\u003e\n```\n\nRemove s3 authentication:\n\n```shell\ndokku neo4j:backup-deauth lollipop\n```\n\n### create a backup of the neo4j service to an existing s3 bucket\n\n```shell\n# usage\ndokku neo4j: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 neo4j: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 neo4j:import lollipop \u003c backup-folder/export\n```\n\n### set encryption for all future backups of neo4j service\n\n```shell\n# usage\ndokku neo4j:backup-set-encryption \u003cservice\u003e \u003cpassphrase\u003e\n```\n\nSet the GPG-compatible passphrase for encrypting backups for backups:\n\n```shell\ndokku neo4j:backup-set-encryption lollipop\n```\n\n### unset encryption for future backups of the neo4j service\n\n```shell\n# usage\ndokku neo4j:backup-unset-encryption \u003cservice\u003e\n```\n\nUnset the `GPG` encryption passphrase for backups:\n\n```shell\ndokku neo4j:backup-unset-encryption lollipop\n```\n\n### schedule a backup of the neo4j service\n\n```shell\n# usage\ndokku neo4j: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 neo4j:backup-schedule lollipop \"0 3 * * *\" my-s3-bucket\n```\n\nSchedule a backup and authenticate via iam:\n\n```shell\ndokku neo4j: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 neo4j:backup-schedule-cat \u003cservice\u003e\n```\n\nCat the contents of the configured backup cronfile for the service:\n\n```shell\ndokku neo4j:backup-schedule-cat lollipop\n```\n\n### unschedule the backup of the neo4j service\n\n```shell\n# usage\ndokku neo4j:backup-unschedule \u003cservice\u003e\n```\n\nRemove the scheduled backup from cron:\n\n```shell\ndokku neo4j:backup-unschedule lollipop\n```\n\n### Disabling `docker pull` calls\n\nIf you wish to disable the `docker pull` calls that the plugin triggers, you may set the `NEO4J_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 pull` is disabled.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmaayanlab%2Fdokku-neo4j","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmaayanlab%2Fdokku-neo4j","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmaayanlab%2Fdokku-neo4j/lists"}