介绍

一个简洁、安全、免费的静态网站评论系统。 A simple, safe, free comment system.

部署

手动部署

下载模块

1
npm install tkserver -g

这样,twikoo的模块就会出现在你系统中node.js中的node_modules

文件配置

环境变量法

创建一个环境变量在运行时传入变量即可

名称描述默认值
TWIKOO_DATA数据库存储路径./data
TWIKOO_PORT端口号8080
TWIKOO_THROTTLEIP 请求限流，当同一 IP 短时间内请求次数超过阈值将对该 IP 返回错误250

修改配置文件

打开server.js文件

修改端口

大约在第41行

1
const port = parseInt(process.env.TWIKOO_PORT) || 9000; //后面为端口号

修改数据存储路径

大约在第7行

1
2
3
4
const dataDir = path.resolve(
  process.cwd(),
  process.env.TWIKOO_DATA || "./data"
); //将data修改为你需要的值

运行

命令行部署

  1. 选择一个存放数据的主文件夹(tkserver 会在此文件下创建./data/子文件夹)
  2. 打开终端输入tkserver

后台运行

screen

1
sudo screen tkserver

如果你的系统没有screen请先下载

1
2
sudo apt-get install screen //debian,ubuntu
sudo yum install screen //centos

最后按下Ctrl+a+d即可以在后端运行(CTRL+C)

官方

1
nohup tkserver >> tkserver.log 2>&1 &

宝塔部署

安装插件

选择node.js版本

最好选择大于14的稳定版

配置 node 项目

  1. 选择添加NODE项目
  2. 选择文件所在目录
  3. 在启动选项处填入node server.js
  4. 在端口出选择上文所定义的端口
  5. 添加域名(自选,最好加上)

pm2 管理器

需要在文件目录运行

1
pm2 start node server.js

docker 部署

1
docker run --name twikoo -e TWIKOO_THROTTLE=1000 -p 8080:8080 -v ${PWD}/data:/app/data -d imaegoo/twikoo

其中${PWD}是你反代地址(服务器真实地址)

更新

私有部署

  1. 修改package.json
  2. 运行npm update或者ncu -u

docker 更新

1
2
3
4
5
6
7
1.停止容器 docker stop twikoo

2.删除容器 docker rm twikoo

3.检查镜像更新情况，更新镜像  docker pull imaegoo/twikoo

4.docker run --name twikoo -e TWIKOO_THROTTLE=1000 -p 8080:8080 -v ${PWD}/data:/app/data -d imaegoo/twikoo

结尾

前端配置和其他选项请前往官网查看,@传送门