Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
hwdsl2 committed May 21, 2022
1 parent e8701fb commit 6250d71
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 10 deletions.
8 changes: 4 additions & 4 deletions README-zh.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
[English](README.md) | [中文](README-zh.md)

# Docker 上的 IPsec VPN 服务器

[![Build Status](https://github.com/hwdsl2/docker-ipsec-vpn-server/actions/workflows/main-alpine.yml/badge.svg)](https://github.com/hwdsl2/docker-ipsec-vpn-server/actions/workflows/main-alpine.yml) [![GitHub Stars](docs/images/badges/github-stars.svg)](https://github.com/hwdsl2/docker-ipsec-vpn-server/stargazers) [![Docker Stars](docs/images/badges/docker-stars.svg)](https://hub.docker.com/r/hwdsl2/ipsec-vpn-server/) [![Docker Pulls](docs/images/badges/docker-pulls.svg)](https://hub.docker.com/r/hwdsl2/ipsec-vpn-server/)
Expand All @@ -10,8 +12,6 @@ IPsec VPN 可以加密你的网络流量,以防止在通过因特网传送时

[**» 另见:IPsec VPN 服务器一键安装脚本**](https://github.com/hwdsl2/setup-ipsec-vpn/blob/master/README-zh.md)

*其他语言版本: [English](https://github.com/hwdsl2/docker-ipsec-vpn-server/blob/master/README.md), [简体中文](https://github.com/hwdsl2/docker-ipsec-vpn-server/blob/master/README-zh.md).*

## 快速开始

使用以下命令在 Docker 上快速搭建 IPsec VPN 服务器:
Expand Down Expand Up @@ -205,7 +205,7 @@ docker cp ipsec-vpn-server:/etc/ipsec.d/vpn-gen.env ./

## 重要提示

*其他语言版本: [English](https://github.com/hwdsl2/docker-ipsec-vpn-server/blob/master/README.md#important-notes), [简体中文](https://github.com/hwdsl2/docker-ipsec-vpn-server/blob/master/README-zh.md#重要提示)。*
*其他语言版本: [English](https://github.com/hwdsl2/docker-ipsec-vpn-server/blob/master/README.md#important-notes), [中文](https://github.com/hwdsl2/docker-ipsec-vpn-server/blob/master/README-zh.md#重要提示)。*

**Windows 用户** 对于 IPsec/L2TP 模式,在首次连接之前需要 [修改注册表](https://github.com/hwdsl2/setup-ipsec-vpn/blob/master/docs/clients-zh.md#windows-错误-809),以解决 VPN 服务器或客户端与 NAT(比如家用路由器)的兼容问题。

Expand Down Expand Up @@ -235,7 +235,7 @@ Status: Image is up to date for hwdsl2/ipsec-vpn-server:latest

## 配置并使用 IKEv2 VPN

*其他语言版本: [English](https://github.com/hwdsl2/docker-ipsec-vpn-server/blob/master/README.md#configure-and-use-ikev2-vpn), [简体中文](https://github.com/hwdsl2/docker-ipsec-vpn-server/blob/master/README-zh.md#配置并使用-ikev2-vpn)。*
*其他语言版本: [English](https://github.com/hwdsl2/docker-ipsec-vpn-server/blob/master/README.md#configure-and-use-ikev2-vpn), [中文](https://github.com/hwdsl2/docker-ipsec-vpn-server/blob/master/README-zh.md#配置并使用-ikev2-vpn)。*

IKEv2 模式是比 IPsec/L2TP 和 IPsec/XAuth ("Cisco IPsec") 更佳的连接模式,该模式无需 IPsec PSK, 用户名或密码。更多信息请看[这里](https://github.com/hwdsl2/setup-ipsec-vpn/blob/master/docs/ikev2-howto-zh.md)。

Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
[English](README.md) | [中文](README-zh.md)

# IPsec VPN Server on Docker

[![Build Status](https://github.com/hwdsl2/docker-ipsec-vpn-server/actions/workflows/main-alpine.yml/badge.svg)](https://github.com/hwdsl2/docker-ipsec-vpn-server/actions/workflows/main-alpine.yml) [![GitHub Stars](docs/images/badges/github-stars.svg)](https://github.com/hwdsl2/docker-ipsec-vpn-server/stargazers) [![Docker Stars](docs/images/badges/docker-stars.svg)](https://hub.docker.com/r/hwdsl2/ipsec-vpn-server/) [![Docker Pulls](docs/images/badges/docker-pulls.svg)](https://hub.docker.com/r/hwdsl2/ipsec-vpn-server/)
Expand All @@ -10,8 +12,6 @@ An IPsec VPN encrypts your network traffic, so that nobody between you and the V

[**» See also: IPsec VPN Server Auto Setup Scripts**](https://github.com/hwdsl2/setup-ipsec-vpn)

*Read this in other languages: [English](README.md), [简体中文](README-zh.md).*

## Quick start

Use this command to set up an IPsec VPN server on Docker:
Expand Down Expand Up @@ -205,7 +205,7 @@ Enjoy your very own VPN!

## Important notes

*Read this in other languages: [English](README.md#important-notes), [简体中文](README-zh.md#重要提示).*
*Read this in other languages: [English](README.md#important-notes), [中文](README-zh.md#重要提示).*

**Windows users**: For IPsec/L2TP mode, a [one-time registry change](https://github.com/hwdsl2/setup-ipsec-vpn/blob/master/docs/clients.md#windows-error-809) is required if the VPN server or client is behind NAT (e.g. home router).

Expand Down Expand Up @@ -235,7 +235,7 @@ Otherwise, it will download the latest version. To update your Docker container,

## Configure and use IKEv2 VPN

*Read this in other languages: [English](README.md#configure-and-use-ikev2-vpn), [简体中文](README-zh.md#配置并使用-ikev2-vpn).*
*Read this in other languages: [English](README.md#configure-and-use-ikev2-vpn), [中文](README-zh.md#配置并使用-ikev2-vpn).*

IKEv2 mode has improvements over IPsec/L2TP and IPsec/XAuth ("Cisco IPsec"), and does not require an IPsec PSK, username or password. Read more [here](https://github.com/hwdsl2/setup-ipsec-vpn/blob/master/docs/ikev2-howto.md).

Expand Down
2 changes: 1 addition & 1 deletion docs/advanced-usage-zh.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# 高级用法

*其他语言版本: [English](advanced-usage.md), [简体中文](advanced-usage-zh.md)。*
*其他语言版本: [English](advanced-usage.md), [中文](advanced-usage-zh.md)。*

- [使用其他的 DNS 服务器](#使用其他的-dns-服务器)
- [不启用 privileged 模式运行](#不启用-privileged-模式运行)
Expand Down
2 changes: 1 addition & 1 deletion docs/advanced-usage.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Advanced Usage

*Read this in other languages: [English](advanced-usage.md), [简体中文](advanced-usage-zh.md).*
*Read this in other languages: [English](advanced-usage.md), [中文](advanced-usage-zh.md).*

- [Use alternative DNS servers](#use-alternative-dns-servers)
- [Run without privileged mode](#run-without-privileged-mode)
Expand Down

0 comments on commit 6250d71

Please sign in to comment.