diff options
Diffstat (limited to 'docs/manual/upgrading')
| -rw-r--r-- | docs/manual/upgrading/index.md | 31 | ||||
| -rw-r--r-- | docs/manual/upgrading/to-v1.9.5.md | 23 | ||||
| -rw-r--r-- | docs/manual/upgrading/to-v1.9.9.md | 21 | ||||
| -rw-r--r-- | docs/manual/upgrading/to-v2.0.0.md | 28 | ||||
| -rw-r--r-- | docs/manual/upgrading/to-v2.0.11.md | 15 | ||||
| -rw-r--r-- | docs/manual/upgrading/to-v2.1.0.md | 27 |
6 files changed, 0 insertions, 145 deletions
diff --git a/docs/manual/upgrading/index.md b/docs/manual/upgrading/index.md deleted file mode 100644 index 1e618d8..0000000 --- a/docs/manual/upgrading/index.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -sidebar: manual ---- - -# Upgrading -When evolving win-acme, we strive for backwards compatibility and in-place upgrades. A typical upgrade can be -deleting everything from the program directory and extracting the new files. This can even be automated by -tools like [Scoop](https://github.com/lukesampson/scoop). - -There are some cases when you might want to be a little more careful. - -- When you made changes to the script(s) included with the distributed .zip-file, you will probably want to - preserve those. We do accept PR's for scripts, so if they are the type of changes which others might find - useful too, please feel free to submit them. -- If you made changes to `wacs.exe.config`, you will probably want to preserve those. If that is the case - please be careful to use the newly released file as the baseline and make the necessary changes there, - 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 -to version 1.9.5 or higher. - -- [v1.9.5](/win-acme/manual/upgrading/to-v1.9.5) -- [v1.9.9](/win-acme/manual/upgrading/to-v1.9.9) -- [v2.0.0](/win-acme/manual/upgrading/to-v2.0.0) -- [v2.1.0](/win-acme/manual/upgrading/to-v2.0.0)
\ No newline at end of file diff --git a/docs/manual/upgrading/to-v1.9.5.md b/docs/manual/upgrading/to-v1.9.5.md deleted file mode 100644 index 01b0e3b..0000000 --- a/docs/manual/upgrading/to-v1.9.5.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -sidebar: manual ---- - -# Migration from <=1.9.4 to v1.9.5 -Version 1.9.5 and later store information in system-wide folders and registry locations by -default, but still support reading configuration data from user specific locations. As such -it is backwards compatible with 1.9.4 and earlier. - -## Registry (optional) -- Export the key `HKEY_CURRENT_USER\Software\letsencrypt-win-simple` -- Delete the key -- Open the .reg file with your favorite text editor -- Replace `HKEY_CURRENT_USER` for `HKEY_LOCAL_MACHINE` and save it -- Import the .reg file - -## File system (optional) -Move the folder `%appdata%\letsencrypt-win-simple` to `%programdata%\letsencrypt-win-simple`. -Make sure the original is deleted, because the program prefers the old one over the new one. - -## Scheduled task (optional) -It should be changed to run as `SYSTEM`. Running under a specific user does not seem to work -if the task is running without a password specified.
\ No newline at end of file diff --git a/docs/manual/upgrading/to-v1.9.9.md b/docs/manual/upgrading/to-v1.9.9.md deleted file mode 100644 index 9db6640..0000000 --- a/docs/manual/upgrading/to-v1.9.9.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -sidebar: manual ---- - -# Migration from v1.9.5+ to v1.9.9 -This version introduced the ability to store information about renewals in a file instead of -the registry. This has several advantages including easier replication, backups, etc. - -By default this is only enable for new clean installs, but you can migrate manually if -you want to. This assumes you already followed the [v1.9.5](/win-acme/manual/upgrading/to-v1.9.5) -steps, or your initial install was on that version or higher. If not, -replace `HKEY_LOCAL_MACHINE` with `HKEY_CURRENT_USER` and `%programdata%` with `%appdata%`. - -- Start `regedit.exe` -- Go to `HKEY_LOCAL_MACHINE\SOFTWARE\letsencrypt-win-simple\` -- For each key there take the following steps: - - Find the matching folder in your `ConfigurationPath`, which defaults to `%programdata%\letsencrypt-win-simple` - - E.g. the key `https://acme-v01.api.letsencrypt.org/` matches with the folder `httpsacme-v01.api.letsencrypt.org` - - Create a new file named `Renewals` in the matching folder - - Copy the contents of the registry subkey `Renewals` to that file -- Delete or rename `HKEY_LOCAL_MACHINE\SOFTWARE\letsencrypt-win-simple\` to make sure the program doesn't find it anymore.
\ No newline at end of file diff --git a/docs/manual/upgrading/to-v2.0.0.md b/docs/manual/upgrading/to-v2.0.0.md deleted file mode 100644 index 40a74d8..0000000 --- a/docs/manual/upgrading/to-v2.0.0.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -sidebar: manual ---- - -# Migration from v1.9.9+ to v2.0.x -Version 2.0.0 is **not** an xcopy update. Many small but potentially **breaking** changes have been made. -See the [release notes](https://github.com/PKISharp/win-acme/releases/tag/v2.0.0.177) for details. This -guide explains how to import the renewals, but you might need to take other steps depending on how you -use the tool. - -## Pre-upgrade -When using an old version of LEWS or win-acme (1.9.7 or older), it's recommended to upgrade to the latest -1.9.x version and forcing a renewal of all certificates before attempting to upgrade to 2.0.0. The reason -for this is that new versions of the 1.9.x series automatically apply some compatibility steps, which may -not have been fully tested for the built-in converter to 2.0.0. - -## Importing renewals -Importing from 1.9.x is pretty easy. In the main menu select the option `More options...` and then -`Import renewals from LEWS/WACS 1.9.x`. The program will locate, convert and import the renewals -from the previous version. It will also disable the scheduled task for the old version and create -a new one for the new version. - -The same thing can be accomplished unattended with the `--import` switch. - -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 deleted file mode 100644 index 86d3a72..0000000 --- a/docs/manual/upgrading/to-v2.0.11.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -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 deleted file mode 100644 index ad69253..0000000 --- a/docs/manual/upgrading/to-v2.1.0.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -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) -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 -needs with `settings.config`, custom plugins or custom Serilog configuration will have to re-apply some of -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.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. -- If you are using custom settings for Serilog, you will have to migrate them to a new file called -`serilog.json`. More details are available [here](/win-acme/manual/advanced-use/custom-logging).
\ No newline at end of file |