mirror of
https://github.com/hwdsl2/setup-ipsec-vpn.git
synced 2024-06-19 20:26:02 +02:00
Update docs
This commit is contained in:
hwdsl2
parent
e0cbc1db49
commit
6c7caea39b
30
README-zh.md
30
README-zh.md
|
|
@ -66,9 +66,7 @@ wget https://git.io/vpnquickstart -O vpn.sh && sudo sh vpn.sh
|
|||
|
||||
- Ubuntu 20.04 (Focal) 或者 18.04 (Bionic)
|
||||
- Debian 11 (Bullseye)[\*](#debian-10-note), 10 (Buster)[\*](#debian-10-note) 或者 9 (Stretch)
|
||||
- CentOS 8[\*\*](#centos-8-note) 或者 7
|
||||
- Rocky Linux 8
|
||||
- AlmaLinux OS 8
|
||||
- CentOS 8[\*\*](#centos-8-note) 或者 7, Rocky Linux 8 或者 AlmaLinux OS 8
|
||||
- Red Hat Enterprise Linux (RHEL) 8 或者 7
|
||||
- Amazon Linux 2
|
||||
- Alpine Linux 3.14
|
||||
|
|
@ -100,6 +98,7 @@ wget https://git.io/vpnquickstart -O vpn.sh && sudo sh vpn.sh
|
|||
wget https://git.io/vpnsetup -O vpn.sh && sudo sh vpn.sh
|
||||
```
|
||||
|
||||
<a name="ikev2-setup-note"></a>
|
||||
在安装成功之后，推荐 [配置 IKEv2](docs/ikev2-howto-zh.md)：
|
||||
|
||||
```bash
|
||||
|
|
@ -120,14 +119,7 @@ sudo sh vpn.sh
|
|||
|
||||
**注：** 一个安全的 IPsec PSK 应该至少包含 20 个随机字符。
|
||||
|
||||
在安装成功之后，推荐 [配置 IKEv2](docs/ikev2-howto-zh.md)：
|
||||
|
||||
```bash
|
||||
# 使用默认选项配置 IKEv2
|
||||
sudo ikev2.sh --auto
|
||||
# 或者你也可以自定义 IKEv2 选项
|
||||
sudo ikev2.sh
|
||||
```
|
||||
在安装成功之后，推荐 [配置 IKEv2](#ikev2-setup-note)。
|
||||
|
||||
**选项 3:** 将你自己的 VPN 登录凭证定义为环境变量：
|
||||
|
||||
|
|
@ -141,14 +133,7 @@ VPN_PASSWORD='你的VPN密码' \
|
|||
sh vpn.sh
|
||||
```
|
||||
|
||||
在安装成功之后，推荐 [配置 IKEv2](docs/ikev2-howto-zh.md)：
|
||||
|
||||
```bash
|
||||
# 使用默认选项配置 IKEv2
|
||||
sudo ikev2.sh --auto
|
||||
# 或者你也可以自定义 IKEv2 选项
|
||||
sudo ikev2.sh
|
||||
```
|
||||
在安装成功之后，推荐 [配置 IKEv2](#ikev2-setup-note)。
|
||||
|
||||
**注：** 如果无法通过 `wget` 下载，你也可以打开 [vpnsetup.sh](vpnsetup.sh)，然后点击右方的 **`Raw`** 按钮。按快捷键 `Ctrl-A` 全选， `Ctrl-C` 复制，然后粘贴到你喜欢的编辑器。
|
||||
|
||||
|
|
@ -219,14 +204,17 @@ wget https://git.io/vpnupgrade -O vpnup.sh && sudo sh vpnup.sh
|
|||
|
||||
## 问题和反馈
|
||||
|
||||
- 有问题需要提问？请先搜索已有的留言，在 [这个 Gist](https://gist.github.com/hwdsl2/9030462#comments) 以及 [我的博客](https://blog.ls20.com/ipsec-l2tp-vpn-auto-setup-for-ubuntu-12-04-on-amazon-ec2/#disqus_thread)。
|
||||
- VPN 的相关问题可在 [Libreswan](https://lists.libreswan.org/mailman/listinfo/swan) 或 [strongSwan](https://lists.strongswan.org/mailman/listinfo/users) 邮件列表提问，或者参考这些网站： [[1]](https://libreswan.org/wiki/Main_Page) [[2]](https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/7/html/security_guide/sec-securing_virtual_private_networks) [[3]](https://wiki.strongswan.org/projects/strongswan/wiki/UserDocumentation) [[4]](https://wiki.gentoo.org/wiki/IPsec_L2TP_VPN_server) [[5]](https://wiki.archlinux.org/index.php/Openswan_L2TP/IPsec_VPN_client_setup)。
|
||||
- 有问题需要提问？请先搜索 [已有的 issues](https://github.com/hwdsl2/setup-ipsec-vpn/issues?q=is%3Aissue) 以及在 [这个 Gist](https://gist.github.com/hwdsl2/9030462#comments) 和 [我的博客](https://blog.ls20.com/ipsec-l2tp-vpn-auto-setup-for-ubuntu-12-04-on-amazon-ec2/#disqus_thread) 上已有的留言。
|
||||
- VPN 的相关问题可在 [Libreswan](https://lists.libreswan.org/mailman/listinfo/swan) 或 [strongSwan](https://lists.strongswan.org/mailman/listinfo/users) 邮件列表提问，或者参考这些网站：[[1]](https://libreswan.org/wiki/Main_Page) [[2]](https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/7/html/security_guide/sec-securing_virtual_private_networks) [[3]](https://wiki.strongswan.org/projects/strongswan/wiki/UserDocumentation) [[4]](https://wiki.gentoo.org/wiki/IPsec_L2TP_VPN_server) [[5]](https://wiki.archlinux.org/index.php/Openswan_L2TP/IPsec_VPN_client_setup)。
|
||||
- 如果你发现了一个可重复的程序漏洞，请提交一个 [GitHub Issue](https://github.com/hwdsl2/setup-ipsec-vpn/issues?q=is%3Aissue)。
|
||||
|
||||
## 卸载说明
|
||||
|
||||
请参见 [卸载 VPN](docs/uninstall-zh.md)。
|
||||
|
||||
- [使用辅助脚本卸载 VPN](docs/uninstall-zh.md#使用辅助脚本卸载-vpn)
|
||||
- [手动卸载 VPN](docs/uninstall-zh.md#手动卸载-vpn)
|
||||
|
||||
## 授权协议
|
||||
|
||||
版权所有 (C) 2014-2021 [Lin Song](https://github.com/hwdsl2) [](https://www.linkedin.com/in/linsongui)
|
||||
|
|
|
|||
28
README.md
28
README.md
|
|
@ -66,9 +66,7 @@ A dedicated server or virtual private server (VPS), freshly installed with one o
|
|||
|
||||
- Ubuntu 20.04 (Focal) or 18.04 (Bionic)
|
||||
- Debian 11 (Bullseye)[\*](#debian-10-note), 10 (Buster)[\*](#debian-10-note) or 9 (Stretch)
|
||||
- CentOS 8[\*\*](#centos-8-note) or 7
|
||||
- Rocky Linux 8
|
||||
- AlmaLinux OS 8
|
||||
- CentOS 8[\*\*](#centos-8-note) or 7, Rocky Linux 8 or AlmaLinux OS 8
|
||||
- Red Hat Enterprise Linux (RHEL) 8 or 7
|
||||
- Amazon Linux 2
|
||||
- Alpine Linux 3.14
|
||||
|
|
@ -100,6 +98,7 @@ To install the VPN, please choose one of the following options:
|
|||
wget https://git.io/vpnsetup -O vpn.sh && sudo sh vpn.sh
|
||||
```
|
||||
|
||||
<a name="ikev2-setup-note"></a>
|
||||
After successful installation, it is recommended to [set up IKEv2](docs/ikev2-howto.md):
|
||||
|
||||
```bash
|
||||
|
|
@ -120,14 +119,7 @@ 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](docs/ikev2-howto.md):
|
||||
|
||||
```bash
|
||||
# Set up IKEv2 using default options
|
||||
sudo ikev2.sh --auto
|
||||
# Alternatively, you may customize IKEv2 options
|
||||
sudo ikev2.sh
|
||||
```
|
||||
After successful installation, it is recommended to [set up IKEv2](#ikev2-setup-note).
|
||||
|
||||
**Option 3:** Define your VPN credentials as environment variables:
|
||||
|
||||
|
|
@ -141,14 +133,7 @@ VPN_PASSWORD='your_vpn_password' \
|
|||
sh vpn.sh
|
||||
```
|
||||
|
||||
After successful installation, it is recommended to [set up IKEv2](docs/ikev2-howto.md):
|
||||
|
||||
```bash
|
||||
# Set up IKEv2 using default options
|
||||
sudo ikev2.sh --auto
|
||||
# Alternatively, you may customize IKEv2 options
|
||||
sudo ikev2.sh
|
||||
```
|
||||
After successful installation, it is recommended to [set up IKEv2](#ikev2-setup-note).
|
||||
|
||||
**Note:** If unable to download via `wget`, you may also open [vpnsetup.sh](vpnsetup.sh), then click the **`Raw`** button on the right. Press `Ctrl-A` to select all, `Ctrl-C` to copy, then paste into your favorite editor.
|
||||
|
||||
|
|
@ -219,7 +204,7 @@ See [Advanced usage](docs/advanced-usage.md).
|
|||
|
||||
## Bugs & Questions
|
||||
|
||||
- Got a question? Please first search other people's comments [in this Gist](https://gist.github.com/hwdsl2/9030462#comments) and [on my blog](https://blog.ls20.com/ipsec-l2tp-vpn-auto-setup-for-ubuntu-12-04-on-amazon-ec2/#disqus_thread).
|
||||
- Got a question? Please first search [existing issues](https://github.com/hwdsl2/setup-ipsec-vpn/issues?q=is%3Aissue) and comments [in this Gist](https://gist.github.com/hwdsl2/9030462#comments) and [on my blog](https://blog.ls20.com/ipsec-l2tp-vpn-auto-setup-for-ubuntu-12-04-on-amazon-ec2/#disqus_thread).
|
||||
- Ask VPN related questions on the [Libreswan](https://lists.libreswan.org/mailman/listinfo/swan) or [strongSwan](https://lists.strongswan.org/mailman/listinfo/users) mailing list, or read these wikis: [[1]](https://libreswan.org/wiki/Main_Page) [[2]](https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/7/html/security_guide/sec-securing_virtual_private_networks) [[3]](https://wiki.strongswan.org/projects/strongswan/wiki/UserDocumentation) [[4]](https://wiki.gentoo.org/wiki/IPsec_L2TP_VPN_server) [[5]](https://wiki.archlinux.org/index.php/Openswan_L2TP/IPsec_VPN_client_setup).
|
||||
- If you found a reproducible bug, open a [GitHub Issue](https://github.com/hwdsl2/setup-ipsec-vpn/issues?q=is%3Aissue) to submit a bug report.
|
||||
|
||||
|
|
@ -227,6 +212,9 @@ See [Advanced usage](docs/advanced-usage.md).
|
|||
|
||||
See [Uninstall the VPN](docs/uninstall.md).
|
||||
|
||||
- [Uninstall using helper script](docs/uninstall.md#uninstall-using-helper-script)
|
||||
- [Manually uninstall the VPN](docs/uninstall.md#manually-uninstall-the-vpn)
|
||||
|
||||
## License
|
||||
|
||||
Copyright (C) 2014-2021 [Lin Song](https://github.com/hwdsl2) [](https://www.linkedin.com/in/linsongui)
|
||||
|
|
|
|||
|
|
@ -2,6 +2,9 @@
|
|||
|
||||
*其他语言版本: [English](uninstall.md), [简体中文](uninstall-zh.md).*
|
||||
|
||||
* [使用辅助脚本卸载 VPN](#使用辅助脚本卸载-vpn)
|
||||
* [手动卸载 VPN](#手动卸载-vpn)
|
||||
|
||||
## 使用辅助脚本卸载 VPN
|
||||
|
||||
**警告：** 此脚本将从你的服务器中删除 IPsec VPN。所有的 VPN 配置将被**永久删除**，并且 Libreswan 和 xl2tpd 将被移除。此操作**不可撤销**！
|
||||
|
|
|
|||
|
|
@ -2,6 +2,9 @@
|
|||
|
||||
*Read this in other languages: [English](uninstall.md), [简体中文](uninstall-zh.md).*
|
||||
|
||||
* [Uninstall using helper script](#uninstall-using-helper-script)
|
||||
* [Manually uninstall the VPN](#manually-uninstall-the-vpn)
|
||||
|
||||
## Uninstall using helper script
|
||||
|
||||
**Warning:** This script will remove IPsec VPN from your server. All VPN configuration will be **permanently deleted**, and Libreswan and xl2tpd will be removed. This **cannot be undone**!
|
||||
|
|
|
|||
Loading…
Reference in New Issue
Block a user