gotify/server 镜像文档

镜像概述和主要用途

gotify/server 是一款轻量级自托管消息收发服务器，专注于提供简单、高效的实时消息传递能力。它支持通过 REST API 发送消息，并通过 WebSocket 实现实时接收，适用于需要私有部署消息通知服务的场景，无需依赖第三方商业推送服务。

核心功能和特性

• 多协议消息传输：支持通过 REST API 发送消息，通过 WebSocket 实时接收消息，实现双向实时通信。
• 完整的管理功能：提供用户、客户端及应用的创建与权限管理，灵活控制消息发送与接收范围。
• 内置 API 文档：集成交互式 API 文档（访问 /docs 路径），便于开发者快速集成。
• Web 管理界面：内置直观的 Web UI，可通过浏览器直接管理服务器配置、用户账户及消息。
• 多客户端支持：提供命令行工具（gotify/cli）和 Android 客户端（gotify/android），覆盖多种使用场景。

使用场景和适用范围

• 私有消息通知系统：企业或个人部署私有服务，用于系统告警、应用通知、状态更新等场景。
• 内部服务通信：作为轻量级消息中间件，实现微服务间、设备间的实时数据传递。
• 个人项目实时通知：为开发项目（如博客、监控工具）添加实时消息推送功能。
• 开发测试环境：快速搭建本地消息服务器，用于调试消息发送、接收逻辑及客户端集成。

详细使用方法和配置说明

Docker 快速部署

通过以下命令启动容器，实现快速部署：

bash
docker run -d \
  --name gotify-server \
  -p 8080:80 \
  -v /path/to/gotify/data:/var/gotify \
  -e GOTIFY_ADMIN_USERNAME=admin \
  -e GOTIFY_ADMIN_PASSWORD=StrongPassword123 \
  gotify/server:latest

参数说明：

• -p 8080:80：将容器内 80 端口映射到主机 8080 端口，通过 http://localhost:8080 访问服务。
• -v /path/to/gotify/data:/var/gotify：挂载数据卷，持久化存储消息、用户配置等数据。
• -e GOTIFY_ADMIN_USERNAME：设置管理员用户名（默认值：admin）。
• -e GOTIFY_ADMIN_PASSWORD：设置管理员密码（建议使用强密码，默认随机生成并在首次启动日志中显示）。

Docker Compose 配置

创建 docker-compose.yml 文件，定义服务配置：

yaml
version: '3'

services:
  gotify:
    image: gotify/server:latest
    container_name: gotify-server
    restart: always
    ports:
      - "8080:80"  # 主机端口:容器端口
    volumes:
      - ./gotify-data:/var/gotify  # 本地目录挂载，持久化数据
    environment:
      - GOTIFY_SERVER_PORT=80  # 容器内服务监听端口（默认80）
      - GOTIFY_DATABASE_DIALECT=sqlite3  # 数据库类型（默认sqlite3，支持mysql/postgres）
      - GOTIFY_ADMIN_USERNAME=admin  # 管理员用户名
      - GOTIFY_ADMIN_PASSWORD=StrongPassword123  # 管理员密码
      - GOTIFY_LOG_LEVEL=info  # 日志级别（debug/info/warn/error，默认info）
    networks:
      - gotify-network

networks:
  gotify-network:

启动服务：

bash
docker-compose up -d

配置参数说明

gotify/server 支持通过环境变量或配置文件（/app/config.yml）进行配置，常用参数如下：

完整配置参数及说明请参考 ***配置文档。

版本控制

项目采用 SemVer（语义化版本）规范进行版本管理。可用版本请参见 GitHub 仓库标签。

许可证

本项目基于 MIT 许可证开源，详情参见 LICENSE 文件。