Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

sync with main project #3

Merged
merged 27 commits into from
Dec 25, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
a7e54a4
build(deps): bump appleboy/ssh-action from 0.1.4 to 0.1.5
dependabot[bot] Aug 1, 2022
83111c5
build(deps): bump actions/checkout from 3.0.2 to 3.1.0
dependabot[bot] Nov 1, 2022
0de56f8
Use --genkey secret filename instead (#1059)
Nov 21, 2022
d375145
Remove Debian 9 in e2e tests as it has been removed by DO
angristan Nov 21, 2022
86a6d2d
Revert "Use --genkey secret filename instead (#1059)"
angristan Nov 21, 2022
d629791
build(deps): bump actions/checkout from 3.1.0 to 3.2.0 (#1075)
dependabot[bot] Jan 3, 2023
638b511
build(deps): bump appleboy/ssh-action from 0.1.5 to 0.1.6 (#1074)
dependabot[bot] Jan 3, 2023
8e427ee
Delete .github/ISSUE_TEMPLATE directory
angristan Jan 3, 2023
039ebaa
Fix the wrong client config when the certificate contains END string …
xumia Jan 3, 2023
9b5361d
Adds the `--no-same-owner` flag to tar command (#1070)
codekandis Jan 3, 2023
4ee44c8
Use DNS fallback to ifconfig.co (#1066)
starek4 Jan 6, 2023
2a57e89
Public IP detection: change provider
angristan Jan 6, 2023
38d3bf9
Update FAQ with IPv6 prefix policies for ULA addresses (#1083)
gits7r Jan 18, 2023
48f8c16
Add issue and PR templates
angristan Jan 21, 2023
2d0eca1
Update issue/PR template + contributing guidelines
angristan Jan 21, 2023
580c617
Update issue template
angristan Jan 21, 2023
64cbbce
Add OpenVPN 2.5 notice to README
angristan Jan 21, 2023
0ac1bf4
Format markdown table in readme
angristan Jan 21, 2023
ca8d58d
Fix checkout in test workflow
angristan Jan 21, 2023
2f76bb5
Update easy-rsa to 3.1.2 and fix compatibility with Ubuntu 22.04
angristan Jan 21, 2023
d2556ff
Add support for CentOS 9 + update supported distributions
angristan Jan 21, 2023
33fe6af
Update cloud providers
angristan Jan 22, 2023
d096f7a
Add star history
angristan Jan 22, 2023
80feebe
Remove visitors badge
angristan Jan 22, 2023
1a249c6
ci: test workflow server images update (#1183)
angristan Nov 20, 2023
651e36c
Fix syntax error on Rocky Linux version check (#1182)
Salbei Nov 20, 2023
5a4b31b
Fix typo in README
angristan Nov 20, 2023
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
74 changes: 0 additions & 74 deletions .github/ISSUE_TEMPLATE/bug.yml

This file was deleted.

21 changes: 0 additions & 21 deletions .github/ISSUE_TEMPLATE/feature-request.md

This file was deleted.

10 changes: 10 additions & 0 deletions .github/issue_template.md
Original file line number Diff line number Diff line change
@@ -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 changes: 7 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -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 changes: 1 addition & 1 deletion .github/workflows/lint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
23 changes: 13 additions & 10 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ on:
push:
branches:
- master
- ci

name: Test
jobs:
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand All @@ -68,23 +71,23 @@ 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
key: ${{ secrets.SSH_KEY }}
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
Expand Down
22 changes: 22 additions & 0 deletions FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -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>"`
54 changes: 32 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -114,27 +113,28 @@ export PASS="1"

## Compatibility

The script supports these OS and architectures:

| | 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 | ❌ | ✅ | ❌ | ❔ |
The script supports these Linux distributions:

| | 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

Expand All @@ -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

---

Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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)
Loading