Skip to content

Commit f6a5f7b

Browse files
author
Romain Jouhannet
committed
Readme update: replicas for docker, version for helm, docker compose up -d
1 parent 11d6d5b commit f6a5f7b

File tree

1 file changed

+14
-7
lines changed

1 file changed

+14
-7
lines changed

README.md

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -23,11 +23,11 @@ For detailed GGBridge configuration instructions on the GitGuardian platform, pl
2323

2424
In summary, the setup process involves the following steps:
2525

26-
1. **Request Bridge Access**
27-
2. **Create Your Bridge**
28-
3. **Configure the Bridge Client**
29-
4. **Configure URL Mapping** (if not done during creation)
30-
5. **Configure Your Integrations**
26+
1. Request Bridge Access
27+
2. Create Your Bridge
28+
3. Configure the Bridge Client
29+
4. Configure URL Mapping
30+
5. Configure Your Integrations
3131

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.
@@ -52,6 +52,9 @@ services:
5252
environment:
5353
SERVER_ADDRESS: <my-subdomain>.ggbridge.gitguardian.com
5454
TLS_ENABLED: 'true'
55+
deploy:
56+
mode: replicated
57+
replicas: 3
5558
volumes:
5659
- ./tls/ca.crt:/etc/ggbridge/tls/ca.crt:ro
5760
- ./tls/tls.crt:/etc/ggbridge/tls/client.crt:ro
@@ -63,7 +66,7 @@ services:
6366
- Run `docker-compose`
6467

6568
```shell
66-
docker compose up
69+
docker compose up -d
6770
```
6871

6972
### Helm deployment
@@ -96,11 +99,15 @@ kubectl -n ggbridge create secret generic ggbridge-client-crt \
9699

97100
4. Configure your Helm values.yaml
98101

99-
Edit your Helm values file to point to your bridge server and the secret created above:
102+
Edit your Helm values file to point to your bridge server and the secret created above
103+
(see the [Helm chart values documentation](./helm/ggbridge) for all available configuration options):
100104

101105
```yaml
102106
hostname: <my-subdomain>.ggbridge.gitguardian.com
103107
108+
image:
109+
tag: latest-shell
110+
104111
tls:
105112
enabled: true
106113
existingSecret: ggbridge-client-crt

0 commit comments

Comments
 (0)