-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
58 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,58 @@ | ||
# VPNSetup | ||
Easily & quickly setup a WireGuard/OpenVPN server and manage your users with ease! | ||
[//]: # (Main image, centered) | ||
<p align="center"> | ||
<img width="300" src="https://raw.githubusercontent.com/GTeamx/.github/main/assets/vpn-setup.png"> | ||
</p> | ||
|
||
[//]: # (Main title, centered) | ||
<h1 align="center">🔒 VPN-Setup 🔒</h1> | ||
|
||
[//]: # (Shield.io badges, main basic stuff, centered) | ||
<div align="center"> | ||
|
||
<a href="">![GitHub Release](https://img.shields.io/github/v/release/GTeamx/VPNSetup?sort=date&display_name=tag&style=for-the-badge&label=Latest%20Release&color=55FFFF)</a> | ||
<a href="">![GitHub Downloads (all assets, latest release)](https://img.shields.io/github/downloads/GTeamx/VPNSetup/latest/total?sort=date&style=for-the-badge&label=Latest%20Downloads)</a> | ||
<a href="">![GitHub Downloads (all assets, all releases)](https://img.shields.io/github/downloads/GTeamx/VPNSetup/total?style=for-the-badge&label=Total%20Downloads)</a> | ||
<a href="">![GitHub License](https://img.shields.io/github/license/GTeamx/VPNSetup?style=for-the-badge)</a> | ||
<br> | ||
<a href="">![GitHub commits since latest release](https://img.shields.io/github/commits-since/GTeamx/VPNSetup/latest?sort=date&style=for-the-badge&label=commits%20since%20release)</a> | ||
<a href="">![GitHub commit activity (branch)](https://img.shields.io/github/commit-activity/m/GTeamx/VPNSetup/dev?style=for-the-badge&label='dev'%20branch%20commits)</a> | ||
<a href="">![GitHub commits difference between two branches/tags/commits](https://img.shields.io/github/commits-difference/GTeamx/VPNSetup?base=main&head=dev&style=for-the-badge&label='dev'%20ahead%20of%20'main'%20in%20commits)</a> | ||
<br> | ||
<a href="">![GitHub branch check runs](https://img.shields.io/github/check-runs/GTeamx/VPNSetup/main?style=for-the-badge&label='main'%20branch%20checks)</a> | ||
<a href="">![GitHub branch check runs](https://img.shields.io/github/check-runs/GTeamx/VPNSetup/dev?style=for-the-badge&label='dev'%20branch%20checks)</a> | ||
<a href="">![Libraries.io dependency status for GitHub repo](https://img.shields.io/librariesio/github/GTeamx/VPNSetup?style=for-the-badge)</a> | ||
<br> | ||
<a href="">![GitHub Repo stars](https://img.shields.io/github/stars/GTeamx/VPNSetup?style=for-the-badge)</a> | ||
<a href="">![GitHub watchers](https://img.shields.io/github/watchers/GTeamx/VPNSetup?style=for-the-badge)</a> | ||
<a href="">![GitHub forks](https://img.shields.io/github/forks/GTeamx/VPNSetup?style=for-the-badge)</a> | ||
<a href="">![Discord](https://img.shields.io/discord/1046001788106575912?style=for-the-badge&label=Discord)</a> | ||
|
||
</div> | ||
|
||
VPN-Setup aims to be an easy to use, efficient & feature filled utility. This goes from automatically setting up VPN services such as WireGuard or OpenVPN, to manage users seamlessly, adding or revoking a client in just a few seconds. | ||
|
||
## 📎 Special Credits | ||
|
||
Special credits to Angristan for his [OpenVPN installation script](https://github.com/angristan/openvpn-install) that we are using to automatically setup OpenVPN and manage users with! | ||
|
||
## 🔔 Releases/Updates | ||
|
||
We highly recommand using the latest releases when possible as they might fix critical issues or errors. **VPN-Setup updates are ONLY RELEASED [HERE](https://github.com/GTeamx/VPNSetup)!**. | ||
|
||
There a high chance you'll face errors and issues if your using the latest .sh file from the dev or main branch, please only use the released versions. | ||
|
||
## 🚷 Errors/Bugs | ||
|
||
If you face any error or bugs during the usage of the script, please open an issue on our GitHub page. Providing sufficiant information to we are able to reproduce the error/issue on our side (provide the OS, released version that you were using, any other installed softwares, any "special" config changes that may or may not have done like in sysctl for exemple, ect...) | ||
|
||
## 🎯 Issues/Feature request | ||
|
||
Before opening an issue or feature request make sure you follow our templates! If your issue/feature request goes unotice, you can open a ticket on our Discord server or bump it! | ||
|
||
## 🔃 Contributing | ||
|
||
Before contributing, please make sure that you follow our conventions (naming scheme, indentation) and that your code works! Make sure to also precise on what OS and what OS version you test were ran, provide any additionnal software installed where you ran your test (if applicable) | ||
|
||
## 📜 License | ||
|
||
This project is licensed under GNU General Public License v3.0 (GPL). |