Bernhard.Linz/openvpn-install
1
0
Fork 0
mirror of https://github.com/angristan/openvpn-install.git synced 2025-02-05 05:01:34 +01:00
Code Issues Projects Releases Wiki Activity

sync with main project

Browse Source
This commit is contained in:
Mohammad Parvin 2023-12-25 15:46:30 +03:30
parent a879503af1
commit 0b969ebc0e
8 changed files with 84 additions and 127 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

74
.github/ISSUE_TEMPLATE/bug.yml vendored
View File

@ -1,74 +0,0 @@
name: Bug Report
description: File a bug report
title: "[Bug]: "
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
**PLEASE** prioritise these communities before opening an issue.
- https://forums.openvpn.net
- https://stackoverflow.com/questions/tagged/openvpn
- https://github.com/angristan/openvpn-install/discussions
⚠️ **ANY ISSUE THAT IS NOT CLEARLY A BUG REPORT WILL BE CLOSED AND/OR CONVERTED TO A DISCUSSION.**
- type: checkboxes
id: pre
attributes:
label: Make sure your check these beforehand!
description: Search before opening an issue.
options:
- label: Issues - https://github.com/angristan/openvpn-install/issues
required: true
- label: README and FAQ - https://github.com/angristan/openvpn-install
required: true
- label: Wiki - https://github.com/angristan/openvpn-install/wiki
required: true
- label: Discussions - https://github.com/angristan/openvpn-install/discussions
required: true
- type: input
id: server
attributes:
label: Server OS
description: What OS is the OpenVPN server running on?
placeholder: Debian 10
validations:
required: false
- type: input
id: openvpn
attributes:
label: OpenVPN version
description: What OpenVPN version is running on your server?
placeholder: 2.5.0
validations:
required: false
- type: input
id: client
attributes:
label: Client
description: What OS and client are you using? Please specify the versions.
placeholder: Viscosity 1.10.1 on macOS 12.1
validations:
required: false
- type: textarea
id: issue
attributes:
label: What is the bug?
description: Also tell us, what did you expect to happen?
placeholder: Tell us what you see!
value: "A bug happened!"
validations:
required: true
- type: textarea
id: logs
attributes:
label: Relevant log output
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
render: shell

21
.github/ISSUE_TEMPLATE/feature-request.md vendored
View File

@ -1,21 +0,0 @@
---
name: Feature request
about: Suggest an idea for this project
title: ""
labels: ""
assignees: ""
---
**Checklist**
- [ ] I read the [README](https://github.com/angristan/openvpn-install/blob/master/README.md)
- [ ] I read the [FAQ](https://github.com/angristan/openvpn-install/blob/master/FAQ.md)
- [ ] I searched the [issues](https://github.com/angristan/openvpn-install/issues?q=is%3Aissue+)
- [ ] My issue is about the script, and not OpenVPN itself
<!---
⚠️
If you need help with OpenVPN itself, please us the [community forums](https://forums.openvpn.net/) or [Stack Overflow](https://stackoverflow.com/questions/tagged/openvpn)
PLEASE OPEN A DISCUSSION INSTEAD: https://github.com/angristan/openvpn-install/discussions
⚠️
--->

10
.github/issue_template.md vendored Normal file
View File

@ -0,0 +1,10 @@
<!---
❗️ Please read ❗️
➡️ If you need help with OpenVPN itself, please use the community forums (https://forums.openvpn.net/) or Stack Overflow (https://stackoverflow.com/questions/tagged/openvpn)
➡️ For the script, prefer opening a discussion thread for help: https://github.com/angristan/openvpn-install/discussions
💡 It helps keep the issue tracker clean and focused on bugs and feature requests.
🙏 Please include as much information as possible, and make sure you're running the latest version of the script.
✍️ Please state the Linux distribution you're using and its version, as well as the OpenVPN version.
✋ For feature requests, remember that this script is meant to be simple and easy to use. If you want to add a lot of options, it's better to fork the project.
--->

7
.github/pull_request_template.md vendored Normal file
View File

@ -0,0 +1,7 @@
<!---
❗️ Please read ❗️
➡️ Please make sure you've followed the guidelines: https://github.com/angristan/openvpn-install#contributing
✅ Please make sure your changes are tested and working
🗣️ Please avoid large PRs, and discuss changes in a GitHub issue first
✋ If the changes are too big and not in line with the project, they will probably be rejected. Remember that this script is meant to be simple and easy to use.
--->

2
.github/workflows/lint.yml vendored
View File

@ -7,7 +7,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Checkout Code
uses: actions/checkout@v3.0.2
uses: actions/checkout@v3.2.0
- name: Lint Code Base
uses: github/super-linter@v4.1.0
env:

23
.github/workflows/test.yml vendored
View File

@ -2,6 +2,7 @@ on:
push:
branches:
- master
- ci
name: Test
jobs:
@ -11,16 +12,18 @@ jobs:
strategy:
matrix:
os-image:
- debian-9-x64
- debian-10-x64
- debian-11-x64
- ubuntu-18-04-x64
- debian-12-x64
- ubuntu-20-04-x64
- fedora-35-x64
- ubuntu-22-04-x64
- fedora-37-x64
- fedora-38-x64
- centos-7-x64
- centos-stream-8-x64
# - centos-stream-9-x64 # yum oomkill
steps:
- uses: actions/checkout@v3.0.2
- uses: actions/checkout@v3.2.0
- name: Setup doctl
uses: digitalocean/action-doctl@v2
@ -50,7 +53,7 @@ jobs:
- name: Setup remote server (Debian/Ubuntu)
if: steps.server_os.outputs.value == 'debian' || steps.server_os.outputs.value == 'ubuntu'
uses: appleboy/ssh-action@v0.1.4
uses: appleboy/ssh-action@v0.1.6
with:
host: ${{ steps.server_ip.outputs.value }}
username: root
@ -59,7 +62,7 @@ jobs:
- name: Setup remote server (Fedora)
if: steps.server_os.outputs.value == 'fedora'
uses: appleboy/ssh-action@v0.1.4
uses: appleboy/ssh-action@v0.1.6
with:
host: ${{ steps.server_ip.outputs.value }}
username: root
@ -68,7 +71,7 @@ jobs:
- name: Setup remote server (CentOS)
if: steps.server_os.outputs.value == 'centos'
uses: appleboy/ssh-action@v0.1.4
uses: appleboy/ssh-action@v0.1.6
with:
host: ${{ steps.server_ip.outputs.value }}
username: root
@ -76,15 +79,15 @@ jobs:
script: set -x && yum install -y git
- name: Download repo and checkout current commit
uses: appleboy/ssh-action@v0.1.4
uses: appleboy/ssh-action@v0.1.6
with:
host: ${{ steps.server_ip.outputs.value }}
username: root
key: ${{ secrets.SSH_KEY }}
script: set -x && git clone https://github.com/angristan/openvpn-install.git && cd openvpn-install && git checkout ${{ github.event.pull_request.head.sha }}
script: set -x && git clone https://github.com/angristan/openvpn-install.git && cd openvpn-install && git checkout ${{ github.sha }}
- name: Run openvpn-install.sh in headless mode
uses: appleboy/ssh-action@v0.1.4
uses: appleboy/ssh-action@v0.1.6
with:
host: ${{ steps.server_ip.outputs.value }}
username: root

22
FAQ.md
View File

@ -151,3 +151,25 @@ route 10.0.0.0 255.0.0.0
```
So for example - here it would route all traffic of `10.0.0.0/8` to the vpn. And the rest through the internet.
---
**Q:** I have enabled IPv6 and my VPN client gets an IPv6 address. Why do I reach the websites or other dual-stacked destionations via IPv4 only?
**A:** This is because inside the tunnel you don't get a publicly routable IPv6 address, instead you get an ULA (Unlique Local Lan) address. Operating systems don't prefer this all the time. You can fix this in your operating system policies as it's unrelated to the VPN itself:
Windows (commands needs to run cmd.exe as Administrator):
```
netsh interface ipv6 add prefixpolicy fd00::/8 3 1
```
Linux:
edit `/etc/gai.conf` and uncomment the following line and also change its value to `1`:
```
label fc00::/7 1
```
This will not work properly unless you add you your VPN server `server.conf` one or two lines to push at least 1 (one) IPv6 DNS server. Most providers have IPv6 servers as well, add two more lines of `push "dhcp-option DNS <IPv6>"`

52
README.md
View File

@ -2,7 +2,6 @@
![Test](https://github.com/angristan/openvpn-install/workflows/Test/badge.svg)
![Lint](https://github.com/angristan/openvpn-install/workflows/Lint/badge.svg)
![visitors](https://visitor-badge.glitch.me/badge?page_id=angristan.openvpn-install)
[![Say Thanks!](https://img.shields.io/badge/Say%20Thanks-!-1EAEDB.svg)](https://saythanks.io/to/angristan)
OpenVPN installer for Debian, Ubuntu, Fedora, CentOS, Arch Linux, Oracle Linux, Rocky Linux and AlmaLinux.
@ -114,27 +113,28 @@ export PASS="1"
## Compatibility
The script supports these OS and architectures:
The script supports these Linux distributions:
| | i386 | amd64 | armhf | arm64 |
| --------------- | ---- | ----- | ----- | ----- |
| Amazon Linux 2 | ❔ | ✅ | ❔ | ❔ |
| Arch Linux | ❔ | ✅ | ❔ | ✅ |
| CentOS 7 | ✅ | ✅ | ✅ | ✅ |
| CentOS 8 | ❌ | ✅ | ❌ | ✅ |
| Debian >= 9 | ✅ | ✅ | ✅ | ✅ |
| Fedora >= 27 | ❔ | ✅ | ❔ | ❔ |
| Ubuntu 16.04 | ✅ | ✅ | ❌ | ❌ |
| Ubuntu >= 18.04 | ✅ | ✅ | ✅ | ✅ |
| Oracle Linux 8 | ❌ | ✅ | ❌ | ❔ |
| Rocky Linux 8 | ❔ | ✅ | ❔ | ❔ |
| AlmaLinux 8 | ❌ | ✅ | ❌ | ❔ |
| | Support |
| ------------------ | ------- |
| AlmaLinux 8 | ✅ |
| Amazon Linux 2 | ✅ |
| Arch Linux | ✅ |
| CentOS 7 | ✅ 🤖 |
| CentOS Stream >= 8 | ✅ 🤖 |
| Debian >= 10 | ✅ 🤖 |
| Fedora >= 35 | ✅ 🤖 |
| Oracle Linux 8 | ✅ |
| Rocky Linux 8 | ✅ |
| Ubuntu >= 18.04 | ✅ 🤖 |
To be noted:
- It should work on Debian 8+ and Ubuntu 16.04+. But versions not in the table above are not officially supported.
- The script is regularly tested against the distributions marked with a 🤖 only.
- It's only tested on `amd64` architecture.
- It should work on older versions such as Debian 8+, Ubuntu 16.04+ and previous Fedora releases. But versions not in the table above are not officially supported.
- It should also support versions between the LTS versions, but these are not tested.
- The script requires `systemd`.
- The script is regularly tested against `amd64` only.
## Fork
@ -150,10 +150,9 @@ More Q&A in [FAQ.md](FAQ.md).
**A:** I recommend these:
- [Vultr](https://www.vultr.com/?ref=8537055-6G): Worldwide locations, IPv6 support, starting at \$3.50/month
- [Hetzner](https://hetzner.cloud/?ref=ywtlvZsjgeDq): Germany, IPv6, 20 TB of traffic, starting at €3/month
- [Digital Ocean](https://goo.gl/qXrNLK): Worldwide locations, IPv6 support, starting at \$5/month
- [PulseHeberg](https://goo.gl/76yqW5): France, unlimited bandwidth, starting at €3/month
- [Vultr](https://www.vultr.com/?ref=8948982-8H): Worldwide locations, IPv6 support, starting at \$5/month
- [Hetzner](https://hetzner.cloud/?ref=ywtlvZsjgeDq): Germany, Finland and USA. IPv6, 20 TB of traffic, starting at 4.5€/month
- [Digital Ocean](https://m.do.co/c/ed0ba143fe53): Worldwide locations, IPv6 support, starting at \$4/month
---
@ -192,12 +191,19 @@ Solutions that provision a ready to use OpenVPN server based on this script in o
## Contributing
## Discuss changes
Please open an issue before submitting a PR if you want to discuss a change, especially if it's a big one.
### Code formatting
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/openvpn-install/blob/master/.github/workflows/push.yml).
## Security and Encryption
> **Warning**
> This has not been updated for OpenVPN 2.5 and later.
OpenVPN's default settings are pretty weak regarding encryption. This script aims to improve that.
OpenVPN 2.4 was a great update regarding encryption. It added support for ECDSA, ECDH, AES GCM, NCP and tls-crypt.
@ -346,3 +352,7 @@ You can [say thanks](https://saythanks.io/to/angristan) if you want!
Many thanks to the [contributors](https://github.com/Angristan/OpenVPN-install/graphs/contributors) and Nyr's original work.
This project is under the [MIT Licence](https://raw.githubusercontent.com/Angristan/openvpn-install/master/LICENSE)
## Star History
[![Star History Chart](https://api.star-history.com/svg?repos=angristan/openvpn-install&type=Date)](https://star-history.com/#angristan/openvpn-install&Date)