Перейти к содержанию

Быстрый старт

Три способа запустить экземпляр — от самого быстрого до самого полного. Во всех случаях API доступен по адресу http://localhost:8000: в корне — стартовая страница с блоком Попробуйте, на /api — интерактивный Swagger UI, на /docs/ — эта документация.

1. Один контейнер

docker run -d --name telegram-me -p 8000:3000 --restart unless-stopped \
  ghcr.io/koval01/telegram-me:latest

Образ также публикуется в Docker Hub как koval01/telegram-me. Без дополнительной настройки он использует кэш внутри процесса — идеальный вариант для одного небольшого экземпляра.

Проверьте:

curl http://localhost:8000/healthz          # {"status":"ok"}
curl http://localhost:8000/v1/body/durov    # channel page as JSON

В репозитории есть compose.yaml, который запускает API рядом с кэшем Valkey (совместим с Redis):

git clone https://github.com/koval01/telegram-me
cd telegram-me
docker compose up -d --wait

Выберите пресет через PRESET:

Пресет Лента Превью Лимит запросов Кэш Парсер
standard (по умолчанию) выкл. вкл. выкл. normal full
full вкл. вкл. выкл. normal full
minimal выкл. выкл. 90 запр./мин на IP aggressive simplified 
PRESET=full docker compose up -d --wait

Всё остальное задаётся в файле .env рядом с compose.yaml — скопируйте .env.example и посмотрите все параметры в разделе Конфигурация.

3. Из исходников

Нужен uv (он сам установит подходящий Python):

git clone https://github.com/koval01/telegram-me
cd telegram-me
uv sync
uv run telegram-me serve --reload   # http://localhost:3000

Полный рабочий процесс описан в разделе Локальная разработка.

Что дальше