revoltchat/client

REVOLT Web Client Docker镜像文档

镜像概述和主要用途

REVOLT Web Client Docker镜像是REVOLT开源聊天平台的官方网页客户端容器化版本，用于快速部署和运行REVOLT的网页界面。该镜像封装了REVOLT Web Client的静态资源及基础Web服务环境，支持通过浏览器访问REVOLT聊天服务，实现用户认证、实时消息收发、频道管理等核心功能。

核心功能和特性

• 实时通信：支持WebSocket协议，实现消息实时收发、状态同步
• 用户交互：提供用户登录/注册、个人资料管理、联系人列表等功能
• 频道管理：支持文本频道、语音频道（需后端支持）、频道权限配置
• 媒体支持：集成图片、文件上传/预览（依赖后端API）
• 响应式设计：适配桌面端、移动端等多终端访问
• 容器化优势：简化部署流程，环境隔离，支持跨平台运行

使用场景和适用范围

• 私有部署：个人或团队部署私有REVOLT服务器时，作为前端访问入口
• 开发测试：快速搭建REVOLT客户端环境，用于功能验证或兼容性测试
• 生产环境：配合REVOLT后端服务（如revolt-api、revolt-db），构建完整聊天平台
• 演示环境：临时部署用于展示REVOLT平台功能

使用方法和配置说明

前提条件

• 已安装Docker Engine（20.10+）或Docker Desktop
• 已部署REVOLT后端服务（API、WebSocket等），或使用官方公共服务

获取镜像

从Docker Hub或私有仓库拉取镜像（假设官方镜像名为revolt/web-client）：

bash
docker pull revolt/web-client:latest

基本使用（docker run）

通过docker run命令快速启动容器，需指定端口映射和后端服务地址：

bash
docker run -d \
  --name revolt-web-client \
  -p 8080:80 \  # 宿主机端口:容器内端口（容器内默认80）
  -e REACT_APP_API_URL="https://your-revolt-api.com" \  # 后端API地址
  -e REACT_APP_WS_URL="wss://your-revolt-ws.com" \  # WebSocket地址
  revolt/web-client:latest

Docker Compose配置

创建docker-compose.yml文件，整合Web Client与后端服务（示例）：

yaml
version: '3.8'

services:
  web-client:
    image: revolt/web-client:latest
    container_name: revolt-web-client
    ports:
      - "8080:80"
    environment:
      - REACT_APP_API_URL="https://revolt-api.local"  # 自定义API地址
      - REACT_APP_WS_URL="wss://revolt-ws.local"      # 自定义WebSocket地址
      - REACT_APP_DEBUG=false                         # 是否启用调试模式（默认false）
    restart: unless-stopped
    depends_on:
      - revolt-api  # 若后端服务在同一compose中，需添加依赖

  # （可选）后端服务示例（需单独部署revolt-api等组件）
  revolt-api:
    image: revolt/api:latest
    # ... 后端服务配置 ...

环境变量说明

端口映射

容器内部默认使用80端口（基于Nginx静态服务），需映射到宿主机端口（如8080）以对外提供访问。示例：

• 宿主机端口80：直接通过http://localhost访问
• 宿主机端口8080：通过http://localhost:8080访问

访问客户端

容器启动后，通过浏览器访问 http://<宿主机IP>:<映射端口>（如http://192.168.1.100:8080），即可打开REVOLT Web Client界面，输入账号密码登录使用。

数据持久化

该镜像为静态资源容器，无持久化数据需求。若需自定义配置（如替换logo、修改样式），可通过挂载本地目录覆盖容器内静态文件：

bash
docker run -d \
  --name revolt-web-client \
  -p 8080:80 \
  -v /path/to/local/assets:/usr/share/nginx/html/assets \  # 挂载自定义资源
  revolt/web-client:latest