diff --git a/docs/guides/advanced-usage.md b/docs/guides/advanced-usage.md index 7ac7f2a3a..c917e08d5 100644 --- a/docs/guides/advanced-usage.md +++ b/docs/guides/advanced-usage.md @@ -4,6 +4,24 @@ sidebarDepth: 3 # Advanced usage +## Configuring proxy settings + +When you choose an on-premises deployment, it may be necessary to configure **Kargo** to use the corporate proxy server. +To use a proxy, you can set the environment variables `HTTP_PROXY`, `HTTPS_PROXY`, `FTP_PROXY` and `NO_PROXY`. + +Depending on the traffic type, set the required variables in your `.env` file: + +```env +HTTP_PROXY="http://USER:PASSWORD@PROXY_SERVER:PORT" +HTTPS_PROXY="https://USER:PASSWORD@PROXY_SERVER:PORT" +FTP_PROXY="http://USER:PASSWORD@PROXY_SERVER:PORT" +NO_PROXY="localhost" +``` + +::: warning +The `NO_PROXY` must at least contain the value `localhost` to let the Krawler jobs healthcheck work correctly. +::: + ## Using the API Gateway As a reminder, an API gateway allows you to map endpoints to a set of services or applications using url rules. Moreover it is possible to protect those endpoints using various authorization strategies ([Key authentication](https://en.wikipedia.org/wiki/Key_authentication), [JSON Web Tokens](https://jwt.io/), [OAuth](https://oauth.net/2/)...) and defining quotas and rate limiting. To enable such a features **Kargo** relies on [express gateway](https://www.express-gateway.io/). diff --git a/docs/tips/packaging-images.md b/docs/tips/packaging-images.md index a3f6b221f..85e1aee7f 100644 --- a/docs/tips/packaging-images.md +++ b/docs/tips/packaging-images.md @@ -39,4 +39,3 @@ for SERVICE in $DELIVERY; do done rclone copy archives s3:bucket/path --include *.gz ``` -