Skip to main content

​
Requirements

  • Linux on x86_64 or aarch64 (any distribution; the binary is static) with systemd, or macOS on Intel or Apple silicon
  • root or sudo
  • curl and sha256sum (Linux) or shasum (macOS)
  • The network requirements in place: direct outbound TCP 443 to api.timbal.ai, no TLS inspection
  • An enrollment token, unused and not expired

​
Install

The script detects the OS and architecture, downloads the connector, verifies its SHA-256 checksum, and registers and starts the service. Then add your databases and file shares: Configure connections.

​
Without the install script

If you can’t pipe a script into a shell, download the binary for your platform from https://api.timbal.ai/v1/connect/releases/latest/ along with SHA256SUMS, check the hash, and run:
Binaries: timbal-connect-x86_64-linux, timbal-connect-aarch64-linux, timbal-connect-x86_64-darwin, timbal-connect-aarch64-darwin.

​
Check that it’s running

You want to see connector enrolled and connected. For a full check of the network and every configured database, run doctor with the service’s configuration:

​
Upgrade

The connector normally updates itself when Timbal pushes a new version. To upgrade by hand, re-run the install command without --token. Configuration and credentials are kept.

​
Re-enroll

If the first attempt used an expired or already-used token, or the connector was revoked in Timbal, re-run the install command with a new --token. Without --url, the server stays on the Timbal environment it is configured for. The server registers as a new connector: the token is written into the existing configuration, the previous identity is moved aside (state.json.pre-reenroll-<number>, kept as a backup) and the service restarts. Connections and other settings are kept. Revoke the old connector if it had been connected before.

​
Uninstall

Uninstalling doesn’t revoke the connector in Timbal; revoke it too if the server leaves your control: Revoke connector. Reinstalling always needs a new enrollment token.

​
Files on the server

​
Next steps

Configure connections

Databases in connections.json, file shares in config.json.

Troubleshooting

Installer messages and what to do about them.