Need help with setup-ipsec-vpn?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

hwdsl2
16.1K Stars 4.4K Forks Other 789 Commits 0 Opened issues

Description

Scripts to build your own IPsec VPN server, with IPsec/L2TP, Cisco IPsec and IKEv2

Services available

!
?

Need anything else?

Contributors list

# 157
Shell
Docker
ipsec
encrypt...
753 commits
# 12,330
Shell
ikev2
l2tp
8 commits
# 15,169
Shell
ikev2
l2tp
6 commits
# 14,072
google-...
google-...
Google
Go
5 commits
# 20,706
HTML
CSS
Shell
ikev2
3 commits
# 1,490
CSS
Shell
PHP
dns-ser...
1 commit
# 47,115
Shell
ikev2
l2tp
1 commit
# 43,592
Dart
Shell
jvm-lan...
flash
1 commit
# 41,944
Shell
l2tp
.NET
cpluspl...
1 commit
# 46,607
Scala
Shell
playfra...
MongoDB
1 commit

IPsec VPN Server Auto Setup Scripts

Build Status GitHub Stars Docker Stars Docker Pulls

Set up your own IPsec VPN server in just a few minutes, with IPsec/L2TP, Cisco IPsec and IKEv2 on Ubuntu, Debian and CentOS. All you need to do is provide your own VPN credentials, and let the scripts handle the rest.

An IPsec VPN encrypts your network traffic, so that nobody between you and the VPN server can eavesdrop on your data as it travels via the Internet. This is especially useful when using unsecured networks, e.g. at coffee shops, airports or hotel rooms.

We will use Libreswan as the IPsec server, and xl2tpd as the L2TP provider.

Read this in other languages: English, 简体中文.

Table of Contents

Quick start

First, prepare your Linux server* with a fresh install of one of the following OS.

Use this one-liner to set up an IPsec VPN server:

Ubuntu & Debian
wget https://git.io/vpnsetup -O vpn.sh && sudo sh vpn.sh && sudo ikev2.sh --auto
CentOS/RHEL, Rocky Linux & AlmaLinux
wget https://git.io/vpnsetup-centos -O vpn.sh && sudo sh vpn.sh && sudo ikev2.sh --auto
Amazon Linux 2
wget https://git.io/vpnsetup-amzn -O vpn.sh && sudo sh vpn.sh && sudo ikev2.sh --auto

Your VPN login details will be randomly generated, and displayed on the screen when finished.

Click here to see the VPN scripts in action (terminal recording).

Note: This recording is for demonstration purposes only. VPN credentials in this recording are NOT valid.

A pre-built Docker image is also available. For other installation options and client setup, read the sections below.

* A dedicated server or virtual private server (VPS). OpenVZ VPS is not supported.

Features

  • New: The faster IPsec/XAuth ("Cisco IPsec") and IKEv2 modes are supported
  • New: A pre-built Docker image of the VPN server is now available
  • Fully automated IPsec VPN server setup, no user input needed
  • Encapsulates all VPN traffic in UDP - does not need ESP protocol
  • Can be directly used as "user-data" for a new Amazon EC2 instance
  • Includes
    sysctl.conf
    optimizations for improved performance

Requirements

A dedicated server or virtual private server (VPS), freshly installed with one of the following OS:

  • Ubuntu 20.04 (Focal) or 18.04 (Bionic)
  • Debian 10 (Buster)* or 9 (Stretch)
  • CentOS 8** or 7
  • Rocky Linux 8
  • AlmaLinux OS 8
  • Red Hat Enterprise Linux (RHEL) 8 or 7
  • Amazon Linux 2

This also includes Linux VMs in public clouds, such as DigitalOcean, Vultr, Linode, Google Compute Engine, Amazon Lightsail, Microsoft Azure, OVH and IBM Cloud. Amazon EC2 users can deploy rapidly using CloudFormation or user data.

Deploy to AWS Deploy to Azure Deploy to DigitalOcean Deploy to Linode

» I want to run my own VPN but don't have a server for that

A pre-built Docker image is also available. Advanced users can set up the VPN server on a Raspberry Pi. [1] [2]

* Debian 10 users should use the standard Linux kernel.
** Support for CentOS Linux 8 will end on December 31, 2021.

:warning: DO NOT run these scripts on your PC or Mac! They should only be used on a server!

Installation

First, update your system with

apt-get update && apt-get dist-upgrade
(Ubuntu/Debian) or
yum update
and reboot. This is optional, but recommended.

To install the VPN, please choose one of the following options:

Option 1: Have the script generate random VPN credentials for you (will be displayed when finished):

Ubuntu & Debian
wget https://git.io/vpnsetup -O vpn.sh && sudo sh vpn.sh
CentOS/RHEL, Rocky Linux & AlmaLinux
yum -y install wget
wget https://git.io/vpnsetup-centos -O vpn.sh && sudo sh vpn.sh
Amazon Linux 2
wget https://git.io/vpnsetup-amzn -O vpn.sh && sudo sh vpn.sh

After successful installation, it is recommended to set up IKEv2:

sudo ikev2.sh --auto

Option 2: Edit the script and provide your own VPN credentials:

Ubuntu & Debian
wget https://git.io/vpnsetup -O vpn.sh
nano -w vpn.sh
[Replace with your own values: YOUR_IPSEC_PSK, YOUR_USERNAME and YOUR_PASSWORD]
sudo sh vpn.sh
CentOS/RHEL, Rocky Linux & AlmaLinux
yum -y install wget nano
wget https://git.io/vpnsetup-centos -O vpn.sh
nano -w vpn.sh
[Replace with your own values: YOUR_IPSEC_PSK, YOUR_USERNAME and YOUR_PASSWORD]
sudo sh vpn.sh
Amazon Linux 2
wget https://git.io/vpnsetup-amzn -O vpn.sh
nano -w vpn.sh
[Replace with your own values: YOUR_IPSEC_PSK, YOUR_USERNAME and YOUR_PASSWORD]
sudo sh vpn.sh

Note: A secure IPsec PSK should consist of at least 20 random characters.

After successful installation, it is recommended to set up IKEv2:

sudo ikev2.sh --auto

Option 3: Define your VPN credentials as environment variables:

Ubuntu & Debian
# All values MUST be placed inside 'single quotes'
# DO NOT use these special characters within values: \ " '
wget https://git.io/vpnsetup -O vpn.sh
sudo VPN_IPSEC_PSK='your_ipsec_pre_shared_key' \
VPN_USER='your_vpn_username' \
VPN_PASSWORD='your_vpn_password' \
sh vpn.sh
CentOS/RHEL, Rocky Linux & AlmaLinux
# All values MUST be placed inside 'single quotes'
# DO NOT use these special characters within values: \ " '
yum -y install wget
wget https://git.io/vpnsetup-centos -O vpn.sh
sudo VPN_IPSEC_PSK='your_ipsec_pre_shared_key' \
VPN_USER='your_vpn_username' \
VPN_PASSWORD='your_vpn_password' \
sh vpn.sh
Amazon Linux 2
# All values MUST be placed inside 'single quotes'
# DO NOT use these special characters within values: \ " '
wget https://git.io/vpnsetup-amzn -O vpn.sh
sudo VPN_IPSEC_PSK='your_ipsec_pre_shared_key' \
VPN_USER='your_vpn_username' \
VPN_PASSWORD='your_vpn_password' \
sh vpn.sh

After successful installation, it is recommended to set up IKEv2:

sudo ikev2.sh --auto

Note: If unable to download via

wget
, you may also open vpnsetup.sh, vpnsetup_centos.sh or vpnsetup_amzn.sh, and click the
Raw
button on the right. Press
Ctrl-A
to select all,
Ctrl-C
to copy, then paste into your favorite editor.

Next steps

Get your computer or device to use the VPN. Please refer to:

Guide: How to Set Up and Use IKEv2 VPN

Configure IPsec/L2TP VPN Clients

Configure IPsec/XAuth ("Cisco IPsec") VPN Clients

If you get an error when trying to connect, see Troubleshooting.

Enjoy your very own VPN! :sparkles::tada::rocket::sparkles:

Important notes

Read this in other languages: English, 简体中文.

Windows users: A one-time registry change is required if the VPN server or client is behind NAT (e.g. home router).

Android users: If you encounter connection issues, try these steps.

The same VPN account can be used by your multiple devices. However, due to an IPsec/L2TP limitation, if you wish to connect multiple devices simultaneously from behind the same NAT (e.g. home router), you must use only IKEv2 or IPsec/XAuth mode.

To view or update VPN user accounts, see Manage VPN users. Helper scripts are included for convenience.

For servers with an external firewall (e.g. EC2/GCE), open UDP ports 500 and 4500 for the VPN. Aliyun users, see #433.

Clients are set to use Google Public DNS when the VPN is active. If another DNS provider is preferred, you may use alternative DNS servers.

Using kernel support could improve IPsec/L2TP performance. It is available on all supported OS. Ubuntu users should install the

linux-modules-extra-$(uname -r)
(or
linux-image-extra
) package and run
service xl2tpd restart
.

The scripts will backup existing config files before making changes, with

.old-date-time
suffix.

Upgrade Libreswan

The additional scripts in extras/ can be used to upgrade Libreswan (changelog | announce). The latest supported version is

4.4
. Check which version is installed:
ipsec --version
.
Ubuntu & Debian
wget https://git.io/vpnupgrade -O vpnup.sh && sudo sh vpnup.sh
CentOS/RHEL, Rocky Linux & AlmaLinux
wget https://git.io/vpnupgrade-centos -O vpnup.sh && sudo sh vpnup.sh
Amazon Linux 2
wget https://git.io/vpnupgrade-amzn -O vpnup.sh && sudo sh vpnup.sh

Manage VPN users

See Manage VPN users.

Advanced usage

See Advanced usage.

Bugs & Questions

Uninstallation

See Uninstall the VPN.

License

Copyright (C) 2014-2021 Lin Song View my profile on LinkedIn
Based on the work of Thomas Sarlandie (Copyright 2012)

Creative Commons License
This work is licensed under the Creative Commons Attribution-ShareAlike 3.0 Unported License
Attribution required: please include my name in any derivative and let me know how you have improved it!

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.