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

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

Open
OJFord opened this issue Sep 1, 2019 · 4 comments
Open

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

OJFord opened this issue Sep 1, 2019 · 4 comments
Labels
enhancement New feature or request good first issue Good for newcomers

Comments

@OJFord
Copy link

OJFord commented Sep 1, 2019

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
Copy link
Owner

pirate commented Sep 11, 2019

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

@OJFord
Copy link
Author

OJFord commented Sep 11, 2019

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 pirate added enhancement New feature or request good first issue Good for newcomers labels Jan 9, 2020
@pirate
Copy link
Owner

pirate commented Jul 2, 2020

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
Copy link
Contributor

rasa commented Apr 27, 2024

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

3 participants