Skip to content

Commit

Permalink
docs(auth): added JWT secret env var docs (#1090)
Browse files Browse the repository at this point in the history
relate to #1062
  • Loading branch information
danielhass authored May 9, 2022
1 parent 49cf846 commit b23e459
Showing 1 changed file with 17 additions and 3 deletions.
20 changes: 17 additions & 3 deletions docs/docs/configuration/authentifications/jwt.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,14 @@
# JWT

AKHQ uses JWT tokens to perform authentication.
Please generate a secret that is at least 256 bits and change the config like this:
AKHQ uses signed JWT tokens to perform authentication.

Please generate a secret that is at least 256 bits.

You can use one of the following methods to provide the generated secret to AKHQ.

## Configuration File

Provide the generated secret via the AKHQ `application.yml` via the following directive:

```yaml
micronaut:
Expand All @@ -12,6 +19,13 @@ micronaut:
signatures:
secret:
generator:
secret: <Your secret here>
secret: <your secret here>
```
## Environment Variable
Provide the generated secret via [Micronaut Property Value Binding](https://docs.micronaut.io/latest/guide/index.html#_property_value_binding) using the following environment variable for the execution environment of AKHQ:
```bash
MICRONAUT_SECURITY_TOKEN_JWT_SIGNATURES_SECRET_GENERATOR_SECRET="<your secret here>"
```

0 comments on commit b23e459

Please sign in to comment.