diff options
author | Wouter Tinus <win.acme.simple@gmail.com> | 2019-12-11 22:49:39 +0100 |
---|---|---|
committer | Wouter Tinus <win.acme.simple@gmail.com> | 2019-12-11 22:49:39 +0100 |
commit | 931284dcc007f96d34bd72a04069eede85d1f1a0 (patch) | |
tree | e5f73a855942ed5d586e5ecef33715a236c4e428 /docs/reference/plugins | |
parent | 1ba45dd171e22698b892fbaa9c6cc69181befb12 (diff) | |
download | letsencrypt-win-simple-931284dcc007f96d34bd72a04069eede85d1f1a0.zip letsencrypt-win-simple-931284dcc007f96d34bd72a04069eede85d1f1a0.tar.gz letsencrypt-win-simple-931284dcc007f96d34bd72a04069eede85d1f1a0.tar.bz2 |
add unit tests, update docs, rename classes
Diffstat (limited to 'docs/reference/plugins')
-rw-r--r-- | docs/reference/plugins/target/iis-binding.md | 10 | ||||
-rw-r--r-- | docs/reference/plugins/target/iis-site.md | 11 | ||||
-rw-r--r-- | docs/reference/plugins/target/iis-sites.md | 11 | ||||
-rw-r--r-- | docs/reference/plugins/target/iis.md | 46 | ||||
-rw-r--r-- | docs/reference/plugins/validation/dns/acme-dns.md | 3 |
5 files changed, 49 insertions, 32 deletions
diff --git a/docs/reference/plugins/target/iis-binding.md b/docs/reference/plugins/target/iis-binding.md deleted file mode 100644 index 9189853..0000000 --- a/docs/reference/plugins/target/iis-binding.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -sidebar: reference ---- - -# IIS binding -Create target based on a single binding of an IIS site. -- Automatically updates webroot path (useful for [FileSystem validation](/win-acme/reference/plugins/validation/http/filesystem)) - -## Unattended -`--target iisbinding --host example.com [--siteid 1]`
\ No newline at end of file diff --git a/docs/reference/plugins/target/iis-site.md b/docs/reference/plugins/target/iis-site.md deleted file mode 100644 index 8b4aeec..0000000 --- a/docs/reference/plugins/target/iis-site.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -sidebar: reference ---- - -# IIS site -Create target based on all bindings of an IIS site. -- Automatically updates webroot path (useful for [FileSystem validation](/win-acme/reference/plugins/validation/http/filesystem)) -- Automatically adds/removes host names based on bindings - -## Unattended -`--target iissite --siteid 1 [--commonname common.example.com] [--excludebindings exclude.example.com]`
\ No newline at end of file diff --git a/docs/reference/plugins/target/iis-sites.md b/docs/reference/plugins/target/iis-sites.md deleted file mode 100644 index 573b148..0000000 --- a/docs/reference/plugins/target/iis-sites.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -sidebar: reference ---- - -# IIS sites -Create target based on all bindings of multiple IIS sites. -- Automatically updates webroot paths (useful for [FileSystem validation](/win-acme/reference/plugins/validation/http/filesystem)) -- Automatically adds/removes host names based on bindings - -## Unattended -`--target iissites --siteid 1,2,3 [--commonname common.example.com] [--excludebindings exclude.example.com]`
\ No newline at end of file diff --git a/docs/reference/plugins/target/iis.md b/docs/reference/plugins/target/iis.md new file mode 100644 index 0000000..b93e3ea --- /dev/null +++ b/docs/reference/plugins/target/iis.md @@ -0,0 +1,46 @@ +--- +sidebar: reference +--- + +# IIS +Create target based on bindings configured in IIS. +- Automatically updates webroot path (useful for [FileSystem validation](/win-acme/reference/plugins/validation/http/filesystem)) + +# Filtering bindings +While it's possible to create a certificate for all bindings in all sites, typically you will want to select some +specific bindings to create a certificate for. There are several filters available, that in some cases can also be +combined with eachother. + +## Site filters +You can choose to limit the certificate to specific websites by specifying a site identifier, or a comma seperated list +of them. The magic value `s` will dynamically target all current and future websites created on the server. + +## Binding filters +You can filter bindings by host name by specifically typing them out. It's also be possible to filter hosts by a pattern +or by a regular expression. + +### Pattern +You may use a `*` for a range of any characters and a `?` for any single character. For example: the pattern `example.*` +will match `example.net` and `example.com` (but not `my.example.com`). The pattern `?.example.com` will match +`a.example.com` and `b.example.com` (but not `www.example.com`). Note that multiple patterns can be combined by +comma seperating them. + +### Regex +If a pattern is not powerful enough for you, there is the ultimate solution of applying a regular expression to the +problem. [regex101.com](https://regex101.com/) is a nice tool to help test your regular expression. + +## Unattended +- ##### Single binding +`--target iis --host example.com [--siteid 1]` +- ##### Multiple bindings +`--target iis --host example.com,www.example.com [--siteid 1,2,3] [--commonname common.example.com]` +- ##### All bindings of a site +`--target iis --siteid 1 [--commonname common.example.com] [--excludebindings exclude.example.com]` +- ##### All bindings of multiple sites +`--target iis --siteid 1,2,3 [--commonname common.example.com] [--excludebindings exclude.example.com]` +- ##### All bindings of all sites +`--target iis --siteid s [--commonname common.example.com] [--excludebindings exclude.example.com]` +- ##### Binding pattern +`--target iis --host-pattern *.example.??? [--siteid 1,2,3] [--commonname common.example.com] [--excludebindings exclude.example.com]` +- ##### Binging regex +`--target iis --host-regex [a-z]{3}\.example(\.com|\.net) [--siteid 1,2,3] [--commonname common.example.com] [--excludebindings exclude.example.com]`
\ No newline at end of file diff --git a/docs/reference/plugins/validation/dns/acme-dns.md b/docs/reference/plugins/validation/dns/acme-dns.md index 8856cda..18f7f6a 100644 --- a/docs/reference/plugins/validation/dns/acme-dns.md +++ b/docs/reference/plugins/validation/dns/acme-dns.md @@ -9,6 +9,9 @@ endpoint is useful, but it is a security concern. As the readme of that project > "You are encouraged to run your own acme-dns instance." +It's possible to use basic authentication for your acme-dns service by specifying a url with +the format `https://user:password@acme-dns.example.com/` + ## Unattended Not supported, unless there is a pre-existing acme-dns registration for all the domains. The reason for this is that acme-dns requires you to create CNAME records. In the future this |