From 1e02e37ff326f1f066be850f9710bddcbef64c26 Mon Sep 17 00:00:00 2001 From: Jonas Kaninda Date: Thu, 7 Nov 2024 00:00:58 +0100 Subject: [PATCH] docs: update configuration example --- README.md | 4 +++- docs/index.md | 5 +---- docs/route.md | 15 ++++++++++++++- 3 files changed, 18 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index bce469c..9c579e8 100644 --- a/README.md +++ b/README.md @@ -44,7 +44,7 @@ It comes with a lot of integrated features, such as: - Cross-Origin Resource Sharing (CORS) - Custom Headers - Backend Errors interceptor -- Support TLS +- Support TLS - Authentication middleware - JWT `client authorization based on the result of a request` - Basic-Auth @@ -57,6 +57,7 @@ It comes with a lot of integrated features, such as: - [ ] OAuth authentication middleware — Optional - [ ] Distributed Rate Limiting for In-Memory client IP based across multiple instances using Redis - [ ] Blocklist IP address middleware + - [x] Block common exploits middleware ---- @@ -88,6 +89,7 @@ docker run --rm --name goma-gateway \ docker run --rm --name goma-gateway \ -v "${PWD}/config:/config" \ -p 80:80 \ + -p 443:443 \ jkaninda/goma-gateway server --config /config/config.yml ``` ### 4. Healthcheck diff --git a/docs/index.md b/docs/index.md index 54efa3f..59b11aa 100644 --- a/docs/index.md +++ b/docs/index.md @@ -40,10 +40,7 @@ We are open to receiving stars, PRs, and issues! --- -The [jkaninda/goma-gateway](https://hub.docker.com/r/jkaninda/goma-gateway) Docker image can be deployed on Docker, Docker Swarm and Kubernetes. - -It also supports database __encryption__ using GPG. - +The [jkaninda/goma-gateway](https://hub.docker.com/r/jkaninda/goma-gateway) Docker image can be deployed on Docker, Docker in Swarm mode, and Kubernetes. ## Available image registries diff --git a/docs/route.md b/docs/route.md index a8bd2cb..cabd948 100644 --- a/docs/route.md +++ b/docs/route.md @@ -9,8 +9,21 @@ nav_order: 3 The Route allows you to match on HTTP traffic and direct it to the backend. +### Example of a route -### Create a route +```yaml + - name: Example + path: /store/cart + rewrite: /cart + destination: http://cart-service:8080 + healthCheck: '' + cors: {} + middlewares: + - api-forbidden-paths + - jwt-auth +``` + +### Full example of routes and middlewares ```yaml # Goma Gateway configurations