docs: document backend-only API and update README

[SasukeXDev]

Motivation

• The project has been focused to operate as a backend-only service after frontend removal and needs clear documentation for integrators and maintainers.
• Consumers require an explicit reference for environment variables, deployment steps, and the authentication flow to run and secure the service.
• The streaming/download entrypoints and byte-range behavior must be documented for correct frontend and client implementations.

Description

• Rewrote README.md to present Surf-TG as a backend-only Telegram file index, search, playlist, thumbnail, watch, and streaming API and removed UI-centric marketing content.
• Added a complete environment variable table and local/Docker/Compose/Heroku deployment instructions to simplify setup across environments.
• Documented the cookie-based authentication flow, admin vs user route restrictions, and called out that several routes still return server-rendered HTML.
• Added an API endpoint reference covering the routes implemented in bot/server/stream_routes.py (including POST /login, POST /logout, GET /, GET /playlist, GET /search/db/{parent}, GET /channel/{chat_id}, GET /search/{chat_id}, GET /api/thumb/{chat_id}, GET /watch/{chat_id}, GET /{chat_id}/{encoded_name}, POST /create, POST /delete, POST /edit, POST /edit_post, GET /searchDbFol, POST /send, GET /reload, and POST /config), plus detailed streaming/download semantics (hash check, Range header support, 206/416 responses) and guidance for building a separate frontend including security notes.

Testing

• Ran git diff --check to validate whitespace and diff consistency, which passed without errors.
• Ran python -m compileall bot to ensure the package compiles, which completed successfully.

---

Codex Task

[vercel]

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Actions	Updated (UTC)
hub360	Building	Preview	Jul 5, 2026 7:17am