revoltchat/server

REVOLT API Server 镜像文档

镜像概述

REVOLT API Server 镜像是部署 REVOLT 平台后端 API 服务的 Docker 镜像，负责处理客户端请求、数据交互及业务逻辑处理，是 REVOLT 系统的核心后端组件。

核心功能与特性

• 提供 RESTful API 接口，支持客户端与后端的数据交互
• 集成用户认证与授权机制，保障服务访问安全
• 支持与数据库等存储服务连接，实现数据持久化
• 具备可配置的服务参数，适应不同部署环境需求
• 内置日志记录功能，便于问题排查与服务监控

使用场景与适用范围

适用于需要部署 REVOLT 平台后端服务的场景，包括：

• 开发环境中搭建本地测试服务器
• 生产环境中部署高可用 API 服务集群
• 快速构建基于 REVOLT 的定制化应用后端

使用方法与配置说明

基本部署命令

通过以下命令启动 REVOLT API Server 容器：

bash
docker run -d \
  --name revolt-api \
  -p 8000:8000 \
  -e DATABASE_URL="postgresql://user:password@db-host:5432/revolt" \
  -e PORT=8000 \
  -e JWT_SECRET="your-jwt-secret" \
  revolt/api-server:latest

参数说明

端口映射

• -p 8000:8000: 将容器内 8000 端口映射到主机，用于外部访问 API 服务

环境变量配置

持久化配置

通过挂载卷实现配置与日志持久化：

bash
docker run -d \
  --name revolt-api \
  -p 8000:8000 \
  -e DATABASE_URL="postgresql://user:password@db-host:5432/revolt" \
  -v ./config:/app/config \
  -v ./logs:/app/logs \
  revolt/api-server:latest

• ./config:/app/config: 挂载主机配置目录，用于自定义服务配置
• ./logs:/app/logs: 挂载主机日志目录，存储运行日志

健康检查

查看容器健康状态：

bash
docker inspect --format='{{.State.Health.Status}}' revolt-api

注意事项

• 首次启动前需确保数据库服务可访问，DATABASE_URL 需正确配置
• 生产环境中建议使用强密钥并定期轮换 JWT_SECRET
• 根据实际需求调整资源限制（如 --memory、--cpus 参数）