List all config options/Wireguard documentation

felagund · 2025-04-09T20:26:22.883Z

So I wanted to change something in my Wireguard settings and I wanted to basically see the manual, or just a list of all possible configuration options (and their names!) for Wireguard. I could not find it, https://openwrt.org/docs/guide-user/services/vpn/wireguard/start is very much tutorial based.

I think such a list used to be standard on the wiki. But do I understand it now correctly that it would need to be compiled by somebody first? And is there a way to list possible options name in UCI or you just need to know/find it scattered somewhere? I feel like I am missing something obvious, but I really could not find it.

Dante · 2025-04-09T22:52:28.261Z

I'm not sure if there's all that much config to it. Have a look at the the code from wireguard-tools. Here's the network config:

github.com/openwrt/openwrt

package/network/utils/wireguard-tools/files/wireguard.sh

eec11fbbb


      
          	config_load network
          	config_get private_key "${config}" "private_key"
          	config_get listen_port "${config}" "listen_port"
          	config_get addresses "${config}" "addresses"
          	config_get mtu "${config}" "mtu"
          	config_get fwmark "${config}" "fwmark"
          	config_get ip6prefix "${config}" "ip6prefix"
          	config_get nohostroute "${config}" "nohostroute"
          	config_get tunlink "${config}" "tunlink"

and here's one for a peer:

github.com/openwrt/openwrt

package/network/utils/wireguard-tools/files/wireguard.sh

eec11fbbb


      
          	config_get_bool disabled "${peer_config}" "disabled" 0
          	config_get public_key "${peer_config}" "public_key"
          	config_get preshared_key "${peer_config}" "preshared_key"
          	config_get allowed_ips "${peer_config}" "allowed_ips"
          	config_get_bool route_allowed_ips "${peer_config}" "route_allowed_ips" 0
          	config_get endpoint_host "${peer_config}" "endpoint_host"
          	config_get endpoint_port "${peer_config}" "endpoint_port"
          	config_get persistent_keepalive "${peer_config}" "persistent_keepalive"

You can have a look around to see if anything else is missing. And feel free to improve the documentation if you're up for it.

elbertmai · 2025-04-09T22:57:49.038Z

felagund:

I wanted to basically see the manual, or just a list of all possible configuration options (and their names!) for Wireguard.

openwrt.org

[OpenWrt Wiki] Tunneling interface protocols

felagund · 2025-04-09T23:37:34.495Z

Dante:

You can have a look around to see if anything else is missing. And feel free to improve the documentation if you're up for it.

Well, I would add the link posted on post after your to the wiki page I linked, so I would put this string:

[[:docs/guide-user/network/tunneling_interface_protocols#protocol_wireguard_wireguard_vpn|Wireguard options documentation]]

to https://openwrt.org/docs/guide-user/services/vpn/wireguard/start but I lack the priviledges to do so :-(.

I just wanted to know what the proper names of the options were, as my mingled config files had two versions of it and I was not sure which was the correct one. That section of documentation is very unsearchable (I tried, wrongly thinking "wireguard" would be a good keyword).

Dante · 2025-04-09T23:41:03.557Z

You can apply for a Wiki account here:

Applying for OpenWrt wiki account Talk about Documentation

If you want to contribute to OpenWrt by adding useful information to the wiki, you must apply for a wiki account using the instructions below or login with a github account. OpenWrt Forum users Please send a PM to wiki-account that contains: desired username real name (if not provided username will be used) email address and an account will be created for you. To send a PM, follow the link above and click the Message button (see the graphic below). [PM] Newcomers to the OpenWrt Forum (Tru…

felagund · 2025-04-09T23:46:58.418Z

I have an account (I log in with GitHub), I have edited wiki in the past. I think this is a special autogenerated page, that is why I cannot edit it. Can you? For me the green "save" button is unclickable.

Dante · 2025-04-09T23:49:16.948Z

I don't have a Wiki account at the moment.

felagund · 2025-04-09T23:52:23.993Z

I see. It is weird, I seem not to be able to edit anywhere, yet it was working a few months ago (I think I edited a typo a week ago too). Not that I was able to find out how to list my list of contributions :-).

system · 2025-04-19T23:52:49.150Z

This topic was automatically closed 10 days after the last reply. New replies are no longer allowed.