diff options
| author | Wouter Tinus <wouter.tinus@gmail.com> | 2020-09-16 16:52:12 +0200 |
|---|---|---|
| committer | Wouter Tinus <wouter.tinus@gmail.com> | 2020-09-16 16:52:12 +0200 |
| commit | 58be2cbc3dbf8b78d4b7e2f524234b58cadc4df2 (patch) | |
| tree | d7b6c12068c12749422b1d31de6b8265a6363a51 /docs/reference/plugins/installation/script.md | |
| parent | d883566a704b2e2c0a7ceb0aaf7868568e4c47fc (diff) | |
| download | letsencrypt-win-simple-58be2cbc3dbf8b78d4b7e2f524234b58cadc4df2.zip letsencrypt-win-simple-58be2cbc3dbf8b78d4b7e2f524234b58cadc4df2.tar.gz letsencrypt-win-simple-58be2cbc3dbf8b78d4b7e2f524234b58cadc4df2.tar.bz2 | |
remove docs, they moved to a seperate repo log ago
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 |