From 74c913cd0c8a7942eecf99b8f4f1e96163cbc945 Mon Sep 17 00:00:00 2001 From: Tobias Kussel Date: Fri, 12 Dec 2025 11:26:42 +0100 Subject: [PATCH] Add documentation for proxy (credential) special character escaping --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d0e462a..b66e11f 100644 --- a/README.md +++ b/README.md @@ -73,7 +73,7 @@ We recommend to install Docker(-compose) from its official sources as described A Bridgehead communicates to all central components via outgoing HTTPS connections. -Your site might require an outgoing proxy (i.e. HTTPS forward proxy) to connect to external servers; you should discuss this with your local systems administration. In that case, you will need to note down the URL of the proxy. If the proxy requires authentication, you will also need to make a note of its username and password. This information will be used later on during the installation process. TLS terminating proxies are also supported, see [here](#tls-terminating-proxies). Apart from the Bridgehead itself, you may also need to configure the proxy server in [git](https://gist.github.com/evantoli/f8c23a37eb3558ab8765) and [docker](https://docs.docker.com/network/proxy/). +Your site might require an outgoing proxy (i.e. HTTPS forward proxy) to connect to external servers; you should discuss this with your local systems administration. In that case, you will need to note down the URL of the proxy. If the proxy requires authentication, you will also need to make a note of its username and password. This information will be used later on during the installation process. Special characters in the proxy values, e.g. in the access credentials, must be [URL-encoded](https://en.wikipedia.org/wiki/Percent-encoding), e.g. by replacing `@` with `%40`, `/` with `%2F` and so on. TLS terminating proxies are also supported, see [here](#tls-terminating-proxies). Apart from the Bridgehead itself, you may also need to configure the proxy server in [git](https://gist.github.com/evantoli/f8c23a37eb3558ab8765) and [docker](https://docs.docker.com/network/proxy/). The following URLs need to be accessible (prefix with `https://`): * To fetch code and configuration from git repositories @@ -536,6 +536,8 @@ and restart the docker daemon: sudo systemctl restart docker ``` +Please note that special characters in the proxy value, such as `#?!()[]{}`, must be double escaped using `%%`. + For more information, please consult the [official documentation](https://docs.docker.com/config/daemon/systemd/#httphttps-proxy). ### Monitoring