Skip to content

Commit

Permalink
[docs] Added all supported paramenters of WireGuard backend #297
Browse files Browse the repository at this point in the history
Closes #297

Co-authored-by: Federico Capoano <[email protected]>
  • Loading branch information
pandafy and nemesifier authored Aug 23, 2024
1 parent 9b2c214 commit 5d8edf4
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 1 deletion.
14 changes: 14 additions & 0 deletions docs/source/backends/wireguard.rst
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,20 @@ key name type default allowed values
underscores
``port`` integer ``51820`` integers
``private_key`` string base64-encoded private key
``dns`` list ``[]`` list of strings containing DNS servers
``mtu`` integer ``1420`` Interface MTU, set to 1280 if using IPv6
``table`` string ``auto`` Controls the routing table to which routes are
added
``pre_up`` string Script snippet which will be executed before
setting up the interface.
``post_up`` string Script snippet which will be executed after setting
up the interface.
``pre_down`` string Script snippet which will be executed before
tearing down the interface.
``post_down`` string Script snippet which will be executed after tearing
down the interface.
``save_config`` boolean ``false`` Save the configuration from the current state of
interface upon shutdown.
``peers`` list ``[]`` list of dictionaries containing following
information of each peer:

Expand Down
3 changes: 2 additions & 1 deletion netjsonconfig/backends/wireguard/schema.py
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,8 @@
"title": "MTU",
"minimum": 68,
"propertyOrder": 5,
"default": 1280,
"default": 1420,
"description": "Interface MTU, set to 1280 if using IPv6.",
},
"table": {
"title": "Table",
Expand Down

0 comments on commit 5d8edf4

Please sign in to comment.