.. _proxy:

Proxy configuration
###################

This tutorial shows you how to configure your system for use behind an
outbound proxy to access the Internet.

|CL-ATTR| applications already benefit from the :ref:`autoproxy`
feature.

.. contents::
    :local:
    :depth: 1

Prerequisites
*************

* You have installed |CL| on your host system.

  For detailed instructions on installing |CL| on a bare metal system, visit
  the :ref:`bare metal installation guide <bare-metal-install-desktop>`.

Shells and programs in a desktop session
****************************************

Terminal
========

Add the following to your ~/.bashrc:

.. code-block:: bash

   export http_proxy=http://your.http-proxy.url:port
   export https_proxy=http://your.https-proxy.url:port
   export ftp_proxy=http://your.ftp-proxy.url:port
   export socks_proxy=http://your.socks-proxy.url:port
   export no_proxy=".your-company-domain.com,localhost"
   export HTTP_PROXY=$http_proxy
   export HTTPS_PROXY=$https_proxy
   export FTP_PROXY=$ftp_proxy
   export SOCKS_PROXY=$socks_proxy
   export NO_PROXY=$no_proxy

wget
====

Run the following command to enable downloading from websites from the terminal:

.. code-block:: bash

   echo >> ~/.wgetrc <<EOF
   http_proxy = your.http-proxy.url:port
   https_proxy = your.https-proxy.url:port
   ftp_proxy = your.http-proxy.url:port
   no_proxy = your-company-domain.com, localhost
   EOF

System service (Docker\*)
=========================

For Docker (and other services that use systemd), follow these steps to
configure and check proxy settings.

.. note::

   Use :command:`sudo`, as you will need elevated permissions.

#. Create the :file:`/etc/systemd/system/docker.service.d` directory to host
   configuration information for the Docker service.

#. Create the :file:`/etc/systemd/system/docker.service.d/http-proxy.conf`
   and add the following lines:

   .. code-block:: bash

      [Service]
      Environment="HTTP_PROXY=http://your.http-proxy.url:port/"
      Environment="HTTPS_PROXY=http://your.https-proxy.url:port/"

#. Load the changes and restart the service.

   .. code-block:: bash

      sudo systemctl daemon-reload
      sudo systemctl restart docker

#. Verify that changes have loaded.

   .. code-block:: bash

      systemctl show --property=Environment docker

   .. code-block:: console

      Environment=HTTP_PROXY=http://your.http-proxy.url:port/ HTTPS_PROXY=http://your.https-proxy.url:port/

.. note::

   This process enables the ability to successfully run ``docker pull``.
   Containers themselves must be configured independently.

git over ssh
************

Add the following to your :file:`~/.ssh/config`:

.. code-block:: bash

   host github.com
        port 22
        user git
        ProxyCommand connect-proxy -S your.ssh-proxy.url:port %h %p

.. note::

   Though netcat is included with |CL|, it is not the BSD version,
   which is the one usually used to enable git over ssh.