Skip to content

.env

The .env file will be used to specify the general settings of the components used by the SeaTicket-docker instance and the environment variables required by each component.

SeaTicket Settings

The default COMPOSE_FILE is caddy.yml,seadb.yml,seaticket.yml,seasearch.yml, with COMPOSE_PATH_SEPARATOR=','. Add the optional Notification file only when enabling that feature. Internal component URLs use built-in defaults and do not need to be added to .env.

Images

All images below are pulled directly from Docker Hub.

Variable Default
SEATICKET_WEB_IMAGE seafileltd/seaticket:1.0-latest
SEATICKET_AI_IMAGE seafileltd/seaticket-ai:1.0-latest
SEATICKET_EVENTS_IMAGE seafileltd/seaticket-events:1.0-latest
SEATICKET_INDEXER_IMAGE seafileltd/seaticket-indexer:1.0-latest
SEATICKET_NOTIFICATION_IMAGE seafileltd/seaticket-notification:1.0-latest
SEADB_IMAGE seaticket/seadb:1.0-latest

Server settings

Variable Description Default Value
SEATICKET_SERVER_PROTOCOL SeaTicket server protocol (http or https) http
SEATICKET_SERVER_HOSTNAME SeaTicket server hostname or domain (required)
JWT_PRIVATE_KEY JWT_PRIVATE_KEY, A random string with a length of no less than 32 characters is required for SeaTicket, which can be generated by using pwgen -s 40 1 (required)

SeaDB settings

Variable Description Default Value
SEADB_SERVER_URL SeaDB server URL. http://seadb:8888
INIT_SEADB_ROOT_PASSWORD Optional separate SeaDB root password. Used only to initialize SeaDB and create its application account. If empty, Compose uses the MySQL initialization root password. INIT_SEATICKET_MYSQL_ROOT_PASSWORD
SEADB_USERNAME Optional separate SeaDB API username. If empty, Compose uses the MySQL application username. MYSQL_DB_USER (seaticket if unset)
SEADB_PASSWORD Optional separate SeaDB API password. If empty, Compose uses the MySQL application password. MYSQL_DB_PASSWORD

By default, SeaDB reuses the MySQL root password for initialization and the MySQL application username/password for API access. Leave all three SeaDB credential variables empty for a standard deployment. Set any of them to use separate credentials; each variable falls back independently.

SeaTicket components authenticate to SeaDB with HTTP Basic authentication. Compose maps the resolved username to SEADB_USER inside the containers. On first deployment, SeaDB runs sea-db init to create root; seaticket then uses that root account to register the non-root application account with default_role. JWT_PRIVATE_KEY configures the SeaDB service itself and is not a SeaDB API access token.

After successful initialization, remove both INIT_SEADB_ROOT_PASSWORD and INIT_SEATICKET_MYSQL_ROOT_PASSWORD from .env and recreate the containers with docker compose up -d. Keep MySQL application credentials and any separate SeaDB application credentials available on every startup. See Start SeaTicket for deployment and initialization steps.

SeaSearch Settings

The standard template preconfigures an internal SeaSearch account and matching token, independently of the first SeaTicket team administrator. No changes are required for a standard deployment.

Variable Description Template default
SEASEARCH_URL SeaSearch API endpoint reachable from SeaTicket services. http://seasearch:4080
INIT_SS_ADMIN_USER Initial SeaSearch administrator username. seaticket
INIT_SS_ADMIN_PASSWORD Initial SeaSearch administrator password. Pre-generated random password in .env
SEASEARCH_TOKEN Base64 value of the actual SeaSearch username:password. Must match the configured account. Preconfigured to match the template account

The template credentials are public and intended only for SeaSearch without published ports. Initialization variables do not update an existing SeaSearch account. See SeaSearch for custom credentials, token generation, and existing-deployment guidance.

Mysql Settings

Variable Description Default Value
MYSQL_DB_HOST The host of MySQL server. Use db for the bundled MariaDB service. db
MYSQL_DB_PORT The port of MySQL server 3306
MYSQL_DB_USER The user for accessing MySQL server seaticket
MYSQL_DB_PASSWORD The password of MySQL server (none)
MYSQL_DB_NAME The SeaTicket database name seaticket_db
INIT_SEATICKET_MYSQL_ROOT_PASSWORD Root password for MySQL/MariaDB, bundled or external. Required for the first automatic database, user, and schema initialization. May be removed after successful deployment; subsequent startups use the application account and persistent initialization state. (none)
INIT_SEATICKET_TEAM_NAME Name of the first SeaTicket team. Used only when no team exists. SeaTicket
INIT_SEATICKET_TEAM_ADMIN_EMAIL Email address of the first team administrator. Used only when no team exists. (none)
INIT_SEATICKET_TEAM_ADMIN_PASSWORD Password of the first team administrator. Used only when no team exists. (none)

Redis Settings

Variable Description Default Value
REDIS_HOST The host of Redis server (required)
REDIS_PORT The port of Redis server 6379
REDIS_PASSWORD The password of Redis server (none)

Notification Settings

Variable Description Default Value
ENABLE_NOTIFICATION_SERVER Enable the WebSocket notification client in seaticket; also add seaticket-notification.yml to COMPOSE_FILE. false

Storage Settings

The Docker deployment defaults to local disk for both attachments and SeaSearch. No S3 service is required with these defaults.

Variable Description Default Value
ATTACHMENT_STORAGE_BACKEND Attachment backend used by the web service, IO service, and indexer. Available values: disk, s3. disk
SS_STORAGE_TYPE Optional SeaSearch backend override (disk or s3). Unset or empty values fall back to ATTACHMENT_STORAGE_BACKEND, then disk. Follows ATTACHMENT_STORAGE_BACKEND
SEATICKET_VOLUME Host directory for SeaTicket configuration, logs, and persistent application data. /opt/seaticket/seaticket-data
SS_DATA_PATH Host directory for persistent SeaSearch data. /opt/seasearch-data

Local attachment storage

With ATTACHMENT_STORAGE_BACKEND=disk, attachments are saved under ${SEATICKET_VOLUME}/data/attachments on the host (/opt/seaticket/seaticket-data/data/attachments by default), in project_attachments and connection_attachments subdirectories. Back up this directory along with the other persistent application data.

The web and indexer images fix the internal root at /opt/seaticket/data/attachments, with /opt/seaticket/data linked to /shared/data. Do not configure ATTACHMENT_STORAGE_LOCAL_ROOT in .env or seaticket_config.yaml.

Changing storage backends

Changing ATTACHMENT_STORAGE_BACKEND or SS_STORAGE_TYPE does not automatically move data between backends.

Optional S3 Settings

Leave these values empty for a default disk deployment. Configure them only when attachments or SeaSearch use s3. See S3 Storage for configuration examples.

Variable Description Required when / Default Value
S3_HOST S3-compatible endpoint, e.g., https://s3-endpoint.example.com or https://s3.<region>.amazonaws.com. Attachments or SeaSearch use S3
S3_KEY_ID S3 access key ID. Attachments or SeaSearch use S3
S3_SECRET_KEY S3 secret access key. Attachments or SeaSearch use S3
S3_FILE_BUCKET Bucket for uploaded files. ATTACHMENT_STORAGE_BACKEND=s3
S3_WEB_CRAWL_BUCKET Bucket for connection assets, such as email attachments. ATTACHMENT_STORAGE_BACKEND=s3
S3_SEASEARCH_BUCKET Bucket for SeaSearch data. Mapped to S3_SS_BUCKET unless explicitly overridden by that variable. Resolved SS_STORAGE_TYPE=s3
S3_AWS_REGION AWS region for SeaSearch S3 requests. us-east-1
S3_USE_V4_SIGNATURE Use Signature Version 4 for SeaSearch S3 requests. true
S3_PATH_STYLE_REQUEST Use path-style S3 requests in SeaSearch. true
S3_SSE_C_KEY Optional SeaSearch SSE-C encryption key. Requires HTTPS and Signature Version 4. Empty

The four advanced options above configure SeaSearch. The attachment backend uses Signature Version 4 and path-style requests directly and does not read these options. Create the buckets required by the selected backends and grant the configured credentials read and write access.

First Team Settings

On a new deployment, SeaTicket automatically creates the first team, its team administrator, and the administrator's initial workspace. This account is a normal SeaTicket user and team administrator, not a system administrator. Existing teams are never changed when the container restarts.

Advanced system systems

Variable Description Default Value
SEATICKET_CONFIG_NAME YAML configuration filename under CONF_PATH, shared by all SeaTicket services seaticket_config.yaml
SEATICKET_LOG_TO_STDOUT Record logs to container standard output false
TIME_ZONE Timezone of SeaTicket server UTC