yetone/alma-relay

选用指南

AI 根据 README 整理 · 2026/11/1 06:42:30

使用方式

通过 Docker、Cloudflare Workers 或 Node.js 部署，使用环境变量配置。

查看 README 依据

(the Alma default), the relay only ever sees ciphertext. It stores nothing on disk and never sees your connect code. Alma ships with a hosted relay (`relay.alma.now`). Run your own if you want the traffic on infrastructure you control, a region closer to you, or no dependency on anyone else's server. ## Deploy Pick one. Each takes a few minutes. ### Option A: Cloudflare Workers (free, no server) [](https://deploy.workers.cloudflare.com/?url=https://github.com/yetone/alma-relay) Or from a clone: ```bash

git clone https://github.com/yetone/alma-relay && cd alma-relay npm install npx wrangler deploy # prints https://alma-relay.<you>.workers.dev ``` This runs on the Workers **Free plan**, using SQLite-backed Durable Objects with WebSocket hibernation, so an idle pairing costs next to nothing. TLS and a `*.workers.dev` hostname come with it. To use your own domain, uncomment `routes` in `wrangler.jsonc`. ### Option B: Docker with automatic HTTPS (any VPS) You need a server with ports 80 and 443 open and a DNS record pointing at it. ```bash

git clone https://github.com/yetone/alma-relay && cd alma-relay cp .env.example .env # set RELAY_DOMAIN=relay.example.com docker compose up -d ``` [Caddy](https://caddyserver.com) obtains and renews the Let's Encrypt certificate on its own. Your relay is at `https://relay.example.com`. ### Option C: Behind your own reverse proxy ```bash docker run -d --restart unless-stopped -p 127.0.0.1:8787:8787 ghcr.io/yetone/alma-relay # or, without Docker (Node ≥ 20): npx github:yetone/alma-relay ``` Then proxy your HTTPS hostname to `127.0.0.1:8787`. WebSockets must be allowed

部署要求

Docker 部署需要服务器开放 80 和 443 端口，并配置 DNS 记录；Cloudflare Workers 免费计划可用；Node.js 部署需要 Node ≥ 20。

查看 README 依据

git clone https://github.com/yetone/alma-relay && cd alma-relay npm install npx wrangler deploy # prints https://alma-relay.<you>.workers.dev ``` This runs on the Workers **Free plan**, using SQLite-backed Durable Objects with WebSocket hibernation, so an idle pairing costs next to nothing. TLS and a `*.workers.dev` hostname come with it. To use your own domain, uncomment `routes` in `wrangler.jsonc`. ### Option B: Docker with automatic HTTPS (any VPS) You need a server with ports 80 and 443 open and a DNS record pointing at it. ```bash

git clone https://github.com/yetone/alma-relay && cd alma-relay cp .env.example .env # set RELAY_DOMAIN=relay.example.com docker compose up -d ``` [Caddy](https://caddyserver.com) obtains and renews the Let's Encrypt certificate on its own. Your relay is at `https://relay.example.com`. ### Option C: Behind your own reverse proxy ```bash docker run -d --restart unless-stopped -p 127.0.0.1:8787:8787 ghcr.io/yetone/alma-relay # or, without Docker (Node ≥ 20): npx github:yetone/alma-relay ``` Then proxy your HTTPS hostname to `127.0.0.1:8787`. WebSockets must be allowed

已知限制

自托管中继无法为官方 Alma iOS 应用发送推送通知，除非自行构建 iOS 应用并提供 APNs 密钥。

查看 README 依据

Tokens are standard HS256 JWTs (`aud: "alma-relay"`, `sub`, `exp`), so any JWT library can mint them too. Rotate the secret to revoke them all. ### Phone notifications The iOS app can't keep a connection open while the phone is locked. "Reply finished" and "Alma has a question" therefore arrive through Apple Push, which the relay sends on the desktop's behalf. Apple only accepts these from the key of the team that signs the app. **A self-hosted relay therefore can't notify the official Alma iOS app.** Everything else works. If you build the iOS app yourself, give the relay your own key: