README.md

tgfs

Telegram becomes a WebDAV server.

Refer to getting started for installation and usage. (Docker or other container engine is required)

Refer to the wiki page for technical detail.

Tested Clients

• rclone
• Cyberduck
• WinSCP
• Documents by Readdle
• VidHub

Features

• Upload and download files to/from a private Telegram channel via WebDAV
• Group files on Telegram channels into folders
• Infinite versioning of files and folders (Folder versioning is only available when Metadata is maintained on Github repository)
• Importing files that are already on Telegram (Only via the Telegram Mini App)
• File size is unlimited (larger files are chunked into parts but appear as a single file to the user)
• Live streaming of videos

Demo Server

• WebDAV URL: https://tgfs-demo.wheatcarrier.site/webdav
• username and password can be any
• File channel on Telegram: @tgfsdemo
• Github repository for metadata: https://github.com/tgfs-demo/tgfs-demo
• Config file: config.yaml

Development

Install the dependencies:

poetry install

Run the app:

poetry run python main.py

Typecheck && lint:

make mypy
make ruff

Before committing and pushing, run the following command to install git hooks:

pre-commit install