Skip to content
You're viewing documentation for v2026.11.14-beta. It may be out of date.Go to latest
TimescaleDB Enterprise
Esc
↑↓navigate↵open⌘Jpreview
On this page

Configuration

Set TLS, the console URL, the mesh range and the secrets of the console in .env, and the update check, telemetry and the console clock.

The console reads its settings from .env in the install directory.

  • To change the TLS mode, TSE_PUBLIC_URL or TSE_BACKUP_DIR, run ./timescale-enterprise.sh in the install directory and select Change the listener.
  • To apply another change to .env, run docker compose -f docker-compose.yml up -d in the install directory.

TLS modes

Set the mode with TSE_TLS_MODE:

Mode Ports on the host Result
none (default) HTTP 8080 Plain HTTP. Only for a trusted network.
self-signed HTTPS 443, 80 redirects to HTTPS The console makes a certificate. Browsers show a warning. Enrollment commands use curl -k.
provided HTTPS 443, 80 redirects to HTTPS Put the certificate and the key in ./certs. Set TSE_TLS_CERT_FILE and TSE_TLS_KEY_FILE to their paths under /certs.

All modes also publish the mesh ports: 8090 (enrollment), 41641/udp (WireGuard) and 3478/udp (STUN). A demo publishes only 8443, with self-signed HTTPS, and 8080, with plain HTTP for the Ignition Enterprise Historian.

Ignition and the self-signed certificate

The Ignition Enterprise Historian checks the certificate of the console. It does not trust the certificate of the self-signed mode until you add it to the Ignition gateway:

  1. Get the certificate of the console. On a computer that reaches the console, run:

    openssl s_client -connect console.example.com:443 -showcerts </dev/null | openssl x509 > console.pem
  2. Copy console.pem to data/certificates/supplemental/ in the install directory of the Ignition gateway.

  3. Restart the gateway.

In Ignition, use the console URL with the host of TSE_PUBLIC_URL. The certificate covers only that host, localhost and 127.0.0.1. When TSE_PUBLIC_URL gets a different host, the console makes a new certificate: do the steps again. See Security certificates in the Ignition docs.

In the provided mode, add the certificate of your certificate authority in the same way, if the gateway does not trust it already. A demo gives Ignition a plain HTTP URL instead.

Environment variable reference

Variable Default Purpose
TSE_AUTH_TOKEN (required) The admin token. A change ends all sessions.
TSE_DB_ENCRYPTION_KEY (required) 64 hex characters. Encrypts the secrets in the console database. If you lose it, the console cannot read its secrets.
TSE_TLS_MODE none See TLS modes.
TSE_TLS_CERT_FILE / TSE_TLS_KEY_FILE (empty) The certificate and the key in provided mode, for example /certs/cert.pem.
TSE_PUBLIC_URL (empty) The console URL that your servers reach, with the scheme. Required before you enroll servers. Use a DNS name. See Change IP addresses.
TSE_MESH_SUBNET 100.64.0.0/10 The range of the mesh addresses, inside 100.64.0.0/10. Set it before you enroll servers. After a change, you must enroll all servers again.
TSE_BACKUP_DIR <install dir>/backups The host directory of the local console backups, an absolute path.
TSE_PACK_DOWNLOAD_TOKEN (empty) A pull token for docker.io/timescale/enterprise-packs. Empty: the console downloads server packages with no login.
TSE_PACK_DOWNLOAD_USER (empty) The login user of TSE_PACK_DOWNLOAD_TOKEN. Empty: timescale.
RELEASE_TAG latest The tag of the console image. The installer sets it.

Update check

The console reads https://enterprise.tigerdata.com/install/latest.json 1 minute after it starts, then once a day. The request sends no data about your install.

  • When a newer release is available, the footer shows <release> is available. Click it to see the upgrade command. See Upgrade.
  • To check now, click Check for updates in the footer.
  • To turn the check off, open Help (?) → About and turn off Check for new releases. You must be an admin.

Telemetry

The console sends usage and diagnostic data to Tiger Data, to improve and support the product. When an operation fails, the data can include log lines of the failed step. An admin sets this in Administration → Telemetry.

Console clock

The servers, two-factor codes, certificates and restore times use the clock of the console host (see Time sync). The console does not set the clock: keep time sync (for example chrony) on in the console host.

Every 5 minutes, the console compares its clock with pool.ntp.org (123/udp), or else with the clocks of the enrolled servers.

  • When the offset is more than 30 seconds, the Overview tab of each service shows Console clock is off.
  • The ConsoleClockWrong alert fires after 10 minutes.
  • Administration → Time sync shows the state of the console clock and of each server.

On a site with no internet access, the console usually cannot measure the offset, and shows no warning. Sync the console host to an NTP server of your site.

Data persistence

The console data and the metrics stay after a restart and an upgrade. An uninstall deletes them, but keeps TSE_BACKUP_DIR.

After the loss of the console host, you need a console backup on an S3 target and its recovery key to restore the console.