Skip to content

Commit 14bbc23

Browse files
committed
docs: document GIT_PROXY_HTTPS_UI_PORT and HTTPS UI/API server
1 parent a07b951 commit 14bbc23

3 files changed

Lines changed: 13 additions & 4 deletions

File tree

website/docs/configuration/overview.mdx

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,18 +47,24 @@ npx -- @finos/git-proxy --config ./config.json
4747
### Set ports with ENV variables
4848

4949
By default, GitProxy uses port 8000 to expose the Git Server and 8080 for the frontend application.
50-
The ports can be changed by setting the `GIT_PROXY_SERVER_PORT`, `GIT_PROXY_HTTPS_SERVER_PORT` (optional) and `GIT_PROXY_UI_PORT`
51-
environment variables:
50+
The ports can be changed by setting the `GIT_PROXY_SERVER_PORT`, `GIT_PROXY_HTTPS_SERVER_PORT` (optional),
51+
`GIT_PROXY_UI_PORT` and `GIT_PROXY_HTTPS_UI_PORT` (optional) environment variables:
5252

5353
```
5454
export GIT_PROXY_UI_PORT="5000"
55+
export GIT_PROXY_HTTPS_UI_PORT="5443"
5556
export GIT_PROXY_SERVER_PORT="9090"
5657
export GIT_PROXY_HTTPS_SERVER_PORT="9443"
5758
```
5859

5960
Note that `GIT_PROXY_UI_PORT` is needed for both server and UI Node processes,
6061
whereas `GIT_PROXY_SERVER_PORT` (and `GIT_PROXY_HTTPS_SERVER_PORT`) is only needed by the server process.
6162

63+
When [TLS is enabled](./reference#tls) via `tls.enabled` with valid `tls.key` and `tls.cert` paths,
64+
the UI/API server also listens on HTTPS on `GIT_PROXY_HTTPS_UI_PORT` (default `8444`) in parallel to
65+
the plain HTTP port. The same TLS credentials configured for the proxy are reused for the UI/API
66+
server.
67+
6268
By default, GitProxy CLI connects to GitProxy running on localhost and default port. This can be
6369
changed by setting the `GIT_PROXY_UI_HOST` and `GIT_PROXY_UI_PORT` environment variables:
6470

website/docs/deployment.mdx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,8 @@ The following environment variables can be set at container runtime:
172172
| Variable | Default | Description |
173173
| ------------------------ | ------------ | -------------------------------------------------------- |
174174
| `GIT_PROXY_SERVER_PORT` | `8000` | Proxy server port |
175-
| `GIT_PROXY_UI_PORT` | `8080` | UI/API server port |
175+
| `GIT_PROXY_UI_PORT` | `8080` | UI/API server port (HTTP) |
176+
| `GIT_PROXY_HTTPS_UI_PORT`| `8444` | UI/API server port (HTTPS, active when `tls.enabled`) |
176177
| `ALLOWED_ORIGINS` | (empty) | CORS allowed origins (comma-separated, or `*` for all) |
177178
| `API_URL` | (empty) | API URL for the UI (leave empty for same-origin) |
178179
| `NODE_ENV` | `production` | Node environment |
@@ -183,6 +184,7 @@ docker run -d \
183184
--name git-proxy \
184185
-p 8000:8000 \
185186
-p 8080:8080 \
187+
-p 8444:8444 \
186188
-e GIT_PROXY_UI_PORT=8080 \
187189
-e ALLOWED_ORIGINS="https://gitproxy.example.com" \
188190
-e NODE_ENV=production \

website/docs/quickstart/intercept.mdx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,8 @@ git remote set-url origin http://localhost:8000/<YOUR-GITHUB-USERNAME>/git-proxy
6262
git remote -v
6363
```
6464

65-
You can also try HTTPS with `git -c http.sslVerify=false remote set-url origin https://localhost:8443/<YOUR-GITHUB-USERNAME>/git-proxy.git`
65+
You can also try HTTPS with `git -c http.sslVerify=false remote set-url origin https://localhost:8443/<YOUR-GITHUB-USERNAME>/git-proxy.git`.
66+
When TLS is enabled, the UI and REST API are also served over HTTPS on port `8444` (configurable via `GIT_PROXY_HTTPS_UI_PORT`) in parallel to the plain HTTP port `8080`.
6667
:::note
6768

6869
SSH protocol is currently not supported, see [#27](https://github.com/finos/git-proxy/issues/27).

0 commit comments

Comments
 (0)