]> git.street.me.uk Git - andy/dehydrated.git/commitdiff
moved and rewritten config section of readme
authorLukas Schauer <lukas@schauer.so>
Thu, 5 Jan 2017 23:38:13 +0000 (00:38 +0100)
committerLukas Schauer <lukas@schauer.so>
Thu, 5 Jan 2017 23:38:13 +0000 (00:38 +0100)
README.md

index c57a07457cd674c2f1d7893241901371ccd4c3de..a0daf2af1a6061d53f008ff434531feafe6b6965 100644 (file)
--- a/README.md
+++ b/README.md
@@ -26,6 +26,18 @@ Generally you want to set up your WELLKNOWN path first, and then fill in domains
 
 If you have any problems take a look at our [Troubleshooting](docs/troubleshooting.md) guide.
 
+## Config
+
+dehydrated is looking for a config file in a few different places, it will use the first one it can find in this order:
+
+- `/etc/dehydrated/config`
+- `/usr/local/etc/dehydrated`
+- The current working directory of your shell
+- The directory from which dehydrated was ran
+
+Have a look at [docs/examples/config](docs/examples/config) to get started, copy it to e.g. `/etc/dehydrated/config`
+and edit it to fit your needs.
+
 ## Usage:
 
 ```text
@@ -57,6 +69,3 @@ Parameters:
  --challenge (-t) http-01|dns-01  Which challenge should be used? Currently http-01 and dns-01 are supported
  --algo (-a) rsa|prime256v1|secp384r1 Which public key algorithm should be used? Supported: rsa, prime256v1 and secp384r1
 ```
-## Config
-
-To change the default configuration you can copy [docs/examples/config](docs/examples/config) to the base dir and edit the file.