KOsync is a progress sync server for KOReader written in Go.
The official KOReader progress sync server is written in Lua using OpenResty.
For deployment it needs Nginx with OpenResty as well as Redis as database.
KOsync wants to be simpler by not having any dependencies besides the OS itself.
(If you need TLS, a reverse proxy is also required, I recommend Caddy)
In addition to requiring Nginx, OpenResty and Redis, the official server is not very maintained.
The last feature adding commits was around 2016.
KOsync vs KOReader Sync Server
You may choose KOsync over KORSS due to the following differences:
- Actively maintained and open for feature requests
- Simple Web Interface (Prototype)
- Written in Go and deploys as a single executable
- Single JSON file as database plus configuration instead of Redis
Additional differences that should be known:
- KOsync is licensed under
EUPL-1.2 or latercompared to KORSS, which isAGPL-3.0 or later - Simple deployment via Docker
- Requires a Reverse Proxy for TLS
Simple Code
KOsync is written in Go with no external dependencies.
All you need to run KOsync is bundled into a single executable.
See docs/build.md for build and deployment instructions.
Simple Datastore
KOsync stores all data, both configuration and user data, in a single JSON file.
The Schema of the file is shown and explained in the next section.
Users can, after entering the custom URL, use the KOReader registration to signup.
After that, they push and pull progress states.
Documents are uploaded by KOReader during progress push.
The push must be triggered by hand or configured to be done automatically when switching pages.
Consult the KOReader documentation for the configuration options.
See docs/database.md
See docs/backups.md
See docs/api.md
See webui/README.md
KOsync is licensed under the European Union Public License v1.2 or later