Yoink is a self-hosted Telegram bot and Mini App for media downloads, music links, group statistics, AI summaries, and saved content.
The current runtime is Rust with an embedded Turso database. A confined Python worker handles media and content extraction. The React frontend includes pages from the plugin repositories. Python bot services and PostgreSQL remain legacy migration and recovery tools, not the default deployment.
| Product | Use |
|---|---|
| Downloads | Download media, select formats, manage personal cookies, and review download history. |
| Music | Resolve music links across providers and optionally send audio. |
| Stats | Read authorized group statistics and search indexed messages. |
| Insight | Summarize content, manage prompts, and configure AI providers. |
| Inbox | Save content, classify items, and organize GitHub Stars. |
Access depends on current roles, feature grants, and group policies. A supported provider can still reject a request because of authentication, region, or upstream changes.
Use the installation guide for source builds or published Linux amd64 images. It covers credentials, storage permissions, the separate Bot API dependency, and first startup.
Clone the repository with its frontend submodules:
git clone --recurse-submodules https://github.com/AdamsGH/yoink-core.gitDo not start a second poller with a bot token that another deployment uses.
- Documentation index
- Architecture
- Configuration
- Deployment and rollback
- Backup and restore
- Development and checks
- HTTP API
- Releases and image publication
The GitHub Wiki uses an export of the public documentation. The repository files are the source of truth.