github
/
acme4j
mirror of https://github.com/shred/acme4j
1
0
Fork 0
Code Issues Releases Wiki Activity

Update migration docs

feature/mock
Richard Körber 2019-12-07 15:34:12 +01:00
parent 5910e7106a
commit d93fa03bc7
No known key found for this signature in database
GPG Key ID: AAB9FD19C78AA3E0
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
src/doc/docs/migration.md
View File

@ -2,6 +2,17 @@
This document will help you migrate your code to the latest _acme4j_ version.
## Migration to Version 2.8
- Challenges can now be found by their class type instead of a type string, which makes finding a challenge type safe. I recommend to migrate your code to this new way. The classic way is not deprecated and will not be removed though. Example:
```java
Http01Challenge challenge = auth.findChallenge(Http01Challenge.TYPE); // old style: by name
Http01Challenge challenge = auth.findChallenge(Http01Challenge.class); // new style: by type
```
- `Login.bindChallenge()` was documented, but missing. It is available now. If you used a custom solution to bind challenges, you can now use the official way.
## Migration to Version 2.7
- Note that _acme4j_ has an `Automatic-Module-Name` set in the acme-client and acme-utils modules now. If you have added _acme4j_ to your Java 9+ module dependencies, you'll need to fix your dependency declaration to `org.shredzone.acme4j` (acme-client) and `org.shredzone.acme4j.utils` (acme-utils).
@ -18,6 +29,9 @@ This document will help you migrate your code to the latest _acme4j_ version.
- The GET compatibility mode has been removed. It also means that the `postasget=false` parameter is ignored from now on. If you need it to connect to your ACME server, do not update to this version until your ACME server has been fixed to support ACME draft 15.
!!! warning
_acme4j_ before version 2.5 will not work with providers like Let's Encrypt any more!
## Migration to Version 2.4
- There was a major change in ACME draft 15. If you use _acme4j_ in a common way, it will transparently take care of everything in the background, so you won't even notice the change.