@@ -6,7 +6,7 @@ The English document is being built. Please refer to the Chinese document.
6
6
7
7
Twikoo 分为云函数和前端两部分,部署时请注意保持二者版本一致。
8
8
9
- * [ 云函数部署] ( #云函数部署 ) 有 4 种方式,[ 一键部署] ( #一键部署 ) 、[ 手动部署] ( #手动部署 ) 、[ 命令行部署] ( #命令行部署 ) 和 [ Vercel 部署] ( #vercel-部署 ) 。
9
+ * [ 云函数部署] ( #云函数部署 ) 有 5 种方式,[ 一键部署] ( #一键部署 ) 、[ 手动部署] ( #手动部署 ) 、[ 命令行部署] ( #命令行部署 ) 、 [ Vercel 部署] ( #vercel-部署 ) 和 [ 私有部署 ] ( #私有部署 ) 。
10
10
* [ 前端部署] ( #前端部署 ) 有 2 种方式,如果您的网站主题支持 Twikoo,您只需在配置文件中指定 Twikoo 即可;如果您的网站主题不支持 Twikoo,您需要修改源码手动引入 Twikoo 的 js 文件并初始化。
11
11
12
12
## 云函数部署
@@ -17,6 +17,7 @@ Twikoo 分为云函数和前端两部分,部署时请注意保持二者版本
17
17
| [ 手动部署] ( #手动部署 ) | [ 建议 ] 手动部署到腾讯云云开发环境,在中国大陆访问速度较快。由于基础版 1 已从 0 元涨价至 6.9 元 / 月,需要付费购买环境才能部署。 |
18
18
| [ 命令行部署] ( #命令行部署 ) | [ 不建议 ] 仅针对有 Node.js 经验的开发者。 |
19
19
| [ Vercel 部署] ( #vercel-部署 ) | [ 建议 ] 适用于想要免费部署的用户,在中国大陆访问速度较慢。 |
20
+ | [ 私有部署] ( #私有部署 ) | [ 建议 ] 适用于有服务器的用户,需要自行申请 HTTPS 证书。 |
20
21
21
22
### 一键部署
22
23
@@ -106,6 +107,32 @@ Vercel 部署的环境需配合 1.4.0 以上版本的 twikoo.js 使用
106
107
8 . 进入 Overview,点击 Domains 下方的链接,如果环境配置正确,可以看到 “Twikoo 云函数运行正常” 的提示
107
108
9 . Vercel Domains(包含 ` https:// ` 前缀,例如 ` https://xxx.vercel.app ` )即为您的环境 id
108
109
110
+ ### 私有部署
111
+
112
+ ::: warning 注意
113
+ 私有部署的环境需配合 1.6.0 或以上版本的 twikoo.js 使用
114
+ :::
115
+
116
+ 1 . 服务端下载安装 [ Node.js] ( https://nodejs.org/zh-cn/ )
117
+ 2 . 安装 Twikoo server: ` npm i -g tkserver `
118
+ 3 . 根据需要配置环境变量
119
+
120
+ | 名称 | 描述 | 默认值 |
121
+ | ---- | ---- | ---- |
122
+ | ` TWIKOO_DATA ` | 数据库存储路径 | ` ./data ` |
123
+ | ` TWIKOO_PORT ` | 端口号 | ` 8080 ` |
124
+ | ` TWIKOO_THROTTLE ` | IP 请求限流,当同一 IP 短时间内请求次数超过阈值将对该 IP 返回错误 | ` 250 ` |
125
+
126
+ 4 . 启动 Twikoo server: ` tkserver `
127
+ 5 . 访问 ` http://服务端IP:8080 `
128
+ 6 . 若能正常访问,服务端地址(包含 ` http:// ` 和端口号,例如 ` http://12.34.56.78:8080 ` )即为您的环境 id
129
+
130
+ ::: tip 提示
131
+ 1 . Linux 服务器可以用 ` nohup tkserver >> tkserver.log 2>&1 & ` 命令后台启动
132
+ 2 . 强烈建议配置前置 nginx 服务器并配置 https 证书
133
+ 3 . 数据在服务器上,请注意定期备份数据
134
+ :::
135
+
109
136
## 前端部署
110
137
111
138
### 在 Hexo 中使用
@@ -253,6 +280,11 @@ yarn deploy -e 您的环境id
253
280
4 . 将 ` "twikoo-vercel": "x.x.x" ` 其中的版本号修改为最新版本号。点击 Commit changes
254
281
5 . 部署会自动触发,可以回到 [ Vercel 仪表板] ( https://vercel.com/dashboard ) ,查看部署状态
255
282
283
+ ### 针对私有部署的更新方式
284
+
285
+ 1 . 在服务器上执行 ` npm i -g tkserver@latest `
286
+ 2 . 重新启动 ` tkserver `
287
+
256
288
### 自动更新
257
289
258
290
考虑到可用性和安全性问题,Twikoo 没有实现自动更新,也没有计划实现自动更新。如果您希望实现自动更新,可以参考 MHuiG 基于 Github 工作流的 [ twikoo-update] ( https://github.com/MHuiG/twikoo-update ) 的实现方式。
0 commit comments