Environment Variables

Glossary of environment variables specific to Cased.

The Cased Shell container is configured with environment variables.

Required variables

Variable

Summary

Example

CASED_SHELL_HOSTNAME

The domain name at which this Cased Shell instance will be accessible.

shell.company.com

CASED_SHELL_SECRET

A secure token available in the Settings tab for your Shell instance.

shell_asdf98asdf8967asdf8967asdfaf5a6

Optional variables

Variable

Summary

Default

CASED_SHELL_LOG_LEVEL

Configures the verbosity of logs. info, warning, and debug are also supported.

error

CASED_SHELL_TLS

Configures the behavior of the HTTPS server embedded in Cased Shell. To automatically obtain a certificate for CASED_SHELL_HOSTNAME at startup, set to auto. To use a self-signed cert, set to internal. To entirely disable the HTTPS listener and instead run a HTTP server on port 8888, set to off.

auto

CASED_SHELL_KEEPALIVE_INTERVAL

Configure the number of seconds between sending a keepalive packet on open SSH connections. Similar to SSH's ServerAliveInterval parameter.

30

CASED_SHELL_HOST_FILE

Enable host auto-discovery by setting this value to the path to a file containing a list of hostnames.

CASED_SHELL_SSH_USERNAME

Set this value to force all outgoing connections to use a fixed username (ec2-user for example).

CASED_SHELL_SSH_PRIVATE_KEY

Set this value to force all outgoing connections to use the provided string as a SSH private key. Note: we recommend using SSH Certificate Authentication instead.

CASED_SHELL_SSH_PASSPHRASE

Set this value to force all outgoing connections to use the provided string the passphrase for the provided SSH private key. Note: we recommend using SSH Certificate Authentication instead.

Questions? Contact us.
FAQ


Did this page help you?