You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+30-2Lines changed: 30 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -39,10 +39,23 @@ The project offers two deployment methods:
39
39
40
40
### Docker deployment
41
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
+
42
45
Deploy the ggbridge client via Docker Compose by performing the following actions:
43
46
44
47
- Create `docker-compose.yml` file
45
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.
Edit your Helm values file to point to your bridge server and the secret created above
103
115
(see the [Helm chart values documentation](./helm/ggbridge) for all available configuration options):
104
116
117
+
> [!IMPORTANT]
118
+
> GGBridge is designed by default to work as HA, so it needs `3` client deployments to work properly. Leave it blank or ensure `deploymentCount: 3` in your `values.yaml` file.
119
+
>
120
+
> ```yaml
121
+
> deploymentCount: 3
122
+
> ```
123
+
105
124
```yaml
106
125
hostname: <my-subdomain>.ggbridge.gitguardian.com
107
126
108
127
image:
109
-
tag: latest-shell
128
+
tag: latest
110
129
111
130
tls:
112
131
enabled: true
@@ -117,6 +136,15 @@ tls:
117
136
key: tls.key
118
137
```
119
138
139
+
> [!TIP]
140
+
> If you need to debug the deployment, you can use the image `latest-shell` instead of `latest`. This image comes with embedded tooling for debugging purposes. :
141
+
>
142
+
> ```yaml
143
+
> image:
144
+
> tag: latest-shell
145
+
> ```
146
+
147
+
120
148
For **OpenShift** deployment, use the following values:
0 commit comments