Create README.md

2016-10-31 10:51:54 +01:00 · 2016-10-31 10:51:54 +01:00 · 1c0c096272
commit 1c0c096272
parent fb7d5db242
1 changed files with 26 additions and 0 deletions
--- a/README.md
+++ 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