KOReader Sync Server
KOReader Sync Server is a self-hosted synchronization service that keeps reading progress in sync across your KOReader e-readers.
Platform availability
Available on 1 of 10 platforms
- Unraid
- TrueNAS (not listed)
- Umbrel (not listed)
- ZimaOS (not listed)
- Proxmox (not listed)
- Helm (not listed)
- Mac (not listed)
- Windows (not listed)
- Linux (not listed)
- Any server (not listed)
Health score?A 0-100 score computed nightly from four factors: maintained (40%: recent commits and steady activity), popular (25%: GitHub stars, log scale), easy to install (20%: platforms, install notes, setup guides, Docker image) and light to run (15%: minimum RAM, ARM support). When the source code has been checked, a fifth factor, security check (20%: automated scan for committed secrets, unsafe desktop-app settings, known-vulnerable dependencies and project hygiene; any serious finding caps it at 20), is added. Factors without data are left out and the rest are rescaled.
68/100 Good
- Maintained
- 76last commit 59 days ago
- Popular
- 58804 GitHub stars
- Easy to install
- 351 install platform, install notes, Docker image
- Light to run
- No data
- Security check
- 95no serious findings, CI, tests
Based on 4 of 5 factors.
Availability: platform listings confirmed today, links checked 51 days ago
- GitHub stars
- 804
- Open issues
- 7
- Last commit
- 2026-09-23
- Latest release
- v2.1.1
- License
- AGPL-3.0
- Activity
- stale
Checked 20 days ago - source: GitHub (koreader/koreader-sync-server)
Resources & Compatibility
ARM (e.g. Raspberry Pi) is supported.
Checked 54 days ago - source: Docker Hub image tags and published docs
First-install notes
- Copy service file and start KOReader Copy koreader.service into /etc/systemd/system, then run systemctl start koreader to launch it now. The service file tells the Linux service starter how to run KOReader, and without it the start command will not work. source
- On reMarkable 3.20+, run xovi first On reMarkable firmware 3.20 or newer, run xovi/rebuild_hashtable and then xovi/start before KOReader starts. These are required steps for the newer firmware, and missing them can prevent KOReader from starting after a reboot. source
- Make KOReader start automatically at boot After KOReader works, run systemctl disable --now xochitl && systemctl enable --now koreader to replace the default launcher. This makes KOReader start automatically at boot instead of the original launcher. source
Fetched 37 days ago - each note links to its source
Variants
Alternatives
No alternatives collected yet.
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.
Answers sourced from github.com, www.ereadersforum.com, www.reddit.com, www.reddit.com
Community
- Progress Sync : r/koreader - Reddit (reddit)
- KOReader Sync and Readest: Cross-Device Progress Sync on the Xteink X4 ... (forum)
- KOReader | eReadersForum.com (forum)
Collected 53 days ago - public community threads