私有部署※
注意
私有部署的环境需配合 1.6.0 或以上版本的 twikoo.js 使用
私有部署对服务器系统没有要求,Windows、Ubuntu、CentOS、macOS 等常用系统均支持。
私有部署涉及终端操作、申请证书、配置反向代理或负载均衡等高级操作,如果对这些不太了解,建议优先选择其他方式部署。
- 服务端下载安装 Node.js
- 安装 Twikoo server:
npm i -g tkserver
- 根据需要配置环境变量,所有的环境变量都是可选的
名称 | 描述 | 默认值 |
---|---|---|
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 |
TWIKOO_LOG_LEVEL | 日志级别,支持 verbose / info / warn / error | info |
TWIKOO_IP_HEADERS | 在一些特殊情况下使用,如使用了CloudFlare CDN 它会将请求 IP 写到请求头的 cf-connecting-ip 字段上,为了能够正确的获取请求 IP 你可以写成 ['headers.cf-connecting-ip'] | [] |
- 启动 Twikoo server:
tkserver
- 访问
http://服务端IP:8080
测试服务是否启动成功 - 配置前置代理实现 HTTPS 访问(可以用 Nginx、负载均衡或 Cloudflare 等)
- 到博客配置文件中配置 envId 为
https://
加域名(例如https://twikoo.yourdomain.com
)
提示
Linux 服务器可以用
nohup tkserver >> tkserver.log 2>&1 &
命令后台启动数据默认在 data 目录,请注意定期备份数据
默认端口为8080,自定义端口使用可使用
TWIKOO_PORT=1234 tkserver
启动。配置systemctl服务配合
TWIKOO_PORT=1234 tkserver
设置开机启动