Browse Source

Flesh out the README

pull/4/head
Chris Smith 8 years ago
parent
commit
54e483bfb4
1 changed files with 23 additions and 3 deletions
  1. 23
    3
      README.md

+ 23
- 3
README.md View File

@@ -27,7 +27,13 @@ are understood:
27 27
 
28 28
 ## Usage
29 29
 
30
-TODO: Finish this!
30
+Create a named volume for your nginx config, if you don't already have one:
31
+
32
+```
33
+docker volume create --name nginx-config
34
+```
35
+
36
+This should be mounted at `/nginx-config`.
31 37
 
32 38
 Then run this container. It takes the same arguments as `service-reporter`:
33 39
 
@@ -41,6 +47,20 @@ Then run this container. It takes the same arguments as `service-reporter`:
41 47
 And some additional arguments:
42 48
 
43 49
 ```
44
-  --cert-path (default: /letsencrypt/certs/%s/fullchain.pem) path to the SSL cert. Use '%s' for the primary vhost.
45
-  --cert-key-path (default: /letsencrypt/certs/%s/privkey.pem) path to the SSL cert's private key. Use '%s' for the primary vhost.
50
+  --cert-path (default: /letsencrypt/certs/%s/fullchain.pem) path to the SSL cert.
51
+  --cert-key-path (default: /letsencrypt/certs/%s/privkey.pem) path to the SSL cert's private key.
52
+```
53
+
54
+For certificate paths, '%s' will be replaced with the (primary) vhost for each
55
+site.
56
+
57
+So running the container will look something like:
58
+
59
+```
60
+docker run -d \
61
+  --name service-nginx \
62
+  --restart always \
63
+  -v nginx-config:/nginx-config \
64
+  csmith/service-nginx:latest
46 65
 ```
66
+

Loading…
Cancel
Save