{"id":28528401,"url":"https://github.com/dokku/dokku-meilisearch","last_synced_at":"2026-05-27T06:01:33.839Z","repository":{"id":37853232,"uuid":"428013981","full_name":"dokku/dokku-meilisearch","owner":"dokku","description":"a meillisearch plugin for dokku","archived":false,"fork":false,"pushed_at":"2026-05-21T19:38:52.000Z","size":430,"stargazers_count":35,"open_issues_count":0,"forks_count":4,"subscribers_count":2,"default_branch":"master","last_synced_at":"2026-05-22T04:47:21.799Z","etag":null,"topics":["dokku","dokku-plugin","dokku-service","meilisearch","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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null},"funding":{"github":"dokku","open_collective":"dokku","patreon":"dokku"}},"created_at":"2021-11-14T18:54:37.000Z","updated_at":"2026-05-21T19:39:44.000Z","dependencies_parsed_at":"2023-02-15T19:01:09.264Z","dependency_job_id":"d06cb393-4cf7-4901-80d2-157c3761821b","html_url":"https://github.com/dokku/dokku-meilisearch","commit_stats":{"total_commits":176,"total_committers":3,"mean_commits":"58.666666666666664","dds":0.5852272727272727,"last_synced_commit":"5fb000a12a1e9b4d392709277ea1aa99186170b7"},"previous_names":[],"tags_count":101,"template":false,"template_full_name":null,"purl":"pkg:github/dokku/dokku-meilisearch","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dokku%2Fdokku-meilisearch","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dokku%2Fdokku-meilisearch/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dokku%2Fdokku-meilisearch/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dokku%2Fdokku-meilisearch/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dokku","download_url":"https://codeload.github.com/dokku/dokku-meilisearch/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dokku%2Fdokku-meilisearch/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33553127,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-05-27T02:00:06.184Z","response_time":53,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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","meilisearch","paas"],"created_at":"2025-06-09T12:41:41.446Z","updated_at":"2026-05-27T06:01:33.625Z","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":[],"sub_categories":[],"readme":"# dokku meilisearch [![Build Status](https://img.shields.io/github/actions/workflow/status/dokku/dokku-meilisearch/ci.yml?branch=master\u0026style=flat-square \"Build Status\")](https://github.com/dokku/dokku-meilisearch/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 meilisearch plugin for dokku. Currently defaults to installing [getmeili/meilisearch v1.45.0](https://hub.docker.com/r/getmeili/meilisearch/).\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-meilisearch.git --name meilisearch\n```\n\n## Commands\n\n```\nmeilisearch:app-links \u003capp\u003e                        # list all meilisearch service links for a given app\nmeilisearch:backup-set-public-key-encryption \u003cservice\u003e \u003cpublic-key-id\u003e # set GPG Public Key encryption for all future backups of meilisearch service\nmeilisearch:backup-unset-public-key-encryption \u003cservice\u003e # unset GPG Public Key encryption for future backups of the meilisearch service\nmeilisearch:create \u003cservice\u003e [--create-flags...]   # create a meilisearch service\nmeilisearch:destroy \u003cservice\u003e [-f|--force]         # delete the meilisearch service/data/container if there are no links left\nmeilisearch:enter \u003cservice\u003e                        # enter or run a command in a running meilisearch service container\nmeilisearch:exists \u003cservice\u003e                       # check if the meilisearch service exists\nmeilisearch:expose \u003cservice\u003e \u003cports...\u003e            # expose a meilisearch service on custom host:port if provided (random port on the 0.0.0.0 interface if otherwise unspecified)\nmeilisearch:info \u003cservice\u003e [--single-info-flag]    # print the service information\nmeilisearch:link \u003cservice\u003e \u003capp\u003e [--link-flags...] # link the meilisearch service to the app\nmeilisearch:linked \u003cservice\u003e \u003capp\u003e                 # check if the meilisearch service is linked to an app\nmeilisearch:links \u003cservice\u003e                        # list all apps linked to the meilisearch service\nmeilisearch:list                                   # list all meilisearch services\nmeilisearch:logs \u003cservice\u003e [-t|--tail] \u003ctail-num-optional\u003e # print the most recent log(s) for this service\nmeilisearch:pause \u003cservice\u003e                        # pause a running meilisearch service\nmeilisearch:promote \u003cservice\u003e \u003capp\u003e                # promote service \u003cservice\u003e as MEILISEARCH_URL in \u003capp\u003e\nmeilisearch:restart \u003cservice\u003e                      # graceful shutdown and restart of the meilisearch service container\nmeilisearch:set \u003cservice\u003e \u003ckey\u003e \u003cvalue\u003e            # set or clear a property for a service\nmeilisearch:start \u003cservice\u003e                        # start a previously stopped meilisearch service\nmeilisearch:stop \u003cservice\u003e                         # stop a running meilisearch service\nmeilisearch:unexpose \u003cservice\u003e                     # unexpose a previously exposed meilisearch service\nmeilisearch:unlink \u003cservice\u003e \u003capp\u003e                 # unlink the meilisearch service from the app\nmeilisearch: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 meilisearch:help. Plugin help output in conjunction with any files in the `docs/` folder is used to generate the plugin documentation. Please consult the `meilisearch:help` command for any undocumented commands.\n\n### Basic Usage\n\n### create a meilisearch service\n\n```shell\n# usage\ndokku meilisearch: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 meilisearch docker container\n\nCreate a meilisearch service named lollipop:\n\n```shell\ndokku meilisearch:create lollipop\n```\n\nYou can also specify the image and image version to use for the service. It *must* be compatible with the getmeili/meilisearch image.\n\n```shell\nexport MEILISEARCH_IMAGE=\"getmeili/meilisearch\"\nexport MEILISEARCH_IMAGE_VERSION=\"${PLUGIN_IMAGE_VERSION}\"\ndokku meilisearch:create lollipop\n```\n\nYou can also specify custom environment variables to start the meilisearch service in semicolon-separated form.\n\n```shell\nexport MEILISEARCH_CUSTOM_ENV=\"USER=alpha;HOST=beta\"\ndokku meilisearch:create lollipop\n```\n\n### print the service information\n\n```shell\n# usage\ndokku meilisearch: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 meilisearch:info lollipop\n```\n\nYou can also retrieve a specific piece of service info via flags:\n\n```shell\ndokku meilisearch:info lollipop --config-dir\ndokku meilisearch:info lollipop --data-dir\ndokku meilisearch:info lollipop --dsn\ndokku meilisearch:info lollipop --exposed-ports\ndokku meilisearch:info lollipop --id\ndokku meilisearch:info lollipop --internal-ip\ndokku meilisearch:info lollipop --initial-network\ndokku meilisearch:info lollipop --links\ndokku meilisearch:info lollipop --post-create-network\ndokku meilisearch:info lollipop --post-start-network\ndokku meilisearch:info lollipop --service-root\ndokku meilisearch:info lollipop --status\ndokku meilisearch:info lollipop --version\n```\n\n### list all meilisearch services\n\n```shell\n# usage\ndokku meilisearch:list\n```\n\nList all services:\n\n```shell\ndokku meilisearch:list\n```\n\n### print the most recent log(s) for this service\n\n```shell\n# usage\ndokku meilisearch: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 meilisearch:logs lollipop\n```\n\nBy default, logs will not be tailed, but you can do this with the --tail flag:\n\n```shell\ndokku meilisearch: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 meilisearch:logs lollipop --tail 5\n```\n\n### link the meilisearch service to the app\n\n```shell\n# usage\ndokku meilisearch: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 meilisearch 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 meilisearch: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_MEILISEARCH_LOLLIPOP_NAME=/lollipop/DATABASE\nDOKKU_MEILISEARCH_LOLLIPOP_PORT=tcp://172.17.0.1:7700\nDOKKU_MEILISEARCH_LOLLIPOP_PORT_7700_TCP=tcp://172.17.0.1:7700\nDOKKU_MEILISEARCH_LOLLIPOP_PORT_7700_TCP_PROTO=tcp\nDOKKU_MEILISEARCH_LOLLIPOP_PORT_7700_TCP_PORT=7700\nDOKKU_MEILISEARCH_LOLLIPOP_PORT_7700_TCP_ADDR=172.17.0.1\n```\n\nThe following will be set on the linked application by default:\n\n```\nMEILISEARCH_URL=http://:SOME_PASSWORD@dokku-meilisearch-lollipop:7700\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 meilisearch:link other_service playground\n```\n\nIt is possible to change the protocol for `MEILISEARCH_URL` by setting the environment variable `MEILISEARCH_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 MEILISEARCH_DATABASE_SCHEME=http2\ndokku meilisearch:link lollipop playground\n```\n\nThis will cause `MEILISEARCH_URL` to be set as:\n\n```\nhttp2://:SOME_PASSWORD@dokku-meilisearch-lollipop:7700\n```\n\n### unlink the meilisearch service from the app\n\n```shell\n# usage\ndokku meilisearch: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 meilisearch service:\n\n\u003e NOTE: this will restart your app and unset related environment variables\n\n```shell\ndokku meilisearch:unlink lollipop playground\n```\n\n### set or clear a property for a service\n\n```shell\n# usage\ndokku meilisearch:set \u003cservice\u003e \u003ckey\u003e \u003cvalue\u003e\n```\n\nSet the network to attach after the service container is started:\n\n```shell\ndokku meilisearch:set lollipop post-create-network custom-network\n```\n\nSet multiple networks:\n\n```shell\ndokku meilisearch:set lollipop post-create-network custom-network,other-network\n```\n\nUnset the post-create-network value:\n\n```shell\ndokku meilisearch: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### enter or run a command in a running meilisearch service container\n\n```shell\n# usage\ndokku meilisearch: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 meilisearch: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 meilisearch:enter lollipop touch /tmp/test\n```\n\n### expose a meilisearch 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 meilisearch: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 meilisearch:expose lollipop 7700\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 meilisearch:expose lollipop 127.0.0.1:7700\n```\n\n### unexpose a previously exposed meilisearch service\n\n```shell\n# usage\ndokku meilisearch:unexpose \u003cservice\u003e\n```\n\nUnexpose the service, removing access to it from the public interface (`0.0.0.0`):\n\n```shell\ndokku meilisearch:unexpose lollipop\n```\n\n### promote service \u003cservice\u003e as MEILISEARCH_URL in \u003capp\u003e\n\n```shell\n# usage\ndokku meilisearch:promote \u003cservice\u003e \u003capp\u003e\n```\n\nIf you have a meilisearch service linked to an app and try to link another meilisearch service another link environment variable will be generated automatically:\n\n```\nDOKKU_MEILISEARCH_BLUE_URL=http://other_service:ANOTHER_PASSWORD@dokku-meilisearch-other-service:7700/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 meilisearch:promote other_service playground\n```\n\nThis will replace `MEILISEARCH_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```\nMEILISEARCH_URL=http://other_service:ANOTHER_PASSWORD@dokku-meilisearch-other-service:7700/other_service\nDOKKU_MEILISEARCH_BLUE_URL=http://other_service:ANOTHER_PASSWORD@dokku-meilisearch-other-service:7700/other_service\nDOKKU_MEILISEARCH_SILVER_URL=http://lollipop:SOME_PASSWORD@dokku-meilisearch-lollipop:7700/lollipop\n```\n\n### start a previously stopped meilisearch service\n\n```shell\n# usage\ndokku meilisearch:start \u003cservice\u003e\n```\n\nStart the service:\n\n```shell\ndokku meilisearch:start lollipop\n```\n\n### stop a running meilisearch service\n\n```shell\n# usage\ndokku meilisearch:stop \u003cservice\u003e\n```\n\nStop the service and removes the running container:\n\n```shell\ndokku meilisearch:stop lollipop\n```\n\n### pause a running meilisearch service\n\n```shell\n# usage\ndokku meilisearch:pause \u003cservice\u003e\n```\n\nPause the running container for the service:\n\n```shell\ndokku meilisearch:pause lollipop\n```\n\n### graceful shutdown and restart of the meilisearch service container\n\n```shell\n# usage\ndokku meilisearch:restart \u003cservice\u003e\n```\n\nRestart the service:\n\n```shell\ndokku meilisearch:restart lollipop\n```\n\n### upgrade service \u003cservice\u003e to the specified versions\n\n```shell\n# usage\ndokku meilisearch: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 meilisearch docker container\n\nYou can upgrade an existing service to a new image or image-version:\n\n```shell\ndokku meilisearch:upgrade lollipop\n```\n\n### Service Automation\n\nService scripting can be executed using the following commands:\n\n### list all meilisearch service links for a given app\n\n```shell\n# usage\ndokku meilisearch:app-links \u003capp\u003e\n```\n\nList all meilisearch services that are linked to the `playground` app.\n\n```shell\ndokku meilisearch:app-links playground\n```\n\n### check if the meilisearch service exists\n\n```shell\n# usage\ndokku meilisearch:exists \u003cservice\u003e\n```\n\nHere we check if the lollipop meilisearch service exists.\n\n```shell\ndokku meilisearch:exists lollipop\n```\n\n### check if the meilisearch service is linked to an app\n\n```shell\n# usage\ndokku meilisearch:linked \u003cservice\u003e \u003capp\u003e\n```\n\nHere we check if the lollipop meilisearch service is linked to the `playground` app.\n\n```shell\ndokku meilisearch:linked lollipop playground\n```\n\n### list all apps linked to the meilisearch service\n\n```shell\n# usage\ndokku meilisearch:links \u003cservice\u003e\n```\n\nList all apps linked to the `lollipop` meilisearch service.\n\n```shell\ndokku meilisearch:links lollipop\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\nIf both passphrase and public key forms of encryption are set, the public key encryption will take precedence.\n\nThe underlying core backup script is present [here](https://github.com/dokku/docker-s3backup/blob/main/backup.sh).\n\nBackups can be performed using the backup commands:\n\n### set GPG Public Key encryption for all future backups of meilisearch service\n\n```shell\n# usage\ndokku meilisearch: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 meilisearch:backup-set-public-key-encryption lollipop\n```\n\nThis method currently requires the \u003cpublic-key-id\u003e to be present on the keyserver `keyserver.ubuntu.com`:\n\n### unset GPG Public Key encryption for future backups of the meilisearch service\n\n```shell\n# usage\ndokku meilisearch:backup-unset-public-key-encryption \u003cservice\u003e\n```\n\nUnset the `GPG` Public Key encryption for backups:\n\n```shell\ndokku meilisearch:backup-unset-public-key-encryption 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 `MEILISEARCH_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-meilisearch","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdokku%2Fdokku-meilisearch","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdokku%2Fdokku-meilisearch/lists"}