Skip to content

Commit

Permalink
docs: Update changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
morihofi committed Jun 7, 2024
1 parent c6cab0e commit b507075
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 12 deletions.
40 changes: 30 additions & 10 deletions CHANGELOG.MD
Original file line number Diff line number Diff line change
Expand Up @@ -20,31 +20,51 @@
- PostgreSQL database is now officially tested and supported (most recent version)

## 2.0-rc2

- removed org.json dependency
- Moved code from `Database` class into its identifiers for better code cleanness
- built-in support for Mozilla's SSL Config JSONs
- `*.cab` CA download support for legacy Windows Mobile 5+ devices
- Legacy CA download page for legacy user agents (IE 9 and older, incl. Pocket PC); Must be used with Mozilla's old ssl config and enabled `allowLegacyResumption` in configuration to access web UI using https
- Legacy CA download page for legacy user agents (IE 9 and older, incl. Pocket PC); Must be used with Mozilla's old ssl
config and enabled `allowLegacyResumption` in configuration to access web UI using https
- Database connection pool is now only in debug mode disabled
- IP issuing support can now be manually enabled/disabled for a provisioner
- Better error message when a IP Address has been used in an `dns`-identifier instead of an `ip`-identifier
- Logger in classes is now private and final everywhere and has been renamed from `log` to `LOG`

## 2.0

- Database reconnect no longer fails
- Better documentation

## 2.0.1

- Dependency Updates
- org.hibernate.orm:hibernate-core 6.4.4.Final to 6.4.5.Final
- org.slf4j:jul-to-slf4j from 2.0.12 to 2.0.13
- jakarta.interceptor:jakarta.interceptor-api from 2.1.0 to 2.2.0
- com.github.spotbugs:spotbugs-annotations from 4.8.3 to 4.8.4
- org.hibernate.orm:hibernate-core 6.4.4.Final to 6.4.5.Final
- org.slf4j:jul-to-slf4j from 2.0.12 to 2.0.13
- jakarta.interceptor:jakarta.interceptor-api from 2.1.0 to 2.2.0
- com.github.spotbugs:spotbugs-annotations from 4.8.3 to 4.8.4

## 2.1

- Frontend Updates
- Removed JTE (Server Side Rendering) for Web UI
- Removed legacy CA download page --> Download CA using direct link
- Use NuxtJS for WebUI
- No CDN resources more needed for UI to display
- Improved REST API
- Removed JTE (Server Side Rendering) for Web UI
- Removed legacy CA download page --> Download CA using direct link
- Use NuxtJS for WebUI
- No CDN resources more needed for UI to display
- Troubleshooting Options
- DNS Query tester
- Backend Updates:
- Configuration scheme for Proxy and Networking changed, see documentation
- Custom DNS Server support and DNS over HTTPS support added
- Usage of proxy is now fully used by ACME Server for all web requests (HTTP-Challenge or Version Check, ...)
- Dedicated HTTP Access Log configurable with nginx like syntax. See documentation for more details
- API
- Swagger and OpenAPI support (beta), on `/swagger` URL
- Reimplemented API
- ACME Protocol
- Support for `notAfter` property in `new-order` Endpoint, thanks to @Gabanna
- Dependency Updates
- org.hibernate.orm:hibernate-core 6.4.5.Final to 6.5.1.Final
- io.javalin:javalin from 6.1.3 to 6.1.6
- com.github.spotbugs:spotbugs-annotations from 4.8.4 to 4.8.5.
7 changes: 5 additions & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ It will tell you what to do next.

If you don't use a released JAR, you need to build it yourself.

### Prerequisites
### Build Prerequisites

You'll need the following prerequisites to be able to build ACME Server

Expand Down Expand Up @@ -93,7 +93,7 @@ You MUST change the `dnsName` value to a DNS name (Not an IP-Address -> won't wo
server. It will be written into certificates, and also served in the ACME API.
You MAY change the ports serving the API and Website. If you set the `http`-Port to `0`, HTTP will be disabled.

It is RECOMMENDED to **not run** ACME Server behind a reverse proxy.
It is RECOMMENDED to **not run** ACME Server behind a reverse proxy. If you run it behind a reverse proxy, the ports MUST match.

```json
{
Expand All @@ -106,6 +106,7 @@ It is RECOMMENDED to **not run** ACME Server behind a reverse proxy.
"http": 80
},
"enableSniCheck": true,
"loggingDirectory": "./serverdata/logs",
"mozillaSslConfig": {
"enabled": false,
"version": "5.7",
Expand All @@ -120,6 +121,8 @@ It is RECOMMENDED to **not run** ACME Server behind a reverse proxy.
}
```

The Path to `loggingDirectory` can be null. The log files created in this directory have an Nginx like `access.log` syntax.

#### Information for standalone

ACME Server has the ability to configure TLS (Protocol that HTTPS uses) with the recommended configurations from the
Expand Down

0 comments on commit b507075

Please sign in to comment.