synckor

SyncKor

A sync server for the e-reader app KOReader.
Made to be a drop-in replacement for the official KOReader sync server.

Demo

https://github.com/user-attachments/assets/87db85a1-c015-4e63-985c-98e079071dec

Quick Start

• The project has an official Docker image published on github container registry.
• The repository is located HERE
• The environment variables that are needed can be found below in the Environment Variables section.
• For setting up the s3 bucket or s3 compatible storage, please reference the detailed guide in the litestream documentation

Getting Started

Dependencies

• Go
• litestream
• SQLite
• MinIO or any other s3 compatible storage

How to Setup the Application (Local)

• Local setup doesn't include litestream

1. Setup a local MinIO object storage.

docker run -p 9000:9000 -p 9001:9001 minio/minio server /data --console-address ":9001"

1. Follow the guide on litestream to create the bucket in the MinIO object storage.
2. Run the make command to start the application.

make run

How to Setup the Application (Docker)

1. Setup a local MinIO object storage.

docker run -p 9000:9000 -p 9001:9001 minio/minio server /data --console-address ":9001"

1. Follow the guide on litestream to create the bucket in the MinIO object storage.
2. Use the make command to build the docker image.

make docker-build

1. Edit the docker-compose.yml file to make sure the environment variables are correct.

2. Use the make command to run the docker image.

make docker-run

Environment Variables

License

This project is licensed under the MIT License - see the LICENSE file for details