Environment Variables

This is a list of all environment variables that can be used to modify the operation of Habitat.

Variable Context Default Description
HAB_AUTH_TOKEN build system no default Authorization token used to perform privileged operations against the depot, e.g. uploading packages or keys.
HAB_CACHE_KEY_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
HAB_DEPOT_URL build system, supervisor https://willem.habitat.sh/v1/depot The depot (or materialized view in the depot) used by the Habitat build system or supervisor
HAB_DOCKER_OPTS 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.
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 service group encryption
HAB_ORIGIN build system no default Origin used to build packages. The signing key for this origin is passed to the build system.
HAB_ORIGIN_KEYS build system no default Comma-separated list of origin keys to automatically share with the build system
HAB_RING supervisor no default The ring used by the supervisor when running with wire encryption
HAB_RING_KEY supervisor no default The name of the ring key when running with wire encryption
HAB_STUDIOS_HOME build system /hab/studios if running as root; $HOME/.hab/studios if running as non-root Directory in which to create build studios
HAB_STUDIO_ROOT build system no default Root of the current studio under $HAB_STUDIOS_HOME. Infrequently overridden.
HAB_USER supervisor no default User key to use when running with service group encryption
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
no_proxy build system, supervisor no default A comma-separated list of domain exclusions for the http_proxy and https_proxy environment variables

Customizing Studio

When you enter a studio, Habitat will attempt to locate /src/.studiorc and source it. Think ~/.bashrc. This file can be used to export any environment variables like the ones you see above as well as any other shell customizations to help you develop your plans from within the studio.

To use this feature, place a .studiorc in the current working directory where you will run hab studio enter.