jody/wireguard-add-client-qr
1
0
Fork 0
Code Issues Pull Requests Actions Packages Releases Activity

Make the README friendlier.

Browse Source
This commit is contained in:
jkaplon 2025-03-11 16:01:53 -04:00
parent 84a50618da
commit 0b370f9eab
1 changed files with 11 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -1,3 +1,13 @@
Bash script for use on wireguard hub/server to auto-configure new clients. Bash script for use on wireguard hub/server to auto-configure new clients.
Output displays a QR code on the terminal for easy setup of wireguard mobile or PC apps. Output displays a QR code on the terminal for easy setup of wireguard mobile or PC apps.
Script must be run on central wireguard hub/server, but resulting QR works on a mobile terminal app or ssh-client (tested with Termux on android). Script must be run on central wireguard hub/server, but resulting QR works on a mobile terminal app or ssh-client (tested with Termux on android...some pinching/zooming necessary to get entire QR code showing on small screens).
During my initial wireguard setup, I ignored anything related to QR codes.
It didn't seem useful since I had a fixed/small number of systems to connect.
But now that I want to add some kid-phones, I'd like to avoid copy/pasting keys.
I previously had an android ad-blocker setup using the built-in 'Private DNS' feature and pi-hole.
It worked well for a few years, but started getting flaky after some android updates in early-2025.
That got me thinking about connecting to pi-hole using my wireguard VPN & I realized why the client QR codes are useful.
`qrencode` is in the main ubuntu 24.04 apt repository, so it should be a reliable dependency.