diff mbox series

[3/4] doc: add missing documentation for Webserver parms

Message ID 20211015102228.2828048-3-sbabic@denx.de
State Accepted
Headers show
Series [1/4] doc: fix sphinx warnings due to wrong indentation | expand

Commit Message

Stefano Babic Oct. 15, 2021, 10:22 a.m. UTC 
Command line parameters for the Webserver were not yet documented.

Signed-off-by: Stefano Babic <sbabic@denx.de>
---
 doc/source/swupdate.rst | 34 ++++++++++++++++++++++++++++++++++
 1 file changed, 34 insertions(+)
diff mbox series

Patch

diff --git a/doc/source/swupdate.rst b/doc/source/swupdate.rst
index 71d8d7b..61663e1 100644
--- a/doc/source/swupdate.rst
+++ b/doc/source/swupdate.rst
@@ -676,6 +676,40 @@  Mandatory arguments are marked with '\*':
 |                         |          | -n 1G   : Set limit to 1 G/s.              |
 +-------------------------+----------+--------------------------------------------+
 
+Webserver command line parameters
+.................................
+
+Example: ``swupdate -w "-r /www -p 8080"``
+
+Mandatory arguments are marked with '\*':
+
++-------------------------+----------+--------------------------------------------+
+|  Parameter              | Type     | Description                                |
++=========================+==========+============================================+
+| -r <document root>      | string   | \* Path where the web app is stored.       |
++-------------------------+----------+--------------------------------------------+
+| -p <port>               | integer  | \* TCP port to be listened                 |
+|                         |          | if not set, 8080 is used                   |
++-------------------------+----------+--------------------------------------------+
+| -s <ssl>                |          | \* Enable SSL support. Note: it must be    |
+|                         |          | configured with CONFIG_MONGOOSESSL         |
++-------------------------+----------+--------------------------------------------+
+| --ssl-cert <cert>       | string   | Path to the certificate to present to      |
+|                         |          | clients                                    |
++-------------------------+----------+--------------------------------------------+
+| -K <key>                | string   | Path to key corresponding to ssl           |
+|                         |          | certificate                                |
++-------------------------+----------+--------------------------------------------+
+| -t <timeout>            | integer  | Timeout to consider a connection lost if   |
+|                         |          | clients stops to send data. If hit, an     |
+|                         |          | update is aborted. Default=0 (unlimited)   |
++-------------------------+----------+--------------------------------------------+
+| --auth-domain <string>  | string   | Set authentication domain                  |
+|                         |          | Default: none                              |
++-------------------------+----------+--------------------------------------------+
+| --global-auth-file      | string   | Set authentication file if any             |
+|  <string>               |          | Default: none                              |
++-------------------------+----------+--------------------------------------------+
 
 systemd Integration
 -------------------