Skip to content

Commit a876c2f

Browse files
ixxeL2097Frederic Spiers
andauthored
docs(readme): remove deprecated docker-compose deployment instructions (#68)
Co-authored-by: Frederic Spiers <[email protected]>
1 parent ef2ab1b commit a876c2f

File tree

1 file changed

+1
-48
lines changed

1 file changed

+1
-48
lines changed

README.md

Lines changed: 1 addition & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -32,54 +32,7 @@ In summary, the setup process involves the following steps:
3232
**ggbridge** is distributed as a Distroless Docker image based on Wolfi OS, ensuring minimal dependencies and enhanced security.
3333
Additionaly, a **shell** variant of the Docker image is available, this version includes additional tools and allows you to connect to the container via a shell, facilitating troubleshooting and debugging during development or integration.
3434

35-
The project offers two deployment methods:
36-
37-
- **Docker Deployment**: Ideal for local testing or simpler use cases.
38-
- **Helm Chart Deployment**: The preferred method for production environments, offering enhanced configurability and scalability for Kubernetes setups.
39-
40-
### Docker deployment
41-
42-
> [!WARNING]
43-
> Please consider that [Docker deployment](#docker-deployment) mode is intended for testing purposes. We highly recommend using [Helm deployment](#helm-deployment) mode.
44-
45-
Deploy the ggbridge client via Docker Compose by performing the following actions:
46-
47-
- Create `docker-compose.yml` file
48-
49-
> [!IMPORTANT]
50-
> GGBridge is designed by default to work as HA, so it needs `3` client deployments to work properly. Ensure `replicas: 3` in your `docker-compose.yml` file. If you lower the replica count, it may result in an unstable bridge.
51-
>
52-
> ```yaml
53-
> services:
54-
> client:
55-
> deploy:
56-
> replicas: 3
57-
> ```
58-
59-
```yaml
60-
name: ggbridge
61-
62-
services:
63-
client:
64-
image: gitguardian/ggbridge:latest-shell
65-
environment:
66-
SERVER_ADDRESS: <my-subdomain>.ggbridge.gitguardian.com
67-
TLS_ENABLED: 'true'
68-
deploy:
69-
replicas: 3
70-
volumes:
71-
- ./tls/ca.crt:/etc/ggbridge/tls/ca.crt:ro
72-
- ./tls/tls.crt:/etc/ggbridge/tls/client.crt:ro
73-
- ./tls/tls.key:/etc/ggbridge/tls/client.key:ro
74-
- ./docker/nginx/nginx.local.conf:/etc/ggbridge/nginx.conf
75-
restart: on-failure
76-
```
77-
78-
- Run `docker-compose`
79-
80-
```shell
81-
docker compose up -d
82-
```
35+
The project can be deployed on Kubernetes-like infrastructure (k0s, k3s, Talos, EKS, GKE, AKS...). GGBridge leverages **Helm Chart Deployment** which is an industry standard method for production environements, offering enhanced configurability and scalability for Kubernetes setups.
8336

8437
### Helm deployment
8538

0 commit comments

Comments
 (0)