Ctrl K
ComunidadGuías…
GITHUB · ANALIZADO

koreader-sync

Servidor de sincronización de posición para KOReader con soporte Docker (arm/amd64). Implementación en Python/FastAPI que permite autoalojamiento doméstico y gestión de progreso de lectura entre dispositivos.

Ficha actualizada 18 sept 2026, 21:05 · upstream 24 may 2024, 15:26 · release v0.0.5

Ver códigoProblemas y ayudaRepositorio ↗
00

Qué es koreader-sync

Descripción editorial construida a partir del repositorio, su documentación y sus señales de mantenimiento.

Este repositorio contiene una implementación sencilla del servidor de sincronización de posición para KOReader, diseñado específicamente para autoalojamiento en entornos domésticos. El proyecto ha sido completamente reescrito a partir de un fork anterior, ofreciendo soporte nativo para Docker tanto en arquitecturas ARM como x86_64.

El servicio se basa en FastAPI y utiliza TinyDB como base de datos ligera para persistir el progreso de lectura. Incluye soporte para variables de entorno que permiten controlar la recepción de IDs de dispositivo aleatorios y habilitar o deshabilitar nuevos registros de usuarios, lo cual es útil para servidores privados con control de acceso básico.

El despliegue puede realizarse mediante instalación directa con pip o a través de Docker Compose. Se recomienda encarecidemente configurar un reverse proxy (como Nginx Proxy Manager) para habilitar HTTPS y mejorar la seguridad en entornos de producción.

CASOS DE USO
  • Sincronizar el progreso de lectura entre múltiples dispositivos KOReader en una red doméstica
  • Autoalojar un servidor privado sin necesidad de registrarse públicamente en servicios externos
  • Gestionar sesiones de lectura persistentes eliminando archivos temporales *.sdr localmente
  • Probar implementaciones de sincronización en entornos ARM (Raspberry Pi) o x86_64
PUNTOS DESTACADOS
  • Soporte nativo para Docker con imágenes optimizadas para arquitecturas arm y amd64
  • Uso de FastAPI y TinyDB proporciona una arquitectura ligera y eficiente en recursos
  • Incluye HEALTHCHECK integrado accesible vía /healthstatus para monitorización
  • Variables de entorno personalizables para control de IDs de dispositivo y registros
PRECAUCIONES
  • No incluye autenticación robusta por defecto; requiere reverse proxy externo para seguridad
  • La persistencia depende exclusivamente de TinyDB, sin replicación o backup automático
  • Requiere configuración manual de variables de entorno para funcionalidades avanzadas
  • El servidor no gestiona actualizaciones automáticas del cliente KOReader
01

Perfil de infraestructura

Estimación inicial derivada del repositorio y de los servicios detectados.

CPU2 vCPUrecomendación inicial
MEMORIA2 GBRAM estimada
DISCO10 GBalmacenamiento base
COMPLEJIDADmediumnivel de operación
02

Despliegue detectado

Qué señales reales de instalación hemos encontrado.

Listo para automatizar

Despliegue recomendado: usar Docker Compose con reverse proxy HTTPS (Nginx Proxy Manager). Configurar RECEIVE_RANDOM_DEVICE_ID=True si se eliminan archivos *.sdr localmente. Asegurar OPEN_REGISTRATIONS=False en producción para evitar registros públicos no deseados. Asignar al menos 2GB RAM y 10GB disco.

✓Dockerfile
✓Compose
✓One-click
03

Stack y dependencias

Componentes inferidos a partir de manifests, configuración y documentación.

FRAMEWORKS
FastAPIPython
SERVICIOS
No detectados
BASES DE DATOS
No detectadas
PUERTOS
8081
06

Experiencia real de la comunidad

Ayuda a contrastar la estimación automática con instalaciones reales.

Todavía no hay datos comunitarios para este proyecto.