Merge pull request #60 from com-pas/update-readme

Update README.md

Author: Rob Tjalma

README.md

@@ -16,7 +16,7 @@ SPDX-License-Identifier: Apache-2.0
 You can run your application in dev mode that enables live coding using:
 
 ```shell script
-./mvnw package io.quarkus:quarkus-maven-plugin:2.4.1.Final:dev
+./mvnw package io.quarkus:quarkus-maven-plugin::dev
 ```
 
 > **_NOTE:_**  Quarkus now ships with a Dev UI, which is available in dev mode only at http://localhost:8080/q/dev/.
@@ -29,8 +29,8 @@ The application can be packaged using:
 ./mvnw package
 ```
 
-It produces the `quarkus-run.jar` file in the `app/target/quarkus-app/` directory. Be aware that it’s not an _über-jar_ as
-the dependencies are copied into the `app/target/quarkus-app/lib/` directory.
+It produces the `quarkus-run.jar` file in the `app/target/quarkus-app/` directory. Be aware that it’s not an _über-jar_
+as the dependencies are copied into the `app/target/quarkus-app/lib/` directory.
 
 If you want to build an _über-jar_, execute the following command:
 
@@ -56,5 +56,28 @@ Or, if you don't have GraalVM installed, you can run the native executable build
 
 You can then execute your native executable with: `./app/target/code-with-quarkus-local-SNAPSHOT-runner`
 
-If you want to learn more about building native executables, please consult https://quarkus.io/guides/maven-tooling.html.
+If you want to learn more about building native executables, please consult https://quarkus.io/guides/maven-tooling.html
+.
 
+## Environment variables
+
+Below environment variable(s) can be used to configure which claims are used to fill user information, for instance Who
+in History Record.
+
+| Environment variable   | Java Property                 | Description                                   | Example |
+|------------------------|-------------------------------|-----------------------------------------------|---------|
+| USERINFO_WHO_CLAIMNAME | compas.userinfo.who.claimname | The Name of the user used in the Who History. | name    |
+
+## Security
+
+To use most of the endpoints the users needs to be authenticated using JWT in the authorization header. There are 4
+environment variables that can be set in the container to configure the validation/processing of the JWT.
+
+| Environment variable | Java Property                    | Description                                        | Example                                                                |
+|----------------------|----------------------------------|----------------------------------------------------|------------------------------------------------------------------------|
+| JWT_VERIFY_KEY       | smallrye.jwt.verify.key.location | Location of certificates to verify the JWT.        | http://localhost:8089/auth/realms/compas/protocol/openid-connect/certs |
+| JWT_VERIFY_ISSUER    | mp.jwt.verify.issuer             | The issuer of the JWT.                             | http://localhost:8089/auth/realms/compas                               |
+| JWT_VERIFY_CLIENT_ID | mp.jwt.verify.audiences          | The Client ID that should be in the "aud" claim.   | scl-auto-alignment                                                     |
+| JWT_GROUPS_PATH      | smallrye.jwt.path.groups         | The JSON Path where to find the roles of the user. | resource_access/scl-auto-alignment/roles                               |
+
+There are no roles defined in this service, only need to be authenticated.