diff options
| author | Wouter Tinus <win.acme.simple@gmail.com> | 2020-10-02 06:04:59 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-10-02 06:04:59 +0200 |
| commit | 160ed1ad546b1a71d0d2a1557073b40983964bfe (patch) | |
| tree | 1e8a1afd3ee2e75c6ee5e10306fc6df1696b1470 /docs/reference/plugins/installation/script.md | |
| parent | c662521de225e4dd4078fc6f0c2d1adfe323e368 (diff) | |
| parent | f0390cc9d8d8ffe82c4641f1e09e06d1ca9e12ae (diff) | |
| download | letsencrypt-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/script.md')
| -rw-r--r-- | docs/reference/plugins/installation/script.md | 42 |
1 files changed, 0 insertions, 42 deletions
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 |