# KOReader Sync Server

KOReader Sync Server is a self-hosted synchronization service that keeps reading progress in sync across your KOReader e-readers. It is open source and self-hosted, installable on Docker Hub and Unraid.

Canonical page: https://ourlocalhost.com/app/949/koreader-sync-server

## Description

KOReader Sync Server is a self-hosted synchronization service that keeps reading progress in sync across your KOReader e-readers. The official image serves HTTPS on container port 7200 with a self-signed certificate and stores its state in Redis, so persistent Redis storage is required. Keep the exposed port on a trusted network, or place the container behind a reverse proxy that terminates TLS.

## Platform availability

Available on 1 of 9 platforms: Unraid.

## Health score

62/100 (Good), based on 3 of 4 factors.
- Maintained: 79 (last commit 29 days ago)
- Popular: 58 (777 GitHub stars)
- Easy to install: 35 (1 install platform, install notes, Docker image)

## Links

- Docker Hub: https://hub.docker.com/r/koreader/kosync
- GitHub: https://github.com/koreader/koreader-sync-server
- Documentation: https://github.com/koreader/koreader
- Unraid: https://ca.unraid.net/apps/koreader-sync-server-1cf6dd40b6p1q4?q=koreader-sync-server

## Common questions

### What port and TLS setup does the official image use?

The official image serves HTTPS on container port 7200 with a self-signed certificate. Keep the exposed port on a trusted network, or place the container behind a reverse proxy that terminates TLS.

### Does the server need a persistent volume?

It stores its state in Redis, so persistent Redis storage is required.

### Do users report Unknown server errors when syncing progress?

Users report seeing Unknown server error when trying to pull or push progress on multiple devices. The thread does not specify a confirmed cause.

### Can a KOReader e-reader and a phone share progress?

A user described using a Kobo Mini and a phone with Progress Sync so progress could be kept in sync.

### Do forum users discuss Readest cross-device sync with KOReader?

Forum users discuss cross-device progress sync setups, including self-hosted KOReader sync servers and public sync options with Readest on iOS or Android.

### Is Docker setup a hurdle for first-time self-hosters?

A user with no Docker knowledge described Docker as a steep learning curve before setting up the server.

---
Source: Our Local Host (https://ourlocalhost.com/app/949/koreader-sync-server), the self-hosted and open-source app directory.