Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

📝 gateway document features #61

Merged
merged 4 commits into from
Aug 14, 2024
Merged

📝 gateway document features #61

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d6c67cd
:memo: gateway document features
simonhir Aug 12, 2024
e92b90e
Merge branch 'main' into feature/gateway-docs
simonhir Aug 12, 2024
832defd
Update refarch-gateway/README.md
simonhir Aug 14, 2024
9bc48c6
Merge branch 'main' into feature/gateway-docs
simonhir Aug 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions refarch-gateway/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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).
Expand Down