Project: Chef Habitat (App Definition and Development / Application Definition & Image Build)
File: environment_variables.md

+++ title = "Environment Variables" description = "Customize and configure your Chef Habitat Studio and Supervisor environments" gh_repo = "habitat" [menu] [menu.habitat] title = "Environment Variables" identifier = "habitat/reference/environment-variables" parent = "habitat/reference" +++ This is a list of all environment variables that can be used to modify the operation of the Chef Habitat Studio and Supervisor. | Variable | Context | Default | Description | |-|-|-|--| | `HABAUTHTOKEN` | build system | no default | Authorization token used to perform privileged operations against the depot, e.g. uploading packages or keys. | `HABBINLINKDIR` | build system | `/hab/bin` | Allows you to change the target directory for the symlink created when you run `hab pkg binlink`. The default value is already included in the `$PATH` variable inside the Studio. | | `HABCACHEKEY_PATH` | build system, Supervisor | `/hab/cache/keys` if running as root; `$HOME/.hab/cache/keys` if running as non-root | Cache directory for origin signing keys | | `HABCTLSECRET` | Supervisor | no default | Shared secret used for . | | `HABBLDRCHANNEL` | build system, Supervisor | `stable` | Set the Chef Habitat Builder channel you are subscribing to, to a specific channel. Defaults to `stable`. | `HABBLDRURL` | build system, Supervisor | `https://bldr.habitat.sh` | Sets an alternate default endpoint for communicating with Builder. Used by the Chef Habitat build system and the Supervisor | | `HABDOCKEROPTS` | build system | no default | When running a Studio on a platform that uses Docker (macOS), additional command line options to pass to the `docker` command. | | `HABINTERNALBLDR_CHANNEL` | build system, Supervisor, exporters | `stable` | Channel from which Chef Habitat-specific packages (e.g., `core/hab-sup`, `core/hab-launcher`, etc.) are downloaded on-demand when first called. Generally of use only for those developing Chef Habitat. Only applies to Chef Habitat-specific packages, and nothing else. | | `HAB_LICENSE` | build system, Supervisor, exporters | no default | Used to accept the . See for valid values. | | `HABLISTENCTL` | Supervisor | 127.0.0.1:9632 | The listen address for the Control Gateway. This also affects `hab` commands that interact with the Supervisor via the Control Gateway, for example: `hab sup status`. | | `HABLISTENGOSSIP` | Supervisor | 0.0.0.0:9638 | The listen address for the Gossip System Gateway | | `HABLISTENHTTP` | Supervisor | 0.0.0.0:9631 | The listen address for the HTTP Gateway | | `HAB_NOCOLORING` | build system | no default | If set to the lowercase string `"true"` this environment variable will unconditionally disable text coloring where possible | | `HAB_NONINTERACTIVE` | build system | no default | If set to the lowercase string `"true"` this environment variable will unconditionally disable interactive progress bars (i.e. "spinners") where possible | | `HAB_ORG` | Supervisor | no default | Organization to use when running with | `HAB_ORIGIN` | build system | no default | Origin used to build

The signing key for this origin is passed to the build system. | | `HABORIGINKEYS` | build system | no default | Comma-separated list of origin keys to automatically share with the build system | | `HAB_RING` | Supervisor | no default | The name of the ring used by the Supervisor when running with | | `HABRINGKEY` | Supervisor | no default | The contents of the ring key when running with . Useful when running in a container. | | `HABSTUDIOSECRET_<VARIABLE>` | build system | no default | Prefix to allow environment variables into the Studio. The prefix will be removed and your variable will be passed into the Studio at build time. | | `HABSTUDIOSHOME` | build system | `/hab/studios` | Directory in which to create build Studios | | `HABSTUDIOBACKLINEPKG` | build system | `core/hab-backline/{{studioversion}}` | Overrides the default package identifier for the "backline" package which installs the Studio baseline package set. | | `HABSTUDIOROOT` | build system | no default | Root of the current Studio under `$HABSTUDIOSHOME`. Infrequently overridden. | | `HABSTUDIONOSTUDIORC` | build system | no default | When set to a non-empty value, a `.studiorc` will not be sourced when entering an interactive Studio via `hab studio enter`. | | `HABSTUDIOSUP` | build system | no default | Used to customize the arguments passed to an automatically launched Supervisor, or to disable the automatic launching by setting it to `false`, `no`, or `0`. | | `HABGLYPHSTYLE` | build system | `full` (`limited` on Windows) | Used to customize the rendering of unicode glyphs in UI messages. Valid values are `full`, `limited`, or `ascii`. | | `HABSUPUPDATE_MS` | Supervisor | 60000 | Interval in milliseconds governing how often to check for Supervisor updates when running with the flag. Note: This variable has been deprecated. Users should instead use the flag. | | `HABUPDATESTRATEGYFREQUENCYMS` | Supervisor | 60000 | Interval in milliseconds governing how often to check for service updates when running with an . Note: This variable has been deprecated. Users should instead use the flag. | | `HAB_USER` | Supervisor | no default | User key to use when running with | | `http_proxy` | build system, Supervisor | no default | A URL for a local HTTP proxy server optionally supporting basic authentication | | `https_proxy` | build system, Supervisor | no default | A URL for a local HTTPS proxy server optionally supporting basic authentication | | `NOINSTALLDEPS` | build system | no default | Set this variable to prevent dependencies install during build | | `noproxy` | build system, Supervisor | no default | A comma-separated list of domain exclusions for the `httpproxy` and `https_proxy` environment variables | | `SSLCERTFILE` | system | no default | Standard OpenSSL environment variable to override the system certificate file. This is particularly important for the secure HTTPS connection with a Builder instance. Can be used to help you navigate corporate firewalls. |