mirror of
https://github.com/dehydrated-io/dehydrated.git
synced 2026-07-05 20:51:48 +02:00
Improve documentation on wildcards
Improve the documentation on how to use wildcard domains. Also give more examples in the docs/examples/domains.txt file.
This commit is contained in:
committed by
Lukas Schauer
parent
9f1ff67870
commit
7c40c727a0
+60
-10
@@ -1,22 +1,72 @@
|
|||||||
### domains.txt
|
## domains.txt
|
||||||
|
|
||||||
dehydrated uses the file `domains.txt` as configuration for which certificates should be requested.
|
dehydrated uses the file `domains.txt` as configuration for which certificates
|
||||||
|
should be requested.
|
||||||
|
|
||||||
The file should have the following format:
|
The file should have the following format:
|
||||||
|
|
||||||
```text
|
```text
|
||||||
|
example.org
|
||||||
example.com www.example.com
|
example.com www.example.com
|
||||||
example.net www.example.net wiki.example.net
|
example.net www.example.net wiki.example.net
|
||||||
|
```
|
||||||
|
|
||||||
|
This states that there are the following certificates:
|
||||||
|
* `example.org` without any *alternative names*
|
||||||
|
* `example.com` with an *alternative name* of `www.example.com`
|
||||||
|
* `example.net` with the *alternative names*: `www.example.net` and
|
||||||
|
`wiki.example.net`
|
||||||
|
|
||||||
|
### Aliases
|
||||||
|
|
||||||
|
You can define an *alias* for your certificate which will (instead of the
|
||||||
|
primary domain) be used as the directory name under your `CERTDIR` and for a
|
||||||
|
per-certificate lookup. This is done using the `>` character. This allows
|
||||||
|
multiple certificates with identical sets of domains but different
|
||||||
|
configuration to exist.
|
||||||
|
|
||||||
|
Here is an example of using an *alias* called `certalias` for creating the
|
||||||
|
certificate for `example.net` with *alternative names* `www.example.net` and
|
||||||
|
`wiki.example.net`. The certificate will be stored in the directory `certalias`
|
||||||
|
under your `CERTDIR`.
|
||||||
|
|
||||||
|
```text
|
||||||
example.net www.example.net wiki.example.net > certalias
|
example.net www.example.net wiki.example.net > certalias
|
||||||
```
|
```
|
||||||
|
|
||||||
This states that there should be two certificates `example.com` and `example.net`,
|
### Wildcards
|
||||||
with the other domains in the corresponding line being their alternative names.
|
|
||||||
|
|
||||||
You can define an alias for your certificate which will (instead of the primary domain) be
|
Support for wildcards was added by the ACME v2 protocol.
|
||||||
used as directory name under your certdir and for a per-certificate lookup.
|
|
||||||
This allows multiple certificates with identical sets of domains but different configuration
|
|
||||||
to exist.
|
|
||||||
|
|
||||||
Certificates with a wildcard domain as first (or only) name require an alias to be set.
|
Certificates with a wildcard domain as the first (or only) name require an
|
||||||
Aliases can't start with `*.`.
|
*alias* to be set. *Aliases* can't start with `*.`.
|
||||||
|
|
||||||
|
For example to create the wildcard for `*.service.example.com` your
|
||||||
|
`domains.txt` could use the *alias* method like this:
|
||||||
|
|
||||||
|
```text
|
||||||
|
*.service.example.com > star_service_example_com
|
||||||
|
```
|
||||||
|
|
||||||
|
This creates a wildcard certificate for only `*.service.example.com` and will
|
||||||
|
store it in the directory `star_service_example_com` under your `CERTDIR`. As a
|
||||||
|
note this certificate will **NOT** be valid for `service.example.com` but only
|
||||||
|
for `*.service.example.com`. So it would, for example, be valid for
|
||||||
|
`foo.service.example.com`.
|
||||||
|
|
||||||
|
|
||||||
|
Another way to create it is using *alternative names*. For example your
|
||||||
|
`domains.txt` could do this:
|
||||||
|
|
||||||
|
```text
|
||||||
|
service.example.com *.service.example.com
|
||||||
|
eggs.example.com *.ham.example.com
|
||||||
|
```
|
||||||
|
|
||||||
|
This creates two certificates one for `service.example.com` with an
|
||||||
|
*alternative name* of `*.service.example.com` and a second certificate for
|
||||||
|
`eggs.example.com` with an *alternative name* of `*.ham.example.com`.
|
||||||
|
|
||||||
|
**Note:** The first certificate is valid for both `service.example.com` and for
|
||||||
|
`*.service.example.com` which can be a useful way to create wildcard
|
||||||
|
certificates.
|
||||||
|
|||||||
@@ -1,2 +1,30 @@
|
|||||||
|
# Create certificate for 'example.org' with an alternative name of
|
||||||
|
# 'www.example.org'. It will be stored in the directory ${CERT_DIR}/example.org
|
||||||
example.org www.example.org
|
example.org www.example.org
|
||||||
|
|
||||||
|
# Create certificate for 'example.com' with alternative names of
|
||||||
|
# 'www.example.com' & 'wiki.example.com'. It will be stored in the directory
|
||||||
|
# ${CERT_DIR}/example.com
|
||||||
example.com www.example.com wiki.example.com
|
example.com www.example.com wiki.example.com
|
||||||
|
|
||||||
|
# Using the alias 'certalias' create certificate for 'example.net' with
|
||||||
|
# alternate name 'www.example.net' and store it in the directory
|
||||||
|
# ${CERTDIR}/certalias
|
||||||
|
example.net www.example.net > certalias
|
||||||
|
|
||||||
|
# Using the alias 'service_example_com' create a wildcard certificate for
|
||||||
|
# '*.service.example.com' and store it in the directory
|
||||||
|
# ${CERTDIR}/service_example_com
|
||||||
|
# NOTE: It is NOT a certificate for 'service.example.com'
|
||||||
|
*.service.example.com > service_example_com
|
||||||
|
|
||||||
|
# Using the alias 'star_service_example_org' create a wildcard certificate for
|
||||||
|
# '*.service.example.org' with an alternative name of `service.example.org'
|
||||||
|
# and store it in the directory ${CERTDIR}/star_service_example_org
|
||||||
|
# NOTE: It is a certificate for 'service.example.org'
|
||||||
|
*.service.example.org service.example.org > star_service_example_org
|
||||||
|
|
||||||
|
# Create a certificate for 'service.example.net' with an alternative name of
|
||||||
|
# '*.service.example.net' (which is a wildcard domain) and store it in the
|
||||||
|
# directory ${CERTDIR}/service.example.net
|
||||||
|
service.example.net *.service.example.net
|
||||||
|
|||||||
Reference in New Issue
Block a user