Search…
Getting Started
Introduction
Quick start
Web Shell
Getting started
Deploying Cased Shell to Amazon ECS
Deploying Cased Shell on Google Cloud Run
Deploying Cased Shell on Heroku
Configuring your Cased Shell instance
Accessing a remote host
Exiting out of a host
Host and container auto-detection
SSH Certificates
Live SSH session sharing
Monitor active SSH sessions
SSH Session replays
Session exports
Web Browser Capabilities
Snippets
Groups and Permissions
Downloading files
Persistent, pluggable storage
Security Design
Environment Variables
SAML setup
PagerDuty
Web Shell Approvals
Overview
5 minute quick start
Workflow
Reporting
Activity
Audit log
Cased CLI Approvals
Overview
15 minute quick start
Getting started with the CLI
Working with the client on the Command Line
The Cased client (cased)
Use with Docker
Use with shell scripts
Configure an app
Installing the client on remote servers
Open Source
Terraform Provider
Terraform - Cased Shell on AWS
Cased CLI
Rails-approvals
Security
Managing API Keys
The system audit trail
Data subprocessors
Powered By GitBook
Environment Variables
Glossary of environment variables specific to Cased.

Required variables

The Cased Shell container is configured with environment 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
Example
CASED_SHELL_PLUGINS
Enable various plugins, including approvals. Each plugin is separated by a comma. Most common:
1
CASED_SHELL_PLUGINS="approval"
Copied!
approval, hyperpower
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.
​
​
Web Shell - Previous
Security Design
Next - Web Shell
SAML setup
Last modified 2mo ago
Copy link
Contents
Required variables
Optional variables