This describes sb
's main configuration options.
This block only describes the command (as in cmd/*.go) that is executed when connecting to a host.
commands:
ssh_command: ttyrec
Right now, the only valid option is ttyrec
: it will connect you to the distant host via ssh
while recording
the session with ttyrec
.
general:
binary_path: /opt/sb/sb
sb_user: sb
sb_user_home: /home/sb
hostname: sb.YOUR_DOMAIN.com
name: sb-us
location: "us"
ssh_port: 22
mosh_ports_range: 40000:49999
env_vars_to_forward: ["USER"]
encryption-key: changemechangemechangemechangeme
binary_path
(string): the path wheresb
's binary is on the bastion serversb_user
(string): the mainsb
system usersb_user_home
(string): the home of the mainsb
user (where global logs are stored)hostname
(string): the hostname of this instance; it will be displayed in the informationname
(string): the name of this instance; it will be displayed in the informationlocation
(string): the location of this instance; it will be displayed in the informationssh_port
(int): the port SSH listens on for this instancemosh_port_range
(string): the UDP range ports that Mosh can useenv_vars_to_forward
([]string): the environment variables thatsb
will forward to a distant hostencryption-key
(string): the encryption key for replication, TTYRecs offloading and backups; it must be either 16, 24 or 32 characters
To learn about replication and high availability, please refer to the dedicated documentation.
replication:
enabled: false
queue:
type: googlepubsub
googlepubsub:
project: demo-gcp-project
topic: sb
enabled
(bool): whether or not replication is enabledqueue
:type
(string): the type of queue to use; as of today, onlygooglepubsub
googlepubsub
:project
(string): The GCP project that hosts the Google PubSub queuetopic
(string): The queue's topic
To avoid multiple instances pulling from the same Google PubSub subscription, each sb
instance registers
to a subscription
built on the following model: [topic-name]-[linux-hostname]
.
If the subscription doesn't exist, it is set to be created automatically.
To learn about TTYRecs offloading and high availability, please refer to the dedicated documentation.
ttyrecsoffloading:
enabled: false
storage:
type: gcs
gcs:
bucket: sb-bucket
objects-base-path: ttyrecs
s3:
region: us-east-2
bucket: sb-bucket
keys-base-path: ttyrecs
aws-access-key: xxx
aws-secret-key: xxx
aws-session-token: xxx
enabled
(bool): whether or not TTYRecs offloading is enabledstorage
:type
(string): the type of remote storage to use; as of today onlygcs
ors3
gcs
:bucket
(string): the Google Cloud Storage bucket to useobjects-base-path
(string): the objects' prefix in the bucket
s3
:region
(string): the region the Amazon S3 bucket sitsbucket
(string): the Amazon S3 bucket to usekeys-base-path
(string): the objects' prefix in the bucketaws-access-key
(string): optional AWS access key; if not specified, taken from the environmentaws-secret-key
(string): optional AWS secret key; if not specified, taken from the environmentaws-session-token
(string): optional AWS session token to use; if not specified, taken from the environment