Teldrive

https://teldrive-docs.pages.dev/docs
Admin
Teldrive is a powerful utility that enables you to organize your Telegram files and unlock their...
Tokens:11,916
Snippets:167
Trust Score:7.2
Update:5 months ago
Show doc for...
Tokens:
Raw
### Docker Setup and Service Start

Source: https://teldrive-docs.pages.dev/docs/guides/caddy-cloudflare

Initializes necessary files and Docker resources, then starts the Teldrive, imgproxy, and Caddy services using Docker Compose. Ensure to replace `yourdomain.com` with your actual domain.

```shell
touch storage.db
docker network create caddy
docker volume create caddy_data
docker compose -f teldrive.yml up -d
docker compose -f imgproxy.yml up -d
docker compose -f caddy.yml up -d
```

--------------------------------

### GET /auth/ws API Request Example

Source: https://teldrive-docs.pages.dev/docs/api

Example of how to initiate a WebSocket connection for QR login. This endpoint is used for establishing a secure, real-time connection.

```shell
curl 'https://teldrive-docs.pages.dev/{url}/api/auth/ws'
```

--------------------------------

### Install Docker

Source: https://teldrive-docs.pages.dev/docs/guides/caddy-cloudflare

Installs Docker on your server. Verify the installation by checking the Docker and Docker Compose versions.

```shell
curl https://get.docker.com | sh
```

```shell
docker --version
docker compose --version
```

--------------------------------

### Start imgproxy Docker Service

Source: https://teldrive-docs.pages.dev/docs/getting-started/advanced

Start the imgproxy service using Docker Compose.

```sh
docker compose up -d

```

--------------------------------

### Initialize and Start Teldrive Services

Source: https://teldrive-docs.pages.dev/docs/guides/nginx-setup

Creates the SQLite storage file if it doesn't exist and then starts the Teldrive and imgproxy services defined in the docker-compose.yml file.

```bash
touch storage.db  # Create the SQLite database file if it doesn't exist
docker compose up -d

```

--------------------------------

### GET /auth/session API Request Example

Source: https://teldrive-docs.pages.dev/docs/api

Example of how to retrieve the current user's session information using a GET request to the session endpoint. The access token is expected as a cookie.

```shell
curl 'https://teldrive-docs.pages.dev/{url}/api/auth/session'
```

--------------------------------

### Install Docker

Source: https://teldrive-docs.pages.dev/docs/getting-started/prerequisites

Installs Docker using the official script. Run this command on Linux and macOS.

```sh
curl https://get.docker.com | sh
```

--------------------------------

### Start Nginx Proxy Containers

Source: https://teldrive-docs.pages.dev/docs/guides/nginx-setup

Starts the Nginx Proxy and Let's Encrypt companion containers in detached mode using the 'proxy.yml' file.

```bash
docker compose -f proxy.yml up -d

```

--------------------------------

### Install Rclone on Windows

Source: https://teldrive-docs.pages.dev/docs/guides/rclone

Execute this PowerShell command to install the rclone integration on Windows systems.

```powershell
powershell -c "irm https://instl.vercel.app/rclone?platform=windows|iex"
```

--------------------------------

### Install Teldrive on Windows

Source: https://teldrive-docs.pages.dev/docs/getting-started/installation

Use this PowerShell command to install Teldrive on Windows systems.

```powershell
powershell -c "irm https://instl.vercel.app/teldrive?platform=windows|iex"
```

--------------------------------

### Verify Docker Installation

Source: https://teldrive-docs.pages.dev/docs/getting-started/prerequisites

Checks if Docker and Docker Compose are installed correctly by displaying their versions.

```sh
docker --version
docker compose --version
```

--------------------------------

### POST /auth/login API Request Example

Source: https://teldrive-docs.pages.dev/docs/api

Example of how to authenticate a user and obtain session information using a POST request to the login endpoint. Ensure all required fields in the JSON body are correctly populated.

```shell
curl 'https://teldrive-docs.pages.dev/{url}/api/auth/login' \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "John Doe",
  "userName": "johndoe",
  "userId": 123456789,
  "isPremium": true,
  "hash": "a1b2c3d4e5f6g7h8i9j0",
  "expires": "",
  "session": ""
}'
```

--------------------------------

### Verify Teldrive Installation

Source: https://teldrive-docs.pages.dev/docs/getting-started/installation

Run this command after installation to confirm Teldrive is set up correctly and display its version.

```sh
teldrive version
```

--------------------------------

### Install Rclone on macOS/Linux

Source: https://teldrive-docs.pages.dev/docs/guides/rclone

Use this command to install the rclone integration on macOS and Linux systems.

```sh
curl -sSL instl.vercel.app/rclone | bash
```

--------------------------------

### Install Teldrive on macOS/Linux

Source: https://teldrive-docs.pages.dev/docs/getting-started/installation

Use this command to install Teldrive on macOS or Linux systems using curl.

```sh
curl -sSL instl.vercel.app/teldrive | bash
```

--------------------------------

### POST /auth/logout API Request Example

Source: https://teldrive-docs.pages.dev/docs/api

Example of how to log out a user by sending a POST request to the logout endpoint. Requires an Authorization header with a Bearer token.

```shell
curl 'https://teldrive-docs.pages.dev/{url}/api/auth/logout' \
  --request POST \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
```

--------------------------------

### Install Docker Volume Plugin for Teldrive

Source: https://teldrive-docs.pages.dev/docs/guides/jellyfin

Installs the rclone Docker volume plugin to enable mounting Teldrive storage. Ensure Teldrive is set up first. Adjust cache and config paths if using a different architecture.

```bash
docker plugin install ghcr.io/tgdrive/docker-volume-rclone --alias rclone --grant-all-permissions args="--allow-other" config=/etc/rclone cache=/var/cache
```

--------------------------------

### Start Teldrive with Docker Compose

Source: https://teldrive-docs.pages.dev/docs/getting-started/usage

Start the Teldrive service in detached mode using Docker Compose. Ensure to remove the networks block if using Supabase and create an empty storage.db file.

```sh
# Remove networks block from docker-compose.yml if using Supabase
touch storage.db
docker compose up -d
```

--------------------------------

### Launch Local PostgreSQL Database

Source: https://teldrive-docs.pages.dev/docs/getting-started/prerequisites

Creates necessary Docker network and volume, then starts the PostgreSQL container in detached mode.

```sh
docker network create postgres
docker volume create postgres_data
docker compose up -d
```

--------------------------------

### Get Files

Source: https://teldrive-docs.pages.dev/docs/api

Retrieves a list of files.

```APIDOC
## GET /files

### Description
Retrieves a list of files.

### Method
GET

### Endpoint
/files
```

--------------------------------

### Example Teldrive Rclone Configuration

Source: https://teldrive-docs.pages.dev/docs/guides/rclone

Configure your rclone settings for Teldrive by adding this section to your rclone.conf file. Ensure you replace 'your_session_token_here' with your actual Teldrive access token.

```toml
[teldrive]
type = "teldrive"
api_host = "http://localhost:8080"
access_token = "your_session_token_here"
chunk_size = "500M"
upload_concurrency = 4
encrypt_files = false
random_chunk_name = true

```

--------------------------------

### Get Version

Source: https://teldrive-docs.pages.dev/docs/api

Retrieves the API version.

```APIDOC
## GET /version

### Description
Retrieves the API version.

### Method
GET

### Endpoint
/version
```

--------------------------------

### Get User Config

Source: https://teldrive-docs.pages.dev/docs/api

Retrieves user configuration settings.

```APIDOC
## GET /users/config

### Description
Retrieves user configuration settings.

### Method
GET

### Endpoint
/users/config
```

--------------------------------

### Get User Channels

Source: https://teldrive-docs.pages.dev/docs/api

Retrieves a list of user channels.

```APIDOC
## GET /users/channels

### Description
Retrieves a list of user channels.

### Method
GET

### Endpoint
/users/channels
```

--------------------------------

### Get File Categories

Source: https://teldrive-docs.pages.dev/docs/api

Retrieves categories for files.

```APIDOC
## GET /files/categories

### Description
Retrieves categories for files.

### Method
GET

### Endpoint
/files/categories
```

--------------------------------

### Local Database Configuration

Source: https://teldrive-docs.pages.dev/docs/getting-started/usage

Configure Teldrive for a local database connection. This setup includes JWT and file encryption settings.

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

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

[tg.uploads]
encryption-key = "your-encryption-key"
```

--------------------------------

### Container Management Script for Rclone Volumes

Source: https://teldrive-docs.pages.dev/docs/guides/jellyfin

A startup script for crontab to manage containers dependent on rclone volumes. It ensures dependent containers are running before starting Jellyfin. Do not use restart policies with rclone volumes.

```bash
#!/bin/bash
set -e

is_container_running() {
  local container_name=$1
  docker inspect -f '{{.State.Running}}' $container_name 2>/dev/null || echo "false"
}

POLL_INTERVAL=2

CONTAINERS=("teldrive")

for container in "${CONTAINERS[@]}"; do
  while [ "$(is_container_running $container)" != "true" ]; do
    echo "Waiting for container $container to be running..."
    sleep $POLL_INTERVAL
  done
  echo "Container $container is running."
done

VOLUME_NAME="rclone"

VOLUME_EXISTS=$(docker volume inspect $VOLUME_NAME > /dev/null 2>&1 && echo "yes" || echo "no")

# Create the volume if it does not exist
if [ "$VOLUME_EXISTS" == "no" ]; then
  echo "Volume $VOLUME_NAME does not exist. Creating volume..."
  docker volume create \
    --driver rclone \
    --opt remote="teldrive_remote_name:" \
    --opt vfs_cache_max_age=7720h \
    --opt vfs_read_chunk_streams=2 \
    --opt vfs_read_chunk_size=64M \
    --opt vfs_cache_max_size=300G \
    $VOLUME_NAME
  echo "Volume $VOLUME_NAME created successfully."
else
  echo "Volume $VOLUME_NAME already exists. Skipping creation."
fi

# Add other services here which depend on rclone volume
cd /path/to/jellyfin/compose && docker compose up -d
```

--------------------------------

### Get Events

Source: https://teldrive-docs.pages.dev/docs/api

Retrieves a list of events.

```APIDOC
## GET /events

### Description
Retrieves a list of events.

### Method
GET

### Endpoint
/events
```

--------------------------------

### Get File by ID and Name

Source: https://teldrive-docs.pages.dev/docs/api

Retrieves a specific file by its ID and name.

```APIDOC
## GET /files/{id}/{name}

### Description
Retrieves a specific file by its ID and name.

### Method
GET

### Endpoint
/files/{id}/{name}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the file.
- **name** (string) - Required - The name of the file.
```

--------------------------------

### Get User Sessions

Source: https://teldrive-docs.pages.dev/docs/api

Retrieves a list of user sessions.

```APIDOC
## GET /users/sessions

### Description
Retrieves a list of user sessions.

### Method
GET

### Endpoint
/users/sessions
```

--------------------------------

### Get Uploads Stats

Source: https://teldrive-docs.pages.dev/docs/api

Retrieves statistics for uploads.

```APIDOC
## GET /uploads/stats

### Description
Retrieves statistics for uploads.

### Method
GET

### Endpoint
/uploads/stats
```

--------------------------------

### Send POST Request using cURL

Source: https://teldrive-docs.pages.dev/docs/api

Example of how to send a POST request to the /auth/login endpoint using cURL. This includes setting the Content-Type header to application/json.

```shell
curl --request POST \
  --url '{url}/api/auth/login' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "John Doe", "userName": "johndoe", "userId": 123456789, "isPremium": true, "hash": "a1b2c3d4e5f6g7h8i9j0", "expires": "", "session": ""}'
```

--------------------------------

### Get File by ID

Source: https://teldrive-docs.pages.dev/docs/api

Retrieves a specific file by its ID.

```APIDOC
## GET /files/{id}

### Description
Retrieves a specific file by its ID.

### Method
GET

### Endpoint
/files/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the file to retrieve.
```

--------------------------------

### Get Events Stream

Source: https://teldrive-docs.pages.dev/docs/api

Retrieves a stream of events.

```APIDOC
## GET /events/stream

### Description
Retrieves a stream of events.

### Method
GET

### Endpoint
/events/stream
```

--------------------------------

### Get Upload by ID

Source: https://teldrive-docs.pages.dev/docs/api

Retrieves information about a specific upload.

```APIDOC
## GET /uploads/{id}

### Description
Retrieves information about a specific upload.

### Method
GET

### Endpoint
/uploads/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the upload.
```

--------------------------------

### Get Share by ID

Source: https://teldrive-docs.pages.dev/docs/api

Retrieves information about a specific share.

```APIDOC
## GET /shares/{id}

### Description
Retrieves information about a specific share.

### Method
GET

### Endpoint
/shares/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the share to retrieve.
```

--------------------------------

### Get User Profile by Name

Source: https://teldrive-docs.pages.dev/docs/api

Retrieves a user's profile by their name.

```APIDOC
## GET /users/profile/{name}

### Description
Retrieves a user's profile by their name.

### Method
GET

### Endpoint
/users/profile/{name}

### Parameters
#### Path Parameters
- **name** (string) - Required - The name of the user whose profile to retrieve.
```

--------------------------------

### Get File Share by ID

Source: https://teldrive-docs.pages.dev/docs/api

Retrieves the share information for a specific file.

```APIDOC
## GET /files/{id}/share

### Description
Retrieves the share information for a specific file.

### Method
GET

### Endpoint
/files/{id}/share

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the file to get share information for.
```

--------------------------------

### Get Share File by ID, File ID, and Name

Source: https://teldrive-docs.pages.dev/docs/api

Retrieves a specific file within a share.

```APIDOC
## GET /shares/{id}/files/{fileId}/{name}

### Description
Retrieves a specific file within a share.

### Method
GET

### Endpoint
/shares/{id}/files/{fileId}/{name}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the share.
- **fileId** (string) - Required - The ID of the file.
- **name** (string) - Required - The name of the file.
```

--------------------------------

### Get Session Information

Source: https://teldrive-docs.pages.dev/docs/api

Retrieves the current user's session information.

```APIDOC
## GET /auth/session

### Description
Retrieves the current user's session information, including user details and session expiry.

### Method
GET

### Endpoint
/auth/session

### Parameters
#### Cookies
- **access_token** (string) - Required - The access token for session validation.

### Response
#### Success Response (200)
The request has succeeded. Returns user session details.
```json
{
  "name": "John Doe",
  "userName": "johndoe",
  "userId": 123456789,
  "isPremium": true,
  "hash": "a1b2c3d4e5f6g7h8i9j0",
  "expires": "2026-05-19T01:10:59.732Z"
}
```

#### Success Response (204)
There is no content to send for this request, but the headers may be useful.

#### Default Response
An unexpected error response.
```json
{
  "code": 500,
  "message": "Internal server error occurred"
}
```
```

--------------------------------

### Get Share Files by ID

Source: https://teldrive-docs.pages.dev/docs/api

Retrieves files associated with a specific share.

```APIDOC
## GET /shares/{id}/files

### Description
Retrieves files associated with a specific share.

### Method
GET

### Endpoint
/shares/{id}/files

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the share.
```

--------------------------------

### Set Up Termux Storage

Source: https://teldrive-docs.pages.dev/docs/guides/teldrive-on-android

Run this command in Termux after the first launch to allow storage access.

```bash
termux-setup-storage
```

--------------------------------

### Create Teldrive Configuration File

Source: https://teldrive-docs.pages.dev/docs/guides/teldrive-on-android

Use nano to create and open the config.toml file for Teldrive configuration. If the file doesn't exist, nano will create it.

```bash
nano config.toml
```

--------------------------------

### Create Nginx Configuration Directories

Source: https://teldrive-docs.pages.dev/docs/guides/nginx-setup

Creates the necessary directories for Nginx certificates, virtual host configurations, HTML content, and custom configurations.

```bash
mkdir -p nginx/certs nginx/vhost.d nginx/html nginx/conf.d nginx/acme

```

--------------------------------

### Configure imgproxy for Thumbnail Resizing

Source: https://teldrive-docs.pages.dev/docs/getting-started/advanced

Set up imgproxy as a Docker service for on-the-fly image resizing for thumbnail viewing. Deploy imgproxy behind a CDN for better performance and enter the URL in Teldrive UI settings.

```yaml
services:
  imgproxy:
    image: darthsim/imgproxy
    container_name: imgproxy
    environment:
      IMGPROXY_ALLOW_ORIGIN: "*"
      IMGPROXY_ENFORCE_WEBP: true
      IMGPROXY_MALLOC: "jemalloc"
    restart: always
    ports:
      - 8000:8080

```

--------------------------------

### Use a Custom Configuration File

Source: https://teldrive-docs.pages.dev/docs/cli/check

Provide a custom configuration file path using the `-c` or `--config` flag when running the check command. This allows you to use settings different from the default.

```bash
teldrive check -c /path/to/config.toml
```

--------------------------------

### Teldrive and Imgproxy Docker Compose Configuration

Source: https://teldrive-docs.pages.dev/docs/guides/nginx-setup

Defines services for Teldrive and imgproxy. Replace 'teldrive.yourdomain.com' and 'img.yourdomain.com' with your actual domain names.

```yaml
version: '3' 

services:
  teldrive:
    image: ghcr.io/tgdrive/teldrive
    container_name: teldrive
    restart: always
    volumes:
      - ./config.toml:/config.toml
      - ./storage.db:/storage.db
    environment:
      - VIRTUAL_HOST=teldrive.yourdomain.com
      - VIRTUAL_PORT=8080
      - LETSENCRYPT_HOST=teldrive.yourdomain.com
    networks:
      - nginx-proxy
      - postgres

  imgproxy:
    image: darthsim/imgproxy
    container_name: imgproxy
    restart: always
    environment:
      - IMGPROXY_ALLOW_ORIGIN=*
      - IMGPROXY_ENFORCE_WEBP=true
      - IMGPROXY_MALLOC=jemalloc
      - VIRTUAL_HOST=img.yourdomain.com
      - VIRTUAL_PORT=8080
      - LETSENCRYPT_HOST=img.yourdomain.com
    networks:
      - nginx-proxy

networks:
  nginx-proxy:
    external: true
  postgres:
    external: true

```

--------------------------------

### Post Files Mkdir

Source: https://teldrive-docs.pages.dev/docs/api

Creates a new directory.

```APIDOC
## POST /files/mkdir

### Description
Creates a new directory.

### Method
POST

### Endpoint
/files/mkdir
```

--------------------------------

### Check and Clean Up Storage

Source: https://teldrive-docs.pages.dev/docs/cli/check

Use the `--clean` flag to not only identify but also remove any detected missing or orphaned file parts from your storage. This helps optimize storage space.

```bash
teldrive check --clean
```

--------------------------------

### Configure Rclone Backup Service

Source: https://teldrive-docs.pages.dev/docs/guides/db-backup

Set up the Rclone backup service using Docker Compose. Customize environment variables for remote storage, retention, schedule, compression, and database connection.

```yml
services:
  rclone-backup:
    image: ghcr.io/tgdrive/rclone-backup:17 # for postgres 16 use tag 16
    container_name: rclone-backup
    environment:
      - RCLONE_REMOTE_NAME=remote
      - BACKUP_KEEP_DAYS=10
      - CRON=0 0 * * * # backup frequency (every 24 hours in this example)
      - ZIP_ENABLE=true # enable backup compression
      - PG_CONNECTION_STRING=postgres://user:pass@postgres/postgres # database string
      - ZIP_PASSWORD=zippass # password to protect backup archives
    restart: always
    networks:
     - postgres
    volumes:
      - /path/to/rclone/configdir/:/config/rclone # mount your rclone config directory

networks:
  postgres:
    external: true

```

--------------------------------

### Configure WebSocket Support for Teldrive

Source: https://teldrive-docs.pages.dev/docs/guides/nginx-setup

Creates a custom Nginx configuration file for Teldrive to enable WebSocket support, including headers for upgrade and connection, and sets a long read timeout.

```bash
cat > nginx/vhost.d/teldrive.yourdomain.com << 'EOL'
location / {
    proxy_set_header Upgrade $http_upgrade;
    proxy_set_header Connection "upgrade";
    proxy_read_timeout 86400;
    client_max_body_size 2000M;
}
EOL

```

--------------------------------

### Post User Bots

Source: https://teldrive-docs.pages.dev/docs/api

Creates a new user bot.

```APIDOC
## POST /users/bots

### Description
Creates a new user bot.

### Method
POST

### Endpoint
/users/bots
```

--------------------------------

### Configure Jellyfin with Teldrive Storage via Docker Compose

Source: https://teldrive-docs.pages.dev/docs/guides/jellyfin

Sets up Jellyfin to use Teldrive storage by defining a Docker Compose file. The 'rclone' volume, created by the plugin, is mounted to '/media'. Similar configurations apply to Plex and Emby.

```yml
services:
  jellyfin:
    image: jellyfin/jellyfin
    container_name: jellyfin
    volumes:
      - /path/to/config:/config
      - /path/to/cache:/cache
      - rclone:/media

volumes:
  rclone:
    external: true
```

--------------------------------

### Nginx Proxy and Let's Encrypt Docker Compose Configuration

Source: https://teldrive-docs.pages.dev/docs/guides/nginx-setup

Defines services for Nginx Proxy and its Let's Encrypt companion. Ensure to replace 'your-email@example.com' with your actual email address.

```yaml
version: '3' 

services:
  nginx-proxy:
    image: nginxproxy/nginx-proxy
    container_name: nginx-proxy
    restart: always
    ports:
      - "80:80"
      - "443:443"
    volumes:
      - /var/run/docker.sock:/tmp/docker.sock:ro
      - ./nginx/certs:/etc/nginx/certs
      - ./nginx/vhost.d:/etc/nginx/vhost.d
      - ./nginx/html:/usr/share/nginx/html
      - ./nginx/conf.d:/etc/nginx/conf.d
    networks:
      - nginx-proxy
    labels:
      - "com.github.jrcs.letsencrypt_nginx_proxy_companion.nginx_proxy=true"

  letsencrypt:
    image: nginxproxy/acme-companion
    container_name: nginx-proxy-letsencrypt
    restart: always
    volumes:
      - /var/run/docker.sock:/var/run/docker.sock:ro
      - ./nginx/certs:/etc/nginx/certs
      - ./nginx/vhost.d:/etc/nginx/vhost.d
      - ./nginx/html:/usr/share/nginx/html
      - ./nginx/acme:/etc/acme.sh
    environment:
      - DEFAULT_EMAIL=your-email@example.com
    depends_on:
      - nginx-proxy
    networks:
      - nginx-proxy

networks:
  nginx-proxy:
    external: true

```

--------------------------------

### Run Teldrive Directly

Source: https://teldrive-docs.pages.dev/docs/getting-started/usage

Execute the Teldrive application directly from the command line. The configuration can be placed in `$HOME/.teldrive/config.toml` for global access.

```sh
./teldrive run
```

--------------------------------

### Post User Channels

Source: https://teldrive-docs.pages.dev/docs/api

Creates a new user channel.

```APIDOC
## POST /users/channels

### Description
Creates a new user channel.

### Method
POST

### Endpoint
/users/channels
```

--------------------------------

### Create Docker Network

Source: https://teldrive-docs.pages.dev/docs/guides/nginx-setup

Creates a shared Docker network named 'nginx-proxy' for Nginx and Let's Encrypt containers.

```bash
docker network create nginx-proxy
```

--------------------------------

### Login

Source: https://teldrive-docs.pages.dev/docs/api

Authenticates a user and returns session information.

```APIDOC
## POST /auth/login

### Description
Authenticates a user and returns session information including user details, premium status, and session expiry.

### Method
POST

### Endpoint
/auth/login

### Parameters
#### Request Body
- **name** (string) - Required - User's display name or full name.
- **userName** (string) - Required - Telegram username without the @ symbol.
- **userId** (integer) - Required - Telegram user ID (unique identifier).
- **isPremium** (boolean) - Required - Premium subscription status.
- **hash** (string) - Required - Session hash for verification and security.
- **expires** (string) - Required - Session expiration date (format: date-time).
- **session** (string) - Optional - Session token for client identification.

### Request Example
```json
{
  "name": "John Doe",
  "userName": "johndoe",
  "userId": 123456789,
  "isPremium": true,
  "hash": "a1b2c3d4e5f6g7h8i9j0",
  "expires": "",
  "session": ""
}
```

### Response
#### Success Response (204)
There is no content to send for this request, but the headers may be useful.

#### Default Response
An unexpected error response.
```json
{
  "code": 500,
  "message": "Internal server error occurred"
}
```
```

--------------------------------

### Caddy Docker Compose Configuration

Source: https://teldrive-docs.pages.dev/docs/guides/caddy-cloudflare

Sets up the Caddy reverse proxy service using Docker Compose. It maps ports, defines network connections, and mounts the Caddyfile and data volume.

```yaml
services:
 caddy:
    image: teldrive/caddy
    container_name: caddy
    ports:
     - "80:80"
     - "443:443"
     - "443:443/udp"
    networks:
      - caddy
    restart: always
    volumes:
      - ./Caddyfile:/etc/caddy/Caddyfile
      - caddy_data:/data

networks:
  caddy:
    external: true

volumes:
  caddy_data:
    external: true
```

--------------------------------

### Supabase Database Configuration

Source: https://teldrive-docs.pages.dev/docs/getting-started/usage

Configure Teldrive to connect to a Supabase database. Ensure `prepare-stmt` is set to `false` and the connection pool is disabled.

```toml
[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 = "your-jwt-secret-key"

[tg.uploads]
encryption-key = "your-encryption-key"
```

--------------------------------

### Update Proxy and Teldrive Containers

Source: https://teldrive-docs.pages.dev/docs/guides/nginx-setup

Pulls the latest images for the proxy containers and Teldrive, then restarts them to apply updates.

```bash
# Update proxy containers
docker compose -f proxy.yml pull
docker compose -f proxy.yml up -d

# Update Teldrive containers
docker compose pull
docker compose up -d

```

--------------------------------

### Configure Multi-Threaded Streams for Teldrive

Source: https://teldrive-docs.pages.dev/docs/getting-started/advanced

Enable multi-threaded options to improve streaming performance, especially if you experience buffering issues. Keep `multi-threads` at 8 or lower to prevent excessive CPU usage.

```toml
[tg.stream]
multi-threads = 6
stream-buffers = 20

```

--------------------------------

### Websocket QR Login

Source: https://teldrive-docs.pages.dev/docs/api

Initiates a QR code login process via WebSocket.

```APIDOC
## GET /auth/ws

### Description
Initiates a QR code login process using WebSockets.

### Method
GET

### Endpoint
/auth/ws

### Response
#### Success Response (101)
Informational response indicating a protocol switch.

#### Default Response
An unexpected error response.
```json
{
  "code": 500,
  "message": "Internal server error occurred"
}
```
```

--------------------------------

### Caddyfile for Teldrive and Imgproxy

Source: https://teldrive-docs.pages.dev/docs/guides/caddy-cloudflare

Defines Caddy reverse proxy configurations for Teldrive and imgproxy. It sets up internal TLS and forwards requests to the respective services.

```caddyfile
teldrive.yourdomain.com {
    tls internal
    reverse_proxy teldrive:8080
}

imgproxy.yourdomain.com {
    tls internal
    reverse_proxy imgproxy:8080
}
```

--------------------------------

### Restore PostgreSQL Database within Docker

Source: https://teldrive-docs.pages.dev/docs/guides/db-backup

Copy a backup file into a PostgreSQL Docker container and then restore the database using `pg_restore`.

```bash
# Copy the backup file into the container
docker cp backup_file.dump postgres_container:/tmp/

docker exec -it postgres_container pg_restore --dbname="your_postgres_url" --create --no-owner --disable-triggers /tmp/backup_file.dump

```

--------------------------------

### Update and Upgrade Termux Packages

Source: https://teldrive-docs.pages.dev/docs/guides/teldrive-on-android

Execute this command to ensure Termux and its packages are up-to-date.

```bash
pkg update && pkg upgrade
```

--------------------------------

### Restore PostgreSQL Database

Source: https://teldrive-docs.pages.dev/docs/guides/db-backup

Restore a PostgreSQL database from a backup file using `pg_restore`. Ensure the database connection string is correct.

```bash
pg_restore --dbname="your_postgres_url" --create --no-owner --disable-triggers backup_file.dump

```

--------------------------------

### Login Endpoint

Source: https://teldrive-docs.pages.dev/docs/api

Authenticates a user and returns session information.

```APIDOC
## POST /auth/login

### Description
Sends a POST request to the login endpoint to authenticate a user.

### Method
POST

### Endpoint
/auth/login

### Request Body
- **name** (string) - Required - The user's full name.
- **userName** (string) - Required - The user's unique username.
- **userId** (integer) - Required - The user's unique ID.
- **isPremium** (boolean) - Required - Indicates if the user has a premium subscription.
- **hash** (string) - Required - A security hash for the session.
- **expires** (string) - Optional - The expiration date/time of the session.
- **session** (string) - Optional - The session token.

### Request Example
```json
{
  "name": "John Doe",
  "userName": "johndoe",
  "userId": 123456789,
  "isPremium": true,
  "hash": "a1b2c3d4e5f6g7h8i9j0",
  "expires": "",
  "session": ""
}
```

### Response
#### Success Response (200)
- **field1** (type) - Description
```

--------------------------------

### Configure Multi-Threaded Streams for Rclone

Source: https://teldrive-docs.pages.dev/docs/getting-started/advanced

Use these Rclone options to improve streaming performance. Avoid setting `vfs-read-chunk-size` too high, as it may cause buffering issues.

```bash
--vfs-read-chunk-size=32M
--vfs-read-chunk-streams=4
--teldrive-threaded-streams=1

```

--------------------------------

### Post Files

Source: https://teldrive-docs.pages.dev/docs/api

Uploads a new file.

```APIDOC
## POST /files

### Description
Uploads a new file.

### Method
POST

### Endpoint
/files
```

--------------------------------

### Local PostgreSQL Docker Compose Configuration

Source: https://teldrive-docs.pages.dev/docs/getting-started/prerequisites

Defines services for a local PostgreSQL database using Docker Compose. Customize username and password for security.

```yml
services:
  postgres:
    image: groonga/pgroonga:latest-alpine-17
    container_name: postgres_db
    restart: always
    networks:
     - postgres
    environment:
      - POSTGRES_USER=teldrive
      - POSTGRES_PASSWORD=secret
      - POSTGRES_DB=postgres
    volumes:
      - postgres_data:/var/lib/postgresql/data

networks:
  postgres:
    external: true

volumes:
  postgres_data:
    external: true
```

--------------------------------

### Perform Basic Storage Integrity Check

Source: https://teldrive-docs.pages.dev/docs/cli/check

Run a basic check to identify missing or orphaned file parts in your Teldrive storage. This command analyzes your storage without making any changes.

```bash
teldrive check
```

--------------------------------

### Imgproxy Docker Compose Configuration

Source: https://teldrive-docs.pages.dev/docs/guides/caddy-cloudflare

Configures the imgproxy service for Docker Compose. It sets the image, container name, network, environment variables for origin allowance and WebP enforcement, and restart policy.

```yaml
services:
  imgproxy:
    image: darthsim/imgproxy
    container_name: imgproxy
    networks:
     - caddy
    environment:
      IMGPROXY_ALLOW_ORIGIN: "*"
      IMGPROXY_ENFORCE_WEBP: true
      IMGPROXY_MALLOC: "jemalloc"
    restart: always

networks:
  caddy:
    external: true
```

--------------------------------

### Post File Share by ID

Source: https://teldrive-docs.pages.dev/docs/api

Creates or updates a share for a specific file.

```APIDOC
## POST /files/{id}/share

### Description
Creates or updates a share for a specific file.

### Method
POST

### Endpoint
/files/{id}/share

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the file to share.
```

--------------------------------

### Post Files Move

Source: https://teldrive-docs.pages.dev/docs/api

Moves files.

```APIDOC
## POST /files/move

### Description
Moves files.

### Method
POST

### Endpoint
/files/move
```

--------------------------------

### Docker Compose Configuration for Teldrive

Source: https://teldrive-docs.pages.dev/docs/getting-started/usage

Define the Teldrive service for Docker Compose. This configuration maps local files for configuration and storage, and exposes the application port.

```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
```

--------------------------------

### Enable File Encryption in Teldrive

Source: https://teldrive-docs.pages.dev/docs/getting-started/advanced

Enable file encryption to secure your data. Store your encryption key securely as files cannot be recovered without it. Add `encrypt_files = true` in your rclone config.

```toml
[tg.uploads]
encryption-key = "your-key"

```

--------------------------------

### Advanced Caddyfile for Layer4 PostgreSQL TLS

Source: https://teldrive-docs.pages.dev/docs/guides/caddy-cloudflare

Configures Caddy to handle Layer4 traffic for PostgreSQL with TLS termination, enabling secure connections on the same port as web traffic. This requires the `teldrive/caddy` image.

```caddyfile
{
	servers {
		listener_wrappers {
			layer4 {
				@postgres tls sni postgres.yourdomain.com 
				route @postgres {
					ls {
						connection_policy {
							alpn postgresql
						}
					}
					proxy postgres:5432
				}
			}
			ls
		}
	}
}

postgres.yourdomain.com {
	respond "ok" 200
}

teldrive.yourdomain.com {
    tls internal
    reverse_proxy teldrive:8080
}

imgproxy.yourdomain.com {
    tls internal
    reverse_proxy imgproxy:8080
}
```

--------------------------------

### Patch User Channels Sync

Source: https://teldrive-docs.pages.dev/docs/api

Synchronizes user channels.

```APIDOC
## PATCH /users/channels/sync

### Description
Synchronizes user channels.

### Method
PATCH

### Endpoint
/users/channels/sync
```

--------------------------------

### Post File Copy by ID

Source: https://teldrive-docs.pages.dev/docs/api

Copies a specific file by its ID.

```APIDOC
## POST /files/{id}/copy

### Description
Copies a specific file by its ID.

### Method
POST

### Endpoint
/files/{id}/copy

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the file to copy.
```

--------------------------------

### Logout

Source: https://teldrive-docs.pages.dev/docs/api

Logs out the current user session.

```APIDOC
## POST /auth/logout

### Description
Logs out the current user session. Requires an Authorization header with a Bearer token.

### Method
POST

### Endpoint
/auth/logout

### Parameters
#### Headers
- **Authorization** (string) - Required - Bearer token for authentication.

### Response
#### Success Response (204)
There is no content to send for this request, but the headers may be useful.

#### Default Response
An unexpected error response.
```json
{
  "code": 500,
  "message": "Internal server error occurred"
}
```
```

--------------------------------

### Post Files Delete

Source: https://teldrive-docs.pages.dev/docs/api

Deletes files.

```APIDOC
## POST /files/delete

### Description
Deletes files.

### Method
POST

### Endpoint
/files/delete
```

--------------------------------

### Post Upload by ID

Source: https://teldrive-docs.pages.dev/docs/api

Uploads a file to a specific upload ID.

```APIDOC
## POST /uploads/{id}

### Description
Uploads a file to a specific upload ID.

### Method
POST

### Endpoint
/uploads/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the upload.
```

--------------------------------

### Patch File by ID

Source: https://teldrive-docs.pages.dev/docs/api

Updates a specific file by its ID.

```APIDOC
## PATCH /files/{id}

### Description
Updates a specific file by its ID.

### Method
PATCH

### Endpoint
/files/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the file to update.
```

--------------------------------

### Patch File Share by ID

Source: https://teldrive-docs.pages.dev/docs/api

Updates the share settings for a specific file.

```APIDOC
## PATCH /files/{id}/share

### Description
Updates the share settings for a specific file.

### Method
PATCH

### Endpoint
/files/{id}/share

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the file whose share settings need to be updated.
```

--------------------------------

### Patch User Channels

Source: https://teldrive-docs.pages.dev/docs/api

Updates user channels.

```APIDOC
## PATCH /users/channels

### Description
Updates user channels.

### Method
PATCH

### Endpoint
/users/channels
```

--------------------------------

### Post Share Unlock by ID

Source: https://teldrive-docs.pages.dev/docs/api

Unlocks a specific share.

```APIDOC
## POST /shares/{id}/unlock

### Description
Unlocks a specific share.

### Method
POST

### Endpoint
/shares/{id}/unlock

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the share to unlock.
```

--------------------------------

### Generate JWT Secret using OpenSSL

Source: https://teldrive-docs.pages.dev/docs/getting-started/usage

Generate a secure random hexadecimal key for JWT authentication using OpenSSL. This key should be 32 bytes long.

```sh
openssl rand -hex 32
```

--------------------------------

### Login API Request Body

Source: https://teldrive-docs.pages.dev/docs/api

This JSON object represents the request body for the /auth/login endpoint. Ensure all fields are correctly populated, especially sensitive information like 'hash'.

```json
{ "name": "John Doe", "userName": "johndoe", "userId": 123456789, "isPremium": true, "hash": "a1b2c3d4e5f6g7h8i9j0", "expires": "", "session": ""}
```

--------------------------------

### Check Storage for a Specific User

Source: https://teldrive-docs.pages.dev/docs/cli/check

Specify a Telegram username with the `--user` flag to perform an integrity check on files belonging to a particular user. This is useful for managing storage for multiple users.

```bash
teldrive check --user yourTelegramUsername
```

--------------------------------

### Delete User Bots

Source: https://teldrive-docs.pages.dev/docs/api

Deletes a user bot.

```APIDOC
## DELETE /users/bots

### Description
Deletes a user bot.

### Method
DELETE

### Endpoint
/users/bots
```

--------------------------------

### Delete File Share by ID

Source: https://teldrive-docs.pages.dev/docs/api

Deletes the share for a specific file.

```APIDOC
## DELETE /files/{id}/share

### Description
Deletes the share for a specific file.

### Method
DELETE

### Endpoint
/files/{id}/share

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the file whose share needs to be deleted.
```

--------------------------------

### Delete User Channel by ID

Source: https://teldrive-docs.pages.dev/docs/api

Deletes a specific user channel.

```APIDOC
## DELETE /users/channels/{id}

### Description
Deletes a specific user channel.

### Method
DELETE

### Endpoint
/users/channels/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the user channel to delete.
```

--------------------------------

### Delete User Session by ID

Source: https://teldrive-docs.pages.dev/docs/api

Deletes a specific user session.

```APIDOC
## DELETE /users/sessions/{id}

### Description
Deletes a specific user session.

### Method
DELETE

### Endpoint
/users/sessions/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the user session to delete.
```

--------------------------------

### Delete Upload by ID

Source: https://teldrive-docs.pages.dev/docs/api

Deletes a specific upload.

```APIDOC
## DELETE /uploads/{id}

### Description
Deletes a specific upload.

### Method
DELETE

### Endpoint
/uploads/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the upload to delete.
```
Tokens:
Raw