diff options
author | kmpm <peter@birchroad.net> | 2019-01-20 12:11:31 +0100 |
---|---|---|
committer | kmpm <peter@birchroad.net> | 2019-01-20 12:13:48 +0100 |
commit | 9a04c5abf4f2b7f961975ee61aede4ec9e99b565 (patch) | |
tree | 90096f60dcc1a4e4e5d664094f728c931342ceb0 /docs/services/tftp.rst | |
parent | ce02006259e45ea9b0ab5f30ac3f1639d2338505 (diff) | |
download | vyos-documentation-9a04c5abf4f2b7f961975ee61aede4ec9e99b565.tar.gz vyos-documentation-9a04c5abf4f2b7f961975ee61aede4ec9e99b565.zip |
services in own folder
* spitting services into multiple files in it's own folder
* making image links absolute
* some linting
Diffstat (limited to 'docs/services/tftp.rst')
-rw-r--r-- | docs/services/tftp.rst | 44 |
1 files changed, 44 insertions, 0 deletions
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 |