Skip to content

Commit 80e84cf

Browse files
author
Vladislav Plikin
committed
Some improvements:
- Kali Linux support - Removed resolvconf installation - Automatic PersistentKeepalive - Config file output right after client creation under QR code - Changed y/n to yes/no to avoid accidental press - Added confirmation for client removing - Replaced way to detect machine IPv4/6 - Updated permissions for whole /etc/wireguard from 644 to 600 - Added IPv6 random generation Used issues/PRs: angristan#474 angristan#430 angristan#482 by bushwhackr angristan#457 by dikeckaan angristan#456 by turekt
1 parent 39caf2f commit 80e84cf

File tree

3 files changed

+134
-94
lines changed

3 files changed

+134
-94
lines changed

‎LICENSE

+13-12
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,21 @@
11
MIT License
22

3-
Copyright (c) 2019 angristan
3+
Copyright (c) 2023 Vladislav Plikin
44

5-
Permission is hereby granted, free of charge, to any person obtaining a copy of
6-
this software and associated documentation files (the "Software"), to deal in
7-
the Software without restriction, including without limitation the rights to
8-
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
9-
the Software, and to permit persons to whom the Software is furnished to do so,
10-
subject to the following conditions:
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
1111

1212
The above copyright notice and this permission notice shall be included in all
1313
copies or substantial portions of the Software.
1414

1515
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
17-
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
18-
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
19-
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
20-
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md

+2-35
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,13 @@
11
# WireGuard installer
22

3-
![Lint](https://github.com/angristan/wireguard-install/workflows/Lint/badge.svg)
4-
[![Say Thanks!](https://img.shields.io/badge/Say%20Thanks-!-1EAEDB.svg)](https://saythanks.io/to/angristan)
5-
63
**This project is a bash script that aims to setup a [WireGuard](https://www.wireguard.com/) VPN on a Linux server, as easily as possible!**
74

85
WireGuard is a point-to-point VPN that can be used in different ways. Here, we mean a VPN as in: the client will forward all its traffic through an encrypted tunnel to the server.
96
The server will apply NAT to the client's traffic so it will appear as if the client is browsing the web with the server's IP.
107

118
The script supports both IPv4 and IPv6. Please check the [issues](https://github.com/angristan/wireguard-install/issues) for ongoing development, bugs and planned features! You might also want to check the [discussions](https://github.com/angristan/wireguard-install/discussions) for help.
129

13-
WireGuard does not fit your environment? Check out [openvpn-install](https://github.com/angristan/openvpn-install).
10+
WireGuard does not fit your environment? For example, you can't use UDP, only TCP? Check out [openvpn-install](https://github.com/angristan/openvpn-install).
1411

1512
## Requirements
1613

@@ -37,34 +34,4 @@ chmod +x wireguard-install.sh
3734

3835
It will install WireGuard (kernel module and tools) on the server, configure it, create a systemd service and a client configuration file.
3936

40-
Run the script again to add or remove clients!
41-
42-
## Providers
43-
44-
I recommend these cheap cloud providers for your VPN server:
45-
46-
- [Vultr](https://www.vultr.com/?ref=8948982-8H): Worldwide locations, IPv6 support, starting at \$5/month
47-
- [Hetzner](https://hetzner.cloud/?ref=ywtlvZsjgeDq): Germany, Finland and USA. IPv6, 20 TB of traffic, starting at 4.5€/month
48-
- [Digital Ocean](https://m.do.co/c/ed0ba143fe53): Worldwide locations, IPv6 support, starting at \$4/month
49-
50-
## Contributing
51-
52-
## Discuss changes
53-
54-
Please open an issue before submitting a PR if you want to discuss a change, especially if it's a big one.
55-
56-
### Code formatting
57-
58-
We use [shellcheck](https://github.com/koalaman/shellcheck) and [shfmt](https://github.com/mvdan/sh) to enforce bash styling guidelines and good practices. They are executed for each commit / PR with GitHub Actions, so you can check the configuration [here](https://github.com/angristan/wireguard-install/blob/master/.github/workflows/lint.yml).
59-
60-
## Say thanks
61-
62-
You can [say thanks](https://saythanks.io/to/angristan) if you want!
63-
64-
## Credits & Licence
65-
66-
This project is under the [MIT Licence](https://raw.githubusercontent.com/angristan/wireguard-install/master/LICENSE)
67-
68-
## Star History
69-
70-
[![Star History Chart](https://api.star-history.com/svg?repos=angristan/wireguard-install&type=Date)](https://star-history.com/#angristan/wireguard-install&Date)
37+
Run the script again to add or remove clients!

0 commit comments

Comments
 (0)