文档用法

了解如何阅读文档。

文档的前置操作

在文档中,我们不会每次都完整把所有需要做的步骤重复写一次,那样的维护非常麻烦。

我们会在文档的开头标注文档所依赖的前置操作,意思是如果您没有弄明白前面的部分,您阅读到这一篇文章时可能会遇到一些困惑,但这是预期之内的,因为它已经在其他地方讲解过了,所以如果您没有看的话,那么就请回头仔细的阅读。

通常的样例如下:

前置知识

如何搜索

页面上方有搜索栏,点击并输入您想搜索的关键词即可。

关键词可以是您部署的服务,日志中的关键词,想要实现的用法,但不要过长。

例如 基岩版,雷池 WAF,router config conflict,Docker 等。

如果您使用手机阅读,使用页面顶部的搜索按钮。

文档类目

文档分为多个板块,以下是一些您可以优先查阅某些部分的情况。

板块目的
配置指南我只是想尽快部署一个服务
用户手册使用 frpc 时需要自定义一些内容
开发者想使用 Lolia 的 API 完成自动化接入等
疑难解答遇到了在配置指南里没提到的问题
扩展阅读想弄清原理和进阶内容

阅读提示

所有命令建议复制使用,如果要自行输入,请注意区分 0 (数字) 和 O (大写字母) 和 o (小写字母)。

本文档中所有 必须参数 使用 <> 标出,所有 可选参数 使用 [] 标出,多个可选项使用 | 分开。

在实际操作时 不需要 输入 <> 和 [],当碰到 | 分开的选项时只能选择其中 任意一个 输入。

在配置文件中找到某个配置项

使用文本编辑器时,使用键盘上的 Ctrl + F 键搜索要修改的部分,例如 server-udp-ports=,则按下 Ctrl + F 并输入 server-udp-ports 然后回车。

检索可能会出现多次,注意前方的注释符号,例如 # 和 // 等,通常以这些开头的行是注释。

亦有可能您要修改的键本身被注释了,不过这些情况一般在文档中会提示。

祝您的文档之旅愉快!