.env

# PLEASE DO NOT EDIT THIS FILE; modify '.env.override' file instead
# This is in order to avoid conflict with upstream code when updating to a newer version

# ShellHub version. 
SHELLHUB_VERSION=v0.16.0

# The default log level for ShellHub.
# VALUES: https://pkg.go.dev/github.com/sirupsen/logrus#Level
SHELLHUB_LOG_LEVEL=info

# The log format for ShellHub.
# VALUES: json, text. 
SHELLHUB_LOG_FORMAT=text

# The network interface to which the gateway container will bind.
# VALUES: Any valid IP address
SHELLHUB_BIND_ADDRESS=0.0.0.0

# The HTTP port for the ShellHub web-based UI, API, and Reverse SSH tunnel.
# VALUES: Any available port on the host
SHELLHUB_HTTP_PORT=80

# The HTTPS port for the ShellHub web-based UI, API, and Reverse SSH tunnel.
# VALUES: Any available port on the host
SHELLHUB_HTTPS_PORT=443

# The SSH port for incoming SSH connections to devices.
# VALUES: Any available port on the host
SHELLHUB_SSH_PORT=22

# Set to true if using a Layer 4 load balancer with proxy protocol in front of ShellHub.
SHELLHUB_PROXY=false

# Enable automatic HTTPS with Let's Encrypt.
SHELLHUB_AUTO_SSL=false

# The domain of the server.
# NOTICE: Required only if automatic HTTPS is enabled.
# VALUES: A valid domain name
SHELLHUB_DOMAIN=localhost

# The network name used by Docker Compose to avoid port collisions when running multiple instances.
# VALUES: A valid network name
SHELLHUB_NETWORK=shellhub_network

# The public URL domain used to generate the public URL for accessing devices via HTTP.
# Values: A valid domain name
SHELLHUB_PUBLIC_URL_DOMAIN=

# Enable geolocation.
# NOTICE: When true, SHELLHUB_MAXMIND_LICENSE is required.
SHELLHUB_GEOIP=false

# GeoLite2 Maxmind license.
# NOTICE: Required only if SHELLHUB_GEOIP is enabled.
# VALUES: A valid Maxmind license key
SHELLHUB_MAXMIND_LICENSE=

# The schedule for worker tasks.
# NOTICE: Format follows Go's cron package (https://pkg.go.dev/github.com/robfig/cron).
SHELLHUB_WORKER_SCHEDULE=@daily

# Internal setting for our cloud service.
SHELLHUB_CLOUD=false

# The URL for the session recording host.
SHELLHUB_RECORD_URL=api:8080

# Enable ShellHub Enterprise features.
# NOTICE: Requires a valid ShellHub Enterprise license.
SHELLHUB_ENTERPRISE=false

# The username for the ShellHub Enterprise Admin Console.
SHELLHUB_ENTERPRISE_ADMIN_USERNAME=

# The password for the ShellHub Enterprise Admin Console.
SHELLHUB_ENTERPRISE_ADMIN_PASSWORD=

# The URL for the Go modules proxy cache (development only).
# SHELLHUB_GOPROXY=http://localhost:3333

# The URL for the NPM proxy cache (development only).
# SHELLHUB_NPM_REGISTRY=http://localhost:4873

# Enable billing features.
# NOTICE: Exclusive used by the UI.
SHELLHUB_BILLING=false

# Billing configuration
SHELLHUB_BILLING_URL=
STRIPE_PUBLISHABLE_KEY=

# The Sentry DSN for error tracking.
SHELLHUB_SENTRY_DSN=

# Enable announcements about releases, new features, critical security issues, and relevant news from ShellHub Community Team.
SHELLHUB_ANNOUNCEMENTS=false

# Show features from Cloud/Enterprise versions in the ShellHub community edition.
SHELLHUB_PAYWALL=true

# Asynq configuration
# The maximum duration to wait before processing a group of tasks.
SHELLHUB_ASYNQ_GROUP_MAX_DELAY=1

# The grace period's upper bound for Asynq task aggregation. Must be greater than "SHELLHUB_ASYNQ_GROUP_MAX_DELAY"
SHELLHUB_ASYNQ_GROUP_GRACE_PERIOD=2

# The maximum number of tasks that can be aggregated together by Asynq.
SHELLHUB_ASYNQ_GROUP_MAX_SIZE=1000

# Allow SSH connections with an agent via a public key for versions below 0.6.0.
# Values: true, false
SHELLHUB_ALLOW_PUBLIC_KEY_ACCESS_BELLOW_0_6_0=false

# The pool size for Redis cache connections.
# NOTICE: Zero means the default value of the Redis driver.
# VALUES: A non-negative integer
SHELLHUB_REDIS_CACHE_POOL_SIZE=0

# The maximum duration (in minutes) for blocking a source from login attempts.
# NOTICE: Set to 0 to disable.
# VALUES: A non-negative integer
SHELLHUB_MAXIMUM_ACCOUNT_LOCKOUT=60

# Controls if the ShellHub community will show features from Cloud/Enterprise versions.
SHELLHUB_PAYWALL=true

# Enable Connector features on UI.
SHELLHUB_CONNECTOR=true