维护指南
了解如何部署、配置和维护私有组件注册表
欢迎来到维护指南!本部分面向 Registry 的管理员和维护者,帮助您部署、配置和管理私有组件注册表。
概述
作为 Registry 维护者,您需要:
- 🚀 部署服务 - 将 Registry 部署到生产环境
- 🔐 配置安全 - 设置认证和访问控制
- 📦 管理组件 - 添加、更新和维护组件库
- 👥 支持团队 - 帮助团队成员使用 Registry
快速部署
配置认证
生成安全令牌:
node -e "console.log(require('crypto').randomBytes(32).toString('hex'))"配置环境变量:
REGISTRY_TOKEN=your_generated_token构建并启动
# 构建注册表文件
pnpm registry:build
# 启动开发服务器
pnpm dev
# 或构建生产版本
pnpm build
pnpm start文档导航
项目结构
了解关键目录和文件:
registry/
├── app/
│ └── api/registry/[name]/ # 🔒 认证 API 路由
├── content/docs/ # 📚 文档内容
├── registry/ # 📦 组件源代码
│ └── new-york/
│ ├── ui/ # UI 组件
│ ├── blocks/ # 区块组件
│ └── lib/ # 工具函数
├── public/r/ # 🔒 生成的 JSON(受保护)
├── registry.json # 📋 组件配置文件
└── middleware.ts # 🛡️ 认证中间件管理组件
添加新组件
- 在
registry/new-york/创建组件文件 - 更新
registry.json配置 - 运行构建命令生成 JSON
pnpm registry:build组织组件
按类型组织组件:
- ui/ - 基础 UI 组件(Button、Input 等)
- blocks/ - 复杂组合组件(Form、Card 等)
- lib/ - 工具函数和 Hooks
版本管理
使用 Git 标签管理组件版本:
git tag -a v1.0.0 -m "Release v1.0.0"
git push origin v1.0.0安全最佳实践
重要安全措施:
- ✅ 强随机令牌 - 至少 32 字节
- ✅ HTTPS 传输 - 生产环境必需
- ✅ 环境变量 - 不要提交令牌到 Git
- ✅ 中间件保护 - 保护
/r/静态文件 - ✅ 定期轮换 - 每 3-6 个月更新令牌
部署平台
支持多种部署平台:
Vercel(推荐)
vercel --prod在 Vercel 控制台配置环境变量 REGISTRY_TOKEN。
Docker
FROM node:20-alpine
WORKDIR /app
COPY . .
RUN pnpm install
RUN pnpm build
ENV REGISTRY_TOKEN=${REGISTRY_TOKEN}
EXPOSE 3000
CMD ["pnpm", "start"]传统服务器
# 使用 PM2 管理进程
pm2 start npm --name "registry" -- start监控和维护
健康检查
监控服务状态:
curl https://your-domain.com/api/health日志管理
查看访问日志,追踪组件使用情况:
# Vercel
vercel logs
# PM2
pm2 logs registry性能优化
- 启用 CDN 缓存
- 压缩 JSON 响应
- 使用 HTTP/2
常见维护任务
更新令牌
- 生成新令牌
- 更新环境变量
- 通知团队成员更新配置
- 监控访问日志确保迁移完成
添加团队成员
- 共享 Registry URL
- 提供访问令牌
- 发送客户端配置指南
故障排查
- 检查环境变量配置
- 验证中间件是否正常工作
- 查看服务器日志
- 测试认证端点
团队协作
文档更新
维护清晰的文档帮助团队使用:
- 更新
content/docs/中的 MDX 文件 - 提供组件使用示例
- 记录常见问题和解决方案
组件审查
建立组件审查流程:
- 代码审查
- 测试覆盖
- 文档完整性
- 设计一致性
获取帮助
如果您遇到问题:
准备好了吗? 开始部署 →