From add0a00124c364f17ad3bb86ef8f174863355bf4 Mon Sep 17 00:00:00 2001 From: hagbard Date: Fri, 18 Oct 2019 12:12:49 -0700 Subject: system-proxy: cli options documented --- docs/system/index.rst | 5 +++-- docs/system/proxy.rst | 28 ++++++++++++++++++++++++++++ 2 files changed, 31 insertions(+), 2 deletions(-) create mode 100644 docs/system/proxy.rst (limited to 'docs/system') diff --git a/docs/system/index.rst b/docs/system/index.rst index 4e23f5a1..4edfce48 100644 --- a/docs/system/index.rst +++ b/docs/system/index.rst @@ -11,13 +11,14 @@ should be ready for further configuration which is described in this chapter. :maxdepth: 2 :hidden: + config-management eventhandler flowaccounting host-information + login-users ntp + proxy serialconsole - login-users syslog task-scheduler - config-management time-zone diff --git a/docs/system/proxy.rst b/docs/system/proxy.rst new file mode 100644 index 00000000..4ff5717b --- /dev/null +++ b/docs/system/proxy.rst @@ -0,0 +1,28 @@ +.. _proxy: + +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 code example below sets a proxy for all HTTP, HTTPS and FTP (anonymous ftp) connections, initiated by vyos. + +.. code-block:: sh + + 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. + +.. code-block:: sh + + vyos@vyos:~$ add system image https://downloads.vyos.io/rolling/current/amd64/vyos-rolling-latest.iso + Trying to fetch ISO file from https://downloads.vyos.io/rolling/current/amd64/vyos-rolling-latest.iso + % Total % Received % Xferd Average Speed Time Time Time Current + Dload Upload Total Spent Left Speed + 1 413M 1 4479k 0 0 995k 0 0:07:04 0:00:04 0:07:00 995k + + + +.. _`basic auth`: https://tools.ietf.org/html/rfc7617 -- cgit v1.2.3