martin/kosyncrs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

README improved

Browse source
This commit is contained in:
Martin Brodbeck 2023-09-27 08:34:51 +02:00
parent b70217755f
commit 06b8f6800d
1 changed files with 6 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
README.md
View file

@ -1,5 +1,10 @@
# KOreader Sync Server
This is a KOreader sync server, implemented in Rust.
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 adopt 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.