KOReaderPyLink
KOReaderPyLink
Docker app from DonKevlar's Repository
Overview
A simple implementation of the KOReader position sync server for self-hosting at home. This is a modified fork of b1n4ryj4n/koreader-sync with some additional logging and slightly modified endpoints.
Requirements
KOReader Application on a dedicated device. (https://github.com/koreader/koreader)
Runtime arguments
- Network
bridge- Shell
sh- Privileged
- false
Template configuration
API PortPorttcp
- Target
- 8081
- Value
- 8081
DB PathPathrw
Remove this path if you don't want a persistant db.
- Target
- /app/data
- Value
- /mnt/cache/appdata/koreaderpylink/db
RECEIVE_RANDOM_DEVICE_IDVariable
Set it true to retrieve always a random device id to force a progress sync. This is usefull if you only sync your progress from one device and usually delete the *.sdr files with some cleaning tools.
- Default
- False
- Value
- False
OPEN_REGISTRATIONSVariable
Enable/disable new registrations to the server. Useful if you want to run a private server for a few users, although it doesn't necessarily improve security by itself. Set to True (enabled) by default.
- Default
- True
- Value
- True
Discord Webhook URLVariable
Discord Webhook URL
- Target
- WEBHOOK_URL
Enable Discord WebhookVariable
Enable/disable discord webhooks
- Target
- WEBHOOK_ENABLED
- Default
- False
- Value
- False
Categories
Details
Repository
ghcr.io/donkevlar/koreaderpylink:mainLast Updated2026-05-31
First Seen2025-02-26
Run KOReaderPyLink on Unraid.
KOReaderPyLink is listed in Community Apps for Unraid OS. Explore Unraid to build a flexible home server, NAS, or homelab.