Rclone setup

1. Install rclone from the Teldrive fork

The teldrive backend only exists in the tgdrive/rclone fork — stock rclone from your package manager or rclone.io does not include it and will fail with unknown backend "teldrive".

Download the latest release for your OS/architecture from tgdrive/rclone releases:

Debian/Ubuntu: install the .deb with sudo dpkg -i rclone-*.deb.
Other Linux/macOS/Windows: extract the .zip and place the rclone binary on your PATH.

Verify you have the fork build:

rclone version
rclone help backend teldrive

The second command must print the Teldrive backend help. If it errors, you are running stock rclone.

2. Create an API key

In Teldrive, open Settings → API keys, create a key, and copy the secret. It is shown once.

3. Configure rclone

rclone config

Choose the teldrive backend and set api_host and api_key.

Minimal config:

[teldrive]
type = teldrive
api_host = https://drive.example.com
api_key = YOUR_TELDRIVE_API_KEY

Non-interactive:

rclone config create teldrive teldrive \
  api_host=https://drive.example.com \
  api_key=YOUR_TELDRIVE_API_KEY

4. Test

rclone lsf teldrive:
rclone mkdir teldrive:/rclone-test
rclone copy ./example.txt teldrive:/rclone-test/
rclone copy teldrive:/rclone-test/example.txt ./download-test/

Revoke exposed/retired keys from Settings → API keys.

Backend options

Option	Config key	Environment variable	Default
API key	`api_key`	`RCLONE_TELDRIVE_API_KEY`	—
API server	`api_host`	`RCLONE_TELDRIVE_API_HOST`	—
Upload host	`upload_host`	`RCLONE_TELDRIVE_UPLOAD_HOST`	—
Chunk size	`chunk_size`	`RCLONE_TELDRIVE_CHUNK_SIZE`	`512Mi`
Upload concurrency	`upload_concurrency`	`RCLONE_TELDRIVE_UPLOAD_CONCURRENCY`	`4`
Teldrive encryption	`encrypt_files`	`RCLONE_TELDRIVE_ENCRYPT_FILES`	`false`
BLAKE3 hashing	`hash_enabled`	`RCLONE_TELDRIVE_HASH_ENABLED`	`true`
Page size	`page_size`	`RCLONE_TELDRIVE_PAGE_SIZE`	`200`
Public-link password	`link_password`	`RCLONE_TELDRIVE_LINK_PASSWORD`	—

Check your installed version:

rclone help backend teldrive

Trash commands

rclone backend trash-list teldrive:
rclone backend restore teldrive: FILE_ID
rclone backend purge teldrive: FILE_ID

purge is permanent.

See Mounting and performance.