Installer options
The command line options and environment variables of the installer, and where to check the signature of a release before you install it.
Run sh timescale-enterprise.sh --help to show the options. With curl ... | sh, put the
options after sh -s --.
Options
| Option | What it does |
|---|---|
| (none) | On a terminal, shows the menu. Without a terminal, installs or upgrades the console. |
--reconfigure |
Asks the listener questions, TSE_PUBLIC_URL and TSE_BACKUP_DIR again. |
--no-up |
Prepares the install, but does not start the console. |
--uninstall |
Removes the console or the demo. See Uninstall. |
--install-docker |
On Linux, installs or starts Docker with no question. |
--offline |
Bundle only. Does not pull the image. Also loads the server packages next to the installer. |
--offline FILE |
Installs or upgrades from an offline/airgapped package. See Airgapped install. |
--make-bundle |
Makes an offline/airgapped package. See Airgapped install. |
--console-arch amd64|arm64 |
With --make-bundle: the architecture of the console host. Needed without a terminal. |
--servers LIST |
With --make-bundle: the server packages, all or a comma-separated list. |
--packs-only |
With --make-bundle: only the server packages. |
--pack FILE... |
Loads server packages into the running console. See Load server packages. |
--dir PATH |
The install directory. Default: /opt/tse, ~/tse for a demo, the bundle directory for a bundle. |
--demo |
Installs, upgrades or starts a demo. --demo stop stops it. --demo reset makes a new demo. |
--restore FILE |
Restores the console from a console backup (.tse file). See Restore the console. |
--force |
With --restore: does not check that the console of the backup still answers. |
Use --pack alone. Use --make-bundle only with --console-arch, --servers and
--packs-only. Use --restore only with --demo, --dir, --offline, --no-up and
--force.
Environment variables
Set these to answer the questions with no terminal:
| Variable | Value |
|---|---|
TSE_INSTALL_TLS_MODE |
1 plain HTTP on 8080, 2 self-signed HTTPS, 3 your own certificate |
TSE_SITE_HOST |
The console address. Needed for 2 and 3 |
TSE_TLS_CERT, TSE_TLS_KEY |
The paths of the certificate and the key. Needed for 3 |
TSE_INSTALL_AUTH_TOKEN |
The login token. Default: a generated token |
TSE_INSTALL_PUBLIC_URL |
TSE_PUBLIC_URL. With --restore, a new URL. Default: the URL of the backup |
TSE_INSTALL_BACKUP_DIR |
TSE_BACKUP_DIR, an absolute path. Default: <install dir>/backups |
TSE_INSTALL_RESTORE_KEY_FILE |
For --restore: the path of the recovery key file |
TSE_INSTALL_DOCKER |
1: the same as --install-docker |
TSE_INSTALL_DEMO_ACCEPT |
1: accept the demo warning, and confirm --demo reset |
TSE_INSTALL_DEMO_CONVERT |
For --uninstall of a demo on Linux: 1 convert, 0 remove |
TSE_INSTALL_PACK_DOWNLOAD |
After an upgrade: 1 download the server packages of the new release, 0 do not |
TSE_INSTALL_SELF_UPDATE |
1 update the installer with no question, 0 do not check |
TSE_PACK_DOWNLOAD_TOKEN |
A pull token for the release files. The installer writes it to .env for the console |
TSE_PACK_DOWNLOAD_USER |
The login user of the pull token. Default timescale |
COMPOSE_PROJECT_NAME |
The Docker Compose project. Default timescale-enterprise |
Verify the release
To check the signature of a release, see Verify a release.