# KOReaderPyLink

KOReaderPyLink is a self-hosted sync server that keeps your reading positions and progress in sync across multiple KOReader e-reader devices, with Docker support. It is open source and self-hosted, installable on Unraid.

Canonical page: https://ourlocalhost.com/app/2970/koreaderpylink

## Description

KOReaderPyLink is a self-hosted sync server that keeps your reading positions and progress in sync across multiple KOReader e-reader devices, with Docker support. This is a modified fork of b1n4ryj4n/koreader-sync with additional logging and slightly modified endpoints.

## Platform availability

Available on 1 of 10 platforms: Unraid.

## Health score

18/100 (Low), based on 3 of 4 factors.
- Maintained: 10 (last commit 633 days ago)
- Popular: 17 (6 GitHub stars)
- Easy to install: 35 (1 install platform, install notes, Docker image)

## Links

- Unraid: https://ca.unraid.net/apps/koreaderpylink-02eiiil0xw8mqx?q=KOReaderPyLink

## Common questions

### How can I disable new registrations for a private KOReaderPyLink server?

Set OPEN_REGISTRATIONS to False. The README notes this is useful for a private server, although it does not necessarily improve security by itself.

### How do I force a progress sync when syncing from one device?

Set RECEIVE_RANDOM_DEVICE_ID to True. This makes the server retrieve a random device ID, which is useful if you delete the .sdr files with cleaning tools.

### What should I enter in KOReader to connect to this server?

Open Settings, Progress Sync, and Custom sync server. Use your server IP with port 8081 or an HTTPS reverse-proxy hostname, then register with a username and password.

### How do I enable Discord notifications?

Set WEBHOOK_ENABLED to True and provide a Discord webhook URL in WEBHOOK_URL. Currently only registrations send a notification.

### Where should Docker store KOReaderPyLink data?

Mount a host data directory to /app/data, as shown by the Docker run command. This is the container path for the server's data.

---
Source: Our Local Host (https://ourlocalhost.com/app/2970/koreaderpylink), the self-hosted and open-source app directory.
