Skip to content

Commit c3384b4

Browse files
committed
docs: add cloudflare public release policy
1 parent 0ed796f commit c3384b4

1 file changed

Lines changed: 24 additions & 0 deletions

File tree

CLAUDE.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# bit-relay Release Policy (Cloudflare)
2+
3+
## Public release profile (default production)
4+
5+
Cloudflare の本番環境は、まず利用者が試しやすいことを優先し、以下の「緩い公開設定」で運用する。
6+
7+
- `BIT_RELAY_AUTH_TOKEN`: **unset**(API/WS の Bearer 認証を要求しない)
8+
- `RELAY_REQUIRE_SIGNATURE`: **false**(署名なし publish を許可)
9+
- `RELAY_ROOM_TOKENS`: **unset** または `{}`(room token を必須にしない)
10+
11+
この設定は「公開リレーとしての参加容易性」を目的としたもので、セキュアな閉域運用を目的としない。
12+
13+
## Strict profile (private/team relay)
14+
15+
チーム内運用や制限付き運用では、別環境を用意して以下を有効化する。
16+
17+
- `BIT_RELAY_AUTH_TOKEN` を設定
18+
- `RELAY_REQUIRE_SIGNATURE=true`
19+
- 必要に応じて `RELAY_ROOM_TOKENS` を設定
20+
21+
## Compatibility policy
22+
23+
- 公開環境は後方互換を優先し、既存クライアントが接続不能になる破壊的なデフォルト変更は避ける。
24+
- 厳格化(認証必須化・署名必須化)は、別環境または明示的な移行告知付きで実施する。

0 commit comments

Comments
 (0)