more documentation
This commit is contained in:
parent
7d5852efdd
commit
99a4c4800e
2 changed files with 18 additions and 1 deletions
|
@ -1,2 +1,5 @@
|
||||||
# KOreader Sync Server
|
# KOreader Sync Server
|
||||||
This is an experimental KOreader sync server, implemented in Rust.
|
This is a KOreader sync server, implemented in Rust.
|
||||||
|
|
||||||
|
## 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.
|
14
nginx/kosynrs.conf
Normal file
14
nginx/kosynrs.conf
Normal file
|
@ -0,0 +1,14 @@
|
||||||
|
server {
|
||||||
|
listen 443 ssl;
|
||||||
|
server_name kosync.example.com;
|
||||||
|
ssl_certificate /etc/letsencrypt/live/example.com/fullchain.pem; # managed by Certbot
|
||||||
|
ssl_certificate_key /etc/letsencrypt/live/example.com/privkey.pem; # managed by Certbot
|
||||||
|
|
||||||
|
access_log /var/log/nginx/kosync_access.log;
|
||||||
|
error_log /var/log/nginx/kosync_error.log;
|
||||||
|
|
||||||
|
|
||||||
|
location / {
|
||||||
|
proxy_pass http://localhost:3003;
|
||||||
|
}
|
||||||
|
}
|
Loading…
Reference in a new issue