wireguard-install
wireguard-install copied to clipboard
Add documentation/references to setup clients
For a WireGuard newbie like me, this repo is missing some trivial points:
- How the client should be set up using the provided client file?
- What to be run on a client machine?
This script makes it so easy to set up a server with almost nothing documented in terms of configuring clients.
Hello, This is not supposed to be part of the installation of the wireguard server. For the client configuration, you need to go to the official doc. But essentially, you simply add to send the .conf file to your client. Install a wireguard client on the machine and load the conf. It's very user-friendly to just import the .conf file and click on "activate".
I was only pointing a typical use case:
People searching how to set up a VPN for personal use. This implies both server and client. The server docs (this script) have no mention about the client setup at all - seems like a missing part.
Then people have to see how script works, do a bunch of checking on how to set up client. What is the point of easy script to set up a server if in the end you end up investigating the inner working. It is supposed to make things easy for going from point A to point D.
Instead I had to check what B does, understand what I need to do in C to reach D.
See related pull request. This would saved me a couple hours if it was there.
On 14 Dec 2020, at 13:48, Rémi FLAMENT [email protected] wrote:
Hello, This is not supposed to be part of the installation of the wireguard server. For the client configuration, you need to go to the official doc. But essentially, you simply add to send the .conf file to your client. Install a wireguard client on the machine and load the conf. It's very user-friendly to just import the .conf file and click on "activate".
— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub, or unsubscribe.
I don't know if it was in the script when you opened this issue, but it now generates a QR code that makes it easy to setup on a phone.
Adding an option to cat out a client config might help, as they can copy and paste that if the user doesn't know how to copy the client file off their VPS with scp, or putty.
@jaminmc QR code was there, but for a desktop client, there was basically no docs to go around with other than self-research.
Then again, hope this pul request of mine can be merged so it's not confusing to others as it was for me.
I agree with dvershinin that setting up a non-phone client (in my case, laptop running linux) is significantly harder than setting up a phone client. The setup script for the server worked really well, thank you! Installing a client on my phone from the app store and scanning the QR code printed by the setup script was impressively smooth, nice work again!
Setting up my laptop felt much less slick. https://www.wireguard.com/quickstart/ has quite a few steps, including configuring the server, which I'd already done. Copying the conf file created on the server to /etc/wireguard/wg0.conf
on the client and running sudo wg-quick up wg0
worked well for me. Why not put those two steps in the README, similar to https://github.com/angristan/wireguard-install/pull/167/files ?