diff options
Diffstat (limited to 'docs/manual')
-rw-r--r-- | docs/manual/renewal-management.md | 4 | ||||
-rw-r--r-- | docs/manual/upgrading/index.md | 3 | ||||
-rw-r--r-- | docs/manual/upgrading/to-v2.0.0.md | 6 | ||||
-rw-r--r-- | docs/manual/upgrading/to-v2.0.11.md | 15 | ||||
-rw-r--r-- | docs/manual/upgrading/to-v2.1.0.md | 12 |
5 files changed, 35 insertions, 5 deletions
diff --git a/docs/manual/renewal-management.md b/docs/manual/renewal-management.md index d017d22..4faad8b 100644 --- a/docs/manual/renewal-management.md +++ b/docs/manual/renewal-management.md @@ -44,7 +44,9 @@ The effects are the same as above. ## Revocation Revoking a certificate should only be done when the private key is believed to have been compromised, not when simply replacing or cancelling it. Revocation can be done from the main menu with -(`More options...` > `Revoke certificate`) +(`Manage renewals` > `Revoke certificate`) +- You can revoke from the command line using the arguments `--revoke [--friendlyname xxx|-id xxx]`. +The effects are the same as above. ## Internals Renewals are stored in the `ConfigPath` which typically means `%ProgramData%\win-acme\acme-v02.api.letsencrypt.org`, diff --git a/docs/manual/upgrading/index.md b/docs/manual/upgrading/index.md index fa114db..1e618d8 100644 --- a/docs/manual/upgrading/index.md +++ b/docs/manual/upgrading/index.md @@ -17,6 +17,9 @@ There are some cases when you might want to be a little more careful. rather than keeping the old file around. This is because the file also contains configuration information for the .NET CLR which has to match the build it's been generated for. +## Testing +It's recommended to review and test all scheduled renewals after an upgrade. + ## Migrations Some versions of win-acme have required or recommended migration steps, which are listed here. "v1.9.5" in this case means that you can or should read this if you're migrating from a version below 1.9.5 diff --git a/docs/manual/upgrading/to-v2.0.0.md b/docs/manual/upgrading/to-v2.0.0.md index b02f84e..40a74d8 100644 --- a/docs/manual/upgrading/to-v2.0.0.md +++ b/docs/manual/upgrading/to-v2.0.0.md @@ -22,5 +22,7 @@ a new one for the new version. The same thing can be accomplished unattended with the `--import` switch. -All imported renewals will immediately be 'expired', so it's a good idea to trigger a renew and check if -all goes well before declaring the conversion a success.
\ No newline at end of file +Note that the import process in versions before 2.1.4 will *not* create an account at the ACMEv2 server +for you, so you will have to set one up (by manually renewing once) before you will be able to renew with +the scheduled task. In any case it's a good idea to review the imported renewals and monitor the +progress of the first execution before declaring the conversion a success.
\ No newline at end of file diff --git a/docs/manual/upgrading/to-v2.0.11.md b/docs/manual/upgrading/to-v2.0.11.md new file mode 100644 index 0000000..86d3a72 --- /dev/null +++ b/docs/manual/upgrading/to-v2.0.11.md @@ -0,0 +1,15 @@ +--- +sidebar: manual +--- + +# Migration from v1.9.x to v2.0.11 +The following does not apply to you. Please just follow the steps for the +[v1.9.x to v2.0.x](/win-acme/manual/upgrading/to-v2.0.0) migration. + +# Migration from v2.0.x to v2.0.11 +You will have to delete the files `Registration_v2` and `Signer_v2` from the ConfigurationPath, +which is `%programdata%\win-acme` by default. Then you will have to manually renew once to +create a new account with the ACME server. + +The reason for this is that v2.0.11 runs on .NET Framework 4.6.1 which required us to drop support +for the elliptic curve account signers.
\ No newline at end of file diff --git a/docs/manual/upgrading/to-v2.1.0.md b/docs/manual/upgrading/to-v2.1.0.md index bdd5e4e..ad69253 100644 --- a/docs/manual/upgrading/to-v2.1.0.md +++ b/docs/manual/upgrading/to-v2.1.0.md @@ -3,7 +3,15 @@ sidebar: manual --- # Migration from v1.9.x to v2.1.x -You can follow the same instructions as listed for for [v1.9.x to v2.0.x](/win-acme/manual/upgrading/to-v2.0.0) +You can follow the same instructions as listed for for +[v1.9.x to v2.0.x](/win-acme/manual/upgrading/to-v2.0.0) +with some notable exceptions. + +Releases `2.1.4` and above will also ensure that there is an account for the +ACMEv2 server, so that an initial manual renewal is no longer required. +For fully unattended upgrades, you will therefor have to specify +`--import --emailaddress you@example.com --accepttos` on the command line so +that the account can be created without additional user input. # Migration from v2.0.x to v2.1.0 Version 2.1.0 is an xcopy update for "standard" users, but those who customized the program to fit their @@ -11,7 +19,7 @@ needs with `settings.config`, custom plugins or custom Serilog configuration wil these modifications. - Custom plugins will have to be modified to conform to the new async interfaces of this version of win-acme. -Also they will have to be targeted to build for .NET Core 3. Note that this does not affect installation or +Also they will have to be targeted to build for .NET Core 3.1. Note that this does not affect installation or DNS scripts, only additional `.dll`s. - settings.config has been replaced with [settings.json](/win-acme/reference/settings). The format is more readable and nicely structured, but if you have some custom settings, you will have to re-apply them. |