npm安装qinglong:原生环境部署与依赖管理详解
概述
青龙(Qinglong)是一个支持 Python3、JavaScript、Shell、Typescript 的定时任务管理平台,通过原生 npm 安装方式部署,可以充分发挥系统的灵活性,实现精细化的依赖管理和环境控制。本文将深入解析 npm 安装青龙的完整流程、依赖管理机制以及生产环境部署的最佳实践。
环境准备与前置依赖
系统要求
青龙支持在以下系统环境中通过 npm 安装:
- Debian/Ubuntu:推荐使用最新 LTS 版本
- Alpine Linux:轻量级部署选择
- CentOS/RHEL:需要额外配置
前置依赖安装
在安装青龙之前,需要确保系统已安装以下基础依赖:
# Debian/Ubuntu 系统
sudo apt update
sudo apt install -y nodejs npm python3 python3-pip pnpm
# CentOS/RHEL 系统
sudo yum install -y nodejs npm python3 python3-pip
npm install -g pnpm
# Alpine Linux
apk add nodejs npm python3 py3-pip
npm install -g pnpm
版本要求检查
# 检查 Node.js 版本
node --version # 需要 >= 14.0.0
# 检查 npm 版本
npm --version # 需要 >= 6.0.0
# 检查 Python 版本
python3 --version # 需要 >= 3.7.0
# 检查 pnpm 版本
pnpm --version # 需要 >= 8.3.1
npm 安装青龙完整流程
1. 通过 npm 安装青龙
# 全局安装青龙
npm install -g @whyour/qinglong
# 或者指定版本安装
npm install -g @whyour/qinglong@latest
2. 初始化项目目录
# 创建项目目录
mkdir qinglong-app && cd qinglong-app
# 初始化配置文件
cp $(npm root -g)/@whyour/qinglong/.env.example .env
# 创建数据目录结构
mkdir -p data/{config,scripts,log,db,upload}
3. 环境配置
编辑 .env
配置文件:
# 应用端口配置
GRPC_PORT=5500
BACK_PORT=5600
PORT=5700
# 日志级别
LOG_LEVEL='info'
# JWT 密钥配置(生产环境必须修改)
JWT_SECRET=your_secure_random_secret_here
JWT_EXPIRES_IN=7d
# 七牛云存储配置(可选)
QINIU_AK=your_access_key
QINIU_SK=your_secret_key
QINIU_SCOPE=your_bucket_name
4. 启动应用
# 开发模式启动
qinglong start
# 或者直接使用 npm 脚本
npm start --prefix $(npm root -g)/@whyour/qinglong
依赖管理深度解析
核心依赖架构
青龙的依赖体系采用分层架构设计:
关键依赖说明
后端核心依赖
依赖包 | 版本 | 作用 | 重要性 |
---|---|---|---|
express | ^4.21.2 | Web 应用框架 | ⭐⭐⭐⭐⭐ |
sequelize | ^6.37.5 | ORM 数据库操作 | ⭐⭐⭐⭐⭐ |
typedi | ^0.10.0 | 依赖注入容器 | ⭐⭐⭐⭐ |
@grpc/grpc-js | ^1.12.3 | gRPC 客户端 | ⭐⭐⭐⭐ |
sqlite3 | 1.0.3 | SQLite 数据库驱动 | ⭐⭐⭐⭐⭐ |
前端核心依赖
依赖包 | 版本 | 作用 | 重要性 |
---|---|---|---|
react | 18.3.1 | UI 框架 | ⭐⭐⭐⭐⭐ |
antd | ^4.24.16 | UI 组件库 | ⭐⭐⭐⭐⭐ |
@umijs/max | ^4.4.4 | 开发框架 | ⭐⭐⭐⭐⭐ |
ahooks | ^3.7.8 | React Hooks 库 | ⭐⭐⭐⭐ |
依赖冲突解决方案
青龙使用 pnpm 的覆盖机制解决依赖冲突:
{
"pnpm": {
"overrides": {
"sqlite3": "git+https://github.com/whyour/node-sqlite3.git#v1.0.3"
},
"peerDependencyRules": {
"ignoreMissing": [
"react", "react-dom", "antd", "dva"
]
}
}
}
生产环境部署指南
1. 使用 PM2 进程管理
# 安装 PM2
npm install -g pm2
# 创建 ecosystem 配置文件
cat > ecosystem.config.js << EOF
module.exports = {
apps: [{
name: 'qinglong',
script: './back/app.ts',
interpreter: 'ts-node',
instances: 'max',
exec_mode: 'cluster',
env: {
NODE_ENV: 'production',
BACK_PORT: 5600,
PORT: 5700
}
}]
}
EOF
# 启动应用
pm2 start ecosystem.config.js
pm2 save
pm2 startup
2. Nginx 反向代理配置
server {
listen 80;
server_name your-domain.com;
location / {
proxy_pass http://127.0.0.1:5700;
proxy_set_header Host $host;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header X-Forwarded-Proto $scheme;
}
# 静态资源缓存
location ~* \.(js|css|png|jpg|jpeg|gif|ico|svg)$ {
expires 1y;
add_header Cache-Control "public, immutable";
proxy_pass http://127.0.0.1:5700;
}
}
3. 数据库优化配置
# 创建数据库优化脚本
cat > /etc/systemd/system/qinglong-db-optimize.service << EOF
[Unit]
Description=Qinglong Database Optimization
After=network.target
[Service]
Type=oneshot
ExecStart=/usr/bin/sqlite3 /path/to/qinglong/data/db/database.sqlite "VACUUM; ANALYZE;"
User=qinglong
[Install]
WantedBy=multi-user.target
EOF
# 创建定时任务
echo "0 3 * * * systemctl start qinglong-db-optimize.service" | sudo tee -a /etc/crontab
监控与维护
健康检查端点
青龙提供以下健康检查接口:
# 应用健康状态
curl http://localhost:5600/api/health
# 数据库连接状态
curl http://localhost:5600/api/system
# gRPC 服务状态
curl http://localhost:5500/grpc.health.v1.Health/Check
日志管理配置
# 配置日志轮转
cat > /etc/logrotate.d/qinglong << EOF
/path/to/qinglong/data/log/*.log {
daily
missingok
rotate 30
compress
delaycompress
notifempty
copytruncate
}
EOF
故障排除与常见问题
依赖安装问题
问题: sqlite3
编译失败 解决方案:
# 安装编译工具
sudo apt install -y python3 make g++
# 清理缓存重试
npm cache clean --force
npm install -g @whyour/qinglong --force
问题: 端口冲突 解决方案:
# 检查端口占用
netstat -tlnp | grep :5700
# 修改配置文件端口
export BACK_PORT=5601
export PORT=5701
性能优化建议
-
数据库性能:
# 启用 WAL 模式 sqlite3 data/db/database.sqlite "PRAGMA journal_mode=WAL;" # 调整缓存大小 sqlite3 data/db/database.sqlite "PRAGMA cache_size=-2000;"
-
内存优化:
# 调整 Node.js 内存限制 export NODE_OPTIONS="--max-old-space-size=4096"
-
进程优化:
# 使用 cluster 模式 export NODE_ENV=production export INSTANCES=4
安全最佳实践
1. 安全加固配置
# 修改默认 JWT 密钥
export JWT_SECRET=$(openssl rand -base64 32)
# 启用 HTTPS
export NODE_ENV=production
export FORCE_HTTPS=true
# 配置 CORS 白名单
export CORS_ORIGIN=https://your-domain.com
2. 定期安全更新
# 检查依赖漏洞
npm audit --global
# 更新青龙版本
npm update -g @whyour/qinglong
# 更新系统依赖
sudo apt update && sudo apt upgrade
总结
通过 npm 安装青龙提供了最大的灵活性和控制权,适合需要深度定制和优化的高级用户。关键优势包括:
- 环境控制:完全掌控运行时环境和依赖版本
- 性能优化:可根据硬件资源进行精细调优
- 安全加固:自定义安全策略和访问控制
- 扩展性:易于集成到现有基础设施中
遵循本文的部署指南和最佳实践,可以构建出稳定、高效、安全的青龙定时任务管理平台。
创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考