From 410879748da81bb76d385b09dfc5638104abe46d Mon Sep 17 00:00:00 2001 From: Jonas Kaninda Date: Sun, 10 Nov 2024 20:19:46 +0100 Subject: [PATCH] docs: update deployment --- README.md | 12 +++++++++--- docs/index.md | 7 ++++--- 2 files changed, 13 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 256d2d9..0feb5da 100644 --- a/README.md +++ b/README.md @@ -54,9 +54,7 @@ It's designed to be straightforward and efficient, offering features, like: - JWT `client authorization based on the result of a request` - Basic-Auth - OAuth -- Rate limiting - - In-Memory Token Bucket based - - In-Memory client IP based +- Rate limiting, In-Memory client IP based - Limit HTTP methods allowed for a particular route. ### Todo: @@ -121,12 +119,20 @@ services: - [x] Windows Please download the binary from the [release page](https://github.com/jkaninda/goma-gateway/releases). +Init configs: + +```shell +./goma config init --output config.yml +``` To run ```shell ./goma server --config config.yml ``` + + + ## Deployment - Docker diff --git a/docs/index.md b/docs/index.md index f7c0c5b..2680fb5 100644 --- a/docs/index.md +++ b/docs/index.md @@ -20,6 +20,9 @@ It's designed to be straightforward and efficient, offering features, like: - Cross-Origin Resource Sharing (CORS) - Custom Headers - Backend Errors interceptor +- Logging +- Metrics +- Supports Load Balancing, round-robin algorithm - Support TLS - Block common exploits middleware - Patterns to detect SQL injection attempts @@ -28,9 +31,7 @@ It's designed to be straightforward and efficient, offering features, like: - JWT `client authorization based on the result of a request` - Basic-Auth - OAuth -- Rate limiting - - In-Memory Token Bucket based - - In-Memory client IP based +- Rate limiting, In-Memory client IP based - Limit HTTP methods allowed for a particular route.