Update docs

mutadecheng · Sep 8, 2022 · 021e6bb · 021e6bb
1 parent eddd688
commit 021e6bb
Show file tree

Hide file tree

Showing 4 changed files with 28 additions and 0 deletions.
diff --git a/README-zh.md b/README-zh.md
@@ -321,6 +321,7 @@ docker exec -it ipsec-vpn-server ikev2.sh
 - [从源代码构建](docs/advanced-usage-zh.md#从源代码构建)
 - [在容器中运行 Bash shell](docs/advanced-usage-zh.md#在容器中运行-bash-shell)
 - [绑定挂载 env 文件](docs/advanced-usage-zh.md#绑定挂载-env-文件)
+- [部署 Google BBR 拥塞控制](docs/advanced-usage-zh.md#部署-google-bbr-拥塞控制)
 
 ## 技术细节
 

diff --git a/README.md b/README.md
@@ -322,6 +322,7 @@ See [Advanced usage](docs/advanced-usage.md).
 - [Build from source code](docs/advanced-usage.md#build-from-source-code)
 - [Bash shell inside container](docs/advanced-usage.md#bash-shell-inside-container)
 - [Bind mount the env file](docs/advanced-usage.md#bind-mount-the-env-file)
+- [Deploy Google BBR congestion control](docs/advanced-usage.md#deploy-google-bbr-congestion-control)
 
 ## Technical details
 

diff --git a/docs/advanced-usage-zh.md b/docs/advanced-usage-zh.md
@@ -15,6 +15,7 @@
 - [从源代码构建](#从源代码构建)
 - [在容器中运行 Bash shell](#在容器中运行-bash-shell)
 - [绑定挂载 env 文件](#绑定挂载-env-文件)
+- [部署 Google BBR 拥塞控制](#部署-google-bbr-拥塞控制)
 
 ## 使用其他的 DNS 服务器
 
@@ -295,6 +296,18 @@ docker run \
     hwdsl2/ipsec-vpn-server
 ```
 
+## 部署 Google BBR 拥塞控制
+
+VPN 服务器搭建完成后，可以通过在 Docker 主机上部署 Google BBR 拥塞控制算法提升性能。
+
+这通常只需要在配置文件 `/etc/sysctl.conf` 中插入设定即可完成。但是部分 Linux 发行版可能需要额外更新 Linux 内核。
+
+详细的部署方法，可以参考[这篇文档](https://github.com/hwdsl2/setup-ipsec-vpn/blob/master/docs/bbr-zh.md)。在完成后重启 Docker 容器：
+
+```
+docker restart ipsec-vpn-server
+```
+
 ## 授权协议
 
 **注：** 预构建镜像中的软件组件（例如 Libreswan 和 xl2tpd）在其各自版权所有者选择的相应许可下。对于任何预构建的镜像的使用，用户有责任确保对该镜像的任何使用符合其中包含的所有软件的任何相关许可。

diff --git a/docs/advanced-usage.md b/docs/advanced-usage.md
@@ -15,6 +15,7 @@
 - [Build from source code](#build-from-source-code)
 - [Bash shell inside container](#bash-shell-inside-container)
 - [Bind mount the env file](#bind-mount-the-env-file)
+- [Deploy Google BBR congestion control](#deploy-google-bbr-congestion-control)
 
 ## Use alternative DNS servers
 
@@ -295,6 +296,18 @@ docker run \
     hwdsl2/ipsec-vpn-server
 ```
 
+## Deploy Google BBR congestion control
+
+After the VPN server is set up, the performance can be improved by deploying the Google BBR congestion control algorithm on your Docker host.
+
+This is usually done by modifying the configuration file `/etc/sysctl.conf`. However, some Linux distributions may additionally require updates to the Linux kernel.
+
+For detailed deployment methods, please refer to [this document](https://github.com/hwdsl2/setup-ipsec-vpn/blob/master/docs/bbr.md). When finished, restart the Docker container:
+
+```
+docker restart ipsec-vpn-server
+```
+
 ## 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.