From 9a04c5abf4f2b7f961975ee61aede4ec9e99b565 Mon Sep 17 00:00:00 2001 From: kmpm Date: Sun, 20 Jan 2019 12:11:31 +0100 Subject: services in own folder * spitting services into multiple files in it's own folder * making image links absolute * some linting --- docs/services/tftp.rst | 44 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 44 insertions(+) create mode 100644 docs/services/tftp.rst (limited to 'docs/services/tftp.rst') diff --git a/docs/services/tftp.rst b/docs/services/tftp.rst new file mode 100644 index 00000000..524c8e5e --- /dev/null +++ b/docs/services/tftp.rst @@ -0,0 +1,44 @@ +TFTP +---- + +Trivial File Transfer Protocol (TFTP_) is a simple lockstep File Transfer +Protocol which allows a client to get a file from or put a file onto a remote +host. One of its primary uses is in the early stages of nodes booting from a +local area network. TFTP has been used for this application because it is very +simple to implement. + +Example +^^^^^^^ + +.. code-block:: sh + + # If you want to enable uploads, else TFTP server will act as read-only (optional) + set service tftp-server allow-upload + + # Directory for TFTP server content + set service tftp-server directory '/config/tftpboot' + + # On which addresses we want to listen for incoming TFTP connections? (mandatory) + set service tftp-server listen-address '2001:db8:ffee::1' + set service tftp-server listen-address '10.10.1.1' + +.. note:: Choose your ``directory`` location carefully or you will loose the + content on image upgrades. Any directory under ``/config`` is save at this + will be migrated. + +.. note:: Configuring a listen-address is essential for the service to work. + +The resulting configuration will look like: + +.. code-block:: sh + + vyos@vyos# show service + tftp-server { + allow-upload + directory /config/tftpboot + listen-address 2001:db8:ffee::1 + listen-address 10.10.1.1 + } + + +.. _TFTP: https://en.wikipedia.org/wiki/Trivial_File_Transfer_Protocol -- cgit v1.2.3 From 1ac4afa392eb4c077507cf3866ebc1b8b3cb1793 Mon Sep 17 00:00:00 2001 From: kmpm Date: Sun, 20 Jan 2019 16:13:07 +0100 Subject: fixed erroneous targets --- docs/services/dynamic-dns.rst | 3 +-- docs/services/index.rst | 2 ++ docs/services/lldp.rst | 6 +----- docs/services/references.rst | 13 +++++++++++++ docs/services/snmp.rst | 5 +---- docs/services/ssh.rst | 2 +- docs/services/tftp.rst | 2 -- docs/services/webproxy.rst | 4 +--- 8 files changed, 20 insertions(+), 17 deletions(-) create mode 100644 docs/services/references.rst (limited to 'docs/services/tftp.rst') diff --git a/docs/services/dynamic-dns.rst b/docs/services/dynamic-dns.rst index dcb9c155..67de6471 100644 --- a/docs/services/dynamic-dns.rst +++ b/docs/services/dynamic-dns.rst @@ -149,5 +149,4 @@ address for the response. ddclient_ will skip any address located before the string set in `[skip]`. -.. _ddclient: http://sourceforge.net/p/ddclient/wiki/Home/ -.. _RFC2136: https://www.ietf.org/rfc/rfc2136.txt +.. include:: references.rst diff --git a/docs/services/index.rst b/docs/services/index.rst index a138c961..80405ef7 100644 --- a/docs/services/index.rst +++ b/docs/services/index.rst @@ -1,5 +1,7 @@ .. _services: +.. include:: references.rst + Services ======== diff --git a/docs/services/lldp.rst b/docs/services/lldp.rst index 88df9b20..6a3bee7b 100644 --- a/docs/services/lldp.rst +++ b/docs/services/lldp.rst @@ -94,8 +94,4 @@ Troubleshooting Use operationnal command ``show log lldp`` to display logs. - -.. _`Cisco Discovery Protocol`: https://en.wikipedia.org/wiki/Cisco_Discovery_Protocol -.. _`Foundry Discovery Protocol`: https://en.wikipedia.org/wiki/Foundry_Discovery_Protocol -.. _MIB: https://en.wikipedia.org/wiki/Management_information_base -.. _SNMP: https://en.wikipedia.org/wiki/Simple_Network_Management_Protocol +.. include:: references.rst diff --git a/docs/services/references.rst b/docs/services/references.rst new file mode 100644 index 00000000..6e6e9595 --- /dev/null +++ b/docs/services/references.rst @@ -0,0 +1,13 @@ +.. _`Cisco Discovery Protocol`: https://en.wikipedia.org/wiki/Cisco_Discovery_Protocol +.. _ddclient: http://sourceforge.net/p/ddclient/wiki/Home/ +.. _`Foundry Discovery Protocol`: https://en.wikipedia.org/wiki/Foundry_Discovery_Protocol +.. _MIB: https://en.wikipedia.org/wiki/Management_information_base +.. _RFC2136: https://www.ietf.org/rfc/rfc2136.txt +.. _SNMP: https://en.wikipedia.org/wiki/Simple_Network_Management_Protocol +.. _SNMPv2: https://en.wikipedia.org/wiki/Simple_Network_Management_Protocol#Version_2 +.. _SNMPv3: https://en.wikipedia.org/wiki/Simple_Network_Management_Protocol#Version_3 +.. _SSH: https://en.wikipedia.org/wiki/Secure_Shell +.. _Squid3: http://www.squid-cache.org/ +.. _Squidguard: http://www.squidguard.org/ +.. _TFTP: https://en.wikipedia.org/wiki/Trivial_File_Transfer_Protocol + diff --git a/docs/services/snmp.rst b/docs/services/snmp.rst index ac79f700..e11e3969 100644 --- a/docs/services/snmp.rst +++ b/docs/services/snmp.rst @@ -177,7 +177,4 @@ After commit the resulting configuration will look like: } -.. _SNMP: https://en.wikipedia.org/wiki/Simple_Network_Management_Protocol -.. _SNMPv2: https://en.wikipedia.org/wiki/Simple_Network_Management_Protocol#Version_2 -.. _SNMPv3: https://en.wikipedia.org/wiki/Simple_Network_Management_Protocol#Version_3 -.. _MIB: https://en.wikipedia.org/wiki/Management_information_base +.. include:: references.rst diff --git a/docs/services/ssh.rst b/docs/services/ssh.rst index a8da9154..4d96f8de 100644 --- a/docs/services/ssh.rst +++ b/docs/services/ssh.rst @@ -147,4 +147,4 @@ as the ``vyos`` user using their own keys. set system login user vyos authentication public-keys 'xrobau' type ssh-rsa -.. _SSH: https://en.wikipedia.org/wiki/Secure_Shell + diff --git a/docs/services/tftp.rst b/docs/services/tftp.rst index 524c8e5e..96b33a65 100644 --- a/docs/services/tftp.rst +++ b/docs/services/tftp.rst @@ -40,5 +40,3 @@ The resulting configuration will look like: listen-address 10.10.1.1 } - -.. _TFTP: https://en.wikipedia.org/wiki/Trivial_File_Transfer_Protocol diff --git a/docs/services/webproxy.rst b/docs/services/webproxy.rst index b739e479..d1c2ca2e 100644 --- a/docs/services/webproxy.rst +++ b/docs/services/webproxy.rst @@ -118,6 +118,4 @@ So sometimes it is useful to bypass a transparent proxy: (This can be useful when a called service has many and/or often changing destination addresses - e.g. Netflix.) - -.. _Squid3: http://www.squid-cache.org/ -.. _Squidguard: http://www.squidguard.org/ +.. include:: references.rst -- cgit v1.2.3