feat: support Railway

twikoojs · Feb 15, 2023 · 6025bff · 6025bff
1 parent 51bdca1
commit 6025bff
Show file tree

Hide file tree

Showing 12 changed files with 108 additions and 33 deletions.
diff --git a/docs/.vuepress/theme/layouts/Layout.vue b/docs/.vuepress/theme/layouts/Layout.vue
@@ -13,7 +13,7 @@
 
  <!-- Twikoo -->
  <div id="twikoo"></div>
- <component :is="'script'" src="https://cdn.jsdelivr.net/npm/twikoo@1.6.9/dist/twikoo.all.min.js" ref="twikooJs"></component>
+ <component :is="'script'" src="https://cdn.jsdelivr.net/npm/twikoo@1.6.10/dist/twikoo.all.min.js" ref="twikooJs"></component>
  </div>
  </template>
  </ParentLayout>

diff --git a/docs/en/quick-start.md b/docs/en/quick-start.md
@@ -14,9 +14,11 @@ Twikoo 分为云函数和前端两部分，部署时请注意保持二者版本
 | <div style="width: 6em">部署方式</div> | 描述 |
 | ---- | ---- |
 | [一键部署](#一键部署) | [ 不建议 ] 虽然方便，但是仅支持按量计费环境——也就是说，**一键部署的环境，当免费资源用尽后，将会产生费用**。且按量计费环境无法切换为包年包月环境。免费额度数据库读操作数只有 500 次 / 天，**无法支撑 Twikoo 的运行需求**。 |
-| [手动部署](#手动部署) | [ 建议 ] 手动部署到腾讯云云开发环境，在中国大陆访问速度较快。由于基础版 1 已从 0 元涨价至 6.9 元 / 月，需要付费购买环境才能部署。 |
+| [手动部署](#手动部署) | [ 建议 ] 手动部署到腾讯云云开发环境，在中国大陆访问速度较快。需要付费购买环境才能部署。 |
 | [命令行部署](#命令行部署) | [ 不建议 ] 仅针对有 Node.js 经验的开发者。 |
-| [Vercel 部署](#vercel-部署) | [ 建议 ] 适用于想要免费部署的用户，在中国大陆访问速度较慢。 |
+| [Vercel 部署](#vercel-部署) | [ 建议 ] 适用于想要免费部署的用户，在中国大陆访问速度较慢甚至无法访问。 |
+| [Railway 部署](#railway-部署) | [ 建议 ] 有充足的免费额度，部署简单，适合全球访问。 |
+| [Zeabur 部署](#zeabur-部署) | [ 建议 ] 有充足的免费额度，部署简单，适合中国大陆访问。 |
 | [私有部署](#私有部署) | [ 建议 ] 适用于有服务器的用户，需要自行申请 HTTPS 证书。 |
 
 ### 一键部署
@@ -49,7 +51,7 @@ exports.main = require('twikoo-func').main
 8. 创建完成后，点击“twikoo"进入云函数详情页，进入“函数代码”标签，点击“文件 - 新建文件”，输入 `package.json`，回车
 9. 复制以下代码、粘贴到代码框中，点击“保存并安装依赖”
 ``` json
-{ "dependencies": { "twikoo-func": "1.6.9" } }
+{ "dependencies": { "twikoo-func": "1.6.10" } }
 ```
 
 ### 命令行部署
@@ -107,6 +109,32 @@ Vercel 部署的环境需配合 1.4.0 以上版本的 twikoo.js 使用
 8. 进入 Overview，点击 Domains 下方的链接，如果环境配置正确，可以看到 “Twikoo 云函数运行正常” 的提示
 9. Vercel Domains（包含 `https://` 前缀，例如 `https://xxx.vercel.app`）即为您的环境 id
 
+### Railway 部署
+
+::: warning 注意
+Railway 部署的环境需配合 1.4.0 以上版本的 twikoo.js 使用
+:::
+
+1. 在 [Railway](https://railway.app/dashboard) 申请并登录账号，点击 New Project - Provision MongoDB，名称随意
+2. 打开 [imaegoo/twikoo-zeabur](https://github.com/imaegoo/twikoo-zeabur) 点击 fork 将仓库 fork 到自己的账号下
+3. 回到 Railway 点击 New - GitHub Repo - Configure GitHub App - 授权 GitHub - 选择刚才 fork 的仓库，等待部署完成
+4. 点开环境卡片 - Variables - New Variable，左边输入 `PORT` 右边输入 `8080` 然后点 Add。
+5. 点开环境卡片 - Settings - Environment - Domains，绑定一个域名（例如 `mytwikoo.up.railway.app`）
+6. 到博客配置文件中配置 envId 为 `https://mytwikoo.up.railway.app`
+
+### Zeabur 部署
+
+::: warning 注意
+Zeabur 部署的环境需配合 1.4.0 以上版本的 twikoo.js 使用
+:::
+
+1. 在 [Zeabur](https://dash.zeabur.com) 申请并登录账号，点击部署新服务 - 部署其他服务 - 部署 MongoDB，名称随意
+2. 打开 [imaegoo/twikoo-zeabur](https://github.com/imaegoo/twikoo-zeabur) 点击 fork 将仓库 fork 到自己的账号下
+3. 回到 Zeabur 点击部署新服务 - 部署你的源代码 - 授权 GitHub - 选择刚才 fork 的仓库，名称随意
+ > _无需配置数据库连接字符串！ Zeabur 已自动配置_
+4. 部署好后点开环境卡片 - 设置 - 域名，绑定一个域名（例如 `mytwikoo.zeabur.app`）
+5. 到博客配置文件中配置 envId 为 `https://mytwikoo.zeabur.app`
+
 ### 私有部署
 
 ::: warning 注意
@@ -133,6 +161,12 @@ Vercel 部署的环境需配合 1.4.0 以上版本的 twikoo.js 使用
 3. 数据在服务器上，请注意定期备份数据
 :::
 
+### 私有部署 (Docker)
+
+```
+docker run --name twikoo -e TWIKOO_THROTTLE=1000 -p 8080:8080 -v ${PWD}/data:/app/data -d imaegoo/twikoo
+```
+
 ## 前端部署
 
 ### 在 Hexo 中使用
@@ -198,6 +232,10 @@ twikoo:
 
 请参考 [maupassant-hexo/_config.yml](https://github.com/tufu9441/maupassant-hexo/blob/master/_config.yml) 进行配置
 
+#### 在 [hexo-theme-redefine](https://github.com/EvanNotFound/hexo-theme-redefine) 主题使用
+
+请参考 [Redefine 官方文档 #comment](https://redefine-docs.ohevan.com/docs/configuration-guide/comment#twikoo) 进行配置
+
 ### 通过 CDN 引入
 
 ::: tip 提示
@@ -206,7 +244,7 @@ twikoo:
 
 ``` html
 <div id="tcomment"></div>
-<script src="https://cdn.jsdelivr.net/npm/twikoo@1.6.9/dist/twikoo.all.min.js"></script>
+<script src="https://cdn.staticfile.org/twikoo/1.6.10/twikoo.all.min.js"></script>
 <script>
 twikoo.init({
  envId: '您的环境id', // 腾讯云环境填 envId；Vercel 环境填地址（https://xxx.vercel.app）
@@ -224,10 +262,10 @@ twikoo.init({
 
 如果遇到默认 CDN 加载速度缓慢，可更换其他 CDN 镜像。以下为可供选择的公共 CDN，其中一些 CDN 可能需要数天时间同步最新版本：
 
-* `https://cdn.staticfile.org/twikoo/1.6.9/twikoo.all.min.js`
-* `https://lib.baomitu.com/twikoo/1.6.9/twikoo.all.min.js`
-* `https://cdn.bootcdn.net/ajax/libs/twikoo/1.6.9/twikoo.all.min.js`
-* `https://cdn.jsdelivr.net/npm/twikoo@1.6.9/dist/twikoo.all.min.js`
+* `https://cdn.staticfile.org/twikoo/1.6.10/twikoo.all.min.js`
+* `https://lib.baomitu.com/twikoo/1.6.10/twikoo.all.min.js`
+* `https://cdn.bootcdn.net/ajax/libs/twikoo/1.6.10/twikoo.all.min.js`
+* `https://cdn.jsdelivr.net/npm/twikoo@1.6.10/dist/twikoo.all.min.js`
 
 ## 开启管理面板（腾讯云环境）
 
@@ -282,10 +320,16 @@ yarn deploy -e 您的环境id
 
 ### 针对私有部署的更新方式
 
-1. 在服务器上执行 `npm i -g tkserver@latest`
-2. 重新启动 `tkserver`
+1. 停止旧版本 `kill $(ps -ef | grep tkserver | grep -v 'grep' | awk '{print $2}')`
+2. 拉取新版本 `npm i -g tkserver@latest`
+3. 启动新版本 `nohup tkserver >> tkserver.log 2>&1 &`
+
+### 针对私有部署 (Docker) 的更新方式
 
-Docker 版先执行 `docker pull imaegoo/twikoo` 再重启容器
+1. 拉取新版本 `docker pull imaegoo/twikoo`
+2. 停止旧版本容器 `docker stop twikoo`
+3. 删除旧版本容器 `docker rm twikoo`
+4. [启动新版本容器](#私有部署-Docker)
 
 ### 自动更新
 

diff --git a/docs/quick-start.md b/docs/quick-start.md
@@ -10,9 +10,11 @@ Twikoo 分为云函数和前端两部分，部署时请注意保持二者版本
 | <div style="width: 6em">部署方式</div> | 描述 |
 | ---- | ---- |
 | [一键部署](#一键部署) | [ 不建议 ] 虽然方便，但是仅支持按量计费环境——也就是说，**一键部署的环境，当免费资源用尽后，将会产生费用**。且按量计费环境无法切换为包年包月环境。免费额度数据库读操作数只有 500 次 / 天，**无法支撑 Twikoo 的运行需求**。 |
-| [手动部署](#手动部署) | [ 建议 ] 手动部署到腾讯云云开发环境，在中国大陆访问速度较快。由于基础版 1 已从 0 元涨价至 6.9 元 / 月，需要付费购买环境才能部署。 |
+| [手动部署](#手动部署) | [ 建议 ] 手动部署到腾讯云云开发环境，在中国大陆访问速度较快。需要付费购买环境才能部署。 |
 | [命令行部署](#命令行部署) | [ 不建议 ] 仅针对有 Node.js 经验的开发者。 |
-| [Vercel 部署](#vercel-部署) | [ 建议 ] 适用于想要免费部署的用户，在中国大陆访问速度较慢。 |
+| [Vercel 部署](#vercel-部署) | [ 建议 ] 适用于想要免费部署的用户，在中国大陆访问速度较慢甚至无法访问。 |
+| [Railway 部署](#railway-部署) | [ 建议 ] 有充足的免费额度，部署简单，适合全球访问。 |
+| [Zeabur 部署](#zeabur-部署) | [ 建议 ] 有充足的免费额度，部署简单，适合中国大陆访问。 |
 | [私有部署](#私有部署) | [ 建议 ] 适用于有服务器的用户，需要自行申请 HTTPS 证书。 |
 
 ### 一键部署
@@ -45,7 +47,7 @@ exports.main = require('twikoo-func').main
 8. 创建完成后，点击“twikoo"进入云函数详情页，进入“函数代码”标签，点击“文件 - 新建文件”，输入 `package.json`，回车
 9. 复制以下代码、粘贴到代码框中，点击“保存并安装依赖”
 ``` json
-{ "dependencies": { "twikoo-func": "1.6.9" } }
+{ "dependencies": { "twikoo-func": "1.6.10" } }
 ```
 
 ### 命令行部署
@@ -103,6 +105,32 @@ Vercel 部署的环境需配合 1.4.0 以上版本的 twikoo.js 使用
 8. 进入 Overview，点击 Domains 下方的链接，如果环境配置正确，可以看到 “Twikoo 云函数运行正常” 的提示
 9. Vercel Domains（包含 `https://` 前缀，例如 `https://xxx.vercel.app`）即为您的环境 id
 
+### Railway 部署
+
+::: warning 注意
+Railway 部署的环境需配合 1.4.0 以上版本的 twikoo.js 使用
+:::
+
+1. 在 [Railway](https://railway.app/dashboard) 申请并登录账号，点击 New Project - Provision MongoDB，名称随意
+2. 打开 [imaegoo/twikoo-zeabur](https://github.com/imaegoo/twikoo-zeabur) 点击 fork 将仓库 fork 到自己的账号下
+3. 回到 Railway 点击 New - GitHub Repo - Configure GitHub App - 授权 GitHub - 选择刚才 fork 的仓库，等待部署完成
+4. 点开环境卡片 - Variables - New Variable，左边输入 `PORT` 右边输入 `8080` 然后点 Add。
+5. 点开环境卡片 - Settings - Environment - Domains，绑定一个域名（例如 `mytwikoo.up.railway.app`）
+6. 到博客配置文件中配置 envId 为 `https://mytwikoo.up.railway.app`
+
+### Zeabur 部署
+
+::: warning 注意
+Zeabur 部署的环境需配合 1.4.0 以上版本的 twikoo.js 使用
+:::
+
+1. 在 [Zeabur](https://dash.zeabur.com) 申请并登录账号，点击部署新服务 - 部署其他服务 - 部署 MongoDB，名称随意
+2. 打开 [imaegoo/twikoo-zeabur](https://github.com/imaegoo/twikoo-zeabur) 点击 fork 将仓库 fork 到自己的账号下
+3. 回到 Zeabur 点击部署新服务 - 部署你的源代码 - 授权 GitHub - 选择刚才 fork 的仓库，名称随意
+ > _无需配置数据库连接字符串！ Zeabur 已自动配置_
+4. 部署好后点开环境卡片 - 设置 - 域名，绑定一个域名（例如 `mytwikoo.zeabur.app`）
+5. 到博客配置文件中配置 envId 为 `https://mytwikoo.zeabur.app`
+
 ### 私有部署
 
 ::: warning 注意
@@ -212,7 +240,7 @@ twikoo:
 
 ``` html
 <div id="tcomment"></div>
-<script src="https://cdn.staticfile.org/twikoo/1.6.9/twikoo.all.min.js"></script>
+<script src="https://cdn.staticfile.org/twikoo/1.6.10/twikoo.all.min.js"></script>
 <script>
 twikoo.init({
  envId: '您的环境id', // 腾讯云环境填 envId；Vercel 环境填地址（https://xxx.vercel.app）
@@ -230,10 +258,10 @@ twikoo.init({
 
 如果遇到默认 CDN 加载速度缓慢，可更换其他 CDN 镜像。以下为可供选择的公共 CDN，其中一些 CDN 可能需要数天时间同步最新版本：
 
-* `https://cdn.staticfile.org/twikoo/1.6.9/twikoo.all.min.js`
-* `https://lib.baomitu.com/twikoo/1.6.9/twikoo.all.min.js`
-* `https://cdn.bootcdn.net/ajax/libs/twikoo/1.6.9/twikoo.all.min.js`
-* `https://cdn.jsdelivr.net/npm/twikoo@1.6.9/dist/twikoo.all.min.js`
+* `https://cdn.staticfile.org/twikoo/1.6.10/twikoo.all.min.js`
+* `https://lib.baomitu.com/twikoo/1.6.10/twikoo.all.min.js`
+* `https://cdn.bootcdn.net/ajax/libs/twikoo/1.6.10/twikoo.all.min.js`
+* `https://cdn.jsdelivr.net/npm/twikoo@1.6.10/dist/twikoo.all.min.js`
 
 ## 开启管理面板（腾讯云环境）
 

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
  "name": "twikoo",
- "version": "1.6.9",
+ "version": "1.6.10",
  "description": "A simple comment system.",
  "keywords": [
  "twikoojs",

diff --git a/src/client/version.js b/src/client/version.js
@@ -1,3 +1,3 @@
-const version = '1.6.9'
+const version = '1.6.10'
 
 export { version }
diff --git a/src/server/function/twikoo/package.json b/src/server/function/twikoo/package.json
@@ -1,6 +1,6 @@
 {
  "name": "twikoo-func",
- "version": "1.6.9",
+ "version": "1.6.10",
  "description": "A simple comment system.",
  "author": "imaegoo <hello@imaegoo.com> (https://github.com/imaegoo)",
  "license": "MIT",

diff --git a/src/server/self-hosted/README.md b/src/server/self-hosted/README.md
@@ -16,7 +16,9 @@ tkserver
 
 | 名称 | 描述 | 默认值 |
 | ---- | ---- | ---- |
-| `TWIKOO_DATA` | 数据库存储路径 | `./data` |
+| `MONGODB_URI` | MongoDB 数据库连接字符串，不传则使用 lokijs | `null` |
+| `MONGO_URL` | MongoDB 数据库连接字符串，不传则使用 lokijs | `null` |
+| `TWIKOO_DATA` | lokijs 数据库存储路径 | `./data` |
 | `TWIKOO_PORT` | 端口号 | `8080` |
 | `TWIKOO_THROTTLE` | IP 请求限流，当同一 IP 短时间内请求次数超过阈值将对该 IP 返回错误 | `250` |
 | `TWIKOO_LOCALHOST_ONLY` | 为`true`时只监听本地请求，使得 nginx 等服务器反代之后不暴露原始端口 | `null` |

diff --git a/src/server/self-hosted/mongo.js b/src/server/self-hosted/mongo.js
@@ -67,7 +67,7 @@ module.exports = async (request, response) => {
  try {
  protect(request)
  accessToken = anonymousSignIn(request)
- await connectToDatabase(process.env.MONGODB_URI)
+ await connectToDatabase(process.env.MONGODB_URI || process.env.MONGO_URL)
  await readConfig()
  allowCors(request, response)
  if (request.method === 'OPTIONS') {
@@ -197,7 +197,7 @@ async function connectToDatabase (uri) {
  // If the database connection is cached,
  // use it instead of creating a new connection
  if (db) return db
- if (!uri) throw new Error('未设置环境变量 MONGODB_URI')
+ if (!uri) throw new Error('未设置环境变量 MONGODB_URI | MONGO_URL')
  // If no connection is cached, create a new one
  console.log('Connecting to database...')
  const client = await MongoClient.connect(uri, {

diff --git a/src/server/self-hosted/package.json b/src/server/self-hosted/package.json
@@ -1,6 +1,6 @@
 {
  "name": "tkserver",
- "version": "1.6.9",
+ "version": "1.6.10",
  "description": "A simple comment system.",
  "keywords": [
  "twikoo",
@@ -31,7 +31,7 @@
  "get-user-ip": "^1.0.1",
  "lokijs": "^1.5.12",
  "mongodb": "^3.6.3",
- "twikoo-func": "1.6.9",
+ "twikoo-func": "1.6.10",
  "uuid": "^8.3.2"
  }
 }
diff --git a/src/server/self-hosted/server.js b/src/server/self-hosted/server.js
@@ -1,7 +1,8 @@
 #!/usr/bin/env node
 
 const http = require('http')
-const twikoo = process.env.MONGODB_URI ? require('./mongo') : require('./index')
+const dbUrl = process.env.MONGODB_URI || process.env.MONGO_URL || null
+const twikoo = dbUrl ? require('./mongo') : require('./index')
 const server = http.createServer()
 
 server.on('request', async function (request, response) {
@@ -33,6 +34,6 @@ const port = parseInt(process.env.TWIKOO_PORT) || 8080
 const host = process.env.TWIKOO_LOCALHOST_ONLY === 'true' ? 'localhost' : '::'
 
 server.listen(port, host, function () {
- console.log(`Twikoo is using ${process.env.MONGODB_URI ? 'mongo' : 'loki'} database`)
+ console.log(`Twikoo is using ${dbUrl ? 'mongo' : 'loki'} database`)
  console.log(`Twikoo function started on host ${host} port ${port}`)
 })
diff --git a/src/server/vercel-min/package.json b/src/server/vercel-min/package.json
@@ -1 +1 @@
-{ "dependencies": { "twikoo-vercel": "1.6.9" } }
+{ "dependencies": { "twikoo-vercel": "1.6.10" } }
diff --git a/src/server/vercel/package.json b/src/server/vercel/package.json
@@ -1,6 +1,6 @@
 {
  "name": "twikoo-vercel",
- "version": "1.6.9",
+ "version": "1.6.10",
  "description": "A simple comment system.",
  "author": "imaegoo <hello@imaegoo.com> (https://github.com/imaegoo)",
  "license": "MIT",
@@ -13,7 +13,7 @@
  "dependencies": {
  "get-user-ip": "^1.0.1",
  "mongodb": "^3.6.3",
- "twikoo-func": "1.6.9",
+ "twikoo-func": "1.6.10",
  "uuid": "^8.3.2"
  }
 }