search

pirate / wireguard-docs

📖 Unofficial WireGuard Documentation: Setup, Usage, Configuration, and full example setups for VPNs supporting both servers & roaming clients.
https://docs.sweeting.me/s/wireguard
MIT License
4.46k stars 309 forks source link

Mark config keys that are available with wg-quick only #21

Open OJFord opened 4 years ago

OJFord commented 4 years ago

DNS and Address for example are only valid config items when using the wg-quick tool, IMO it would be good to distinguish these and any others, just a brief:

[wg-quick only]

marker, perhaps linking to a section that explains.

pirate commented 4 years ago

Sure, although I'm surprised anyone uses raw wg tbh, wg-quick has always seemed like the primary user-facing CLI to me.

OJFord commented 4 years ago

Depends on use case I suppose, if you're using it as a client(s) - server VPN for privacy or whatever wg-quick is probably great. For networking many servers though you might prefer to use systemd (supports WireGuard netdevs as of v241 as I recall, better support in 243) or similar file-based config.

pirate commented 4 years ago

I just checked and wg-quick handles a superset of wg's file-based config features. I use it for my server-to-server VPN, not for privacy, and have never felt the need to drop down to raw wg. I remain unconvinced that anyone should start by using wg directly unless they already know what they're doing (in which case they don't need these docs anyway), but I still think labeling them better is harmless so I'll leave this issue open.

Edit: my position on this has softened somewhat as of 2024. I still think wg-quick is the easiest interface for beginners but I'd be open to PRs clarifying which parts are wg / wg-quick-specific.

rasa commented 2 months ago

Note that some environments, such as OpenWRT, don't provide/support wg-quick.