- Notifications
You must be signed in to change notification settings - Fork6.4k
Scripts to build your own IPsec VPN server, with IPsec/L2TP, Cisco IPsec and IKEv2
License
hwdsl2/setup-ipsec-vpn
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
Set up your own IPsec VPN server in just a few minutes, with IPsec/L2TP, Cisco IPsec and IKEv2.
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 useLibreswan as the IPsec server, andxl2tpd as the L2TP provider.
» 📖 Book: Build Your Own VPN Server [English |中文 |Español |Deutsch |Français |Italiano |NL |PT |日本語]
First, prepare your Linux server* with an install of Ubuntu, Debian or CentOS.
Use this one-liner to set up an IPsec VPN server:
wget https://get.vpnsetup.net -O vpn.sh&& sudo sh vpn.shYour VPN login details will be randomly generated, and displayed when finished.
Optional: InstallWireGuard and/orOpenVPN on the same server.
See the script in action (terminal recording).
Note: This recording is for demo purposes only. VPN credentials in this recording areNOT valid.
Click here if you are unable to download.
You may also usecurl to download:
curl -fsSL https://get.vpnsetup.net -o vpn.sh&& sudo sh vpn.shAlternative setup URLs:
https://github.com/hwdsl2/setup-ipsec-vpn/raw/master/vpnsetup.shhttps://gitlab.com/hwdsl2/setup-ipsec-vpn/-/raw/master/vpnsetup.sh
If you are unable to download, openvpnsetup.sh, then click theRaw button on the right. PressCtrl/Cmd+A to select all,Ctrl/Cmd+C to copy, then paste into your favorite editor.
A pre-builtDocker image is also available. For other options and client setup, read the sections below.
* A cloud server, virtual private server (VPS) or dedicated server.
- Fully automated IPsec VPN server setup, no user input needed
- Supports IKEv2 with strong and fast ciphers (e.g. AES-GCM)
- Generates VPN profiles to auto-configure iOS, macOS and Android devices
- Supports Windows, macOS, iOS, Android, Chrome OS and Linux as VPN clients
- Includes helper scripts to manage VPN users and certificates
A cloud server, virtual private server (VPS) or dedicated server, with an install of:
- Ubuntu 24.04, 22.04 or 20.04
- Debian 12 or 11
- CentOS Stream 9
- Rocky Linux or AlmaLinux
- Oracle Linux
- Amazon Linux 2
Other supported Linux distributions.
- Raspberry Pi OS (Raspbian)
- Kali Linux
- Alpine Linux
- Red Hat Enterprise Linux (RHEL)
This also includes Linux VMs in public clouds, such asDigitalOcean,Vultr,Linode,OVH andMicrosoft Azure. Public cloud users can also deploy usinguser data.
Quick deploy to:
» I want to run my own VPN but don't have a server for that
For servers with an external firewall (e.g.EC2/GCE), open UDP ports 500 and 4500 for the VPN.
A pre-builtDocker image is also available. Advanced users can install on aRaspberry Pi.[1][2]
First, update your server withsudo apt-get update && sudo apt-get dist-upgrade (Ubuntu/Debian) orsudo 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).
wget https://get.vpnsetup.net -O vpn.sh&& sudo sh vpn.shOption 2: Edit the script and provide your own VPN credentials.
wget https://get.vpnsetup.net -O vpn.shnano -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.
Option 3: Define your VPN credentials as environment variables.
# All values MUST be placed inside 'single quotes'# DO NOT use these special characters within values: \ " 'wget https://get.vpnsetup.net -O vpn.shsudo VPN_IPSEC_PSK='your_ipsec_pre_shared_key' \VPN_USER='your_vpn_username' \VPN_PASSWORD='your_vpn_password' \sh vpn.sh
You may optionally installWireGuard and/orOpenVPN on the same server. If your server runs CentOS Stream, Rocky Linux or AlmaLinux, first install OpenVPN/WireGuard, then install the IPsec VPN.
Click here if you are unable to download.
You may also usecurl to download. For example:
curl -fL https://get.vpnsetup.net -o vpn.shsudo sh vpn.sh
Alternative setup URLs:
https://github.com/hwdsl2/setup-ipsec-vpn/raw/master/vpnsetup.shhttps://gitlab.com/hwdsl2/setup-ipsec-vpn/-/raw/master/vpnsetup.sh
If you are unable to download, openvpnsetup.sh, then click theRaw button on the right. PressCtrl/Cmd+A to select all,Ctrl/Cmd+C to copy, then paste into your favorite editor.
I want to install the older Libreswan version 4.
It is generally recommended to use the latestLibreswan version 5, which is the default version in this project. However, if you want to install the older Libreswan version 4:
wget https://get.vpnsetup.net -O vpn.shsudo VPN_SWAN_VER=4.15 sh vpn.sh
Note: If Libreswan version 5 is already installed, you may need to firstUninstall the VPN before installing Libreswan version 4. Alternatively, download theupdate script, edit it to specifySWAN_VER=4.15, then run the script.
By default, clients are set to useGoogle Public DNS when the VPN is active. When installing the VPN, you may optionally specify custom DNS server(s) for all VPN modes. Example:
sudo VPN_DNS_SRV1=1.1.1.1 VPN_DNS_SRV2=1.0.0.1 sh vpn.sh
UseVPN_DNS_SRV1 to specify the primary DNS server, andVPN_DNS_SRV2 to specify the secondary DNS server (optional).
Below is a list of some popular public DNS providers for your reference.
| Provider | Primary DNS | Secondary DNS | Notes |
|---|---|---|---|
| Google Public DNS | 8.8.8.8 | 8.8.4.4 | Default in this project |
| Cloudflare | 1.1.1.1 | 1.0.0.1 | See also:Cloudflare for families |
| Quad9 | 9.9.9.9 | 149.112.112.112 | Blocks malicious domains |
| OpenDNS | 208.67.222.222 | 208.67.220.220 | Blocks phishing domains, configurable. |
| CleanBrowsing | 185.228.168.9 | 185.228.169.9 | Domain filters available |
| NextDNS | Varies | Varies | Ad blocking, free tier available.Learn more. |
| Control D | Varies | Varies | Ad blocking, configurable.Learn more. |
If you need to change DNS servers after VPN setup, seeAdvanced usage.
Note: If IKEv2 is already set up on the server, the variables above have no effect for IKEv2 mode. In that case, to customize IKEv2 options such as DNS servers, you can firstremove IKEv2, then set it up again usingsudo ikev2.sh.
When installing the VPN, advanced users can optionally customize IKEv2 options.
Option 1: Skip IKEv2 during VPN setup, then set up IKEv2 using custom options.
When installing the VPN, you can skip IKEv2 and only install the IPsec/L2TP and IPsec/XAuth ("Cisco IPsec") modes:
sudo VPN_SKIP_IKEV2=yes sh vpn.sh
(Optional) If you want to specify custom DNS server(s) for VPN clients, defineVPN_DNS_SRV1 and optionallyVPN_DNS_SRV2. SeeUse alternative DNS servers for details.
After that, run the IKEv2 helper script to set up IKEv2 interactively using custom options:
sudo ikev2.sh
You can customize the following options: VPN server's DNS name, name and validity period of the first client, DNS server for VPN clients and whether to password protect client config files.
Note: TheVPN_SKIP_IKEV2 variable has no effect if IKEv2 is already set up on the server. In that case, to customize IKEv2 options, you can firstremove IKEv2, then set it up again usingsudo ikev2.sh.
Option 2: Customize IKEv2 options using environment variables.
When installing the VPN, you can optionally specify a DNS name for the IKEv2 server address. The DNS name must be a fully qualified domain name (FQDN). Example:
sudo VPN_DNS_NAME='vpn.example.com' sh vpn.shSimilarly, you may specify a name for the first IKEv2 client. The default isvpnclient if not specified.
sudo VPN_CLIENT_NAME='your_client_name' sh vpn.shBy default, clients are set to useGoogle Public DNS when the VPN is active. You may specify custom DNS server(s) for all VPN modes. Example:
sudo VPN_DNS_SRV1=1.1.1.1 VPN_DNS_SRV2=1.0.0.1 sh vpn.sh
By default, no password is required when importing IKEv2 client configuration. You can choose to protect client config files using a random password.
sudo VPN_PROTECT_CONFIG=yes sh vpn.sh
For reference: List of IKEv1 and IKEv2 parameters.
| IKEv1 parameter* | Default value | Customize (env variable)** |
|---|---|---|
| Server address (DNS name) | - | No, but you can connect using a DNS name |
| Server address (public IP) | Auto detect | VPN_PUBLIC_IP |
| IPsec pre-shared key | Auto generate | VPN_IPSEC_PSK |
| VPN username | vpnuser | VPN_USER |
| VPN password | Auto generate | VPN_PASSWORD |
| DNS servers for clients | Google Public DNS | VPN_DNS_SRV1, VPN_DNS_SRV2 |
| Skip IKEv2 setup | no | VPN_SKIP_IKEV2=yes |
* These IKEv1 parameters are for IPsec/L2TP and IPsec/XAuth ("Cisco IPsec") modes.
** Define these as environment variables when running vpn(setup).sh.
| IKEv2 parameter* | Default value | Customize (env variable)** | Customize (interactive)*** |
|---|---|---|---|
| Server address (DNS name) | - | VPN_DNS_NAME | ✅ |
| Server address (public IP) | Auto detect | VPN_PUBLIC_IP | ✅ |
| Name of first client | vpnclient | VPN_CLIENT_NAME | ✅ |
| DNS servers for clients | Google Public DNS | VPN_DNS_SRV1, VPN_DNS_SRV2 | ✅ |
| Protect client config files | no | VPN_PROTECT_CONFIG=yes | ✅ |
| Enable/Disable MOBIKE | Enable if supported | ❌ | ✅ |
| Client cert validity | 10 years (120 months) | VPN_CLIENT_VALIDITY**** | ✅ |
| CA & server cert validity | 10 years (120 months) | ❌ | ❌ |
| CA certificate name | IKEv2 VPN CA | ❌ | ❌ |
| Certificate key size | 3072 bits | ❌ | ❌ |
* These IKEv2 parameters are for IKEv2 mode.
** Define these as environment variables when running vpn(setup).sh, or when setting up IKEv2 in auto mode (sudo ikev2.sh --auto).
*** Can be customized during interactive IKEv2 setup (sudo ikev2.sh). Refer to option 1 above.
**** UseVPN_CLIENT_VALIDITY to specify the client cert validity period in months. Must be an integer between 1 and 120.
In addition to these parameters, advanced users can alsocustomize VPN subnets during VPN setup.
Read this in other languages:English,中文,日本語.
Get your computer or device to use the VPN. Please refer to:
Configure IKEv2 VPN Clients (recommended)
Configure IPsec/L2TP VPN Clients
Configure IPsec/XAuth ("Cisco IPsec") VPN Clients
Read📖 VPN book to accessextra content.
Enjoy your very own VPN! ✨🎉🚀✨
Windows users: For IPsec/L2TP mode, aone-time registry change is required if the VPN server or client is behind NAT (e.g. home router).
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 from behind the same NAT (e.g. home router), you must useIKEv2 orIPsec/XAuth mode. To view or update VPN user accounts, seeManage VPN users.
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 useGoogle Public DNS when the VPN is active. If another DNS provider is preferred, seeAdvanced usage.
Using kernel support could improve IPsec/L2TP performance. It is available onall supported OS. Ubuntu users should install thelinux-modules-extra-$(uname -r) package and runservice xl2tpd restart.
The scripts will backup existing config files before making changes, with.old-date-time suffix.
Use this one-liner to updateLibreswan (changelog |announce) on your VPN server.
wget https://get.vpnsetup.net/upg -O vpnup.sh&& sudo sh vpnup.shClick here if you are unable to download.
You may also usecurl to download:
curl -fsSL https://get.vpnsetup.net/upg -o vpnup.sh&& sudo sh vpnup.shAlternative update URLs:
https://github.com/hwdsl2/setup-ipsec-vpn/raw/master/extras/vpnupgrade.shhttps://gitlab.com/hwdsl2/setup-ipsec-vpn/-/raw/master/extras/vpnupgrade.sh
If you are unable to download, openvpnupgrade.sh, then click theRaw button on the right. PressCtrl/Cmd+A to select all,Ctrl/Cmd+C to copy, then paste into your favorite editor.
The latest supported Libreswan version is5.2. Check installed version:ipsec --version.
Note:xl2tpd can be updated using your system's package manager, such asapt-get on Ubuntu/Debian.
SeeManage VPN users.
- Manage VPN users using helper scripts
- View VPN users
- View or update the IPsec PSK
- Manually manage VPN users
SeeAdvanced usage.
- Use alternative DNS servers
- DNS name and server IP changes
- IKEv2-only VPN
- Internal VPN IPs and traffic
- Specify VPN server's public IP
- Customize VPN subnets
- Port forwarding to VPN clients
- Split tunneling
- Access VPN server's subnet
- Access VPN clients from server's subnet
- Modify IPTables rules
- Deploy Google BBR congestion control
To uninstall IPsec VPN, run thehelper script:
Warning: This helper script will remove IPsec VPN from your server. All VPN configuration will bepermanently deleted, and Libreswan and xl2tpd will be removed. Thiscannot be undone!
wget https://get.vpnsetup.net/unst -O unst.sh&& sudo bash unst.shClick here if you are unable to download.
You may also usecurl to download:
curl -fsSL https://get.vpnsetup.net/unst -o unst.sh&& sudo bash unst.shAlternative script URLs:
https://github.com/hwdsl2/setup-ipsec-vpn/raw/master/extras/vpnuninstall.shhttps://gitlab.com/hwdsl2/setup-ipsec-vpn/-/raw/master/extras/vpnuninstall.sh
For more information, seeUninstall the VPN.
- Have a suggestion for this project? Open anEnhancement request.Pull requests are also welcome.
- If you found a reproducible bug, open a bug report for theIPsec VPN or for theVPN scripts.
- Got a question? Please first searchexisting issues and commentsin this Gist andon my blog.
- Ask VPN related questions on theLibreswan orstrongSwan mailing list, or read these wikis:[1][2][3][4][5].
Copyright (C) 2014-2025Lin Song
Based onthe work of Thomas Sarlandie (Copyright 2012)
This work is licensed under theCreative 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!
About
Scripts to build your own IPsec VPN server, with IPsec/L2TP, Cisco IPsec and IKEv2
