# Functions

AuthConnectAddr returns the default address to search for auth.
AuthListenAddr returns the default listening address for the Auth service.
ConfigureLimiter assigns the default parameters to a connection throttler (AKA limiter).
KubeProxyListenAddr returns the default listening address for the Kubernetes Proxy service.
ProxyListenAddr returns the default listening address for the SSH Proxy service.
ProxyWebListenAddr returns the default listening address for the Web-based SSH Proxy service.
ReverseTunnellListenAddr returns the default listening address for the SSH Proxy service used by the SSH nodes to establish proxy<->ssh_node connection from behind a firewall which blocks inbound connecions to ssh_nodes.
SSHServerListenAddr returns the default listening address for the Web-based SSH Proxy service.

# Constants

AccessPointCachedValues is the default maximum amount of cached values in access point.
AccountLockInterval defines a time interval during which a user account is locked after MaxLoginAttempts.
ActivePartyTTL is a TTL when party is marked as inactive.
ActiveSessionTTL is a TTL when session is marked as inactive.
AnyAddress is used to refer to the non-routable meta-address used to refer to all addresses on the machine.
AttemptTTL is TTL for login attempt.
AuditLogSessions is the default expected amount of concurrent sessions supported by Audit logger, this number limits the possible amount of simultaneously processes concurrent sessions by the Audit log server, and 16K is OK for now.
AuditLogTimeFormat is the format for the timestamp on audit log files.
When running as a "SSH Proxy" this port will be used to serve auth requests.
BackendDir is a default backend subdirectory.
BackendPath is a default backend path parameter.
Default DB to use for persisting state.
By default SSH server (and SSH proxy) will bind to this IP.
CacheTTL is a default cache TTL for persistent node cache.
CallbackTimeout is how long to wait for a response from SSO provider before timeout.
CATTL is a default lifetime of a CA certificate.
CertDuration is a default certificate duration 12 is default as it' longer than average working day (I hope so).
ClientCacheSize is the size of the RPC clients expiring cache.
CSRSignTimeout is a default timeout for CSR request to be processed by K8s.
DefaultDialTimeout is a default TCP dial timeout we set for our connection attempts.
DefaultIdleConnectionDuration indicates for how long Teleport will hold the SSH connection open if there are no reads/writes happening over it.
By default all users use /bin/bash.
DefaultThrottleTimeout is a timemout used to throttle failed auth servers.
The following are cryptographic primitives Teleport does not support in it's default configuration.
The following are cryptographic primitives Teleport does not support in it's default configuration.
Name of events bolt database file stored in DataDir.
EventsIterationLimit is a default limit if it's not set for events.
EventsIterationLimit is max iteration limit for events.
GithubAuthRequestTTL is TTL of internally stored Github auth request.
The following are cryptographic primitives Teleport does not support in it's default configuration.
The following are cryptographic primitives Teleport does not support in it's default configuration.
HostCertCacheSize is the number of host certificates to cache at any moment.
HostCertCacheTime is how long a certificate stays in the cache.
HOTPFirstTokensRange is amount of lookahead tokens we remember for sync purposes.
HOTPTokenDigits is the number of digits in each token.
HTTPIdleTimeout is a default timeout for idle HTTP connections.
Web UI over HTTP(s).
HTTPMaxIdleConns is the max idle connections across all hosts.
HTTPMaxIdleConnsPerHost is the max idle connections per-host.
InviteTokenTTL sets the lifespan of tokens used for adding nodes and users to a cluster.
IterationLimit is a default limit if it's not set.
KubeProxyListenPort is a default port for kubernetes proxies.
Number of max.
Number of max.
Localhost is the address of localhost.
LogRotationPeriod defines how frequently to rotate the audit log file.
MaxCertDuration limits maximum duration of validity of issued cert.
MaxIterationLimit is max iteration limit.
MaxLoginAttempts sets the max.
MaxPasswordLength is maximum password length (for sanity).
MaxSignupTokenTTL is a maximum TTL for a web signup one time token clients can reduce this time, not increase it.
MinCertDuration specifies minimum duration of validity of issued cert.
MinPasswordLength is minimum password length.
Namespace is default namespace.
1 hour.
OIDCAuthRequestTTL is TTL of internally stored auth request created by client.
PlaybackRecycleTTL is the TTL for unpacked session playback files.
ProvisioningTokenTTL is a the default TTL for server provisioning tokens.
ReadHeadersTimeout is a default TCP timeout when we wait for the response headers to arrive.
RecentCacheTTL is a default cache TTL for recently accessed items.
RoleAuthService is authentication and authorization service, the only stateful role in the system.
RoleNode is SSH stateless node.
RoleProxy is a stateless SSH access proxy (bastion).
RotationGracePeriod is a default rotation period for graceful certificate rotations, by default to set to maximum allowed user cert duration.
RSABits is the default RSA bits for the private key.
SAMLAuthRequestTTL is TTL of internally stored auth request created by client.
path to a self-signed TLS cert file for HTTPS connection for the web proxy.
path to a self-signed TLS PRIVATE key file for HTTPS connection for the web proxy.
path to a self-signed TLS PUBLIC key file for HTTPS connection for the web proxy.
ServiceName is the default PAM policy to use if one is not passed in configuration.
ShutdownPollPeriod is a polling period for graceful shutdowns of SSH servers.
SignupTokenTTL is a default TTL for a web signup one time token.
When running in "SSH Proxy" role this port will be used to accept incoming client connections and proxy them to SSHServerListenPort of one of many SSH nodes.
When running in "SSH Proxy" role this port will be used for incoming connections from SSH nodes who wish to use "reverse tunnell" (when they run behind an environment/firewall which only allows outgoing connections).
When running in "SSH Server" mode behind a proxy, this listening port will be used to connect users to:.
This is hardcoded in the U2F library.
UploaderConcurrentUploads is a default number of concurrent.
UploaderScanPeriod is a default uploader scan period.
WaitCopyTimeout is how long Teleport will wait for a session to finish copying data from the PTY after "exit-status" has been received.
WebsocketAudit is sending a audit event over the websocket to the web client.
WebsocketClose is sent when the SSH session is over without any errors.
WebsocketRaw is sending raw terminal bytes over the websocket to the web client.
WebsocketResize is receiving a resize request.
WebsocketVersion is the version of the protocol.
WindowsOpenSSHNamedPipe is the address of the named pipe that the OpenSSH agent is on.

# Variables

AuthServersRefreshPeriod is a period for clients to refresh their their stored list of auth servers.
CACertFile is the default name of the certificate authority file to watch.
ConfigEnvar is a name of teleport's configuration environment variable.
ConfigFilePath is default path to teleport config file.
DataDir is where all mutable data is stored (user keys, recorded sessions, registered SSH servers, etc):.
ETCDPrefix is default key in ETCD clustered configurations.
FastAttempts is the initial amount of fast retry attempts before switching to slow mode.
HighResPollingPeriod is a default high resolution polling period.
KeepAliveCountMax is the number of keep-alive messages that can be sent without receiving a response from the client before the client is disconnected.
KeepAliveInterval is interval at which Teleport will send keep-alive messages to the client.
LicenseFile is the default name of the license file.
LowResPollingPeriod is a default low resolution polling period.
NewtworkBackoffDuration is a standard backoff on network requests usually is slow, e.g.
NewtworkRetryDuration is a standard retry on network requests to retry quickly, e.g.
ReportingPeriod is a period for reports in logs.
ReverseTunnelAgentHeartbeatPeriod is the period between agent heartbeat messages.
ReverseTunnelOfflineThreshold is the threshold of missed heartbeats after which we are going to declare the reverse tunnel offline.
ServerHeartbeatTTL is a period between heartbeats Median sleep time between node pings is this value / 2 + random deviation added to this time to avoid lots of simultaneous heartbeats coming to auth server.
SessionIdlePeriod is the period of inactivity after which the session will be considered idle.
SessionRefreshPeriod is how often session data is updated on the backend.
StartRoles is default roles teleport assumes when started via 'start' command.
TerminalResizePeriod is how long tsh waits before updating the size of the terminal window.