home

TELOS Wiki

Welcome to the TELOS (Telegram External Loader & Orchestrator System) documentation!

TELOS is a Docker-based automation system that monitors Telegram channels for IPA files, processes them, extracts metadata, fetches App Store information, and publishes everything to GitHub with support for multiple sideloading app formats.

---

📚 Documentation Index

Getting Started

• Installation - Prerequisites, setup, and deployment
• Configuration - Environment variables and settings
• Quick Start Guide - Get up and running in minutes

Core Concepts

• Architecture - System design and component overview
• Telegram Integration - How TELOS monitors and downloads from Telegram
• GitHub Integration - Releases, uploads, and storage management
• JSON Formats - AltStore, Esign, Scarlet, and Feather support

Usage

• Web Dashboard - Real-time monitoring and controls
• Queue Management - Managing pending downloads
• Scanning & Processing - How files are discovered and processed
• Priority Apps - Configuring preferred tweaks per app

Operations

• GitHub Actions - Backup and regeneration workflows
• Cleanup & Maintenance - Managing storage and old releases
• Troubleshooting - Common issues and solutions

Development

• API Reference - REST API endpoints
• Database Schema - PostgreSQL models
• Contributing - Development setup and guidelines

---

🚀 Quick Links

• Dashboard: http://localhost:3000
• API Docs: http://localhost:7531/docs
• Health Check: http://localhost:7531/health

---

✨ Key Features

Feature	Description
Telegram Monitoring	Monitors configured channels for .IPA files using MTProto
IPA Processing	Extracts Info.plist, entitlements, and detects injected tweaks
App Store Lookup	Fetches icons, screenshots, and descriptions (30-day cache)
Multi-Format JSON	Generates store.json, esign.json, scarlet.json, feather.json
GitHub Releases	Uploads IPAs to releases (supports up to 2GB per file)
Version Priority	Configure preferred tweaks per app (PRIORITY_APPS)
Web Dashboard	Real-time monitoring, metrics, queue management
Automatic Cleanup	Age-based and version-based release cleanup

---

🛠️ Tech Stack

• Backend: Python 3.12, FastAPI, SQLAlchemy, TDLib
• Frontend: React, Vite
• Database: PostgreSQL 16
• Deployment: Docker Compose
• Platforms: ARM64 (Raspberry Pi 5) / x86 Linux / macOS