From 15957f5289d7a6832bfe4fa87c0c9f00630d6972 Mon Sep 17 00:00:00 2001 From: Jonas Kaninda Date: Tue, 5 Nov 2024 12:44:26 +0100 Subject: [PATCH 1/2] docs: update configuration deployment --- README.md | 12 ++++++++---- docs/quickstart.md | 6 +++++- goma.yml | 6 +++++- 3 files changed, 18 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index c471544..f968511 100644 --- a/README.md +++ b/README.md @@ -44,6 +44,7 @@ It comes with a lot of integrated features, such as: - Cross-Origin Resource Sharing (CORS) - Custom Headers - Backend Errors interceptor +- TLS - Authentication middleware - JWT `client authorization based on the result of a request` - Basic-Auth @@ -53,11 +54,10 @@ It comes with a lot of integrated features, such as: ### Todo: - - [ ] Support TLS - - [ ] Blocklist IP address middleware - [ ] OAuth authentication middleware — Optional - - [ ] Distributed Rate Limiting for Token based across multiple instances using Redis - [ ] Distributed Rate Limiting for In-Memory client IP based across multiple instances using Redis + - [ ] Blocklist IP address middleware + ---- @@ -122,13 +122,17 @@ Example of a configuration file # Goma Gateway configurations gateway: ########## Global settings - listenAddr: 0.0.0.0:80 + listenAddr: :80 #:443 SSL # Proxy write timeout writeTimeout: 15 # Proxy read timeout readTimeout: 15 # Proxy idle timeout idleTimeout: 60 + ## SSL Certificate file + sslCertFile: '' #cert.pem + ## SSL Private Key file + sslKeyFile: ''#key.pem # Proxy rate limit, it's In-Memory IP based # Distributed Rate Limiting for Token based across multiple instances is not yet integrated rateLimiter: 0 diff --git a/docs/quickstart.md b/docs/quickstart.md index 21ed7f5..f04a3c9 100644 --- a/docs/quickstart.md +++ b/docs/quickstart.md @@ -57,13 +57,17 @@ Example of a configuration file # Goma Gateway configurations gateway: ########## Global settings - listenAddr: 0.0.0.0:80 + listenAddr: :80 #:443 SSL # Proxy write timeout writeTimeout: 15 # Proxy read timeout readTimeout: 15 # Proxy idle timeout idleTimeout: 60 + ## SSL Certificate file + sslCertFile: '' #cert.pem + ## SSL Private Key file + sslKeyFile: ''#key.pem # Proxy rate limit, it's In-Memory IP based # Distributed Rate Limiting for Token based across multiple instances is not yet integrated rateLimiter: 0 diff --git a/goma.yml b/goma.yml index 9b186bb..905e145 100644 --- a/goma.yml +++ b/goma.yml @@ -1,13 +1,17 @@ # Goma Gateway configurations gateway: ########## Global settings - listenAddr: 0.0.0.0:80 + listenAddr: :80 #:443 SSL # Proxy write timeout writeTimeout: 15 # Proxy read timeout readTimeout: 15 # Proxy idle timeout idleTimeout: 60 + ## SSL Certificate file + sslCertFile: '' #cert.pem + ## SSL Private Key file + sslKeyFile: ''#key.pem # Proxy rate limit, it's In-Memory IP based # Distributed Rate Limiting for Token based across multiple instances is not yet integrated rateLimiter: 0 From 5a24c5aa78853c9c23c189acbe537d82611691a1 Mon Sep 17 00:00:00 2001 From: Jonas Kaninda Date: Tue, 5 Nov 2024 12:46:02 +0100 Subject: [PATCH 2/2] docs: update configuration deployment --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index f968511..755cf78 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 -- TLS +- Support TLS - Authentication middleware - JWT `client authorization based on the result of a request` - Basic-Auth