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

Explain version numbering of ACME v2 releases

pull/38/head
Richard Körber 2017-08-13 13:45:27 +02:00
parent 627a13cd93
commit 434329c6d5
1 changed files with 9 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -22,11 +22,18 @@ It is an independent open source implementation that is not affiliated with or e
* See the [online documentation](https://shredzone.org/maven/acme4j/) about how to use _acme4j_. * See the [online documentation](https://shredzone.org/maven/acme4j/) about how to use _acme4j_.
* For a quick start, have a look at [the source code of an example](https://github.com/shred/acme4j/blob/master/acme4j-example/src/main/java/org/shredzone/acme4j/ClientTest.java). * For a quick start, have a look at [the source code of an example](https://github.com/shred/acme4j/blob/master/acme4j-example/src/main/java/org/shredzone/acme4j/ClientTest.java).
## Compatibility ## Future Compatibility
This version of _acme4j_ is tailor-made for _Let's Encrypt_ and other CAs that use the [Boulder](https://github.com/letsencrypt/boulder) server and the "ACME v1" protocol. This version of _acme4j_ is tailor-made for _Let's Encrypt_ and other CAs that use the [Boulder](https://github.com/letsencrypt/boulder) server and the "ACME v1" protocol.
Support for the latest [ACME v2](https://letsencrypt.org/2017/06/14/acme-v2-api.html) protocol is currently being implemented in the ["draft" branch](https://github.com/shred/acme4j/tree/draft) of _acme4j_. _Let's Encrypt_ will offer an ACME v2 API endpoint by January 2018. ACME v1 is deprecated and will be replaced by ACME v2 in the near future. _Let's Encrypt_ [has announced](https://letsencrypt.org/2017/06/14/acme-v2-api.html) to offer an ACME v2 API endpoint by January 2018. There is no end of life date for ACME v1 at the moment.
To prepare your software for ACME v2, you can use _acme4j_ available in the ["draft" branch](https://github.com/shred/acme4j/tree/draft), which fully supports the ACME v2 protocol, but is not downward compatible to ACME v1. A first release of this branch will be available at Maven Central in due time.
Make sure to set the correct major version in your dependencies:
* _acme4j_ version 0.xx → ACME v1 protocol. **This is what you want for production code at the moment.**
* _acme4j_ version 1.xx → ACME v2 protocol. The "draft" branch. Not meant for production yet.
## Contribute ## Contribute