hoppscotch

Office Web - Source - Docker Image - Document

hoppscotch 一个轻量级的基于 Web 的 API 开发套件。

端口描述

参数	端口	描述
`FRONTEND_PORT`	`3000`	前端
`APP_PORT`	`3200`	桌面客户端
`ADMIN_PORT`	`3100`	管理端
`BACKEND_PORT`	`3170`	后端
`AIO_PORT`	`8080`	All-In-One 一体化

部署教程

初始化配置信息

bash

# 一体（若非80或443，则需含完整的路径）
./setup.sh aio hostname:8080

# 单体（不含端口）
./setup.sh one hostname

# 若为 https 协议，则第三参数必存在
./setup.sh one hostname x

初始化

启动 PostgreSQL：

bash

# aio
docker compose --profile init up -d

初始化数据库

bash

# 一体
docker compose run --rm --entrypoint pnpm aio dlx prisma migrate deploy

# 单体
docker compose run --rm --entrypoint pnpm backend dlx prisma migrate deploy

启动 Hoppscotch：

bash

# 一体
docker compose --profile aio up -d

# 单体
docker compose --profile one up -d

访问 Hoppscotch 管理端：

bash

# 一体
http://hostname:8080 # Web
http://hostname:8080/admin # Admin
http://hostname:8080/backend # API

# 单体
http://hostname:3000 # Web
http://hostname:3100 # Admin
http://hostname:3170 # API

生成密钥

bash

openssl rand -hex 16

OAuth 配置

bash

VITE_ALLOWED_AUTH_PROVIDERS=GOOGLE,GITHUB,MICROSOFT,EMAIL

第三方登录配置

GITHUB_CLIENT_ID=*****
GITHUB_CLIENT_SECRET=*****
GITHUB_CALLBACK_URL=http://localhost:3170/v1/auth/github/callback
GITHUB_SCOPE=user:email

邮箱登录配置（社区版不支持）

bash

MAILER_SMTP_HOST=smtp.domain.com
MAILER_SMTP_PORT=587
MAILER_SMTP_SECURE=true
MAILER_SMTP_USER=user@domain.com
MAILER_SMTP_PASSWORD=pass
MAILER_TLS_REJECT_UNAUTHORIZED=true

桌面配置域名绑定到服务的 3200 端口，若域名为 a.x.com，那么需要将 http://app.a_x_com(Windows)、app://a_x_com(Linux)平台的添加至 WHITELISTED_ORIGINS 列表中。

bash

# app://hoppscotch_my_domain_com   for Linux and macOS machines.
# http://app.hoppscotch_my_domain_com   for Windows machine.

hoppscotch ​

端口描述 ​

部署教程 ​

初始化 ​

hoppscotch

端口描述

部署教程

初始化