Updated docs

Author: DeekshithSH

docs/customization/customize-replies.md

@@ -0,0 +1,143 @@
+# Customizing Bot Reply Text
+
+TG-FileStream uses a translation registry system to manage reply texts.
+
+All default messages are defined in:
+
+tgfs/utils/translation.py
+
+Messages are loaded using a registry-based system.
+
+This allows overriding text without modifying core files.
+
+---
+
+# How It Works
+
+The core project defines:
+
+- A base language class (`en`)
+- A registry dictionary
+- Messages fetched dynamically via registry
+
+Example (simplified):
+
+```python
+registry = {}
+registry["en"] = en
+```
+
+When the bot needs a message, it fetches it from the active language class in the registry.
+
+---
+
+# Overriding Reply Text Using a Patch
+
+To override messages, you create a patch that:
+
+1. Inherits from the base language class
+2. Overrides specific text variables
+3. Registers your custom class into the registry
+
+---
+
+# Official CustomReply Patch
+
+You can use the official template:
+
+https://github.com/SpringsFern/CustomReply
+
+---
+
+# Step-by-Step Guide
+
+## 1. Fork the Repository
+
+Fork:
+
+https://github.com/SpringsFern/CustomReply
+
+Modify the code inside:
+
+```
+CustomReply/__init__.py
+```
+
+---
+
+## 2. Example Customization
+
+```python
+from tgfs.utils.translation import registry, en
+
+class CustomText(en):
+    START_TEXT = "Hey there how are you\nYou can send me any file and I will generate a link for that file."
+
+registry["en"] = CustomText
+```
+
+This overrides the default `START_TEXT`.
+
+You can override any variable defined in:
+
+https://github.com/SpringsFern/TG-FileStream/blob/main/tgfs/utils/translation.py
+
+---
+
+## 3. Install the Patch
+
+Clone your fork inside:
+
+```
+<TG-FileStream base folder>/tgfs/patches/
+```
+
+Example:
+
+```bash
+cd tgfs/patches
+git clone https://github.com/<your-username>/CustomReply
+```
+
+---
+
+## 4. Restart TG-FileStream
+
+```bash
+sudo systemctl restart tgfs
+```
+
+Or if running manually:
+
+```bash
+python -m tgfs
+```
+
+---
+
+# Adding New Language Support
+
+You can:
+
+1. Submit pull request to:
+   https://github.com/SpringsFern/tgfs_translation
+
+OR
+
+2. Add new language class inside your patch:
+
+```python
+class CustomSpanish(en):
+    START_TEXT = "Hola!"
+
+registry["es"] = CustomSpanish
+```
+
+---
+
+# Best Practices
+
+- Do not modify `translation.py` directly.
+- Always use patches.
+- Only override variables you need.
+- Keep your patch repository separate for easier upgrades.

docs/customization/index.md

@@ -0,0 +1,50 @@
+# Customization Overview
+
+TG-FileStream supports modular customization without modifying core logic.
+
+The project is structured to allow:
+
+- External feature injection
+- Patch-based enhancements
+- Optional components
+
+---
+
+## Architecture Overview
+
+Core
+
+  ↓
+
+Extension Loader
+
+  ↓
+
+Patches
+
+  ↓
+
+Runtime Behavior
+
+---
+
+## Customization Methods
+
+### 1. Configuration-based
+
+Modify `.env` variables to change behavior.
+
+[Environment Variables](../setup/environment-variables/)
+
+### 2. Patch-Based
+
+Inject behavior into specific lifecycle hooks.
+
+---
+
+## Recommended Workflow
+
+1. Do NOT modify core files.
+2. Create a patch.
+3. Test locally.
+4. Deploy.

docs/customization/patches.md

@@ -0,0 +1,39 @@
+# Official Patches
+
+This page lists patches officially maintained for TG-FileStream.
+
+Patches extend functionality without modifying core files.
+
+---
+
+## Available Patches
+### 1. Custom Reply Templates
+[GitHub](https://github.com/SpringsFern/CustomReply)
+
+Allows overriding default bot reply messages.
+See:
+➡ [/customization/customize-replies.md](./customize-replies.md)
+
+### 2. WebPlayer
+[GitHub](https://github.com/SpringsFern/tgfs_webplayer)
+
+Simple HTML5 Player
+
+### 3. Translation
+[GitHub](https://github.com/SpringsFern/tgfs_translation)
+
+Translation of Bot Reply text to additional languages
+
+## How Patches Work
+
+Patches are loaded during application startup.
+
+They:
+
+- Hook into lifecycle events
+- Override default behavior
+- Extend functionality
+
+---
+
+⚠ Always verify compatibility before upgrading core version.

docs/getting-started/architecture.md

@@ -0,0 +1,93 @@
+# Architecture
+
+This page explains how TG-FileStream works internally.
+
+---
+
+## High-Level Architecture
+
+User → Cloudflare (Optional) → Nginx Reverse Proxy → TGFS Workers → Telegram API
+
+---
+
+## Core Components
+
+### 1. Telegram Client Layer
+
+Handles:
+
+- Receiving files
+- Sending files to bin channel
+- Generating file metadata
+- Managing flood waits
+
+---
+
+### 2. HTTP Streaming Layer
+
+Built using:
+
+- aiohttp
+
+Responsible for:
+
+- Handling incoming HTTP requests
+- Serving file streams
+- Managing chunked downloads
+
+---
+
+### 3. Worker Layer
+
+Each worker:
+
+- Runs on a separate port
+- Maintains its own session
+- Handles HTTP requests independently
+
+Nginx distributes traffic across workers.
+
+---
+
+### 4. Reverse Proxy (Nginx)
+
+Responsible for:
+
+- Load balancing
+- HTTPS termination
+- Client buffering control
+- Connection management
+
+---
+
+### 5. Patch System
+
+During startup:
+
+- TGFS loads patches from `tgfs/patches/`
+- Extensions modify behavior
+- Translation overrides are registered
+
+This enables safe customization.
+
+---
+
+## Data Flow Example
+
+1. User sends file to bot
+2. File and Metadata is stored in Database
+3. Download link generated
+4. User accesses link
+5. Nginx forwards request to worker
+6. Worker fetches file from Telegram
+7. File streamed to user
+
+---
+
+## Scaling Model
+
+Scaling is achieved by:
+
+- Running multiple worker services
+- Using Nginx upstream with `least_conn`
+- Optionally using multiple bot tokens