Skip to content

docs: README.en.md を receiver の現行契約に同期する (#105) - #107

Merged
kosako merged 1 commit into
mainfrom
docs/105-en-readme-sync
Jul 5, 2026
Merged

docs: README.en.md を receiver の現行契約に同期する (#105)#107
kosako merged 1 commit into
mainfrom
docs/105-en-readme-sync

Conversation

@kosako

@kosako kosako commented Jul 5, 2026

Copy link
Copy Markdown
Owner

概要

Issue #105。README.md(日本語)は #103 / #104 / #106 で receiver の契約変更に追従済みだが、ミラーの README.en.md が古いままだったので同期する(PR #104 の Codex レビュー ⚪ nit 起点。#101 と同型のドキュメント同期 PR)。

変更内容(すべて README.md の既存記述の英訳ミラー)

  • RECEIVER_TOKEN: 「read-only GETs are not gated」→ 閲覧系も保護 + inbox ログイン(HMAC 派生 cookie、7 日、Secure 条件、ローテで全失効)に更新
  • INGEST_KEYS / ingestKeys(projectId 紐付け含む)と ALLOWED_ORIGINS の項目を追加
  • GET /healthz / graceful shutdown の bullet を追加
  • invalid setting warning + limits: / rate limit: サマリの段落を追加
  • Public Deployment (EC2 etc.) 節を新設(reverse proxy / RECEIVER_TOKEN / ALLOWED_ORIGINS / INGEST_KEYS / PUBLIC_BASE_URL / secrets env 注入 / healthz)
  • Init options に ingestKey を追加
  • GitHub Issue 節: 認証有効時の screenshot リンク退化を追記
  • Current Boundary: 「Auth」→「Per-reviewer authentication(将来スコープ)」に更新

テスト

npm run check 全 105 件パス(docs のみ、コード変更なし)。

Closes #105

🤖 Generated with Claude Code

https://claude.ai/code/session_01LRdDjwxbAAaTMwwnzipkau

#103(inbox ログイン + CORS 制限)・#104(healthz / graceful shutdown /
設定警告)・#106(ingest key)で README.md に入れた receiver 契約の変更を
英語版にミラーする:

- RECEIVER_TOKEN の説明を「閲覧系も保護 + inbox ログイン(HMAC cookie)」に更新
- INGEST_KEYS / ALLOWED_ORIGINS の項目を追加
- healthz・graceful shutdown・invalid setting warning を追記
- Public Deployment (EC2 etc.) 節を新設
- Init options に ingestKey を追加、Current Boundary の Auth 行を更新

Closes #105

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01LRdDjwxbAAaTMwwnzipkau
@kosako

kosako commented Jul 5, 2026

Copy link
Copy Markdown
Owner Author

🔍 レビュー依頼(→ Codex)

  • 観点: ドキュメント同期 PR(docs: README.en.md を receiver の現行契約(#43 認証・CORS / #99 healthz・shutdown)に同期する #105、コード変更なし)。重点:
    • 実装との正確性: 英語版の記述が server/receive.js / widget/src/index.js の実挙動と一致しているか(認証対象 endpoint の列挙、cookie 属性、401/403 の条件、healthz の仕様、警告ログの形式)
    • README.md との同値性: 日本語版と意味がズレていないか、ミラー漏れがないか
    • secret / 内部情報の混入がないこと
  • ランク: 🔴 must / 🟡 should / ⚪ nit
  • 結果はこの PR にコメントで返します

@kosako

kosako commented Jul 5, 2026

Copy link
Copy Markdown
Owner Author

📋 レビュー結果(by Codex GPT-5.5)

判定: ✅ merge 可(must 0 件) — 🟡 should / ⚪ nit も 0 件

🔴 must

なし

🟡 should

なし

⚪ nit

なし

レビュアーの検証範囲(要旨)

README.en.md の差分全体を、server/receive.js(auth route table / cookie / 401・403 / healthz / shutdown / CORS / 警告ログ)および widget/src/index.js(ingestKey 送信)と突き合わせて実装との一致を確認。README.md の対応箇所との同値性、secret・内部参照の混入なしも確認。

@kosako
kosako marked this pull request as ready for review July 5, 2026 13:58
@kosako
kosako merged commit 4afb53e into main Jul 5, 2026
1 check passed
@kosako
kosako deleted the docs/105-en-readme-sync branch July 5, 2026 13:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: README.en.md を receiver の現行契約(#43 認証・CORS / #99 healthz・shutdown)に同期する

1 participant