如何在Docker环境中部署Keyshade：Web、API与CLI的容器化实践-开发者社区

如何在Docker环境中部署Keyshade：Web、API与CLI的容器化实践

【免费下载链接】keyshadeRealtime secret and configuration management tool项目地址: https://gitcode.com/gh_mirrors/ke/keyshade

Keyshade是一款实时密钥和配置管理工具，通过Docker容器化部署可以快速搭建完整的密钥管理系统。本文将详细介绍如何使用Docker Compose实现Keyshade的Web界面、API服务和CLI工具的容器化部署，帮助新手用户轻松上手这一强大的配置管理解决方案。

📋 准备工作：环境与资源检查

在开始部署前，请确保您的环境满足以下要求：

Docker Engine (20.10+) 和 Docker Compose (v2+)
至少2GB可用内存和5GB磁盘空间
Git工具（用于克隆代码仓库）

项目已提供完整的容器化配置文件，主要包括：

docker-compose.yml：定义所有服务组件的编排文件
应用Dockerfile：apps/api/Dockerfile（API服务）、apps/platform/Dockerfile（Web平台）和apps/web/Dockerfile（前端网站）

首先克隆项目代码库：

git clone https://gitcode.com/gh_mirrors/ke/keyshade cd keyshade

🐳 核心服务架构解析

Keyshade的Docker部署架构包含多个协同工作的服务组件，在docker-compose.yml中定义了完整的服务依赖关系：

基础服务组件

PostgreSQL：数据库服务，存储所有密钥和配置数据
Redis：缓存和消息队列，支持实时数据同步
Sentry：错误跟踪和性能监控系统

应用服务组件

API服务：基于Node.js的后端服务，提供密钥管理核心功能
Web平台：Next.js构建的管理界面，用于可视化配置
CLI工具：命令行接口，支持终端环境下的密钥操作

图1：Keyshade容器化部署的服务依赖关系图

⚙️ 配置文件详解与自定义

Docker Compose配置

docker-compose.yml文件定义了所有服务的运行参数，核心配置包括：

services: db: image: postgres:13 ports: - '5432:5432' environment: POSTGRES_USER: postgres POSTGRES_PASSWORD: password POSTGRES_DB: keyshade_db volumes: - db:/var/lib/postgresql/data redis: image: redis:7 ports: - '6379:6379' volumes: - redis:/data

关键自定义项：

修改默认密码：替换POSTGRES_PASSWORD为安全密码
调整端口映射：如需避免端口冲突，修改端口映射如5433:5432
持久化存储：默认使用命名卷，如需指定路径可修改volumes配置

应用环境变量

各应用服务通过环境变量进行配置，主要环境变量文件包括：

API服务：apps/api/.env
Web平台：apps/platform/.env.local

必要配置项：

# API服务配置 PORT=4200 DATABASE_URL=postgresql://postgres:password@db:5432/keyshade_db # Web平台配置 NEXT_PUBLIC_BACKEND_URL=http://api:4200

🚀 一键部署完整系统

完成配置后，使用以下命令启动所有服务：

# 构建并启动所有容器 docker-compose up -d --build # 查看服务状态 docker-compose ps # 查看API服务日志 docker-compose logs -f api

首次启动需要执行数据库迁移：

# 进入API容器 docker-compose exec api sh # 执行数据库迁移 pnpm prisma migrate deploy # 初始化管理员账户 pnpm seed

服务启动成功后，可通过以下地址访问：

Web管理平台：http://localhost:3000
API服务：http://localhost:4200
Sentry监控：http://localhost:9002

图2：Keyshade部署完成后的初始仪表盘界面

🔧 容器化CLI工具使用

Keyshade CLI工具也可以在容器环境中使用，项目提供了便捷的命令封装：

# 构建CLI镜像 docker build -t keyshade-cli -f apps/cli/Dockerfile . # 运行CLI命令 docker run --rm -it keyshade-cli keyshade --version # 配置CLI连接到本地API服务 docker run --rm -it -v $HOME/.keyshade:/root/.keyshade keyshade-cli keyshade login http://host.docker.internal:4200

✅ 验证部署与基本操作

部署完成后，建议进行以下验证步骤：

访问Web界面：打开http://localhost:3000，使用默认管理员账户登录（admin@keyshade.dev / password）
创建测试项目：
- 点击"Create project"按钮
- 输入项目名称（如"My App"）
- 选择私有项目类型
- 完成创建

图3：创建测试项目后的Keyshade仪表盘

添加测试密钥：

# 使用CLI添加测试密钥 docker run --rm -it -v $HOME/.keyshade:/root/.keyshade keyshade-cli keyshade secret create -p "My App" -k "TEST_KEY" -v "secret_value"

验证密钥获取：

# 通过API获取密钥 curl http://localhost:4200/api/v1/projects/my-app/secrets/TEST_KEY \ -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

📝 常见问题与解决方案

服务启动失败

检查日志：docker-compose logs [service_name]
端口冲突：修改docker-compose.yml中的端口映射
数据库连接问题：确保数据库服务先于API服务启动

持久化数据管理

备份数据：

# 备份PostgreSQL数据 docker-compose exec db pg_dump -U postgres keyshade_db > backup.sql # 恢复数据 cat backup.sql | docker-compose exec -T db psql -U postgres -d keyshade_db