diff --git a/docs/docs/configuration.md b/docs/docs/configuration.md index 82832ac7b..b833b4335 100644 --- a/docs/docs/configuration.md +++ b/docs/docs/configuration.md @@ -289,3 +289,25 @@ repo = icechunk.Repository.open( authorize_virtual_chunk_access=credentials, ) ``` + +## Proxy configuration + +Icechunk supports routing its requests through a proxy. This is useful when your object storage service itself is behind a proxy. + +!!! note + + Proxy support is currently only implemented for S3-compatible storage instances. + +Icechunk automatically detects proxy settings from environment variables: + +```bash +export HTTPS_PROXY=http://proxy.corp.com:8080 +export HTTP_PROXY=http://proxy.corp.com:8080 +``` + +No code changes are required. Icechunk checks proxy sources in this order: +1. `HTTPS_PROXY` / `https_proxy` - highest priority +2. `HTTP_PROXY` / `http_proxy` +3. `ALL_PROXY` / `all_proxy` + +Note that you must set the environment variable at the OS level, not via the python interpreter.