[{"_1":2,"_161":-5,"_162":-5},"loaderData",{"_3":4,"_17":18,"_25":26,"_140":141},"root",{"_5":-5,"_6":-7,"_7":8,"_9":-7,"_10":11,"_12":-7,"_13":14,"_15":16},"currentUser","primaryEmail","siteVerification","6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI","toast","enableDev",false,"incidentStatus","theme","system","contrast","normal","routes/_layout",{"_19":-5,"_20":21,"_22":21,"_23":11,"_24":21},"username","isAskGordonEnabled",true,"isUsingNewTemplate","showMinimalLanding","showHoneypotTrap","routes/_layout.r.$namespace.$reponame",{"_27":28,"_29":-5,"_30":11,"_31":11,"_32":33,"_34":35,"_36":-5,"_37":11,"_38":39,"_87":-5,"_88":89,"_128":-5,"_129":11,"_130":21,"_131":11,"_132":11,"_133":-5,"_134":11,"_135":-5,"_136":137,"_138":90,"_139":-7},"canonicalUrl","https://hub.docker.com/r/jessecollier/envconsul/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","jessecollier","reponame","envconsul","cloudBuildSource","isAutobuildsAvailable","repo",{"_40":41,"_42":43,"_45":46,"_47":35,"_48":11,"_49":50,"_51":52,"_53":54,"_56":35,"_32":33,"_57":58,"_59":44,"_60":61,"_62":63,"_64":65,"_66":-5,"_67":61,"_68":69,"_70":11,"_71":33,"_72":73,"_78":21,"_79":80,"_84":33,"_85":86},"categories",[],"content_types",[44],"image","date_registered","2017-07-13T21:34:07.366711Z","description","is_private","last_updated","2017-07-13T21:45:16.610827Z","last_modified","2024-10-16T13:48:34.145251Z","media_types",[55],"application/vnd.docker.container.image.v1+json","name","pull_count",204,"repository_type","star_count",0,"status",1,"status_description","active","source","collaborator_count","full_description","envconsul\n=========\n\n[![Latest Version](http://img.shields.io/github/release/hashicorp/envconsul.svg?style=flat-square)][release]\n[![Build Status](http://img.shields.io/travis/hashicorp/envconsul.svg?style=flat-square)][travis]\n\n[release]: https://releases.hashicorp.com/envconsul/\n[travis]: http://travis-ci.org/hashicorp/envconsul\n\nenvconsul provides a convenient way to populate values from [Consul][] into a child process environment using the `envconsul` daemon.\n\nThe daemon `envconsul` allows applications to be configured with environment variables, without having knowledge about the existence of Consul. This makes it especially easy to configure applications throughout all your environments: development, testing, production, etc.\n\nenvconsul is inspired by [envdir][] in its simplicity, name, and function.\n\n**The documentation in this README corresponds to the master branch of envconsul. It may contain unreleased features or different APIs than the most recently released version. Please see the Git tag that corresponds to your version of envconsul for the proper documentation.**\n\nInstallation\n------------\nYou can download a released `envconsul` artifact from [the envconsul release page](https://releases.hashicorp.com/envconsul/). If you wish to compile from source, you will need to have buildtools and [Go][] installed:\n\n```shell\n$ git clone https://github.com/hashicorp/envconsul.git\n$ cd envconsul\n$ make\n```\n\nThis process will create `bin/envconsul` which may be invoked as a binary.\n\n\nUsage\n-----\n### Options\n| Option | Description |\n| ----------------- |------------ |\n| `auth` | The basic authentication username (and optional password), separated by a colon. There is no default value.\n| `consul`* | The location of the Consul instance to query (may be an IP address or FQDN) with port.\n| `max-stale` | The maximum staleness of a query. If specified, Consul will distribute work among all servers instead of just the leader. The default value is 0 (none).\n| `ssl` | Use HTTPS while talking to Consul. Requires the Consul server to be configured to serve secure connections. The default value is false.\n| `ssl-ca-cert` | Path to a CA certificate file, containing one or more CA certificates to use to validate the certificate sent by the consul server to us. This is a handy alternative to setting ```--ssl-verify=false``` if you are using your own CA.\n| `ssl-cert` | Path to an SSL client certificate to use to authenticate to the consul server. Useful if the consul server \"verify_incoming\" option is set.\n| `ssl-verify` | Verify certificates when connecting via SSL. This requires the use of `-ssl`. The default value is true.\n| `syslog` | Send log output to syslog (in addition to stdout and stderr). The default value is false.\n| `syslog-facility` | The facility to use when sending to syslog. This requires the use of `-syslog`. The default value is `LOCAL0`.\n| `token` | The [Consul API token][Consul ACLs]. There is no default value.\n| `kill-signal` | Kill signal to send to child process. Defaults to `SIGTERM` but can be one of `SIGHUP,SIGTERM,SIGINT,SIGQUIT,SIGUSR1,SIGUSR2`\n| `wait` | The `minimum(:maximum)` to wait before rendering a command to fire, separated by a colon (`:`). If the optional maximum value is omitted, it is assumed to be 4x the required minimum value. There is no default value.\n| `retry` | The amount of time to wait if Consul returns an error when communicating with the API. The default value is 5 seconds.\n| `prefix` | A prefix to watch in Consul. This may be specified multiple times.\n| `secret` | A secret to watch in Vault. This may be specified multiple times.\n| `sanitize` | Replace invalid characters in keys to underscores.\n| `splay` | The maximum time to wait before restarting the program, from which a random value is chosen.\n| `upcase` | Convert all environment variable keys to uppercase.\n| `config` | The path to a configuration file or directory of configuration files on disk, relative to the current working directory. Values specified on the CLI take precedence over values specified in the configuration file. There is no default value.\n| `log-level` | The log level for output. This applies to the stdout/stderr logging as well as syslog logging (if enabled). Valid values are \"debug\", \"info\", \"warn\", and \"err\". The default value is \"warn\".\n| `pristine` | Only use variables retrieved from consul, do not inherit existing environment variables.\n| `once` | Run envconsul once and exit (as opposed to the default behavior of daemon). _(CLI-only)_\n| `version` | Output version information and quit. _(CLI-only)_\n\n\\* = Required parameter\n\nMultiple prefixes are merged in the order they are specified, with the right-most prefix taking precedence over its left siblings/ Vault secrets always take precedence over consul prefixes.\n\nFor example, consider:\n\n```shell\n$ envconsul -prefix global/config -prefix redis/config\n```\n\nIn this example, the values of `redis` take precedence over the values in `global`. If they had the following structure:\n\n```text\n# Global\nA=1\nB=1\nC=1\n\n# Redis\nA=2\n```\n\nThe resulting environment would be:\n\n```text\nA=2\nB=1\nC=1\n```\n\n#### Custom Kill Signal\n\nEnvconsul by default will send the `SIGTERM` signal to the child process. If you want to override this to pass in a custom signal use the `kill-signal` config option. This option takes one of `SIGHUP,SIGTERM,SIGINT,SIGQUIT,SIGUSR1,SIGUSR2` or for Windows `SIGINT,SIGTERM,SIGQUIT`.\n\n### Command Line\nThe CLI interface supports all of the options detailed above.\n\nQuery the nyc1 demo Consul instance, rending all the keys in `config/redis`, and printing the environment.\n\n```shell\n$ envconsul \\\n -consul demo.consul.io \\\n -prefix redis/config@nyc3 \\\n env\n```\n\nQuery a local Consul instance, converting special characters in keys to undercores and uppercasing the keys:\n\n```shell\n$ envconsul \\\n -consul 127.0.0.1:8500 \\\n -sanitize \\\n -upcase \\\n -prefix redis/config \\\n env\n```\n\n### Configuration File\nThe envconsul configuration file is written in [HashiCorp Configuration Language (HCL)][HCL]. By proxy, this means the envconsul configuration file is JSON-compatible. For more information, please see the [HCL specification][HCL].\n\nThe Configuration file syntax interface supports all of the options detailed above, but the dashes are replaced with underscores.\n\n```javascript\nconsul = \"127.0.0.1:8500\"\ntoken = \"abcd1234\"\nmax_stale = \"10m\"\ntimeout = \"5s\"\nretry = \"10s\"\nsanitize = true\nsplay = \"5s\"\n\nkill_signal = \"SIGHUP\"\n\nvault {\n address = \"https://vault.service.consul:8200\"\n token = \"abcd1234\" // May also be specified via the envvar VAULT_TOKEN\n renew = true\n\n ssl {\n enabled = true\n verify = true\n cert = \"/path/to/client/cert.pem\"\n ca_cert = \"/path/to/ca/cert.pem\"\n }\n}\n\nprefix {\n path = \"config/global\"\n}\n\nprefix {\n path = \"config/redis\"\n format = \"prod_{{ key }}\"\n}\n\nsecret {\n path = \"secret/creds\"\n}\n\nauth {\n enabled = true\n username = \"test\"\n password = \"test\"\n}\n\nssl {\n enabled = true\n verify = false\n}\n\nsyslog {\n enabled = true\n facility = \"LOCAL5\"\n}\n```\n\nPlease note: Vault secrets always take precedence over consul prefixes. This is to mitigate a security vulnerability.\n\nExamples\n--------\n### Redis\nRedis is a command key-value storage engine. If Redis is configured to read the given environment variables, you can use `envconsul` to start and manage the process:\n\n```shell\n# Ensure \"daemonize no\" is set in the redis configuration first.\n$ envconsul \\\n -consul demo.consul.io \\\n -prefix redis/config \\\n redis-server [opts...]\n```\n\n### Env\nThis example is a great way to see `envconsul` in action. In practice, it is unlikely to be a useful use of envconsul though:\n\n```shell\n$ envconsul \\\n -consul=demo.consul.io \\\n -prefix redis/config \\\n -once \\\n env\nADDRESS=1.2.3.4\nPORT=55\n```\n\nWe can also ask envconsul to poll for configuration changes and automatically restart the process:\n\n```\n$ envconsul \\\n -consul=demo.consul.io \\\n -prefix redis/config \\\n python -c 'import os, time; print os.environ; time.sleep(1000);'\n{ 'ADDRESS': '1.2.3.4', 'PORT': '55' }\n-----\n{ 'ADDRESS': '1.2.3.4' }\n-----\n{ 'ADDRESS': '1.2.3.4', 'MAXCONNS': '50' }\n-----\n```\n\n### Vault Secrets\nWith the Vault integration, it is possible to pull secrets from Vault directly into the environment using envconsul. The only restriction is that the data must be \"flat\" and all keys and values must be strings or string-like values. envconsul will return an error if you try to read from a value that returns a map, for example.\n\nFirst, you must add the vault address and token information to the configuration file. It is not possible to specify these values via the command line:\n\n```javascript\nvault {\n address = \"https://vault.service.consul:8200\"\n token = \"abcd1234\" // May also be specified via the envvar VAULT_TOKEN\n renew = true\n\n ssl {\n enabled = true\n verify = true\n cert = \"/path/to/client/cert.pem\"\n ca_cert = \"/path/to/ca/cert.pem\"\n }\n}\n```\n\nAssuming a secret exists at secret/passwords that was created like so:\n\n```\n$ vault write secret/passwords username=foo password=bar\n```\n\nenvconsul can pull those values into the environment:\n\n```\n$ envconsul \\\n -config=\"./config.hcl\" \\\n -secret=\"secret/passwords\" \\\n env\n\nsecret_passwords_username=foo\nsecret_passwords_password=bar\n```\n\nNotice that the environment variables are prefixed with the path. The slashes in the path are converted to underscores, followed by the key:\n\n```text\nsecret/passwords => secret_passwords\nmysql/creds/readonly => mysql_creds_readonly\n```\n\nThis behavior may be disabled by setting `no_prefix`\n\n```javascript\nsecret {\n no_prefix = true\n path = \"secret/passwords\"\n}\n\nusername=foo\npassword=bar\n```\n\nYou can also apply key transformations to the data:\n\n```\n$ envconsul \\\n -config=\"./config.hcl\" \\\n -secret=\"mysql/creds/readonly\" \\\n -upcase \\\n env\n\nMYSQL_CREDS_READONLY_USERNAME=root-aefa635a-18\nMYSQL_CREDS_READONLY_PASSWORD=132ae3ef-5a64-7499-351e-bfe59f3a2a21\n```\n\nIt is highly encouraged that you specify the format for vault keys to include a common prefix, like:\n\n```javascript\nsecret {\n path = \"secret/passwords\"\n format = \"secret_{{ key }}\"\n}\n```\n\nThe format string is passed to the go formatter and \"{{ key }}\" dictates where the key will go. This will help filter out the environment when execing to a child-process, for example.\n\nDebugging\n---------\nenvconsul can print verbose debugging output. To set the log level for envconsul, use the `-log-level` flag:\n\n```shell\n$ envconsul -log-level info ...\n```\n\n```text\n [INFO] (cli) received redis from Watcher\n [INFO] (cli) invoking Runner\n# ...\n```\n\nYou can also specify the level as debug:\n\n```shell\n$ envconsul -log-level debug ...\n```\n\n```text\n [DEBUG] (cli) creating Runner\n [DEBUG] (cli) creating Consul API client\n [DEBUG] (cli) creating Watcher\n [INFO] (watcher) adding \"storeKeyPrefix(redis/config)\"\n [DEBUG] (watcher) \"storeKeyPrefix(redis/config)\" starting\n [DEBUG] (cli) looping for data\n [DEBUG] (view) \"storeKeyPrefix(redis/config)\" starting fetch\n [DEBUG] (\"storeKeyPrefix(redis/config)\") querying Consul with ...\n [DEBUG] (\"storeKeyPrefix(redis/config)\") Consul returned 0 key pairs\n [INFO] (view) \"storeKeyPrefix(redis/config)\" received data from consul\n [INFO] (cli) received \"storeKeyPrefix(redis/config)\" from Watcher\n [DEBUG] (cli) detected quiescence, starting timers\n [DEBUG] (cli) looping for data\n [DEBUG] (cli) quiescence minTimer fired, invoking Runner\n [DEBUG] (view) \"storeKeyPrefix(redis/config)\" starting fetch\n [DEBUG] (\"storeKeyPrefix(redis/config)\") querying Consul with ...\n# ...\n```\n\nQuiescence\n----------\nIf you have a large number of services that are in flux, you may want to specify a quiescence timer. This will prevent commands from running until a stable state is reached (or a maximum timeout you specify). You can specify the quiescence interval using the `-wait` flag on the command line:\n\n```shell\nenvconsul -wait \"10s:50s\"\n```\n\nThis tells envconsul to wait for a period of 10 seconds while we do not have data before running/restarting the command, but to wait no more than 50 seconds.\n\n\nContributing\n------------\nTo hack on envconsul, you will need a modern [Go][] environment. To compile the `envconsul` binary and run the test suite, simply execute:\n\n```shell\n$ make\n```\n\nThis will compile the `envconsul` binary into `bin/envconsul` and run the test suite.\n\nIf you just want to run the tests:\n\n```shell\n$ make\n```\n\nOr to run a specific test in the suite:\n\n```shell\ngo test ./... -run SomeTestFunction_name\n```\n\nSubmit Pull Requests and Issues to the envconsul project on GitHub.\n\n\n\n[Consul]: http://consul.io/ \"Service discovery and configuration made easy\"\n[envdir]: http://cr.yp.to/daemontools/envdir.html \"envdir\"\n[Releases]: https://releases.hashicorp.com/envconsul/ \"envconsul releases page\"\n[HCL]: https://github.com/hashicorp/hcl \"HashiCorp Configuration Language (HCL)\"\n[Go]: http://golang.org \"Go the language\"\n[Consul ACLs]: http://www.consul.io/docs/internals/acl.html \"Consul ACLs\"\n","has_starred","hub_user","immutable_tags_settings",{"_74":11,"_75":76},"enabled","rules",[77],".*","is_automated","permissions",{"_81":21,"_82":11,"_83":11},"read","write","admin","user","storage_size",7775574,"orgData","recentTags",[90],{"_91":44,"_92":93,"_94":95,"_96":97,"_98":99,"_49":117,"_118":93,"_119":33,"_120":55,"_56":121,"_122":123,"_124":108,"_125":117,"_126":65,"_127":21},"content_type","creator",16117,"full_size",4879625,"id",12925105,"images",[100],{"_101":102,"_103":104,"_105":106,"_107":108,"_109":110,"_111":112,"_113":106,"_114":-5,"_115":95,"_62":65,"_116":-5},"architecture","amd64","digest","sha256:c28d528d2b6a41d4d394d6753de02383e8d3a026eb3819f6287ff810cda8dbbc","features","","last_pulled","2026-10-19T20:11:54.925334568Z","last_pushed","2017-07-13T21:45:17Z","os","linux","os_features","os_version","size","variant","2017-07-13T21:45:16.294204Z","last_updater","last_updater_username","media_type","latest","repository",1650197,"tag_last_pulled","tag_last_pushed","tag_status","v2","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","showSbxRunInCloud","showSbxLogoOverride","sbxTrademarkText","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"selectedTag","attestationsUrl","routes/_layout.r.$namespace.$reponame.tags",{"_38":142,"_149":150,"_136":159,"_160":11},{"_40":143,"_42":144,"_45":46,"_47":35,"_48":11,"_49":50,"_51":52,"_53":145,"_56":35,"_32":33,"_57":58,"_59":44,"_60":61,"_62":63,"_64":65,"_66":-5,"_67":61,"_68":69,"_70":11,"_71":33,"_72":146,"_78":21,"_79":148,"_84":33,"_85":86},[],[44],[55],{"_74":11,"_75":147},[77],{"_81":21,"_82":11,"_83":11},"tags",{"_151":63,"_152":-5,"_153":-5,"_154":155},"count","next","previous","results",[156],{"_91":44,"_92":93,"_94":95,"_96":97,"_98":157,"_49":117,"_118":93,"_119":33,"_120":55,"_56":121,"_122":123,"_124":108,"_125":117,"_126":65,"_127":21},[158],{"_101":102,"_103":104,"_105":106,"_107":108,"_109":110,"_111":112,"_113":106,"_114":-5,"_115":95,"_62":65,"_116":-5},[],"canDeleteTags","actionData","errors"]

jessecollier/envconsul

Tags for jessecollier/envconsul