Proxy Usage

Pro Tip

We recommend using a transparent proxy! A transparent proxy can hide its settings, hence it is safer and requires no additional configuration on the target machine.

Warning

If your proxy setup breaks SSL connections (end-to-end encryption for HTTPS), then the Sandbox installation will NOT succeed, and you should perform an Offline Installation instead!

Info

This feature is available from Sandbox version 1.9.3

Proxy server configuration

The following URLs are recommended to bypass on the proxy server:

Sandbox server configuration

The following configuration is necessary for the installer and the product to work properly behind a non-transparent HTTP proxy.

Before Sandbox installation

Set the following configuration settings before installation.

Warning

These settings are only used during the installation process to prepare the environment for the Sandbox service!

If the proxy settings are changed after the installation, please apply the changes mentioned in the next section OR repeat the installation process to make sure that the Sandbox service uses the updated configuration!

System-wide proxy configuration

Update the /etc/environment config, copy the proxy variables to the end of the file as described below. This will be used by tools like WGET, CURL, APT.

Warning

Always set the NO_PROXY variable to precisely match the example below. The IP address ranges: 172.16.0.0/12 and 192.168.0.0/16 are used by Docker, do not reuse them for other purposes.

Please use your own proxy URL instead of the example proxy.example.com:3128.

Info

The proxy format is <protocol>://<user>:<password>@<domain or IP address>:<port> where <user> and <password> are URL encoded strings.

http_proxy=http://proxy.example.com:3128 https_proxy=https://proxy.example.com:3128 HTTP_PROXY=http://proxy.example.com:3128 HTTPS_PROXY=https://proxy.example.com:3128 NO_PROXY=localhost,172.16.0.0/12,192.168.0.0/16,fsio,broker,transform,reverse_proxy

Once the file is updated log out and log in again for these changes to take effect:

exit

Docker proxy configuration

Create the docker daemon proxy configuration file.

sudo mkdir -p /etc/systemd/system/docker.service.d sudo touch /etc/systemd/system/docker.service.d/http-proxy.conf

Update the proxy settings similarly to the system-wide proxy configuration:

[Service] Environment="HTTP_PROXY=http://proxy.example.com:3128" Environment="HTTPS_PROXY=https://proxy.example.com:3128" Environment="NO_PROXY=localhost,172.16.0.0/12,192.168.0.0/16,fsio,broker,transform,reverse_proxy"

Optionally, if the docker daemon is already installed on your system, restart it:

sudo systemctl daemon-reload sudo service docker restart

Install Sandbox as described on the Installation page.

Warning

Online license activation is not working when a proxy is used!

Please follow the "Offline license activation" section of the License Activation page.

Proxy configuration change after Sandbox installation (optional)

Info

Sandbox components will use the proxy settings stored in /home/sandbox/.docker/config.json (this file is created/updated by the Sandbox installer).

It is possible to change the proxy configuration used by Sandbox components (Docker containers) without reinstalling Sandbox. If your proxy configuration changed, please modify the settings in /home/sandbox/.docker/config.json (the path may differ if you installed Sandbox under a different user):

{ "proxies": { "default": { "httpProxy": "http://proxy.example.com:3128", "httpsProxy": "https://proxy.example.com:3128", "noProxy": "localhost,172.16.0.0/12,192.168.0.0/16,fsio,broker,transform,reverse_proxy" } } }

Then please restart the sandbox service to remove and restart all Docker containers:

sudo service sandbox restart

You can check the currently used proxy configuration for a given Docker container, e.g. for transform :

docker inspect --format='{{range .Config.Env}}{{println .}}{{end}}' transform

This is the expected output:

HTTP_PROXY=http://proxy.example.com:3128 http_proxy=http://proxy.example.com:3128 HTTPS_PROXY=https://proxy.example.com:3128 https_proxy=https://proxy.example.com:3128 NO_PROXY=localhost,172.16.0.0/12,192.168.0.0/16,fsio,broker,transform,reverse_proxy no_proxy=localhost,172.16.0.0/12,192.168.0.0/16,fsio,broker,transform,reverse_proxy PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin UNAME=sandbox


Next to read:
Air-gapped Systems

See the "Technical Datasheet" for a complete list of features: https://docs.opswat.com/filescan/datasheet/technical-datasheet

On This Page
Proxy UsageProxy server configurationSandbox server configurationBefore Sandbox installationProxy configuration change after Sandbox installation (optional)System-wide proxy configurationDocker proxy configuration