Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
hwdsl2 committed May 14, 2022
1 parent ba797fe commit d179fbd
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README-zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@

本镜像以 Alpine 3.15 或 Debian 11 为基础,并使用 [Libreswan](https://libreswan.org) (IPsec VPN 软件) 和 [xl2tpd](https://github.com/xelerance/xl2tpd) (L2TP 服务进程)。

IPsec VPN 可以加密你的网络流量,以防止在通过因特网传送时,你和 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).*
Expand All @@ -30,6 +32,14 @@ docker run \

要了解更多有关如何使用本镜像的信息,请继续阅读以下部分。

## 功能特性

- 支持具有强大和快速加密算法(例如 AES-GCM)的 IKEv2 模式
- 生成 Apple 配置文件以自动配置 iOS 和 macOS 客户端
- 支持 Windows、macOS、iOS、Android 和 Linux 作为 VPN 客户端
- 包括辅助脚本以管理 IKEv2 用户和证书
- 客户端设置、高级用法等的详细文档

## 安装 Docker

首先在你的 Linux 服务器上 [安装 Docker](https://docs.docker.com/engine/install/)。另外你也可以使用 [Podman](https://podman.io) 运行本镜像,需要首先为 `docker` 命令 [创建一个别名](https://podman.io/whatis.html)
Expand Down
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ Docker image to run an IPsec VPN server, with IPsec/L2TP, Cisco IPsec and IKEv2.

Based on Alpine 3.15 or Debian 11 with [Libreswan](https://libreswan.org) (IPsec VPN software) and [xl2tpd](https://github.com/xelerance/xl2tpd) (L2TP daemon).

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.

[**» See also: IPsec VPN Server on Ubuntu, Debian and CentOS**](https://github.com/hwdsl2/setup-ipsec-vpn)

*Read this in other languages: [English](README.md), [简体中文](README-zh.md).*
Expand All @@ -30,6 +32,14 @@ Your VPN login details will be randomly generated. See [Retrieve VPN login detai

To learn more about how to use this image, read the sections below.

## Features

- Supports IKEv2 with strong and fast ciphers (e.g. AES-GCM)
- Generates Apple profiles to auto-configure iOS and macOS clients
- Supports Windows, macOS, iOS, Android and Linux as VPN clients
- Includes a helper script to manage IKEv2 users and certificates
- Detailed documentation for client setup, advanced usage and more

## Install Docker

First, [install Docker](https://docs.docker.com/engine/install/) on your Linux server. You may also use [Podman](https://podman.io) to run this image, after [creating an alias](https://podman.io/whatis.html) for `docker`.
Expand Down

0 comments on commit d179fbd

Please sign in to comment.