summaryrefslogtreecommitdiffstats
path: root/docs/reference/plugins/installation
diff options
context:
space:
mode:
authorWouter Tinus <win.acme.simple@gmail.com>2020-10-02 06:04:59 +0200
committerGitHub <noreply@github.com>2020-10-02 06:04:59 +0200
commit160ed1ad546b1a71d0d2a1557073b40983964bfe (patch)
tree1e8a1afd3ee2e75c6ee5e10306fc6df1696b1470 /docs/reference/plugins/installation
parentc662521de225e4dd4078fc6f0c2d1adfe323e368 (diff)
parentf0390cc9d8d8ffe82c4641f1e09e06d1ca9e12ae (diff)
downloadletsencrypt-win-simple-160ed1ad546b1a71d0d2a1557073b40983964bfe.zip
letsencrypt-win-simple-160ed1ad546b1a71d0d2a1557073b40983964bfe.tar.gz
letsencrypt-win-simple-160ed1ad546b1a71d0d2a1557073b40983964bfe.tar.bz2
Merge pull request #1672 from win-acme/2.1.11v2.1.11
2.1.11
Diffstat (limited to 'docs/reference/plugins/installation')
-rw-r--r--docs/reference/plugins/installation/iisftp.md12
-rw-r--r--docs/reference/plugins/installation/iisweb.md34
-rw-r--r--docs/reference/plugins/installation/index.md21
-rw-r--r--docs/reference/plugins/installation/script.md42
4 files changed, 0 insertions, 109 deletions
diff --git a/docs/reference/plugins/installation/iisftp.md b/docs/reference/plugins/installation/iisftp.md
deleted file mode 100644
index 393179c..0000000
--- a/docs/reference/plugins/installation/iisftp.md
+++ /dev/null
@@ -1,12 +0,0 @@
----
-sidebar: reference
----
-
-# 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 [--ftpsiteid x]` \ No newline at end of file
diff --git a/docs/reference/plugins/installation/iisweb.md b/docs/reference/plugins/installation/iisweb.md
deleted file mode 100644
index c9d2cef..0000000
--- a/docs/reference/plugins/installation/iisweb.md
+++ /dev/null
@@ -1,34 +0,0 @@
----
-sidebar: reference
----
-
-# 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/empty 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
deleted file mode 100644
index a031317..0000000
--- a/docs/reference/plugins/installation/index.md
+++ /dev/null
@@ -1,21 +0,0 @@
----
-sidebar: reference
----
-
-# 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 (simple mode)
-In simple mode the default installation plugin is [IIS Web](/win-acme/reference/plugins/installation/iisweb).
-
-## Default (full options / unattended)
-In full options and unattended modes there are **no** default installation steps,
-which is equivalent to `--installation none`. You can 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
deleted file mode 100644
index 561a52a..0000000
--- a/docs/reference/plugins/installation/script.md
+++ /dev/null
@@ -1,42 +0,0 @@
----
-sidebar: reference
----
-
-# 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.
-
-| Value | Replaced with |
-|----------------|----------------|
-| `{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 (first) 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}'"` \ No newline at end of file