Saltar a contenido

Inicio rápido

Tres formas de poner en marcha una instancia, de la más rápida a la más completa. Todas exponen la API en http://localhost:8000: una página de inicio con un recuadro Pruébalo en la raíz, Swagger UI interactivo en /api y esta documentación en /docs/.

1. Un solo contenedor

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

La imagen también se publica en Docker Hub como koval01/telegram-me. Sin más configuración usa una caché dentro del proceso, ideal para una única instancia pequeña.

Compruébalo:

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

El repositorio incluye un compose.yaml que ejecuta la API junto a una caché Valkey (compatible con Redis):

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

Elige un preset con PRESET:

Preset Feed Vistas previas Límite de solicitudes Caché Parser
standard (por defecto) no sí no normal full
full sí sí no normal full
minimal no no 90 sol./min por IP aggressive simplified 
PRESET=full docker compose up -d --wait

Todo lo demás se define en un archivo .env junto a compose.yaml: copia .env.example y consulta Configuración para ver todas las opciones.

3. Desde el código fuente

Requiere uv (instala por sí mismo una versión de Python adecuada):

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

Consulta Desarrollo local para el flujo de trabajo completo.

Próximos pasos