Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
hwdsl2 committed Mar 19, 2022
1 parent 4fcea45 commit cd72ef7
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 14 deletions.
8 changes: 1 addition & 7 deletions README-zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,15 +15,13 @@
- [快速开始](#快速开始)
- [安装 Docker](#安装-docker)
- [下载](#下载)
- [镜像对照表](#镜像对照表)
- [如何使用本镜像](#如何使用本镜像)
- [下一步](#下一步)
- [重要提示](#重要提示)
- [更新 Docker 镜像](#更新-docker-镜像)
- [配置并使用 IKEv2 VPN](#配置并使用-ikev2-vpn)
- [高级用法](#高级用法)
- [技术细节](#技术细节)
- [另见](#另见)
- [授权协议](#授权协议)

## 快速开始
Expand Down Expand Up @@ -71,7 +69,7 @@ docker image tag quay.io/hwdsl2/ipsec-vpn-server hwdsl2/ipsec-vpn-server

高级用户可以自己从 GitHub [编译源代码](docs/advanced-usage-zh.md#从源代码构建)

## 镜像对照表
### 镜像对照表

有两个预构建的镜像可用。默认的基于 Alpine 的镜像大小仅 ~17MB。

Expand Down Expand Up @@ -322,10 +320,6 @@ docker exec -it ipsec-vpn-server ikev2.sh

* 4500/udp and 500/udp for IPsec

## 另见

* [IPsec VPN Server on Ubuntu, Debian and CentOS](https://github.com/hwdsl2/setup-ipsec-vpn/blob/master/README-zh.md)

## 授权协议

**注:** 预构建镜像中的软件组件(例如 Libreswan 和 xl2tpd)在其各自版权所有者选择的相应许可下。对于任何预构建的镜像的使用,用户有责任确保对该镜像的任何使用符合其中包含的所有软件的任何相关许可。
Expand Down
8 changes: 1 addition & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,15 +15,13 @@ Based on Alpine 3.15 or Debian 11 with [Libreswan](https://libreswan.org) (IPsec
- [Quick start](#quick-start)
- [Install Docker](#install-docker)
- [Download](#download)
- [Image comparison](#image-comparison)
- [How to use this image](#how-to-use-this-image)
- [Next steps](#next-steps)
- [Important notes](#important-notes)
- [Update Docker image](#update-docker-image)
- [Configure and use IKEv2 VPN](#configure-and-use-ikev2-vpn)
- [Advanced usage](#advanced-usage)
- [Technical details](#technical-details)
- [See also](#see-also)
- [License](#license)

## Quick start
Expand Down Expand Up @@ -71,7 +69,7 @@ Supported platforms: `linux/amd64`, `linux/arm64` and `linux/arm/v7`.

Advanced users can [build from source code](docs/advanced-usage.md#build-from-source-code) on GitHub.

## Image comparison
### Image comparison

Two pre-built images are available. The default Alpine-based image is only ~17MB.

Expand Down Expand Up @@ -323,10 +321,6 @@ The ports that are exposed for this container to work are:

* 4500/udp and 500/udp for IPsec

## See also

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

## License

**Note:** The software components inside the pre-built image (such as Libreswan and xl2tpd) are under the respective licenses chosen by their respective copyright holders. As for any pre-built image usage, it is the image user's responsibility to ensure that any use of this image complies with any relevant licenses for all software contained within.
Expand Down

0 comments on commit cd72ef7

Please sign in to comment.