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
Changes from 1 commit
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 ``1280`` MTU set on the interface
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would change the description here to just "interface MTU".

I was confused by the default value here because I remember the default MTU being 1420, but on IPv6 is 1280.

I just realized this is not a great situation. I am thinking about the easiest acceptable solution here..

We could set the default to 1420 both here and in the schema, and add a help text (description property in the schema) which says: "Interface MTU, set to 1280 if using IPv6."

Alternatively, we could remove the default and state in the description to use 1420 or 1280 whether using ipv4 or ipv6, however, I using IPv4 is the norm, so the first solution is probably going to be the most comfortable for most users.

What do you think?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like the first solution more. I have made changes accordingly.

``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