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.

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

Added documentation for gateway configuration files #418

Merged
merged 1 commit into from
Sep 4, 2024
Merged
Changes from all commits
Commits
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
42 changes: 42 additions & 0 deletions gateway/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
This folder contains configuration files and custom templates for geOrchestra Gateway.

## Documentation

Documentation can be found in [docs directory at root of georchestra-gateway](https://github.com/georchestra/georchestra-gateway/blob/ui_customization_doc/docs) repository.

## List of configuration files

#### `application.yaml`

Contains filters applicable to all transfers through the gateway, and general Spring settings.

#### `gateway.conf`

Contains access rules for all services available through the gateway.

Please see https://github.com/georchestra/georchestra-gateway/blob/main/docs/access-rules.adoc

#### `roles-mappings.yaml`

Allow to map roles returned by authentication providers to standardized geOrchestra roles.

Please see https://github.com/georchestra/georchestra-gateway/blob/main/docs/roles-mappings.adoc

#### `routes.yaml`

Contains list of routes for redirection to the correct service URL based on criterias (typically URL patterns but other criterias exists).
Also allows to apply additional filters on this route.

Please see https://cloud.spring.io/spring-cloud-gateway/reference/html

#### `security.yaml`

Contains all settings about authentication. Please see the following documents :
OAuth2 : https://github.com/georchestra/georchestra-gateway/blob/main/docs/authzn.adoc
Pre-authentication : https://github.com/georchestra/georchestra-gateway/blob/main/docs/pre-authentication.adoc

## Templates

If needed, default pages can be overriden by custom templates. This includes login, logout page, and error pages. Only existing templates will override default ones.

Please see https://github.com/georchestra/georchestra-gateway/blob/main/docs/ui-customization.adoc
Loading