From 645c05a10fcfdba4fee267f5c783d3d1d22000e2 Mon Sep 17 00:00:00 2001
From: Kevin Putnam <kevin.putnam@intel.com>
Date: Mon, 17 Jun 2019 12:23:28 -0700
Subject: [PATCH] KP add proxy tutorial (#514)

* First commit of proxy tutorial

Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>

* First commit of new proxy tutorial content.

Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>

* Added additional content and some todo items.

Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>

* Removed todo list.

Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>

* Added requested proxy variables.

Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>

* Updates based on peer review.

Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>

* Fixed typo.

Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
---
 source/clear-linux/guides/guides.rst          |   2 +
 .../clear-linux/tutorials/tutorial-proxy.rst  | 115 ++++++++++++++++++
 source/clear-linux/tutorials/tutorials.rst    |   1 +
 3 files changed, 118 insertions(+)
 create mode 100644 source/clear-linux/tutorials/tutorial-proxy.rst

diff --git a/source/clear-linux/guides/guides.rst b/source/clear-linux/guides/guides.rst
index c39057b2..d00fd5da 100644
--- a/source/clear-linux/guides/guides.rst
+++ b/source/clear-linux/guides/guides.rst
@@ -9,6 +9,8 @@ The following guides provide step-by-step instructions on using |CL|.
 
    As of 22 May 2019 :file:`mixin` is no longer supported.
 
+.. _tooling:
+
 Tooling
 =======
 
diff --git a/source/clear-linux/tutorials/tutorial-proxy.rst b/source/clear-linux/tutorials/tutorial-proxy.rst
new file mode 100644
index 00000000..eab5ca47
--- /dev/null
+++ b/source/clear-linux/tutorials/tutorial-proxy.rst
@@ -0,0 +1,115 @@
+.. _tutorial-proxy:
+
+Setting up proxy
+################
+
+This tutorial shows you how to configure your system for use behind an
+outbound proxy to access the Internet. 
+
+|CL| :ref:`tooling` applications already benefit from the :ref:`autoproxy`
+feature. 
+
+.. contents:: 
+    :local:
+    :depth: 1
+
+Prerequisites
+*************
+
+This tutorial assumes 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 this 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), you can follow these steps to configure and check proxy settings:
+
+.. note::
+
+    Be sure to use :command:`sudo`, as you will need elevated permissions.
+
+#. Create :file:`/etc/systemd/system/docker.service.d` directory to host
+   configuration information for the Docker service.
+
+#. Create :file:`/etc/systemd/system/docker.service.d/http-proxy.conf` and add:
+
+    .. 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 Clear Linux, it is not the BSD version,
+    which is the one usually used to enable git over ssh.
\ No newline at end of file
diff --git a/source/clear-linux/tutorials/tutorials.rst b/source/clear-linux/tutorials/tutorials.rst
index aebbfd30..0d5300e9 100644
--- a/source/clear-linux/tutorials/tutorials.rst
+++ b/source/clear-linux/tutorials/tutorials.rst
@@ -28,3 +28,4 @@ Explore our tutorials to discover what you can do with |CL|!
    nvidia
    dars
    redis
+   tutorial-proxy