Teldrive Usage Guide

This guide will help you set up and use Teldrive. Ensure you have met all the prerequisites and have the necessary configuration values ready.

Configuration

Create a config.toml with the following content, replacing the placeholders with your actual values.

config.toml for Supabase DB

[db]
data-source = "postgres://<db username>:<db password>@<db host>/<db name>"
prepare-stmt = false

[db.pool]
enable = false

[jwt]
allowed-users = ["your-telegram-username"]
secret = "abcd"

config.toml for Local DB

[db]
data-source = "postgres://<db username>:<db password>@<db host>/<db name>"

[jwt]
allowed-users = ["your-telegram-username"]
secret = "abcd"

Values

• data-source: Connection string obtained from supabase or local db instance
• allowed-users: Make sure to add your telegram username here for restricting access to others users.

NOTE

• For local db use data-source from prerequisites guide.
• For advanced cli usage.
• For Sample config visit.

Generating a JWT Secret

For the secret field, use your generated JWT secret. You can generate one using:

• OpenSSL: openssl rand -hex 32
• Or visit: Generate Secret

Run With Docker

docker-compose.yml

services:
  teldrive:
    image: ghcr.io/tgdrive/teldrive
    restart: always
    container_name: teldrive
    networks:
     - postgres
    volumes:
      - ./config.toml:/config.toml
      - ./storage.db:/storage.db
    ports:
      - 8080:8080
networks:
  postgres:                                 
    external: true

# Remove networks block from teldrive.yml if you are using supabase
touch storage.db
docker compose up -d

• Go to http://localhost:8080 in your browser to access teldrive.

Run Without Docker

./teldrive run

• You can also create config in $HOME/.teldrive/config.toml then you can run teldrive from everywhere.
• Go to http://localhost:8080 in your browser to access teldrive.
• Sync channels from UI settings.
• Set default channel in UI settings.

NOTE

• If you are stuck on login screen you have to sync your system clock so that telegram doesn't drop all the packets.See more here.
• You can also use NTP(Network Time Protocol) to sync your system clock.To enable this in teldrive use ntp key in tg config section or pass --tg-ntp in cli.