Skip to content

tgfilestream Documentation

Welcome to the official documentation for tgfilestream (TGFS).

TGFS is a lightweight Telegram client and HTTP server that acts as a proxy between Telegram servers and HTTP clients, allowing direct downloads of Telegram media files via HTTP.

It is designed for scalable, self-hosted deployments using:

  • Multi-worker architecture
  • Reverse proxy (Nginx)
  • Patch-based extensibility

What This Documentation Covers

This documentation explains:

  • How to deploy it on a VPS
  • How to configure and scale it
  • How to customize behavior safely
  • How to extend it using patches

Documentation Sections

🚀 Getting Started

Understand the architecture and internal design of TGFS.

➡ Getting Started

⚙️ Setup

Step-by-step guide to deploy TGFS on a server.

➡ Setup Guide

🔧 Customization

Learn how to modify behavior without touching core code.

➡ Customization

Project Repositories