Skip to content

Commit

Permalink
doc/configuration: document remote provider arguments and provide exa…
Browse files Browse the repository at this point in the history
…mples

Signed-off-by: Bastian Krause <[email protected]>
  • Loading branch information
Bastian-Krause committed Jul 28, 2023
1 parent 1a66ea5 commit c345273
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions doc/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1221,6 +1221,23 @@ RemoteTFTPProvider / RemoteHTTPProvider
These describe a `TFTPProvider`_ or `HTTPProvider`_ resource available on a
remote computer.

.. code-block:: yaml
RemoteTFTPProvider
host: "tftphost"
internal: "/srv/tftp/board-23/"
external: "board-23/"
RemoteHTTPProvider:
host: "httphost"
internal: "/srv/www/board-23/"
external: "http://192.168.1.1/board-23/"
Arguments:
- host (str): hostname of the remote host
- internal (str): path prefix to the HTTP/TFTP root directory on ``host``
- external (str): corresponding path prefix for use by the target

Used by:
- `TFTPProviderDriver`_
- `HTTPProviderDriver`_
Expand All @@ -1229,6 +1246,14 @@ RemoteNFSProvider
+++++++++++++++++
An `NFSProvider`_ resource available on a remote computer.

.. code-block:: yaml
RemoteNFSProvider:
host: "nfshost"
Arguments:
- host (str): hostname of the remote host

Used by:
- `NFSProviderDriver`_

Expand Down

0 comments on commit c345273

Please sign in to comment.