added documentation for SSL usage
authorDaniel Schregenberger <daniel@despite.ch>
Tue, 6 Oct 2015 16:53:14 +0000 (18:53 +0200)
committerDaniel Schregenberger <daniel@despite.ch>
Tue, 6 Oct 2015 16:53:14 +0000 (18:53 +0200)
README.md

index 9561a80..08ef76d 100644 (file)
--- a/README.md
+++ b/README.md
@@ -36,6 +36,19 @@ Usage: ./ympd [OPTION]...
  --help                     this help
 ```
 
+SSL Support
+-----------
+To run ympd with SSL support:
+
+- create a certificate (key and cert in the same file), example:
+```
+# openssl req -x509 -newkey rsa:2048 -keyout key.pem -out cert.pem -days 1000 -nodes
+# cat key.pem cert.pem > ssl.pem
+```
+- tell ympd to use a webport using SSL and where to find the certificate: 
+```
+# ./ympd -w "ssl://8081:/path/to/ssl.pem"
+```
 
 Copyright
 ---------