Skip to content

Commit

Permalink
Update migration docs
Browse files Browse the repository at this point in the history
  • Loading branch information
shred committed Dec 7, 2019
1 parent 5910e71 commit d93fa03
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions src/doc/docs/migration.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand All @@ -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.
Expand Down

0 comments on commit d93fa03

Please sign in to comment.