📝 gateway document features (#61)

* 📝 gateway document features * Update refarch-gateway/README.md Co-authored-by: Tobias Stadler <[email protected]> --------- Co-authored-by: Tobias Stadler <[email protected]>
it-at-m · Aug 14, 2024 · 12b6fa4 · 12b6fa4
1 parent a3022e6
commit 12b6fa4
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/refarch-gateway/README.md b/refarch-gateway/README.md
@@ -1,10 +1,22 @@
 # RefArch Gateway
 
+RefArch gateway based on [Spring Cloud Gateway](https://spring.io/projects/spring-cloud-gateway).
+
 ## Usage
 
 The gateway is released as container image `ghcr.io/it-at-m/refarch/refarch-gateway` and can be used either directly or
 via the corresponding [Helm-Chart](https://github.com/it-at-m/helm-charts/tree/main/charts/refarch-gateway).
 
+## Features
+
+Beside the default functionality of Spring Cloud Gateway (i.e. routing) following features are preconfigured/provided:
+
+- OAuth 2.0 based login
+- Route protection
+- CSRF protection with whitelist
+- Cookie to JWT mapping for session management
+- Health and metrics endpoints
+
 ### Routing
 
 Routes are configured via environment variables as listed under [Configuration](#configuration).