spacebarchat/server

Spacebar Server Docker 镜像文档

GitHub: https://github.com/spacebarchat/docker

镜像概述

Spacebar Server Docker镜像提供了快速部署Spacebar聊天服务器的解决方案，支持开发环境和生产环境，兼容多种数据库和存储后端，简化了服务器搭建流程。

核心功能与特性

• 多环境支持：同时支持开发环境和生产环境部署
• 数据库兼容性：提供SQLite（开发环境）和PostgreSQL（生产环境）两种数据库选项
• 存储灵活性：支持本地文件存储和S3云存储两种存储方式
• 自动健康检查：生产环境配置中包含数据库健康检查机制
• 持久化存储：通过Docker卷实现数据持久化，确保数据不丢失

使用场景

• 开发测试：快速搭建本地开发环境，无需复杂配置
• 生产部署：稳定运行的生产环境，支持高可用性配置
• 灵活存储需求：根据实际需求选择本地存储或S3云存储

使用方法

开发环境部署

前提条件

• 已安装Docker和Docker Compose

部署步骤

1. 创建docker-compose.yaml文件，内容如下：

yaml
version: "3.9"
services:
  spacebar:
    image: spacebarchat/server:latest-sqlite
    ports:
      - "3001:3001"
    volumes:
      - spacebar-database:/exec/persistent/database/
      - spacebar-storage:/exec/persistent/storage
    environment:
      DATABASE: "/exec/persistent/database/database.db"
      STORAGE_PROVIDER: "file"
      STORAGE_LOCATION: "/exec/persistent/storage/"
      PORT: "3001"
volumes:
  spacebar-database:
  spacebar-storage:

2. 启动服务：

bash
sudo docker compose up
# 或后台运行
sudo docker compose up -d

生产环境部署

生产环境支持两种存储方式：本地文件存储和S3云存储，均使用PostgreSQL数据库。

本地文件存储配置

1. 首先设置环境变量：

bash
export POSTGRES_USER=postgres
export POSTGRES_PASSWORD=postgres
export POSTGRES_DATABASE=spacebar

2. 创建docker-compose.prod.yaml文件：

yaml
version: "3.9"
services:
  spacebar:
    image: spacebarchat/server:latest-postgressql
    restart: unless-stopped
    ports:
      - "3001:3001"
    volumes:
      - spacebar-storage:/exec/persistent/storage
    environment:
      DATABASE: postgres://${POSTGRES_USER}:${POSTGRES_PASSWORD}@db:5432/${POSTGRES_DATABASE}
      STORAGE_PROVIDER: "file"
      STORAGE_LOCATION: "/exec/persistent/storage/"
      PORT: "3001"
    depends_on:
      db:
        condition: service_healthy
  db:
    image: postgres:15-alpine
    restart: unless-stopped
    environment:
      - POSTGRES_USER=${POSTGRES_USER:?err}
      - POSTGRES_PASSWORD=${POSTGRES_PASSWORD:?err}
      - POSTGRES_DB=${POSTGRES_DATABASE:?err}
    ports:
      - '127.0.0.1:5432:5432'
    volumes: 
      - db:/var/lib/postgresql/data
    healthcheck:
      test: ["CMD-SHELL", "pg_isready -d ${POSTGRES_DATABASE} -U ${POSTGRES_USER}"]
      interval: 10s
      timeout: 5s
      retries: 5
volumes:
  spacebar-storage:
  db:

3. 启动服务：

bash
sudo docker-compose -f docker-compose.prod.yaml up
# 或后台运行
sudo docker-compose -f docker-compose.prod.yaml up -d

S3存储配置

1. 设置环境变量（在原有PostgreSQL变量基础上添加）：

bash
export S3_BUCKET=S3://...
export S3_BUCKET_NAME=test
export S3_BUCKET_REGION=eu-central-1

2. 创建docker-compose.prod.s3.yaml文件：

yaml
version: "3.9"
services:
  spacebar:
    image: spacebarchat/server:latest-postgressql
    restart: unless-stopped
    ports:
      - "3001:3001"
    environment:
      DATABASE: postgres://${POSTGRES_USER}:${POSTGRES_PASSWORD}@db:5432/${POSTGRES_DATABASE}
      STORAGE_PROVIDER: s3
      STORAGE_LOCATION: ${S3_BUCKET:?err}
      STORAGE_BUCKET: ${S3_BUCKET_NAME:?err}
      STORAGE_REGION: ${S3_BUCKET_REGION:?err}
      PORT: "3001"
    depends_on:
      db:
        condition: service_healthy
  db:
    image: postgres:15-alpine
    restart: unless-stopped
    environment:
      - POSTGRES_USER=${POSTGRES_USER}
      - POSTGRES_PASSWORD=${POSTGRES_PASSWORD}
      - POSTGRES_DB=${POSTGRES_DATABASE}
    ports:
      - '127.0.0.1:5432:5432'
    volumes: 
      - db:/var/lib/postgresql/data
    healthcheck:
      test: ["CMD-SHELL", "pg_isready -d ${POSTGRES_DATABASE} -U ${POSTGRES_USER}"]
      interval: 10s
      timeout: 5s
      retries: 5
volumes:
  db:

3. 启动服务：

bash
docker-compose -f docker-compose.prod.s3.yaml up
# 或后台运行
docker-compose -f docker-compose.prod.s3.yaml up -d

注意事项

首次启动时可能会出现以下错误，属于正常现象，可以忽略：

db_1        | 2023-03-04 17:28:25.790 UTC [63] ERROR:  relation "config" does not exist at character 31
db_1        | 2023-03-04 17:28:25.790 UTC [63] STATEMENT:  SELECT COUNT(1) AS "cnt" FROM "config" "ConfigEntity"

带NGINX和客户端的部署（开发中）

spacebar-server-client-proxy目录下提供了一个实验性项目，包含Spacebar服务器、客户端、反向代理和SSL配置。

部署步骤

bash
# 克隆仓库
git clone https://github.com/spacebarchat/docker.git
# 进入目录
cd docker/spacebar-server-client-proxy

设置环境变量：

bash
export POSTGRES_USER=postgres
export POSTGRES_PASSWORD=your-password
export POSTGRES_DATABASE=spacebar
export MAIL_CERTBOT=your-email
export NGINX_HOST=your-domain

启动服务：

bash
sudo docker-compose -f docker-compose.prod.yaml up
# 或后台运行
sudo docker-compose -f docker-compose.prod.yaml up -d

Spacebar客户端

客户端目前处于开发阶段，暂无详细文档。有关客户端部署，请参考上述"带NGINX和客户端的部署（开发中）"部分。