diff --git a/README.md b/README.md new file mode 100644 index 0000000..2a10bb4 --- /dev/null +++ b/README.md @@ -0,0 +1,26 @@ +[Koreader Sync Server](https://github.com/koreader/koreader-sync-server) to sync [Koreader](https://github.com/koreader/koreader) devices. + +# Volumes +- `/var/lib/redis/` +- `/etc/ssl/nginx/:ro`: certificates must be here + +# Environment Variables +## CERT_NAME +- default: fullchain.pem + +Name of the certificate file. + +## KEY_NAME +- default: privkey.pem + +Name of the key file. + +# Ports +- 7200 + +# Capabilities +- CHOWN +- DAC_OVERRIDE +- NET_BIND_SERVICE +- SETGID +- SETUID