Twikoo 评论系统私有部署(非Docker)

FatPig2024-06-032025-02-16

前言

Twikoo是一个简洁、安全、免费的静态博客评论系统。它主要用于为静态博客（如 Hexo、Hugo 等）提供评论功能，支持 Markdown 语法，具有快速部署和轻量级的特点。以下是 Twikoo 使用云开发 / Vercel / 私有服务器作为评论后台。本文主要介绍在私有服务器上部署Twikoo，私有部署具有更高可靠性、可用性。

Twikoo 官网：https://twikoo.js.org

Twikoo on GitHub：https://github.com/twikoojs/twikoo

Twikoo 官方文档：https://twikoo.js.org/intro.html

一、整体流程

服务端下载安装 Node.js
安装 Twikoo server: npm i -g tkserver
启动 Twikoo server: tkserver
访问 http://服务端IP:8080 测试服务是否启动成功
配置前置代理实现 HTTPS 访问（可以用 Nginx、负载均衡或 Cloudflare 等）
到博客配置文件中配置 envId 为 https:// 加域名（例如 https://twikoo.yourdomain.com）

二、部署Twikoo

本文使用的服务器环境是Ubuntu 24.04 LTS

2.1 安装 Node.js

(1) 安装Node.js

1 2	sudo apt update sudo apt install nodejs npm

(2) 查看安装结果，打印对应版本号则安装成功

1 2	node -v npm -v

2.2 安装 Twikoo Server

(1) 输入以下命令，安装Twikoo Server

1	sudo npm i -g tkserver

(2) 输入以下命令启动 Twikoo server

tkserver

(3) 访问 http://服务端IP:8080 测试服务是否启动成功，显示如下界面则表示启动成功

(4) 修改默认端口等设置（可选，无特殊需求可跳过此步）

方式一：修改Twikoo配置文件，Twikoo 的配置文件路径在 /usr/local/lib/node_modules/tkserver，其中配置端口的文件为/usr/local/lib/node_modules/tkserver/server.js

方式二：修改环境变量

在Linux系统中，添加环境变量可以通过修改~/.bashrc实现，以修改tkserver端口号成8088为例

1	nano ~/.bashrc

在文件末尾添加 export TWIKOO_PORT=8088，保存并退出

刷新环境变量

1	source ~/.bashrc

通过以上任意一种方式修改完默认端口号，再使用tkserver命令启动twikoo服务，端口已变成修改的值。

另外可以通过nohup tkserver >> tkserver.log 2>&1 & 命令后台启动tkserver
使用 TWIKOO_PORT=端口号 tkserver命令自定义端口启动tkserver

(5) 设置tkserver 开机自启动

**确认 Node.js 和tkserver 安装路径：

1 2	which node which tkserver

这将返回 node 和 tkserver 的路径，需要记下这些路径。

创建 systemd 服务文件：

1	sudo nano /etc/systemd/system/tkserver.service

编辑服务文件：

[Unit]
Description=Twikoo Server
After=network.target

[Service]
Environment=TWIKOO_PORT=1234
ExecStart=/usr/bin/env node /path/to/tkserver
WorkingDirectory=/path/to
Restart=always
User=your_username
Environment=NODE_ENV=production

[Install]
WantedBy=multi-user.target

Environment=TWIKOO_PORT=1234：设置 TWIKOO_PORT 环境变量以指定自定义端口。
/usr/bin/env node：通过 env 命令查找 node 的实际路径，无需修改。
/usr/local/bin/tkserver：tkserver 程序文件的实际路径。
WorkingDirectory：tkserver 的工作目录。
your_username：Linux服务器的用户名。

以我本机为例，node 路径为 /usr/bin/node，tkserver 安装在 /usr/local/bin/tkserver，用户名为 root（建议用户名使用root，避免权限问题导致的启动失败），端口我设置为默认端口8080，具体配置如下：

[Unit]
Description=Twikoo Server
After=network.target

[Service]
Environment=TWIKOO_PORT=8080
ExecStart=/usr/bin/env node /usr/local/bin/tkserver
WorkingDirectory=/usr/local/bin/
Restart=always
User=root
Environment=NODE_ENV=production

[Install]
WantedBy=multi-user.target

重新加载 systemd 配置并启用服务：

1 2	sudo systemctl daemon-reload sudo systemctl restart tkserver

检查服务状态和日志：

1 2	sudo systemctl status tkserver sudo journalctl -u tkserver -f

可以尝试重启服务器后，并访问http://服务端IP:端口 测试开机自启动是否设置成功，显示如下界面则表示启动成功

2.3 配置HTTPS

完成前面步骤，twikoo后台已经部署完成，我们可以在主题配置文件中将前面的http://服务端IP:端口作为twikoo的envId填入既可以完成twikoo的部署，但为了提高网站的安全性，建议给twikoo服务添加一个域名，并设置为HTTPS访问，具体操作如下：

2.3.1 安装 Nginx

下载安装 Nginx

1	sudo apt install nginx

查看版本

nginx -v

2.3.2 创建twikoo子域名和申请证书

在阿里云中对主机域名再添加一个子域名

如我这里就是：twikoo.fatpig.cc

再申请一个免费SSL证书

将上一步申请的证书下载下来，放到服务器上。

例：我的存放路径：/etc/nginx/ssl

将两个文件twikoo.fatpig.cc.key和twikoo.fatpig.cc.pem放入该目录下。

输入以下命令，在/etc/nginx/sites-enabled路径下在其中新建一个twikoo.conf的配置文件

1	nano /etc/nginx/sites-enabled/twikoo.conf

根据实际情况修改以下配置，并粘贴到twikoo.conf中，保存并退出

upstream twi { # 需要配置upstream
    server fatpig.cc:8080; # 你的主域名+端口
}

server {
    listen 80; # 监听80端口，处理HTTP请求
    server_name twikoo.fatpig.cc; # 子域名

    # 将所有HTTP请求重定向到HTTPS
    return 301 https://$host$request_uri;
}

server {
    listen 443 ssl; # 监听443端口，处理HTTPS请求
    server_name twikoo.fatpig.cc; # 子域名

    ssl_certificate /etc/nginx/ssl/twikoo.fatpig.cc.pem;
    ssl_certificate_key /etc/nginx/ssl/twikoo.fatpig.cc.key;

    # SSL配置
    ssl_session_timeout 5m;
    ssl_protocols TLSv1 TLSv1.1 TLSv1.2;
    ssl_ciphers HIGH:!aNULL:!MD5;
    ssl_prefer_server_ciphers on;

    location / {
        proxy_pass http://twi;
        # 如需CORS头，请取消以下行的注释
        # add_header Access-Control-Allow-Origin "*" always;
        # add_header Access-Control-Allow-Methods "POST, GET, PUT, DELETE, OPTIONS";
        # add_header Access-Control-Allow-Headers "Origin, Authorization, Accept";
    }
}