Merge pull request #99 from jkaninda/docs

Docs

README.md

@@ -56,10 +56,10 @@ It's designed to be straightforward and efficient, offering features, like:
   - OAuth 
 - Rate limiting, In-Memory client IP based
 - Limit HTTP methods allowed for a particular route.
+- Distributed rate limiting, client IP based using Redis
 
 ### Todo:
   - [ ] Blocklist IP address middleware
-  - [ ] Distributed Rate Limiting for In-Memory client IP based across multiple instances using Redis
 
 ----
 

docs/index.md

@@ -33,6 +33,8 @@ It's designed to be straightforward and efficient, offering features, like:
   - OAuth
 - Rate limiting, In-Memory client IP based
 - Limit HTTP methods allowed for a particular route.
+- Distributed rate limiting, client IP based using Redis
+
 
 
 Declare your routes and middlewares as code.

docs/quickstart/distrubuted-intance.md

@@ -0,0 +1,29 @@
+---
+title: Distributed instances
+layout: default
+parent: Quickstart
+nav_order: 5
+---
+
+
+# Distributed instances
+
+```yaml
+version: "1.0"
+gateway:
+  sslCertFile: cert.pem
+  sslKeyFile: key.pem
+  writeTimeout: 15
+  readTimeout: 15
+  idleTimeout: 30
+  rateLimit: 60 # peer minute
+  blockCommonExploits: false
+  accessLog: /dev/Stdout
+  errorLog: /dev/stderr
+  logLevel: ''
+  ## Redis connexion for distributed rate limiting; when using multiple instances | It's optional
+  redis:
+    addr: redis:6379
+    password: password
+```
+

examples/configMap.yaml

@@ -4,7 +4,7 @@ metadata:
   name: goma-config
 data:
   goma.yml: |
-      # Goma Gateway configurations
+    # Goma Gateway configurations
     version: 1.0
     gateway:
       # Proxy write timeout
@@ -22,6 +22,10 @@ data:
       logLevel: info # debug, trace, off
       accessLog:    "/dev/Stdout"
       errorLog:     "/dev/stderr"
+        ## Redis connexion for distributed rate limiting, when using multiple instances | It's optional
+        #redis:
+        #addr: redis:6379
+      # password: password
       ## Enable, disable routes health check
       disableHealthCheckStatus: false
       ## Returns backend route healthcheck errors

examples/goma.yml

@@ -16,6 +16,10 @@ gateway:
   logLevel: info # debug, trace, off
   accessLog:    "/dev/Stdout"
   errorLog:     "/dev/stderr"
+  ## Redis connexion for distributed rate limiting, when using multiple instances | It's optional
+  #redis:
+    #addr: redis:6379
+   # password: password
   ## Enable, disable routes health check
   disableHealthCheckStatus: false
   ## Returns backend route healthcheck errors

internal/middleware/block-common-exploits.go

@@ -41,7 +41,7 @@ func BlockExploitsMiddleware(next http.Handler) http.Handler {
 			pathTraversalPattern.MatchString(r.URL.Path) ||
 			xssPattern.MatchString(r.URL.RawQuery) {
 			logger.Error("%s: %s Forbidden - Potential exploit detected", getRealIP(r), r.URL.Path)
-			RespondWithError(w, http.StatusForbidden, fmt.Sprintf("%d Forbidden - Potential exploit detected", http.StatusForbidden))
+			RespondWithError(w, http.StatusForbidden, fmt.Sprintf("%d Forbidden", http.StatusForbidden))
 			return
 
 		}
@@ -52,7 +52,7 @@ func BlockExploitsMiddleware(next http.Handler) http.Handler {
 					for _, value := range values {
 						if sqlInjectionPattern.MatchString(value) || xssPattern.MatchString(value) {
 							logger.Error("%s: %s %s Forbidden - Potential exploit detected", getRealIP(r), r.Method, r.URL.Path)
-							RespondWithError(w, http.StatusForbidden, fmt.Sprintf("%d Forbidden - Potential exploit detected", http.StatusForbidden))
+							RespondWithError(w, http.StatusForbidden, fmt.Sprintf("%d Forbidden", http.StatusForbidden))
 							return
 						}
 					}