Skip to content

Commit

Permalink
feat(docs): explanation of ssl usage (#1797)
Browse files Browse the repository at this point in the history
  • Loading branch information
jonasvoelcker authored May 31, 2024
1 parent 2387557 commit bf43660
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions docs/docs/configuration/others.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,22 @@
> Since AKHQ is based on [Micronaut](https://micronaut.io/), you can customize configurations (server port, ssl, ...) with [Micronaut configuration](https://docs.micronaut.io/snapshot/guide/configurationreference.html#io.micronaut.http.server.HttpServerConfiguration).
> More information can be found on [Micronaut documentation](https://docs.micronaut.io/snapshot/guide/index.html#config)
### Activating SSL

When using HTTPS for communication, Micronaut will need to get the certificate within Netty. This uses classes of the java.base package which are no longer activated inside the JDK we use. The configuration at the bottom needs to be extended by this environment variable:

```
JDK_JAVA_OPTIONS: --add-exports\=java.base/sun.security.x509\=ALL-UNNAMED
```

```yaml
micronaut:
server:
ssl:
enabled: true
build-self-signed: true
```
## JSON Logging
In order to configure AKHQ to output log in JSON format, a logback configuration needs to be provided, e.g. `logback.xml`
```
Expand Down

0 comments on commit bf43660

Please sign in to comment.