Hoppscotch项目Docker Compose部署指南

概述

Hoppscotch是一个开源的API开发工具，本文将从技术角度深入解析其Docker Compose部署方案。通过Docker Compose，我们可以轻松实现Hoppscotch的自托管部署，满足不同场景下的需求。

核心服务架构

Hoppscotch的Docker部署包含以下几个核心组件：

1. 后端服务(hoppscotch-backend)：处理业务逻辑，默认运行在3170端口
2. 主应用服务(hoppscotch-app)：包含集成的Web应用服务器，运行在3000端口
3. 自托管管理面板(hoppscotch-sh-admin)：用于管理自托管实例，运行在3100端口
4. 数据库服务(hoppscotch-db)：PostgreSQL数据库实例
5. 自动迁移服务(hoppscotch-migrate)：处理数据库迁移

部署方案详解

1. 默认部署方案（推荐）

docker compose --profile default up

此方案会启动：

• 一体化服务(AIO)
• 数据库服务
• 自动迁移服务

适合大多数用户，提供完整功能体验。

2. 无数据库部署方案

docker compose --profile default-no-db up

此方案仅启动一体化服务，适用于已拥有外部数据库的用户。使用时需确保：

1. 已正确配置外部数据库连接
2. 已更新.env文件中的DATABASE_URL

3. 组件独立部署方案

可根据需求单独部署特定组件：

# 仅后端服务
docker compose --profile backend up

# 仅主应用和Web服务器
docker compose --profile app up

# 仅管理面板
docker compose --profile admin up

# 仅数据库
docker compose --profile database up

4. 开发环境部署方案

docker compose --profile just-backend up

此方案启动除Web应用外的所有服务，适合本地开发环境。

关键配置说明

数据库配置

默认数据库配置如下：

environment:
  POSTGRES_USER: postgres
  POSTGRES_PASSWORD: testpass  # 生产环境务必修改
  POSTGRES_DB: hoppscotch

生产环境中必须修改默认密码，并考虑：

1. 数据持久化方案
2. 定期备份策略
3. 性能调优参数

端口映射

各服务默认端口映射：

• 主应用：3000
• 管理面板：3100
• 后端API：3170
• Web服务器：3200
• 数据库：5432

可根据实际环境调整端口映射关系，避免冲突。

高级配置建议

1. TLS配置：可通过修改Caddyfile实现HTTPS支持
2. 性能调优：根据负载调整容器资源限制
3. 日志管理：配置集中式日志收集
4. 监控告警：集成Prometheus等监控工具

注意事项

1. 默认配置和独立服务配置不要混用，会导致端口冲突
2. 生产环境务必修改默认凭据
3. 废弃服务(deprecated)仅用于兼容性，新部署不应使用
4. 开发时可挂载代码目录实现热更新

总结

Hoppscotch提供了灵活的Docker Compose部署方案，从简单的一键部署到复杂的组件化部署都能满足。理解各服务组件的关系和配置要点，能够帮助开发者根据实际需求定制最适合的部署方案。