From c25c40dfa96dfeb022b203280c607c1f1835417b Mon Sep 17 00:00:00 2001
From: Robert Göhler <github@ghlr.de>
Date: Sun, 24 Jan 2021 22:14:00 +0100
Subject: Migrate new file structure to crux (#435)

* order workflows and add submodule

* rename gitmodules file

* delete docs/.gitignore

* add vyos custom linter

* correct __pycache__ in gitignore

* add test-coverage.py

* move draw.io folder

* arrange changelog, install history and about

* arrange: firewall

* arrange: highavailability

* arrange: loadbalancing

* arrange: nat

* arrange: services

* sort configexamples and configuration interfaces

* wireles: rename wireless

* rearrange: Protocols and Policy

* rearrange: Firewall and Zone Policy

* rearrange: Interfaces

* rearrange: Interfaces

* rearrange: dynamic DNS

* hostinfo: add page to index

* rearrange: appendix

* venv: add Pipfile

* rearrange: contributing

* index: remove debugging

* rearrange: fix all figure and refs

* rearrange: commandtree

* fix: cli, openvpn, install headline level

* protocols: change headline

* firewall: move mss clamping

* ip: separate ipv4 and ipv6

* arp: move to static page

* igmp: rename multicast page

* Update to year 2021
---
 docs/configuration/service/tftp-server.rst | 42 ++++++++++++++++++++++++++++++
 1 file changed, 42 insertions(+)
 create mode 100644 docs/configuration/service/tftp-server.rst

(limited to 'docs/configuration/service/tftp-server.rst')

diff --git a/docs/configuration/service/tftp-server.rst b/docs/configuration/service/tftp-server.rst
new file mode 100644
index 00000000..9ce46b02
--- /dev/null
+++ b/docs/configuration/service/tftp-server.rst
@@ -0,0 +1,42 @@
+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:: none
+
+  # 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:: none
+
+  vyos@vyos# show service
+   tftp-server {
+      allow-upload
+      directory /config/tftpboot
+      listen-address 2001:db8:ffee::1
+      listen-address 10.10.1.1
+   }
+
-- 
cgit v1.2.3