简体中文 | English

TG Vault

Telegram file transfer and archiving with web file management and multiple storage providers.

Quick start · Deployment guide · Releases

Features

• Telegram file transfers, channel/group batch downloads by date or tag, and subscription sync.
• Web uploads, search, folder organization and media previews.
• Web and Bot task management: progress, failure details, pause, resume and retry.
• Local disk, OneDrive, Google Drive, Aliyun OSS, S3 and WebDAV storage.
• Administrator password, Bot user allowlist and TOTP two-factor authentication.

Channel downloads and subscriptions require a Telegram user account with source access. TG Vault does not bypass Telegram permissions or server limits.

Quick start

Prepare a Linux server, Docker Compose, and Web/API HTTPS domains under the same parent domain.

git clone https://github.com/hicocos/tg-vault.git
cd tg-vault
./deploy/install.sh

The installer pulls the latest amd64/arm64 images from GHCR without a registry login or local compilation, falling back to a source build if pulling fails. Do not copy .env.example before a fresh install. Follow the prompts for addresses and a storage directory.

1. Configure HTTPS proxies as described in the deployment guide: Web → 127.0.0.1:47832, API → 127.0.0.1:51947.
2. Restrict both endpoints to yourself until initialization is complete. Open the web UI and set an administrator password before allowing access.
3. Under Settings → Telegram, connect your Bot and configure user permissions. Sign in with a Telegram user account for channel downloads or subscriptions.

Send /start to the Bot to begin, or /help for commands. Use ./deploy/install.sh --build to force a source build. See the deployment guide for other options; detailed guides are currently in Chinese.

Backup and updates

Back up .env, the database and complete file data before upgrading, then run from the project directory:

./deploy/install.sh

The script updates source and pulls latest, retaining existing configuration and data mounts. See backup and recovery. Do not troubleshoot with docker compose down -v.

Documentation

• Deployment guide: installation, HTTPS, backups, recovery and updates.
• Configuration and usage: environment variables, Telegram, storage and permissions.
• Local storage locations: mounts, path verification and data protection.
• Local development: development setup and build checks.

License

MIT License · hicocos/tg-vault