Merge pull request #65 from jkaninda/docs

docs: update configuration example
This commit is contained in:
2024-11-07 00:01:53 +01:00
committed by GitHub
3 changed files with 18 additions and 6 deletions

View File

@@ -44,7 +44,7 @@ It comes with a lot of integrated features, such as:
- Cross-Origin Resource Sharing (CORS) - Cross-Origin Resource Sharing (CORS)
- Custom Headers - Custom Headers
- Backend Errors interceptor - Backend Errors interceptor
- Support TLS - Support TLS
- Authentication middleware - Authentication middleware
- JWT `client authorization based on the result of a request` - JWT `client authorization based on the result of a request`
- Basic-Auth - Basic-Auth
@@ -57,6 +57,7 @@ It comes with a lot of integrated features, such as:
- [ ] OAuth authentication middleware — Optional - [ ] OAuth authentication middleware — Optional
- [ ] Distributed Rate Limiting for In-Memory client IP based across multiple instances using Redis - [ ] Distributed Rate Limiting for In-Memory client IP based across multiple instances using Redis
- [ ] Blocklist IP address middleware - [ ] 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 \ docker run --rm --name goma-gateway \
-v "${PWD}/config:/config" \ -v "${PWD}/config:/config" \
-p 80:80 \ -p 80:80 \
-p 443:443 \
jkaninda/goma-gateway server --config /config/config.yml jkaninda/goma-gateway server --config /config/config.yml
``` ```
### 4. Healthcheck ### 4. Healthcheck

View File

@@ -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. 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.
It also supports database __encryption__ using GPG.
## Available image registries ## Available image registries

View File

@@ -9,8 +9,21 @@ nav_order: 3
The Route allows you to match on HTTP traffic and direct it to the backend. 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 ```yaml
# Goma Gateway configurations # Goma Gateway configurations