Skip to content

Proxy Configuration ​

If your environment requires an outbound proxy, Butler Sheet Icons (BSI) can use standard proxy environment variables. This is useful when BSI needs Internet access (for example, downloading a browser on first run) or when your infrastructure routes outbound traffic through a proxy.

Supported variables:

  • http_proxy
  • https_proxy

Set these before starting BSI (binary or Docker). Examples below are sourced from the original project README.

Set proxy variables ​

bash
# Linux/macOS
export http_proxy='http://username:[email protected]:port'
export https_proxy='http://username:[email protected]:port'
powershell
# Windows/PowerShell
$env:http_proxy = 'http://username:[email protected]:port'
$env:https_proxy = 'http://username:[email protected]:port'

Using Docker ​

Pass the proxy variables into the container with -e or --env-file.

bash
docker run --rm \
  -e http_proxy='http://username:[email protected]:port' \
  -e https_proxy='http://username:[email protected]:port' \
  -v "$(pwd)/images:/nodeapp/img" \
  ptarmiganlabs/butler-sheet-icons:latest \
  qscloud create-sheet-thumbnails \
    --imagedir ./img \
    --headless true

Notes ​

  • The proxy variables affect outbound network calls made by BSI and the embedded browser downloads.
  • Clear or override the variables if not needed in certain contexts.
  • For CI/CD usage, see the CI/CD Integration page’s proxy section.

See also ​

Released under the MIT License.