+
+
+
+
+复制如上图的 WebHook 地址，并修改 Artalk 的 `webhook_url` 配置即可。
+
+
+
+可参考：[“飞书帮助中心文档”](https://www.feishu.cn/hc/zh-CN/articles/360024984973)
+
+## 钉钉
+
+```yaml
+admin_notify:
+ # 钉钉
+ ding_talk:
+ enabled: true
+ token: ""
+ secret: ""
+```
+
+可参考：[“钉钉开放文档”](https://open.dingtalk.com/document/robots/custom-robot-access)
+
+## Bark
+
+```yaml
+admin_notify:
+ # Bark
+ bark:
+ enabled: true
+ server: "http://day.app/xxxxxxx/"
+```
+
+[Bark](https://github.com/Finb/Bark) 是一款开源的 iOS App，并且[支持自托管](https://github.com/Finb/bark-server)，你能使用 Bark 轻松地推送消息给你的 iOS 设备。
+
+你可以在 App Store 搜索下载，并获得需要填入 Artalk 的 `server` 配置项：
+
+
+
+
+
+## Slack
+
+```yaml
+admin_notify:
+ # Slack
+ slack:
+ enabled: true
+ oauth_token: ""
+ receivers:
+ - "CHANNEL_ID"
+```
+
+## LINE
+
+```yaml
+admin_notify:
+ # LINE
+ line:
+ enabled: true
+ channel_secret: ""
+ channel_access_token: ""
+ receivers:
+ - "USER_ID_1"
+ - "GROUP_ID_1"
+```
+
+## 通知模版
+
+```yaml
+admin_notify:
+ notify_tpl: "default"
+```
+
+配置项 `admin_notify.notify_tpl` 可设置为自定义通知模版「文件路径」，默认的通知模版为：
+
+```
+@{{reply_nick}}:
+
+{{reply_content}}
+
+{{link_to_reply}}
+```
+
+可用变量和邮件模板相同，可参考：[“邮件模版”](./email.md#邮件模板)
+
+## 嘈杂模式 `noise_mode`
+
+```yaml
+admin_notify:
+ noise_mode: false
+```
+
+noise_mode 默认为关闭状态，当该项设置为 `false` 时，站内仅向管理员回复的消息会发送通知，例如「普通用户 A」回复「普通用户 B」，这两个用户之间的通讯不会通知管理员。
+
+注：当 `moderator.pending_default` 为 `true` 时，noise_mode 为始终开启状态。
+
+## WebHook 回调
+
+开启 WebHook 后，创建新评论将以 **POST** 方式携带 `application/json` 类型的 Body 数据请求设定的 WebHook 地址。
+
+你可以编写自己的 Server 端代码，处理来自 Artalk 的请求。
+
+**Artalk 配置文件**
+
+```yaml
+admin_notify:
+ webhook:
+ enabled: true
+ url: "http://localhost:8080/"
+```
+
+**Body 数据内容**
+
+`application/json` 类型
+
+|Key|描述|类型|备注|
+| - | - | - | - |
+|`notify_subject`|通知标题 |String| 对应 admin_notify.notify_subject 配置项 |
+|`notify_body` |通知内容 |String| 根据 admin_notify.notify_tpl 模版渲染 |
+|`comment` |评论内容 |Object| 新创建的评论数据对象 |
+|`parent_comment`|评论回复的目标|Object| Root 根节点评论类型改项为 null |
+
+**Body 数据样本**
+
+```js
+{
+ "notify_subject": "",
+ "notify_body": "@测试用户:\n\n测试内容\n\nhttps://127.0.0.1/index.html?atk_comment=1057",
+ "comment": {
+ "id": 1057,
+ "content": "测试内容",
+ "user_id": 226,
+ "nick": "测试用户",
+ "email_encrypted": "654236c1e78i4c09a17c4869c9d43910",
+ "link": "https://qwqaq.com",
+ "ua": "Mozilla/5.0 (Macintosh; Intel Mac OS X 12_4_0) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/101.0.4951.64 Safari/537.36",
+ "date": "2022-05-23 17:00:23",
+ "is_collapsed": false,
+ "is_pending": false,
+ "is_pinned": false,
+ "is_allow_reply": false,
+ "rid": 0,
+ "badge_name": "",
+ "badge_color": "",
+ "visible": true,
+ "vote_up": 0,
+ "vote_down": 0,
+ "page_key": "/index.html",
+ "page_url": "https://127.0.0.1/index.html",
+ "site_name": "ArtalkDocs"
+ },
+ "parent_comment": null
+}
+```
+
+**Node.js express 处理示例**
+
+```js
+const express = require('express');
+
+const app = express();
+
+app.use(express.json()); // Use JSON middleware
+
+app.post('/', function(request, response){
+ console.log(request.body);
+
+ const notifySubject = request.body.notify_subject
+ const notifyBody = request.body.notify_body
+ console.log(notifySubject, notifyBody);
+
+ response.send(request.body);
+});
+
+app.listen(8080);
+```
+
+**Node.js http 处理示例**
+
+```js
+const http = require("http");
+
+const requestListener = function (req, res) {
+ // receive json request
+ let body = "";
+ req.on("data", function (data) {
+ body += data;
+ });
+ req.on("end", function () {
+ let json = "";
+ try {
+ json = JSON.parse(body);
+ } catch {}
+
+ // do something with json
+ console.log(json);
+ res.end();
+ });
+
+ res.writeHead(200);
+ res.end("Hello, World!");
+};
+
+const server = http.createServer(requestListener);
+server.listen(8080);
+```
+
+**PHP Laravel 处理示例**
+
+```php
+Route::get('/', function (Request $request) {
+ $data = $request->json()->all();
+ $notify_subject = $data["notify_subject"];
+ $notify_body = $data["notify_body"];
+});
+```
+
+**Golang net/http 处理示例**
+
+```go
+package main
+
+import (
+ "encoding/json"
+ "log"
+ "net/http"
+)
+
+type ArtalkNotify struct {
+ NotifySubject string `json:"notify_subject"`
+ NotifyBody string `json:"notify_body"`
+ Comment interface{} `json:"comment"`
+ ParentComment interface{} `json:"parent_comment"`
+}
+
+func webhookHandler(rw http.ResponseWriter, req *http.Request) {
+ decoder := json.NewDecoder(req.Body)
+ var notify ArtalkNotify
+ err := decoder.Decode(¬ify)
+ if err != nil {
+ panic(err)
+ }
+ log.Println(notify.NotifyBody)
+}
+
+func main() {
+ http.HandleFunc("/webhook", webhookHandler)
+ log.Fatal(http.ListenAndServe(":8080", nil))
+}
+```
+
diff --git a/docs/guide/backend/build.md b/docs/guide/backend/build.md
new file mode 100644
index 000000000..1876eee3c
--- /dev/null
+++ b/docs/guide/backend/build.md
@@ -0,0 +1,67 @@
+# 后端构建
+
+## 编译运行
+
+```bash
+# 拉取代码
+git clone https://github.com/ArtalkJS/Artalk.git Artalk
+
+# 编译程序
+cd Artalk && make all
+
+# 配置文件
+cp artalk.example.yml artalk.yml
+vim artalk.yml
+
+# 运行程序
+./bin/artalk help
+./bin/artalk -c artalk.yml server
+```
+
+## 构建二进制文件
+
+```bash
+# 拉取代码
+git clone https://github.com/ArtalkJS/Artalk.git
+
+# 执行编译
+make all
+```
+
+编译二进制文件将会输出到 `bin` 目录中
+
+## Docker Compose 编译运行
+
+```bash
+# 拉取代码
+git clone https://github.com/ArtalkJS/Artalk
+cd Artalk
+
+# 构建镜像
+docker-compose build
+
+# 运行
+docker-compose up -d
+```
+
+## Docker 镜像构建
+
+```bash
+# 拉取代码
+git clone https://github.com/ArtalkJS/Artalk
+cd Artalk
+
+# 构建镜像
+make docker-docker
+
+# 发布镜像
+make docker-push
+```
+
+## DevOps
+
+后端构建目前已交给 [GitHub Actions](https://github.com/ArtalkJS/Artalk/actions) 自动完成
+
+|Docker 镜像构建|Release 编译|
+|-|-|
+|[](https://github.com/ArtalkJS/Artalk/actions/workflows/dockerhub.yml)|[](https://github.com/ArtalkJS/Artalk/actions/workflows/release.yml)|
diff --git a/docs/guide/backend/captcha.md b/docs/guide/backend/captcha.md
new file mode 100644
index 000000000..a7b3fc313
--- /dev/null
+++ b/docs/guide/backend/captcha.md
@@ -0,0 +1,80 @@
+# 验证码
+
+Artalk 内置图片验证码功能，你可以配置操作频率限制，当超过限度时激活验证码。
+
+此外，你也可以接入[极验](https://www.geetest.com/)，拥有一个滑动验证码。
+
+完整的 `captcha` 配置如下：
+
+```yaml
+# 验证码
+captcha:
+ enabled: true # 总开关
+ always: false # 总是需要验证码
+ action_limit: 3 # 激活验证码所需操作次数
+ action_reset: 60 # 重置操作计数器超时 (单位：s, 设为 -1 不重置)
+ # Geetest 极验
+ geetest: # https://www.geetest.com
+ enabled: false
+ captcha_id: ""
+ captcha_key: ""
+```
+
+- **always**：当该项为 `true` 时，总是需要输入验证码。
+- **action_limit**：激活评论所需的操作次数。
+- **action_reset**：当时间超过该值时会重置操作计数器，单位为秒，设为 `-1` 将永不重置。
+
+注：当 `always` 开启时，`action_limit` 和 `action_reset` 配置将失效。
+
+## 配置举例
+
+#### 例 1
+
+在 60s 时间范围内，当操作次数超过 3 次，将一直被要求输入验证码：
+
+```yaml
+captcha:
+ action_limit: 3
+ action_reset: 60
+```
+
+在 60s 后将自动重置计数器，即重新获得 3 次不用输入验证码的机会。
+
+#### 例 2
+
+无论多少时间范围内，这个 IP 地址操作次数只要超过 5 次时，将一直被要求输入验证码：
+
+```yaml
+captcha:
+ action_limit: 5
+ action_reset: -1
+```
+
+#### 例 3
+
+总是要求输入验证码，无论这个 IP 操作多少次：
+
+```yaml
+captcha:
+ always: true
+```
+
+## 操作的定义
+
+一个 IP 地址的一次「评论、投票、图片上传、密码验证」都算作一次「操作」。
+
+## Geetest 极验
+
+Artalk 支持接入 [Geetest 极验](https://www.geetest.com/adaptive-captcha) 第四代「行为验」，启用极验后，验证码将切换为滑动验证码。
+
+你需要在官网注册账号，并申请获得 `captcha_id` 和 `captcha_key`，并填入配置文件：
+
+```yaml
+captcha:
+ # 省略其他配置...
+ geetest:
+ enabled: true
+ captcha_id: ""
+ captcha_key: ""
+```
+
diff --git a/docs/guide/backend/config.md b/docs/guide/backend/config.md
new file mode 100644
index 000000000..a7a3cba00
--- /dev/null
+++ b/docs/guide/backend/config.md
@@ -0,0 +1,314 @@
+# 后端配置
+
+::: tip
+后端配置可以在侧边栏 “[控制中心](/guide/frontend/sidebar.md)” 直接修改，无需手动修改配置
+:::
+
+Artalk 默认以工作目录下的 `artalk.yml` 作为配置文件，可使用参数 `-c` 来指定具体文件：
+
+```bash
+artalk -c ./conf.yml
+```
+
+## 获取模版配置文件
+
+可参考一份「完整的配置文件」：[artalk.example.yml](https://github.com/ArtalkJS/Artalk/blob/master/artalk.example.yml)
+
+#### 使用 gen 命令生成配置文件
+
+Artalk 提供 `gen` 命令，你可以快速生成一份新的配置文件：
+
+```bash
+artalk gen conf ./artalk.yml
+```
+
+#### 命令行下载配置文件
+
+```bash
+curl -L https://raw.githubusercontent.com/ArtalkJS/Artalk/master/artalk.example.yml > artalk.yml
+```
+
+```bash
+wget -O artalk.yml https://raw.githubusercontent.com/ArtalkJS/Artalk/master/artalk.example.yml
+```
+
+## 加密密钥 `app_key`
+
+在 Artalk 启动之前，你需要配置一个 `app_key` 用于对网站内容进行安全加密：
+
+```yaml
+app_key: "<任意的字符>"
+```
+
+## 数据库 `db`
+
+Artalk 支持连接多种数据库，支持 SQLite、MySQL、PostgreSQL、SQL Server 配置如下：
+
+#### SQLite
+
+SQLite 是轻型数据库，使用单个文件存储数据，无需额外运行程序，尤其适合小型站点，例如个人博客。
+
+```yaml
+db:
+ type: "sqlite"
+ file: "./data/artalk.db"
+```
+
+#### MySQL / PostgreSQL / SQL Server
+
+修改 `type` 为你的数据库类型：
+
+```yaml
+db:
+ type: "mysql" # sqlite, mysql, pgsql, mssql
+ name: "artalk" # 数据库名
+ host: "localhost" # 地址
+ port: "3306" # 端口
+ user: "root" # 账号
+ password: "" # 密码
+ charset: "utf8mb4" # 编码格式
+ table_prefix: "" # 表前缀 (例如："atk_")
+```
+
+数据表将在 Artalk 启动时自动完成创建，无需额外操作。
+
+## 管理员 `admin_users`
+
+你需要配置管理员账户，这样才能通过「[控制中心](../frontend/sidebar.md)」对站点内容进行管理。
+
+Artalk 支持多站点，你可以创建多个管理员账户，为其分配站点，让你的朋友们共用同一个后端程序。
+
+详情参考：[“管理员 × 多站点”](/guide/backend/multi-site.md)
+
+## 可信域名 `trusted_domains`
+
+```yaml
+trusted_domains:
+ - "https://前端使用域名A.com"
+ - "https://前端使用域名B.com"
+```
+
+配置该项能限制来自列表外的 Referer 和跨域请求。
+
+:::tip
+
+你需要将「使用该后端的前端」URL 地址加入可信域名列表中，
+
+若非默认 80/443 端口需额外附带端口号，例如：`https://example.com:8080`
+
+:::
+
+在侧边栏[控制中心](../frontend/sidebar.md#控制中心)「站点」选项卡 - 选择站点「修改 URL」，填入站点 URL 也具有相同的效果；添加多个 URL 可使用 `","` 英文逗号分隔，修改后请重启 Artalk。
+
+可以将其关闭：
+
+```yaml
+trusted_domains:
+ - "*"
+```
+
+::: danger
+
+但并不建议这样做，关闭后将存在潜在安全风险，例如可能遭受 CSRF 跨域攻击。
+
+:::
+
+细节：`trusted_domains` 配置项实际上是对响应标头：
+
+- `Access-Control-Allow-Origin` 的控制 (参考：[W3C Cross-Origin Resource Sharing](https://fetch.spec.whatwg.org/#http-cors-protocol))
+- `Referer` 的限制 (参考：[Referer - HTTP | MDN](https://developer.mozilla.org/zh-CN/docs/Web/HTTP/Headers/Referer))
+
+CSRF 跨域攻击防范措施参考：[OWASP 安全备忘单](https://cheatsheetseries.owasp.org/cheatsheets/Cross-Site_Request_Forgery_Prevention_Cheat_Sheet.html)
+
+## 默认站点 `site_default`
+
+如果你觉得大概是不会用到 Artalk 的多站点功能，可以直接将该项配置为你的站点名，例如：
+
+```yaml
+site_default: "Artalk 官网"
+```
+
+然后在前端直接使用这个站点名：
+
+```js
+new Artalk({ site: "Artalk 官网" })
+```
+
+这样，你就无需在侧边栏的[控制中心](../frontend/sidebar.md#控制中心)手动创建站点。
+
+## 前端配置 `frontend`
+
+增加 `frontend` 字段内容可以在后端控制前端的配置，详情可参考：[“在后端控制前端”](/guide/backend/fe-control)。
+
+## 邮件通知 `email`
+
+配置邮件通知，让回复通过邮件的形式通知目标用户，你可以自定义邮件发送者名称、标题、模版等。
+
+详情参考：[“后端 · 邮件通知”](/guide/backend/email.md)
+
+## 多元推送 `admin_notify`
+
+你可以配置多种消息发送方式，例如飞书、Telegram 等，当收到新的评论时通知管理员。
+
+详情参考：[“后端 · 多元推送”](/guide/backend/admin_notify.md)
+
+## 评论审核 `moderator`
+
+配置评论审核来自动拦截垃圾评论。
+
+详情参考：[“后端 · 评论审核”](/guide/backend/moderator.md)
+
+## 验证码 `captcha`
+
+支持图片、滑动验证码，通过验证码对请求频率进行限制。
+
+详情参考：[“后端 · 验证码”](/guide/backend/captcha.md)
+
+## 缓存配置 `cache`
+
+为了提高评论系统的响应速度和性能，Artalk 内置一套缓存机制，并且默认开启，无需额外配置。但如果有需要，你也可以连接外部缓存服务器，支持 Redis 和 Memcache。
+
+```yaml
+cache:
+ type: "builtin" # 支持 redis, memcache, builtin (自带缓存)
+ expires: 30 # 缓存过期时间 (单位：分钟)
+ warm_up: false # 程序启动时预热缓存
+ server: "" # 连接缓存服务器 (例如："localhost:6379")
+```
+
+- **warm_up**：缓存预热功能。设置为 `true`，在 Artalk 启动时会立刻对数据库内容进行全面缓存，如果你的评论数据较多，多达上万条，启动时间可能会延长。
+- **type**：缓存类型。可选：`redis`, `memcache`, `builtin`。
+
+type 默认为 `builtin`，如遇特殊情况可将缓存关闭，将其设置为 `disabled`。
+
+注：如果在 Artalk 程序外部修改数据库内容，需要刷新 Artalk 缓存才能更新。
+
+---
+
+Redis 身份认证、数据库配置：
+
+```yaml
+# 缓存
+cache:
+ # 省略其他配置项...
+ redis:
+ network: "tcp" # 连接方式 (tcp 或 unix)
+ username: "" # 用户名
+ password: "" # 密码
+ db: 0 # 使用零号数据库
+```
+
+技术细节：[Artalk 缓存机制 时序图.png](/images/artalk/artalk-cache.png)
+
+
+
+## 监听地址 `host`
+
+Artalk 的默认 HTTP 端口为 23366，你可以在配置文件中指定：
+
+```yaml
+host: "0.0.0.0"
+port: 23366
+```
+
+配置 `host` 监听地址为 `0.0.0.0` 将 Artalk 服务暴露到全网可访问范围，
+
+如果你只想让 Artalk 仅本地能够访问，可将 `host` 配置为 `127.0.0.1`。
+
+命令行下启动 Artalk 时，可以携带 `--host` 和 `--port` 参数分别对地址和端口进行指定，例如：
+
+```bash
+artalk server --host 127.0.0.1 --port 8080
+```
+
+## 加密传输 `ssl`
+
+```yaml
+ssl:
+ enabled: true
+ cert_path: ""
+ key_path: ""
+```
+
+你可以配置该项，让 HTTP 升级为 HTTPS，通过 SSL 协议加密传输数据。
+
+- `cert_path`：SSL 证书公钥文件路径。
+- `key_path`：SSL 证书私钥文件路径。
+
+你也可以直接反向代理 Artalk 本地服务器，然后在例如 Nginx 启用 HTTPS。
+
+## 时区配置 `timezone`
+
+```yaml
+timezone: "Asia/Shanghai"
+```
+
+该值填写你所在地时区，对应 IANA 数据库时区名，参考：[Wikipedia](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) / [RFC-6557](https://www.rfc-editor.org/rfc/rfc6557.html)。
+
+```
+UTC+08:00 Asia/Shanghai
+UTC+09:00 Asia/Tokyo
+UTC-07:00 America/Los_Angeles
+UTC-04:00 America/New_York
+```
+
+## 登录超时 `login_timeout`
+
+该值设定管理员账户登录 JWT 令牌的有效期，单位：秒。
+
+例如，3 天有效：
+
+```yaml
+login_timeout: 259200
+```
+
+## 日志配置 `log`
+
+打开日志后，系统错误等信息将被记录到设定的文件中。
+
+```yaml
+log:
+ enabled: true # 总开关
+ filename: "./data/artalk.log" # 日志文件路径
+```
+
+## 调试模式 `debug`
+
+将 `debug` 配置为 `true` 启用调试模式。
+
+```yaml
+debug: true
+```
+
+## 工作目录 `-w` 参数
+
+Artalk 在不指定工作目录的情况下，会使用「程序启动时的目录」作为工作目录。
+
+```bash
+pwd # 显示当前目录路径
+```
+
+使用参数 `-w` 来指定工作目录，它通常是一个「绝对路径」，例如：
+
+```bash
+artalk -w /root/artalk -c ./conf.yml
+```
+
+注：`-c` 的相对路径会基于 `-w` 的路径，Artalk 此时会读取 `/root/artalk/conf.yml` 作为配置文件。
+
+其次，在「配置文件中」使用的「相对路径」，也会基于「工作目录」。
+
+例如 `conf.yml` 中有这样的配置：
+
+```yaml
+test_file: "./data/artalk.log"
+```
+
+将读取 `/root/artalk/data/artalk.log`。
+
+::: tip
+
+配置文件相关代码：[/config/config.go](https://github.com/ArtalkJS/Artalk/blob/master/config/config.go)
+
+前往：[“前端配置”](/guide/frontend/config.md)
+:::
diff --git a/docs/guide/backend/daemon.md b/docs/guide/backend/daemon.md
new file mode 100644
index 000000000..b8ae92db7
--- /dev/null
+++ b/docs/guide/backend/daemon.md
@@ -0,0 +1,75 @@
+# 守护进程
+
+## Docker
+
+更新 Docker 容器的 [Restart 策略](https://docs.docker.com/config/containers/start-containers-automatically/#use-a-restart-policy) 以达到进程守护效果。
+
+```bash
+docker update --restart=unless-stopped artalk
+```
+
+## Docker Compose
+
+在 `docker-compose.yml` 文件给服务添加 `restart: unless-stopped` 策略：
+
+```diff
+version: '3'
+services:
+ artalk:
++ restart: unless-stopped
+```
+
+## tmux
+
+tmux 将创建一个持续的命令行会话，在 SSH 或 tty 断开后保持在后台。
+
+Note: 服务器关闭或重启后，tmux 会话将被清除，需要手动重新运行程序。
+
+1. 创建会话 `tmux new -s artalk`
+2. 运行程序 `./artalk server`
+
+恢复接入会话：`tmux attach -t artalk`
+
+查看所有会话：`tmux ls`
+
+## systemd
+
+`sudo vim /etc/systemd/system/artalk.service`
+
+```ini
+[Unit]
+Description=Artalk
+After=network.target remote-fs.target nss-lookup.target
+
+[Service]
+User=root
+ExecStart=
+
+## 邮件模板
+
+### 模板变量
+
+你可以在 `mail_subject` 和 `mail_subject_to_admin` 以及邮件模板文件中使用模板变量：
+
+```yaml
+email:
+ # 省略其他配置...
+ mail_subject: "[{{site_name}}] 您收到了来自 @{{reply_nick}} 的回复"
+ mail_subject_to_admin: '[{{site_name}}] 您的文章 "{{page_title}}" 有新回复'
+ mail_tpl: "default" # 邮件模板文件
+```
+
+变量是 “Mustache” 的语法，`双大括号` + `变量名` 的形式即可输出一个变量：
+
+**基本内容变量**
+
+```
+{{content}} # 评论内容
+{{link_to_reply}} # 回复链接
+{{nick}} # 评论者昵称
+{{page_title}} # 页面标题
+{{page_url}} # 页面 PageKey (URL)
+{{reply_content}} # 回复对象的内容
+{{reply_nick}} # 回复对象的昵称f
+{{site_name}} # 站点名
+{{site_url}} # 站点 URL
+```
+
+::: details 查看其他变量
+
+```
+# 评论创建者
+{{comment.badge_color}}
+{{comment.badge_name}}
+{{comment.content}}
+{{comment.content_raw}}
+{{comment.date}}
+{{comment.datetime}}
+{{comment.email}}
+{{comment.email_encrypted}}
+{{comment.id}}
+{{comment.is_allow_reply}}
+{{comment.is_collapsed}}
+{{comment.is_pending}}
+{{comment.link}}
+{{comment.nick}}
+{{comment.page.admin_only}}
+{{comment.page.id}}
+{{comment.page.key}}
+{{comment.page.site_name}}
+{{comment.page.title}}
+{{comment.page.url}}
+{{comment.page.vote_down}}
+{{comment.page.vote_up}}
+{{comment.page_key}}
+{{comment.page_title}}
+{{comment.rid}}
+{{comment.site.first_url}}
+{{comment.site.id}}
+{{comment.site.name}}
+{{comment.site.urls.0}}
+{{comment.site.urls_raw}}
+{{comment.site_name}}
+{{comment.time}}
+{{comment.ua}}
+{{comment.visible}}
+{{comment.vote_down}}
+{{comment.vote_up}}
+
+# 父评论（评论创建者回复的评论）
+{{parent_comment.badge_color}}
+{{parent_comment.badge_name}}
+{{parent_comment.content}}
+{{parent_comment.content_raw}}
+{{parent_comment.date}}
+{{parent_comment.datetime}}
+{{parent_comment.email}}
+{{parent_comment.email_encrypted}}
+{{parent_comment.id}}
+{{parent_comment.is_allow_reply}}
+{{parent_comment.is_collapsed}}
+{{parent_comment.is_pending}}
+{{parent_comment.link}}
+{{parent_comment.nick}}
+{{parent_comment.page.admin_only}}
+{{parent_comment.page.id}}
+{{parent_comment.page.key}}
+{{parent_comment.page.site_name}}
+{{parent_comment.page.title}}
+{{parent_comment.page.url}}
+{{parent_comment.page.vote_down}}
+{{parent_comment.page.vote_up}}
+{{parent_comment.page_key}}
+{{parent_comment.page_title}}
+{{parent_comment.rid}}
+{{parent_comment.site.first_url}}
+{{parent_comment.site.id}}
+{{parent_comment.site.name}}
+{{parent_comment.site.urls}}
+{{parent_comment.site.urls_raw}}
+{{parent_comment.site_name}}
+{{parent_comment.time}}
+{{parent_comment.ua}}
+{{parent_comment.visible}}
+{{parent_comment.vote_down}}
+{{parent_comment.vote_up}}
+```
+
+:::
+
+::: details 查看数据样例
+
+```json
+{
+ "content": "测试内容
\n", + "link_to_reply": "https://artalk.js.org/?atk_comment=8100&atk_notify_key=44a9b2f08312565fba47c716df9d177f", + "nick": "用户名", + "page_title": "Artalk", + "page_url": "https://artalk.js.org/", + + "reply_content": "回复者内容
\n", + "reply_nick": "回复者", + "site_name": "ArtalkDemo", + "site_url": "http://localhost:3000/", + + "comment.badge_color": "", + "comment.badge_name": "", + "comment.content": "回复者内容
\n", + "comment.content_raw": "回复者内容", + "comment.date": "2021-11-22", + "comment.datetime": "2021-11-22 22:22:42", + "comment.email": "replyer@example.com", + "comment.email_encrypted": "249898bd50e0febc5799485cf10b345a", + "comment.id": 8100, + "comment.is_allow_reply": true, + "comment.is_collapsed": false, + "comment.is_pending": false, + "comment.link": "", + "comment.nick": "回复者", + "comment.page.admin_only": false, + "comment.page.id": 75, + "comment.page.key": "https://artalk.js.org/", + "comment.page.site_name": "ArtalkDemo", + "comment.page.title": "Artalk", + "comment.page.url": "https://artalk.js.org/", + "comment.page.vote_down": 0, + "comment.page.vote_up": 0, + "comment.page_key": "https://artalk.js.org/", + "comment.page_title": "Artalk", + "comment.rid": 8099, + "comment.site.first_url": "http://localhost:3000/", + "comment.site.id": 2, + "comment.site.name": "ArtalkDemo", + "comment.site.urls.0": "http://localhost:3000/", + "comment.site.urls_raw": "http://localhost:3000/", + "comment.site_name": "ArtalkDemo", + "comment.time": "22:22:42", + "comment.ua": "Mozilla/5.0 (iPhone; CPU iPhone OS 13_2_3 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/13.0.3 Mobile/15E148 Safari/604.1", + "comment.visible": false, + "comment.vote_down": 0, + "comment.vote_up": 0, + + "parent_comment.badge_color": "", + "parent_comment.badge_name": "", + "parent_comment.content": "测试内容
\n", + "parent_comment.content_raw": "测试内容", + "parent_comment.date": "2021-11-22", + "parent_comment.datetime": "2021-11-22 22:21:17", + "parent_comment.email": "test@example.com", + "parent_comment.email_encrypted": "55502f40dc8b7c769880b10874abc9d0", + "parent_comment.id": 8099, + "parent_comment.is_allow_reply": true, + "parent_comment.is_collapsed": false, + "parent_comment.is_pending": false, + "parent_comment.link": "https://qwqaq.com", + "parent_comment.nick": "用户名", + "parent_comment.page.admin_only": false, + "parent_comment.page.id": 75, + "parent_comment.page.key": "https://artalk.js.org/", + "parent_comment.page.site_name": "ArtalkDemo", + "parent_comment.page.title": "Artalk", + "parent_comment.page.url": "https://artalk.js.org/", + "parent_comment.page.vote_down": 0, + "parent_comment.page.vote_up": 0, + "parent_comment.page_key": "https://artalk.js.org/", + "parent_comment.page_title": "Artalk", + "parent_comment.rid": 0, + "parent_comment.site.first_url": "http://localhost:3000/", + "parent_comment.site.id": 2, + "parent_comment.site.name": "ArtalkDemo", + "parent_comment.site.urls.0": "http://localhost:3000/", + "parent_comment.site.urls_raw": "http://localhost:3000/", + "parent_comment.site_name": "ArtalkDemo", + "parent_comment.time": "22:21:17", + "parent_comment.ua": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/93.0.4577.82 Safari/537.36", + "parent_comment.visible": false, + "parent_comment.vote_down": 0, + "parent_comment.vote_up": 0, +} +``` + +::: + +### 自定义模板 + +你可以将 `mail_tpl` 设置为一个「具体的文件路径」，使用外部的自定义邮件模板。 + +例如，将 `mail_tpl` 配置为 `"/root/Artalk/data/mail_tpl/your_email_template.html"` + +```yaml +email: + mail_tpl: "/root/Artalk/data/mail_tpl/your_email_template.html" + # 其他配置省略... +``` + +那么，在这个路径应该有一个文件： + +```html +Hi, {{nick}}：
++ 您在 “{{page_title}}” 收到了回复： +
+
+```
+
+注：这里的 `<后端地址>` 是前端 `conf.server` 配置。
+
+当该项为「完整 URL 路径」时，例如：`https://cdn.github.com/img/` 时，图片标签将为：
+
+```html
+
+```
+
+提示：这个配置可以结合负载均衡等场景使用。
+
+## 在前端自定义上传 API
+
+前端提供了配置项 `imgUploader`，你可以自定义前端图片上传时请求的 API，例如：
+
+```js
+new Artalk({
+ imgUploader: async (file) => {
+ const form = new FormData()
+ form.set('file', file)
+
+ const imgUrl = await fetch("https://api.example.org/upload", {
+ method: 'POST',
+ body: form
+ })
+
+ return imgUrl
+ }
+})
+```
+
+参考：[前端配置文档](../frontend/config.md#imguploader)
diff --git a/docs/guide/backend/index.md b/docs/guide/backend/index.md
new file mode 100644
index 000000000..9ae482b04
--- /dev/null
+++ b/docs/guide/backend/index.md
@@ -0,0 +1,22 @@
+---
+prev: install.md
+next: config.md
+---
+
+# Artalk
+
+Artalk 拥有一个 Golang 语言编写的后端程序。
+
+[GitHub 代码仓库](https://github.com/ArtalkJS/Artalk)
+
+- 高效快速
+- 异步执行
+- 跨平台兼容
+- 轻量级部署
+
+## Supports
+
+- 运行环境：支持 Linux, Windows, Darwin (x64 + ARM)
+- 数据存储：支持 SQLite, MySQL, PostgreSQL, SQL Server
+- 邮件发送：支持 SMTP, 阿里云邮件, 调用 sendmail 发送邮件
+- 高效缓存：支持 Redis, Memcache, In-Memory (BigCache)
diff --git a/docs/guide/backend/install.md b/docs/guide/backend/install.md
new file mode 100644
index 000000000..c025ca421
--- /dev/null
+++ b/docs/guide/backend/install.md
@@ -0,0 +1,7 @@
+---
+next: '/guide/backend/config.md'
+---
+
+# 后端部署
+
+参考：[程序部署](../deploy.md)
diff --git a/docs/guide/backend/moderator.md b/docs/guide/backend/moderator.md
new file mode 100644
index 000000000..18ac6a9bf
--- /dev/null
+++ b/docs/guide/backend/moderator.md
@@ -0,0 +1,112 @@
+# 评论审核
+
+完整的 `moderator` 配置如下：
+
+```yaml
+# 评论审核
+moderator:
+ pending_default: false # 发表新评论默认为 “待审状态”
+ api_fail_block: false # 垃圾检测 API 请求错误仍然拦截
+ # akismet.com 反垃圾
+ akismet_key: ""
+ # 腾讯云文本内容安全 (tms)
+ tencent: # https://cloud.tencent.com/document/product/1124/64508
+ enabled: false
+ secret_id: ""
+ secret_key: ""
+ region: "ap-guangzhou"
+ # 阿里云内容安全
+ aliyun: # https://help.aliyun.com/document_detail/28417.html
+ enabled: false
+ access_key_id: ""
+ access_key_secret: ""
+ region: "cn-shanghai"
+ # 关键词词库过滤
+ keywords:
+ enabled: false
+ pending: false # 匹配成功设为待审状态
+ files: # 支持多个词库文件
+ - "./data/词库_1.txt"
+ file_sep: "\n" # 词库文件内容分割符
+ replac_to: "x" # 替换字符
+```
+
+## 默认待审模式
+
+开启发表新评论默认为 “待审状态”：
+
+```yaml
+moderator:
+ pending_default: true
+```
+
+## Akismet
+
+[Akismet](https://akismet.com/) 是 WordPress 提供的面向全球范围的老牌垃圾拦截 API，通常对一些英文的垃圾评论十分凑效。Akismet 提供了 Personal 免费版本，适用于个人博客站点。
+
+
+
+你能在 [Akismet 官网](https://akismet.com/) 轻松地申请 `akismet_key`，并填入配置文件中，即可启用 Akismet 垃圾拦截。
+
+
+
+```yaml
+moderator:
+ akismet_key: "your_key"
+```
+
+## 腾讯云文本内容安全
+
+可参考：[“腾讯云文档”](https://cloud.tencent.com/document/product/1124/64508)
+
+开通「文本内容安全」后，在「访问管理」-「API 密钥管理」新增具有权限的 Secret，然后填入配置：
+
+```yaml
+moderator:
+ tencent:
+ enabled: true
+ secret_id: ""
+ secret_key: ""
+ region: "ap-guangzhou"
+```
+
+## 阿里云内容安全
+
+可参考：[“阿里云文档”](https://help.aliyun.com/document_detail/28417.html)
+
+开通「阿里云内容安全」后，阿里云后台创建 Access Key 并填入配置：
+
+```yaml
+moderator:
+ aliyun:
+ enabled: true
+ access_key_id: ""
+ access_key_secret: ""
+ region: "cn-shanghai"
+```
+
+## 关键词词库过滤
+
+如果你不想依赖于远程 API，可以在本地配置导入词库文件，让 Artalk 根据词语来检测垃圾评论：
+
+```yaml
+moderator:
+ keywords:
+ enabled: true
+ pending: false # 匹配成功设为待审状态
+ files: # 支持多个词库文件
+ - "./data/词库_1.txt"
+ file_sep: "\n" # 词库文件内容分割符
+ replac_to: "x" # 替换字符
+```
+
+- **pending**：当成功匹配时，是否将评论设为待审核状态。
+- **files**：词库文件。允许多个文件，Artalk 启动时会合并词库。
+- **file_sep**：词库文件内容分割符。例如：文件中每行一个词语，该项配置 `\n`。
+- **replac_to**：替换字符。例如：该项设置为 `x`，你可以将 `pending` 设置为 `false`，评论自动过审，但匹配到的词语会被替换为 `x`，例如 `fxxk`、`xxxx`。
+
+注：`replac_to` 不建议使用 `*` 星号，应为它和 Markdown 的加粗语法冲突。
+
+## 使用验证码
+
+你可以开启 Artalk 的验证码功能，支持图片和滑动验证码，[参考此处](./captcha.md)。
diff --git a/docs/guide/backend/multi-site.md b/docs/guide/backend/multi-site.md
new file mode 100644
index 000000000..c85d208a3
--- /dev/null
+++ b/docs/guide/backend/multi-site.md
@@ -0,0 +1,144 @@
+# 管理员 × 多站点
+
+Artalk 支持站点隔离，以及为站点分配指定的管理员账户，
+
+所以，你可以实现两种模式：单人多站点、多人多站点。
+
+运用「单人多站点」模式，你能够实现多个站点共用同一个 Artalk 后端程序，集中化管理。
+
+运用「多人多站点」模式，你可以和你的朋友们共用同一个 Artalk 后端程序。😉
+
+## 管理员配置
+
+你可以设置多个管理员账户，当输入框输入匹配管理员用户名和邮箱时，将弹出密码验证提示框，
+
+并且只有管理员才能访问侧边栏「[控制中心](../frontend/sidebar.md#控制中心)」，在前端对评论内容进行管理操作。
+
+在配置文件中添加如下内容：
+
+```yaml
+admin_users:
+ - name: "admin"
+ email: "admin@example.com"
+ password: ""
+ badge_name: "管理员"
+ badge_color: "#FF6C00"
+ - name: "admin2"
+ email: "admin2@example.com"
+ password: ""
+ badge_name: "小管理员"
+ badge_color: "#FF6C00"
+```
+
+每一项配置的解释：
+
+- **name** & **email**：用户名和邮箱，**不区分大小写**。
+- **password**：用户密码。
+
+ 支持 bcrypt 和 md5 加密，例如填写：`"(md5)50c21190c6e4e5418c6a90d2b5031119"`。
+
+ **建议使用更安全的 bcrypt 加密算法**，在 Linux 环境下，你可以使用 [htpasswd 命令](https://httpd.apache.org/docs/2.4/programs/htpasswd.html) 来生成密文：
+
+ ```bash
+ unset HISTFILE # 临时禁用 history 防止密码在历史记录中出现
+ htpasswd -bnBC 10 "" "your_password" | tr -d ':'
+ ```
+
+ 然后配置填写：`"(bcrypt)$2y$10$ti4vZYIrxVN8rLcY..."`，以 `(bcrypt)` 开头。
+
+ 命令解释参考：[“Compute bcrypt hash from command line”](https://unix.stackexchange.com/questions/307994/compute-bcrypt-hash-from-command-line#answer-419855)
+
+- **badge_name**：用户显示的头衔徽标文字。
+- **badge_color**：用户显示的头衔徽标背景颜色。
+
+## 站点的创建和管理
+
+你可以在侧边栏「[控制中心](../frontend/sidebar.md#控制中心)」创建多个站点，管理站点和快速切换站点，详情可参考：[“侧边栏”](/guide/frontend/sidebar.html)。
+
+## 超级管理员、普通管理员
+
+管理员分为「超级管理员」和「普通管理员」，前者可以管理全部站点，后者只能管理部分站点。
+
+普通管理员将：
+
+ - 不会收到其它站点的评论邮件通知，邮件通知彼此隔离。
+ - 不能对设定范围外的站点进行 删除、修改、查询 等操作。
+ - 仅能在受限模式下使用 数据导入导出、站点管理 等功能。
+
+完整的 `admin_users` 配置如下：
+
+```yaml
+admin_users:
+ - name: "超级管理员"
+ email: "super_admin@example.com"
+ password: "(bcrypt)$2y$10$ti4vZYIrxVN8rLcYXVgXCO.GJND0dyI49r7IoF3xqIx8bBRmIBZRm"
+ badge_name: "超级管理员"
+ badge_color: "#FF6C00"
+ receive_email: false
+
+ - name: "普通管理员1"
+ email: "admin1@example.com"
+ password: "(bcrypt)$2y$10$ti4vZYIrxVN8rLcYXVgXCO.GJND0dyI49r7IoF3xqIx8bBRmIBZRm"
+ badge_name: "管理员"
+ badge_color: "#FF6C00"
+ sites:
+ - 站点名 A
+ - 站点名 B
+
+ - name: "普通管理员2"
+ email: "admin2@example.com"
+ password: "(bcrypt)$2y$10$ti4vZYIrxVN8rLcYXVgXCO.GJND0dyI49r7IoF3xqIx8bBRmIBZRm"
+ badge_name: "管理员"
+ badge_color: "#FF6C00"
+ sites:
+ - 站点名 C
+ - 站点名 D
+```
+
+### 为管理员分配站点
+
+- **sites**：向管理员分配站点，即控制管理员对于站点「[控制中心](../frontend/sidebar.md#控制中心)」的可访问权限。
+
+ 当未分配站点时，即 sites 未配置时，该账户为「**超级管理员**」，可以管理全部站点：
+
+ ```yaml
+ admin_users:
+ - name: "super_admin"
+ # 未分配 sites，为超级管理员
+ ```
+
+ 当分配站点后，即 sites 已配置时，该管理员成为「**普通管理员**」：
+
+ ```yaml
+ admin_users:
+ - name: "a_admin_user"
+ # ↓ 为账户分配 sites
+ sites:
+ - 站点名 A
+ - 站点名 B
+ ```
+
+ 注：你至少需要一个超级管理员，这样才能创建站点。
+
+### 控制管理员接收邮件通知
+
+当页面有新的评论时，邮件会发送给**该站点**的全部管理员，但你可以配置 `receive_email` 强制禁用它。
+
+这对于设定了多个邮箱，但又不希望某些邮箱收到评论邮件的情况很有帮助。
+
+- **receive_email**：设置为 `false` 系统将不会发送邮件通知给该用户。
+
+ 注：禁止后该管理员用户仍可以收到来自他人的 @AT 回复，只是当用户对页面进行评论时 (创建根评论时) 不发送邮件通知。
+
+```yaml
+admin_users:
+ - name: "super_admin"
+ # 未分配 sites，即为超级管理员
+ receive_email: false # ← 超级管理员不接收邮件
+
+ - name: "a_admin_user"
+ # 分配 sites，即为普通管理员
+ sites:
+ - 站点名 A
+ - 站点名 B
+```
diff --git a/docs/guide/backend/notify.md b/docs/guide/backend/notify.md
new file mode 100644
index 000000000..4113b27cc
--- /dev/null
+++ b/docs/guide/backend/notify.md
@@ -0,0 +1,21 @@
+# 多元通知
+
+Artalk v2.1.8+ 配置项：
+
+- `notify` 弃用并变更为 `admin_notify`
+- `email.mail_subject_to_admin` 弃用并变更为 `admin_notify.email.mail_subject`
+
+```yaml
+# 管理员多元推送
+admin_notify:
+ # 通知模版
+ notify_tpl: "default"
+ noise_mode: false
+ # 邮件通知管理员
+ email:
+ enabled: true # 当使用其他推送方式时，可以关闭管理员邮件通知
+ mail_subject: "[{{site_name}}] 您的文章「{{page_title}}」有新回复"
+```
+
+
+请参考新文档：[多元推送](./admin_notify.md)
diff --git a/docs/guide/backend/relative-path.md b/docs/guide/backend/relative-path.md
new file mode 100644
index 000000000..0853ea0bf
--- /dev/null
+++ b/docs/guide/backend/relative-path.md
@@ -0,0 +1,53 @@
+# 相对 / 绝对路径
+
+Artalk 支持解析相对路径，因此你可以在前端页面进行如下配置：
+
+```js
+new Artalk({
+ site: "举个栗子站点", // 你的站点名
+ pageKey: "/relative-path/xx.html", // 使用相对路径
+})
+```
+
+建议页面使用相对路径，因为这为日后的「站点迁移」需求创建条件。
+
+然后，你需要在侧边栏「[控制中心](../frontend/sidebar.md#控制中心)」-「站点」找到 “举个栗子站点”，修改站点 URL。
+
+
+
+之后，所有相对路径都会「基于这个站点 URL」，例如：
+
+```bash
+"/relative-path/xx.html"
+ ↓ 解析为
+"https://设定的举个栗子站点URL.xxx/relative-path/xx.html"
+```
+
+### 解析后的 URL 用途
+
+站点 URL + 页面 相对路径 将用于：
+
+- **邮件通知**中的回复评论链接
+- **侧边栏**快速跳转到某条评论
+- **控制中心**页面管理打开页面
+- **获取页面标题**等信息时使用
+
+### 配置多个站点 URL 的情况
+
+你可能需要配置站点的多个 URL 来允许 Referer 和跨域。
+
+「[控制中心](../frontend/sidebar.md#控制中心)」-「站点」修改站点 URL 支持为站点添加多个 URL，用英文逗号 `,` 分隔开每个 URL 即可。
+
+**当站点存在多个 URL 时**，「相对路径」会基于多个 URL 中的「**第一个**」URL。
+
+### 使用绝对路径的情况
+
+区别于使用相对路径，你可以使用绝对路径，例如前端这样配置：
+
+```js
+new Artalk({
+ pageKey: "https://your_domain.com/relative-path/xx.html", // 使用绝对路径
+})
+```
+
+这时后端不会去解析该地址，邮件、侧边栏等地方都是直接使用 `pageKey` 这个绝对路径来定位页面。
diff --git a/docs/guide/backend/reverse-proxy.md b/docs/guide/backend/reverse-proxy.md
new file mode 100644
index 000000000..726876f8a
--- /dev/null
+++ b/docs/guide/backend/reverse-proxy.md
@@ -0,0 +1,111 @@
+# 反向代理
+
+## Nginx
+
+假定：
+
+- 你想绑定的域名是：`artalk.your_domain.com`
+- Artalk 本地地址：`http://localhost:23366`
+
+以 Ubuntu 20.04 为例：
+
+创建站点配置文件：
+
+```bash
+sudo vim /etc/nginx/sites-available/artalk.your_domain.com
+```
+
+编辑反向代理配置文件：
+
+```nginx
+server
+{
+ listen 80;
+ listen [::]:80;
+
+ server_name artalk.your_domain.com;
+
+ location / {
+ proxy_redirect off;
+ proxy_set_header Host $host;
+ proxy_set_header X-Real-IP $remote_addr;
+ proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+ proxy_pass http://localhost:23366/;
+ }
+}
+```
+
+创建软链接启用站点：
+
+```bash
+sudo ln -s /etc/nginx/sites-available/artalk.your_domain.com /etc/nginx/sites-enabled/
+```
+
+验证配置文件是否有效：
+
+```bash
+sudo nginx -t
+```
+
+配置没有问题，重启 Nginx：
+
+```bash
+sudo systemctl restart nginx
+```
+
+配置前端：
+
+```js
+new Artalk({ server: "http://artalk.your_domain.com" })
+```
+
+::: tip
+你还可以再套一层 CDN，然后加上 SSL
+
+注意配置文件权限，以及反代目标 URL 可访问性
+
+尤其是运行在 Docker 容器内的 artalk，注意检查 IP 和端口是否能够被 Nginx 正常访问
+:::
+
+## Caddy
+
+创建 Caddyfile：
+
+```
+artalk.your_domain.com {
+ reverse_proxy / http://localhost:23366
+}
+```
+
+## Apache
+
+需要启用反代模块 `mod_proxy.c`
+
+```apache
+@qwqcode
diff --git a/docs/guide/frontend/artalk-lite.md b/docs/guide/frontend/artalk-lite.md new file mode 100644 index 000000000..468603e73 --- /dev/null +++ b/docs/guide/frontend/artalk-lite.md @@ -0,0 +1,13 @@ +# 精简版本 + +ArtalkLite 是 Artalk 的精简版本，相较于普通版，有以下区别： + +- 体积更小，更为简约 +- 默认关闭表情包、投票、UA 徽标 +- 去除 marked 依赖，但支持一些基本的 Markdown 语法 + +ArtalkLite 随普通版一起发布，你可以将 CDN 地址文件名修改为 ArtalkLite 获取： + +> https://unpkg.com/artalk@2/dist/ArtalkLite.js +> +> https://unpkg.com/artalk@2/dist/ArtalkLite.css diff --git a/docs/guide/frontend/config.md b/docs/guide/frontend/config.md new file mode 100644 index 000000000..3df459e85 --- /dev/null +++ b/docs/guide/frontend/config.md @@ -0,0 +1,451 @@ +# 前端配置 + +::: tip +前端配置可以在侧边栏 “[控制中心](/guide/frontend/sidebar.md)” 直接修改，无需手动修改配置 +::: + +```js +new Artalk({ 你的配置... }) +``` + +- 默认配置：[defaults.ts](https://github.com/ArtalkJS/Artalk/blob/master/packages/artalk/src/defaults.ts) +- 声明文件：[artalk-config.d.ts](https://github.com/ArtalkJS/Artalk/blob/master/packages/artalk/types/artalk-config.d.ts) + +## 基本配置（必填项） + +### el + +**装载元素**（填入需要绑定的元素 Selector） + +- 类型：`String|HTMLElement` +- 默认值：`undefined` + +> 例如：`#Comments` 对应元素 `` + +### pageKey + +**页面地址**（相对路径 / 完整 URL） + +- 类型：`String` +- 默认值：`location.pathname` + +可留空自动获取页面的相对路径。 + +可以填写由博客系统生成的 `固定链接`，但建议使用相对路径以便日后切换域名。 + +参考：[“关于使用相对 / 绝对路径”](/guide/backend/relative-path.md) + +### pageTitle + +**页面标题**（用于管理列表显示，邮件通知等） + +- 类型：`String` +- 默认值：`document.title` + +可留空自动获取页面的 `