zerocustom/gotify-e repository overview

Gotify 客户端 (curl/App/CLI)
    │ HTTP / WebSocket
    ▼
Gotify<sup>[E]</sup>  ──HTTP──►  Gotify 后端
    │
    ▼
/data/

pip install -r requirements.txt
# 需要 libmagic: brew install libmagic / apt install libmagic1
cp .env.example .env
cd app && uvicorn app:app --reload --port 8765

# 启动后打开浏览器访问：
open http://localhost:8765/docs

curl -F "[email protected]" -F "message=test" \
  "http://localhost:8765/message?token=your_token"
curl -F "[email protected]" -F "[email protected]" \
  -F "message=multi" "http://localhost:8765/message?token=your_token"

# 安装测试依赖
pip install pytest pytest-asyncio httpx websockets

# 单元测试（无需外部依赖）
pytest test/ -v -k "not integration"

# 集成测试（需要启动的 Gotify 后端和 Gotify[E] 网关，通过环境变量配置）
export GOTIFY_BACKEND=http://localhost:8080
export GATEWAY_URL=http://localhost:8765
export APP_TOKEN=your_gotify_app_token
export CLIENT_TOKEN=your_gotify_client_token
python3 test/integration_test.py

# 上传场景测试
python3 test/upload_scenarios_test.py

services:
  gotify:
    image: gotify/server:latest
    restart: unless-stopped
    ports:
      - 8080:80
    volumes:
      - gotify-data:/app/data

  gateway:
    image: zerocustom/gotify-e:latest
    restart: unless-stopped
    ports:
      - 8765:8765
    environment:
      - GOTIFY_BACKEND=http://gotify:80
      - PUBLIC_URL=http://localhost:8765
    volumes:
      - uploads-data:/data
    depends_on:
      - gotify

volumes:
  gotify-data:
  uploads-data:

docker compose up -d
# 客户端连接 http://localhost:8765 即可

docker run -d --name=gotify-e \
  -p 8765:8765 \
  -e GOTIFY_BACKEND=http://host.docker.internal:8080 \
  -e PUBLIC_URL=http://localhost:8765 \
  -v uploads-data:/data \
  --restart unless-stopped \
  zerocustom/gotify-e:latest

客户端 ──Content-Encoding: gzip──► Caddy/nginx ──解压后明文────► Gotify[E]

docker logs -f gotify-e

curl http://localhost:8765/version

{"version": 3, "_gateway": "Gotify[e]", "_upload_max": 52428800, "_max_files": 5}

git clone <your-repo-url> gotify-e
cd gotify-e
docker build -t gotify-e:latest .

├── app/                     # 主程序
│   ├── app.py               # 路由 + 中间件 + WebSocket + 入口点
│   ├── proxy.py             # 代理管道 + HttpClient 协议/实现
│   ├── upload.py            # 上传拦截 + 错误处理
│   ├── storage.py           # 文件存储引擎
│   ├── config.py            # 配置管理 + 版本号常量
│   ├── docker.sh            # 容器引导脚本
│       └── _gateway/            # i18n 多语言 UI 层
│       ├── i18n.js          #   引擎：语言检测 + 文本替换 + Intl 相对时间
│       ├── enhance.js       #   增强：品牌标记 + 布局 + 时间切换按钮
│       └── lang/            #   翻译文件
│           ├── zh_CN.js     #     简体中文（180 条）
│           ├── en.js        #     英语占位
│           ├── fr.js / de.js / es.js / pt.js
│           └── ru.js / it.js / ko.js / ja.js
├── docs/                    # 文档（中英双语）
│   ├── app.md / app.zh.md
│   ├── config.md / config.zh.md
│   ├── i18n.md / i18n.zh.md
│   └── storage.md / storage.zh.md
├── Dockerfile               # 生产镜像构建
├── docker-compose.yml       # 编排部署
├── requirements.txt         # Python 依赖
├── .env.example             # 环境变量模板
├── .dockerignore
├── CHANGELOG.md
└── README.md