summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorkroy <kroy@kroy.io>2019-11-27 13:46:02 -0600
committerChristian Poessinger <christian@poessinger.com>2019-11-28 05:35:01 +0100
commit6b38a32cb10dd0d3d289cfd01e5f263bc9218586 (patch)
tree8e0928833c455f7ab449ed4809f31e29e5b7c44c /docs
parent8da3e3415c3817d9f68d0653b0d839610b0d8110 (diff)
downloadvyos-documentation-6b38a32cb10dd0d3d289cfd01e5f263bc9218586.tar.gz
vyos-documentation-6b38a32cb10dd0d3d289cfd01e5f263bc9218586.zip
system-proxy: cleanup and example enhancement
Diffstat (limited to 'docs')
-rw-r--r--docs/system/proxy.rst10
1 files changed, 7 insertions, 3 deletions
diff --git a/docs/system/proxy.rst b/docs/system/proxy.rst
index 59bf6d52..f57b5cd2 100644
--- a/docs/system/proxy.rst
+++ b/docs/system/proxy.rst
@@ -4,16 +4,20 @@ System Proxy
============
Some IT environments require the use of a proxy to connect to the Internet.
-The option allowes to set a HTTP proxy and if necessary, supports `basic auth`_.
+The ``system proxy`` option sets the configuration for a proxy, and if necessary, supports `basic auth`_.
-The code example below sets a proxy for all HTTP, HTTPS and FTP (anonymous ftp) connections, initiated by vyos.
+This example sets a proxy for all connections initiated by VyOS, including HTTP, HTTPS, and FTP (anonymous ftp).
.. code-block:: console
set system proxy url http://10.100.100.1
set system proxy port 8080
-That enables the update of a system image if the vyos system operates behind a proxy.
+ # If a username and password are required
+ set system proxy username vyosuser
+ set system proxy password vyosuser-password
+
+That enables the update of a system image if the VyOS system operates behind a proxy.
.. code-block:: console