summaryrefslogtreecommitdiff
path: root/docs/configuration/system/proxy.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/configuration/system/proxy.rst')
-rw-r--r--docs/configuration/system/proxy.rst28
1 files changed, 28 insertions, 0 deletions
diff --git a/docs/configuration/system/proxy.rst b/docs/configuration/system/proxy.rst
new file mode 100644
index 00000000..8e0339a7
--- /dev/null
+++ b/docs/configuration/system/proxy.rst
@@ -0,0 +1,28 @@
+.. _system_proxy:
+
+############
+System Proxy
+############
+
+Some IT environments require the use of a proxy to connect to the Internet.
+Without this configuration VyOS updates could not be installed directly by
+using the :opcmd:`add system image` command (:ref:`update_vyos`).
+
+.. cfgcmd:: set system proxy url <url>
+
+ Set proxy for all connections initiated by VyOS, including HTTP, HTTPS, and
+ FTP (anonymous ftp).
+
+.. cfgcmd:: set system proxy port <port>
+
+ Configure proxy port if it does not listen to the default port 80.
+
+.. cfgcmd:: set system proxy username <username>
+
+ Some proxys require/support the "basic" HTTP authentication scheme as per
+ :rfc:`7617`, thus a username can be configured.
+
+.. cfgcmd:: set system proxy password <password>
+
+ Some proxys require/support the "basic" HTTP authentication scheme as per
+ :rfc:`7617`, thus a password can be configured.