Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs] Added all supported paramenters of WireGuard backend #297 #311

Merged
merged 3 commits into from
Aug 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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