martin
/
kosyncrs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
36 Commits 2 Branches 3 Tags 64 KiB
Rust 100%
Go to file
Martin Brodbeck 3b4e61ac14 typo 2023-09-29 10:35:13 +02:00
nginx more documentation 2023-09-26 22:03:52 +02:00
src code beautifying 2023-09-27 08:44:53 +02:00
systemd systemd example file 2023-09-26 21:16:25 +02:00
.gitignore Initial commit 2023-09-25 15:12:47 +02:00
Cargo.lock Version 1.0.1 2023-09-26 22:05:50 +02:00
Cargo.toml Version 1.0.1 2023-09-26 22:05:50 +02:00
README.md typo 2023-09-29 10:35:13 +02:00

README.md

KOreader Sync Server

This is a KOreader sync server, implemented in Rust. It uses the crates axum, redis, serde and serde_json.

Requirements

  • Rust toolchain (≥ 1.63) for compilation
  • A running Redis server
  • Nginx (or Apache) webserver as a reverse proxy, since kosyncrs only listens locally and uses HTTP.

Installation

Just compile it with cargo build --release. You can then copy the executable for example to /usr/local/bin/. If you want to start the service automatically, you can adapt the example systemd file for your needs. You can also use nginx as a reverse proxy, so that the sync server listens on port 443.

Todo

  • Test, if it really works, and if it works reliably. Feedback is very welcome!
  • Make it more configurable