devbennett7/goma-gateway
1
0
Fork 0
Code Pull Requests Activity

docs: update deployment configurstion example

Browse Source
This commit is contained in:
Jonas Kaninda
2024-10-30 04:57:07 +01:00
parent aaee77f81d
commit 8ad0de5616
2 changed files with 6 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@@ -106,7 +106,7 @@ docker run --rm --name goma-gateway \
Create a config file in this format Create a config file in this format
## Customize configuration file ## Customize configuration file
Example of configuration file Example of a configuration file
```yaml ```yaml
## Goma - simple lightweight API Gateway and Reverse Proxy. ## Goma - simple lightweight API Gateway and Reverse Proxy.
# Goma Gateway configurations # Goma Gateway configurations
@@ -128,6 +128,7 @@ gateway:
disableRouteHealthCheckError: false disableRouteHealthCheckError: false
# Disable display routes on start # Disable display routes on start
disableDisplayRouteOnStart: false disableDisplayRouteOnStart: false
# disableKeepAlive allows enabling and disabling KeepALive server
disableKeepAlive: false disableKeepAlive: false
# interceptErrors intercepts backend errors based on defined the status codes # interceptErrors intercepts backend errors based on defined the status codes
interceptErrors: interceptErrors:
@@ -195,7 +196,7 @@ gateway:
- path: /path-example - path: /path-example
# Rules defines which specific middleware applies to a route path # Rules defines which specific middleware applies to a route path
rules: rules:
- jwtAuth - jwt
# path to protect # path to protect
- path: /admin - path: /admin
# Rules defines which specific middleware applies to a route path # Rules defines which specific middleware applies to a route path
@@ -205,7 +206,7 @@ gateway:
- path: /path-example - path: /path-example
# Rules defines which specific middleware applies to a route path # Rules defines which specific middleware applies to a route path
rules: rules:
- jwtAuth - jwt
- path: /history - path: /history
http: http:
url: http://security-service:8080/security/authUser url: http://security-service:8080/security/authUser
@@ -237,7 +238,7 @@ gateway:
#Defines proxy middlewares #Defines proxy middlewares
middlewares: middlewares:
# Enable Basic auth authorization based # Enable Basic auth authorization based
- name: local-auth-basic - name: basic-auth
# Authentication types | jwt, basic, OAuth # Authentication types | jwt, basic, OAuth
type: basic type: basic
rule: rule:

1
goma.yml
View File

@@ -18,6 +18,7 @@ gateway:
disableRouteHealthCheckError: false disableRouteHealthCheckError: false
# Disable display routes on start # Disable display routes on start
disableDisplayRouteOnStart: false disableDisplayRouteOnStart: false
# disableKeepAlive allows enabling and disabling KeepALive server
disableKeepAlive: false disableKeepAlive: false
# interceptErrors intercepts backend errors based on defined the status codes # interceptErrors intercepts backend errors based on defined the status codes
interceptErrors: interceptErrors: