docs: add Docker deployment example

This commit is contained in:
2024-11-04 06:00:28 +01:00
parent d94aefb53f
commit 803c8f09dc
3 changed files with 46 additions and 6 deletions

View File

@@ -4,9 +4,9 @@ layout: home
nav_order: 1
---
# About Goma Gateway
# Goma Gateway
{:.no_toc}
Goma Gateway is a lightweight API Gateway.
Goma Gateway is a lightweight API Gateway Management.
<img src="https://raw.githubusercontent.com/jkaninda/goma-gateway/main/logo.png" width="150" alt="Goma logo">
@@ -29,6 +29,7 @@ It comes with a lot of integrated features, such as:
Declare your routes and middlewares as code.
----
Architecture:
<img src="https://raw.githubusercontent.com/jkaninda/goma-gateway/main/goma-gateway.png" width="912" alt="Goma archi">
@@ -64,7 +65,7 @@ While it may work against different implementations, there are no guarantees abo
## References
We decided to publish this image as a simpler and more lightweight alternative because of the following requirements:
We decided to publish this image as a simpler and more lightweight because of the following requirements:
- The original image is based on `Alpine` and requires additional tools, making it heavy.
- This image is written in Go.

View File

@@ -27,6 +27,25 @@ docker run --rm --name goma-gateway \
- Goma Gateway readiness: `/readyz`
- Routes health check: `/healthz`
### 5. Simple deployment in docker compose file
```yaml
services:
goma-gateway:
image: jkaninda/goma-gateway
command: server
healthcheck:
test: curl -f http://localhost/readyz || exit 1
interval: 30s
retries: 5
start_period: 20s
timeout: 10s
ports:
- "80:80"
volumes:
- ./config:/config/
```
## Customize configuration file
Example of a configuration file