Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Simple implementation of the KOReader position sync server for self-hosting at home which has docker support for arm and amd64 :)

License

Notifications You must be signed in to change notification settings

b1n4ryj4n/koreader-sync

Repository files navigation

Koreader position sync server

Description

This is a simple implementation of the KOReader (https://github.com/koreader/koreader) position sync server for self-hosting at home which has docker support for arm and amd64 :) This is a fork of https://github.com/myelsukov/koreader-sync but with a complete code rewrite.

Dependencies

Install and run

> pip install -r requirements.txt
> uvicorn kosync:app --host 0.0.0.0 --port 8081

Or via Docker

> docker build --rm=true --tag=kosync:latest .
> docker compose up -d

Environment Variables

  • RECEIVE_RANDOM_DEVICE_ID ("True"|"False")

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.

  • OPEN_REGISTRATIONS ("True"|"False")

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.

Dockerhub

There is also a dockerhub image available if you are not able to build yourself the image.

For linux/amd64 you can use docker pull b1n4ryj4n/koreader-sync and for linux/arm docker pull b1n4ryj4n/koreader-sync:arm

Connection

Changelog

[0.0.5] - 2024年05月24日

Added

[0.0.4] - 2023年10月29日

Added

[0.0.3] - 2022年03月20日

Added

  • Added an environment variable option to receive always a random device id

[0.0.2] - 2022年02月21日

Added

[0.0.1] - 2021年09月15日

Added

  • First version

About

Simple implementation of the KOReader position sync server for self-hosting at home which has docker support for arm and amd64 :)

Topics

Resources

License

Stars

Watchers

Forks

Contributors 4

AltStyle によって変換されたページ (->オリジナル) /