{"id":13558587,"url":"https://github.com/dokku/dokku-graphite","last_synced_at":"2026-03-05T16:38:28.808Z","repository":{"id":43025629,"uuid":"47205036","full_name":"dokku/dokku-graphite","owner":"dokku","description":"a graphite, grafana, statsd, carbon plugin for dokku","archived":false,"fork":false,"pushed_at":"2024-06-29T07:48:19.000Z","size":441,"stargazers_count":57,"open_issues_count":4,"forks_count":13,"subscribers_count":5,"default_branch":"master","last_synced_at":"2024-10-30T00:56:03.378Z","etag":null,"topics":["dokku","dokku-plugin","dokku-service","grafana","graphite","paas","statsd"],"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-12-01T17:13:54.000Z","updated_at":"2024-10-02T15:19:31.000Z","dependencies_parsed_at":"2023-02-15T19:01:09.398Z","dependency_job_id":"c2049a87-f325-49ba-b42b-d7ba1c8d7df4","html_url":"https://github.com/dokku/dokku-graphite","commit_stats":{"total_commits":448,"total_committers":9,"mean_commits":49.77777777777778,"dds":0.2209821428571429,"last_synced_commit":"dc8fb785fcd020069ed1521c589bea7f53687f14"},"previous_names":[],"tags_count":77,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dokku%2Fdokku-graphite","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dokku%2Fdokku-graphite/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dokku%2Fdokku-graphite/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dokku%2Fdokku-graphite/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dokku","download_url":"https://codeload.github.com/dokku/dokku-graphite/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246465225,"owners_count":20781919,"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","grafana","graphite","paas","statsd"],"created_at":"2024-08-01T12:05:02.871Z","updated_at":"2026-03-05T16:38:28.796Z","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 graphite [![Build Status](https://img.shields.io/github/actions/workflow/status/dokku/dokku-graphite/ci.yml?branch=master\u0026style=flat-square \"Build Status\")](https://github.com/dokku/dokku-graphite/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 graphite plugin for dokku. Currently defaults to installing [dokku/docker-grafana-graphite 6.4.4](https://hub.docker.com/r/dokku/docker-grafana-graphite/).\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-graphite.git --name graphite\n```\n\n## Commands\n\n```\ngraphite:app-links \u003capp\u003e                           # list all graphite service links for a given app\ngraphite:backup-set-public-key-encryption \u003cservice\u003e \u003cpublic-key-id\u003e # set GPG Public Key encryption for all future backups of graphite service\ngraphite:backup-unset-public-key-encryption \u003cservice\u003e # unset GPG Public Key encryption for future backups of the graphite service\ngraphite:create \u003cservice\u003e [--create-flags...]      # create a graphite service\ngraphite:destroy \u003cservice\u003e [-f|--force]            # delete the graphite service/data/container if there are no links left\ngraphite:enter \u003cservice\u003e                           # enter or run a command in a running graphite service container\ngraphite:exists \u003cservice\u003e                          # check if the graphite service exists\ngraphite:expose \u003cservice\u003e \u003cports...\u003e               # expose a graphite service on custom host:port if provided (random port on the 0.0.0.0 interface if otherwise unspecified)\ngraphite:info \u003cservice\u003e [--single-info-flag]       # print the service information\ngraphite:link \u003cservice\u003e \u003capp\u003e [--link-flags...]    # link the graphite service to the app\ngraphite:linked \u003cservice\u003e \u003capp\u003e                    # check if the graphite service is linked to an app\ngraphite:links \u003cservice\u003e                           # list all apps linked to the graphite service\ngraphite:list                                      # list all graphite services\ngraphite:logs \u003cservice\u003e [-t|--tail] \u003ctail-num-optional\u003e # print the most recent log(s) for this service\ngraphite:nginx-expose \u003cservice\u003e \u003cdomain\u003e           # expose the graphite service's grafana via an nginx vhost\ngraphite:nginx-unexpose \u003cservice\u003e                  # expose the graphite service's grafana via an nginx vhost\ngraphite:pause \u003cservice\u003e                           # pause a running graphite service\ngraphite:promote \u003cservice\u003e \u003capp\u003e                   # promote service \u003cservice\u003e as STATSD_URL in \u003capp\u003e\ngraphite:restart \u003cservice\u003e                         # graceful shutdown and restart of the graphite service container\ngraphite:set \u003cservice\u003e \u003ckey\u003e \u003cvalue\u003e               # set or clear a property for a service\ngraphite:start \u003cservice\u003e                           # start a previously stopped graphite service\ngraphite:stop \u003cservice\u003e                            # stop a running graphite service\ngraphite:unexpose \u003cservice\u003e                        # unexpose a previously exposed graphite service\ngraphite:unlink \u003cservice\u003e \u003capp\u003e                    # unlink the graphite service from the app\ngraphite: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 graphite:help. Plugin help output in conjunction with any files in the `docs/` folder is used to generate the plugin documentation. Please consult the `graphite:help` command for any undocumented commands.\n\n### Basic Usage\n\n### create a graphite service\n\n```shell\n# usage\ndokku graphite: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 graphite docker container\n\nCreate a graphite service named lollipop:\n\n```shell\ndokku graphite:create lollipop\n```\n\nYou can also specify the image and image version to use for the service. It *must* be compatible with the dokku/docker-grafana-graphite image.\n\n```shell\nexport STATSD_IMAGE=\"dokku/docker-grafana-graphite\"\nexport STATSD_IMAGE_VERSION=\"${PLUGIN_IMAGE_VERSION}\"\ndokku graphite:create lollipop\n```\n\nYou can also specify custom environment variables to start the graphite service in semicolon-separated form.\n\n```shell\nexport STATSD_CUSTOM_ENV=\"USER=alpha;HOST=beta\"\ndokku graphite:create lollipop\n```\n\n### print the service information\n\n```shell\n# usage\ndokku graphite: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 graphite:info lollipop\n```\n\nYou can also retrieve a specific piece of service info via flags:\n\n```shell\ndokku graphite:info lollipop --config-dir\ndokku graphite:info lollipop --data-dir\ndokku graphite:info lollipop --dsn\ndokku graphite:info lollipop --exposed-ports\ndokku graphite:info lollipop --id\ndokku graphite:info lollipop --internal-ip\ndokku graphite:info lollipop --initial-network\ndokku graphite:info lollipop --links\ndokku graphite:info lollipop --post-create-network\ndokku graphite:info lollipop --post-start-network\ndokku graphite:info lollipop --service-root\ndokku graphite:info lollipop --status\ndokku graphite:info lollipop --version\n```\n\n### list all graphite services\n\n```shell\n# usage\ndokku graphite:list\n```\n\nList all services:\n\n```shell\ndokku graphite:list\n```\n\n### print the most recent log(s) for this service\n\n```shell\n# usage\ndokku graphite: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 graphite:logs lollipop\n```\n\nBy default, logs will not be tailed, but you can do this with the --tail flag:\n\n```shell\ndokku graphite: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 graphite:logs lollipop --tail 5\n```\n\n### link the graphite service to the app\n\n```shell\n# usage\ndokku graphite: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 graphite 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 graphite: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_STATSD_LOLLIPOP_NAME=/lollipop/DATABASE\nDOKKU_STATSD_LOLLIPOP_PORT=tcp://172.17.0.1:8125\nDOKKU_STATSD_LOLLIPOP_PORT_8125_TCP=tcp://172.17.0.1:8125\nDOKKU_STATSD_LOLLIPOP_PORT_8125_TCP_PROTO=tcp\nDOKKU_STATSD_LOLLIPOP_PORT_8125_TCP_PORT=8125\nDOKKU_STATSD_LOLLIPOP_PORT_8125_TCP_ADDR=172.17.0.1\n```\n\nThe following will be set on the linked application by default:\n\n```\nSTATSD_URL=statsd://dokku-graphite-lollipop:8125\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 graphite:link other_service playground\n```\n\nIt is possible to change the protocol for `STATSD_URL` by setting the environment variable `STATSD_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 STATSD_DATABASE_SCHEME=statsd2\ndokku graphite:link lollipop playground\n```\n\nThis will cause `STATSD_URL` to be set as:\n\n```\nstatsd2://dokku-graphite-lollipop:8125\n```\n\n### unlink the graphite service from the app\n\n```shell\n# usage\ndokku graphite: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 graphite service:\n\n\u003e NOTE: this will restart your app and unset related environment variables\n\n```shell\ndokku graphite:unlink lollipop playground\n```\n\n### set or clear a property for a service\n\n```shell\n# usage\ndokku graphite:set \u003cservice\u003e \u003ckey\u003e \u003cvalue\u003e\n```\n\nSet the network to attach after the service container is started:\n\n```shell\ndokku graphite:set lollipop post-create-network custom-network\n```\n\nSet multiple networks:\n\n```shell\ndokku graphite:set lollipop post-create-network custom-network,other-network\n```\n\nUnset the post-create-network value:\n\n```shell\ndokku graphite: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 graphite service container\n\n```shell\n# usage\ndokku graphite: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 graphite: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 graphite:enter lollipop touch /tmp/test\n```\n\n### expose a graphite 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 graphite: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 graphite:expose lollipop 8125 8126 80 81 2003\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 graphite:expose lollipop 127.0.0.1:8125 8126 80 81 2003\n```\n\n### unexpose a previously exposed graphite service\n\n```shell\n# usage\ndokku graphite:unexpose \u003cservice\u003e\n```\n\nUnexpose the service, removing access to it from the public interface (`0.0.0.0`):\n\n```shell\ndokku graphite:unexpose lollipop\n```\n\n### promote service \u003cservice\u003e as STATSD_URL in \u003capp\u003e\n\n```shell\n# usage\ndokku graphite:promote \u003cservice\u003e \u003capp\u003e\n```\n\nIf you have a graphite service linked to an app and try to link another graphite service another link environment variable will be generated automatically:\n\n```\nDOKKU_STATSD_BLUE_URL=statsd://other_service:ANOTHER_PASSWORD@dokku-graphite-other-service:8125/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 graphite:promote other_service playground\n```\n\nThis will replace `STATSD_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```\nSTATSD_URL=statsd://other_service:ANOTHER_PASSWORD@dokku-graphite-other-service:8125/other_service\nDOKKU_STATSD_BLUE_URL=statsd://other_service:ANOTHER_PASSWORD@dokku-graphite-other-service:8125/other_service\nDOKKU_STATSD_SILVER_URL=statsd://lollipop:SOME_PASSWORD@dokku-graphite-lollipop:8125/lollipop\n```\n\n### start a previously stopped graphite service\n\n```shell\n# usage\ndokku graphite:start \u003cservice\u003e\n```\n\nStart the service:\n\n```shell\ndokku graphite:start lollipop\n```\n\n### stop a running graphite service\n\n```shell\n# usage\ndokku graphite:stop \u003cservice\u003e\n```\n\nStop the service and removes the running container:\n\n```shell\ndokku graphite:stop lollipop\n```\n\n### pause a running graphite service\n\n```shell\n# usage\ndokku graphite:pause \u003cservice\u003e\n```\n\nPause the running container for the service:\n\n```shell\ndokku graphite:pause lollipop\n```\n\n### graceful shutdown and restart of the graphite service container\n\n```shell\n# usage\ndokku graphite:restart \u003cservice\u003e\n```\n\nRestart the service:\n\n```shell\ndokku graphite:restart lollipop\n```\n\n### upgrade service \u003cservice\u003e to the specified versions\n\n```shell\n# usage\ndokku graphite: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 graphite docker container\n\nYou can upgrade an existing service to a new image or image-version:\n\n```shell\ndokku graphite:upgrade lollipop\n```\n\n### Service Automation\n\nService scripting can be executed using the following commands:\n\n### list all graphite service links for a given app\n\n```shell\n# usage\ndokku graphite:app-links \u003capp\u003e\n```\n\nList all graphite services that are linked to the `playground` app.\n\n```shell\ndokku graphite:app-links playground\n```\n\n### check if the graphite service exists\n\n```shell\n# usage\ndokku graphite:exists \u003cservice\u003e\n```\n\nHere we check if the lollipop graphite service exists.\n\n```shell\ndokku graphite:exists lollipop\n```\n\n### check if the graphite service is linked to an app\n\n```shell\n# usage\ndokku graphite:linked \u003cservice\u003e \u003capp\u003e\n```\n\nHere we check if the lollipop graphite service is linked to the `playground` app.\n\n```shell\ndokku graphite:linked lollipop playground\n```\n\n### list all apps linked to the graphite service\n\n```shell\n# usage\ndokku graphite:links \u003cservice\u003e\n```\n\nList all apps linked to the `lollipop` graphite service.\n\n```shell\ndokku graphite: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 graphite service\n\n```shell\n# usage\ndokku graphite: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 graphite: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 graphite service\n\n```shell\n# usage\ndokku graphite:backup-unset-public-key-encryption \u003cservice\u003e\n```\n\nUnset the `GPG` Public Key encryption for backups:\n\n```shell\ndokku graphite: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 `GRAPHITE_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-graphite","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdokku%2Fdokku-graphite","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdokku%2Fdokku-graphite/lists"}