diff options
author | WouterTinus <wouter.tinus@gmail.com> | 2019-08-26 07:06:41 +0200 |
---|---|---|
committer | WouterTinus <wouter.tinus@gmail.com> | 2019-08-26 07:06:41 +0200 |
commit | 833289e1538f868166a5dd5f9613893e770e8c93 (patch) | |
tree | 806ee04ac9cf7dfeabdd87ff3905d917e3ff5f48 /docs/reference/plugins/installation | |
parent | a60811a02dc9eaccf233946557b3e00e01bb3176 (diff) | |
download | letsencrypt-win-simple-833289e1538f868166a5dd5f9613893e770e8c93.zip letsencrypt-win-simple-833289e1538f868166a5dd5f9613893e770e8c93.tar.gz letsencrypt-win-simple-833289e1538f868166a5dd5f9613893e770e8c93.tar.bz2 |
adopt bugfixes fluentcommandlineparser
Diffstat (limited to 'docs/reference/plugins/installation')
-rw-r--r-- | docs/reference/plugins/installation/iisftp.md | 11 | ||||
-rw-r--r-- | docs/reference/plugins/installation/iisweb.md | 33 | ||||
-rw-r--r-- | docs/reference/plugins/installation/index.md | 17 | ||||
-rw-r--r-- | docs/reference/plugins/installation/script.md | 42 |
4 files changed, 99 insertions, 4 deletions
diff --git a/docs/reference/plugins/installation/iisftp.md b/docs/reference/plugins/installation/iisftp.md index 9cbb12c..416e5fb 100644 --- a/docs/reference/plugins/installation/iisftp.md +++ b/docs/reference/plugins/installation/iisftp.md @@ -1,3 +1,12 @@ --- sidebar: reference ----
\ No newline at end of file +--- + +# IIS FTP +Create or update FTP site bindings in IIS, according to the following logic: + +- Any existing FTP sites linked to the previous certificate are updated to use the new certificate. +- The target FTP site will be updated to use the new certificate. + +## Unattended +``--installation iisftp [--installationsiteid x]`
\ No newline at end of file diff --git a/docs/reference/plugins/installation/iisweb.md b/docs/reference/plugins/installation/iisweb.md index 9cbb12c..2a04dc1 100644 --- a/docs/reference/plugins/installation/iisweb.md +++ b/docs/reference/plugins/installation/iisweb.md @@ -1,3 +1,34 @@ --- sidebar: reference ----
\ No newline at end of file +--- + +# IIS Web +Create or update website bindings in IIS, according to the following logic: + +- Existing https bindings in *any* site linked to the previous certificate are updated to use the new certificate. +- Hosts names which are determined to not yet have been covered by any existing binding, will be processed further. + - All existing https bindings in *target* site whose hostnames match with the new certificate are updated + to use the new certificate. This happens even if they are using certificates issued by other authorities. + (Note that if you want to prevent this from happening, you can use the `--excludebindings` switch). + - If no existing https binding can be found, a new binding is created. + - It will create bindings on the specified installation site and fall back to the target site if there is none. + - It will use port `443` on IP `*` unless different values are specified with the `--sslport` and/or + `--sslipaddress` switches. + - New bindings will be created or updated for matching host headers with the most specific match. E.g. if you + generate a certificate for `a.b.c.com`, the order of preference for the binding creation/change will be: + 1. a.b.c.com + 2. *.b.c.com + 3. *.c.com + 4. *.com + 5. Default (emtpy) binding + - If the certificate contains a wildcard domain, the order of preference will be: + 1. *.a.b.c.com + 2. x.a.b.c.com + - In both cases, the first preferred option will be created from scratch if none of the later options + are available. + - In some cases the plugin will not be able to (safely) add a new binding on older versions of IIS, e.g. due to + lack of support for SNI and/or wildcard bindings. In that case the user will have to create them manually. + Renewals will still be automatic after this initial manual setup. + +## Unattended +`--installation iis [--installationsiteid x] [-sslport x] [--sslipaddress x]`
\ No newline at end of file diff --git a/docs/reference/plugins/installation/index.md b/docs/reference/plugins/installation/index.md index 9cbb12c..1cfd89a 100644 --- a/docs/reference/plugins/installation/index.md +++ b/docs/reference/plugins/installation/index.md @@ -1,3 +1,18 @@ --- sidebar: reference ----
\ No newline at end of file +--- + +# Installation plugins +Installation plugins are responsible for making the necessary changes to your +application(s) after successfully creating or renewing a certificate. Currently +there are three of these plugins. + +## Multiple +More than one plugin can run by choosing them in order of execution. In interactive mode you +will be asked, for unattended mode you can provide a comma seperated list, +e.g. `--installation certificatestore,pemfiles` + +## Default +In simple mode the default installation plugin is [IIS Web](/win-acme/reference/plugins/installation/iisweb). +In full options and unattended modes there are no default installation steps, you have to explicitly +choose them from the interface or using the `--installation` switch.
\ No newline at end of file diff --git a/docs/reference/plugins/installation/script.md b/docs/reference/plugins/installation/script.md index 9cbb12c..8951bde 100644 --- a/docs/reference/plugins/installation/script.md +++ b/docs/reference/plugins/installation/script.md @@ -1,3 +1,43 @@ --- sidebar: reference ----
\ No newline at end of file +--- + +# Script +Runs an external script or executable after a succesful renewal. This may be a `.bat`, `.ps1` or even `.exe`. +You provide the program with the path to the script and it will run automatically. + +## Parameters +The following variables can be provided from the program to the script as command line arguments. + +``` +{0} or {CertCommonName} - Common name (primary domain name) +{1} or {CachePassword} - The .pfx password (generated randomly for each renewal) +{2} or {CacheFile} - Full path of the cached.pfx file +{4} or {CertFriendlyName} - Friendly name of the generated certificate +{5} or {CertThumbprint} - Thumbprint of the generated certificate +{7} or {RenewalId} - Id of the renewal + +{3} or {6} or {StorePath} - Path or store name used by the store plugin +{StoreType} - Name of the plugin (CentralSsl, CertificateStore or PemFiles) +``` + +## Example +If you need your scripts parameters to look something like this: + +`action=import file=C:\mydomain.pfx password=*****` + +Then your argument string should look like this: + +`action=import file={CacheFile} password={CachePassword}` + +## Unattended +`--installation script --script C:\script.bat [--scriptparameters x]` + +### Parameter escaping +If you need to put double quotes around your parameters from the command line, you have to escape them with a slash, for example: + +`--scriptparameters "action=import file=\"{CacheFile}\" password=\"{CachePassword}\""` + +For **Powershell** scripts, string parameters can also be delimited with **single** quotes, for example: + +`--scriptparameters "action=import file='{CacheFile}' password='{CachePassword}'"` |