[Docs] Document node anti-abuse limits and migration

オープン
#45 コメント 2 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
3/5
見積もり時間
1〜2日
初心者へのやさしさ
72/100
issue の種類
ドキュメント
明瞭さ
明確に書かれている
活発さ
活発
技術スタック
javascript
領域
documentation

調査の方向性

Start by comparing the node configuration and WebSocket guide examples with config.default.json, then review the implementation and related work in Adamant-im/adamant#292 and #218 for the documented behavior. Cover the listed limits, migration rules, proxy boundary, process-local counters, and client handling guidance. Done means the operator guidance is complete and the examples match the default configuration.

索引モデルが issue の本文から書いたものです。

説明

APIs documentation Nodes

Summary

Document the operator-facing anti-abuse configuration implemented for Adamant-im/adamant#292.

Scope

  • Explain the preferred limit field and the legacy max compatibility behavior.
  • Document aggregate surface limits and per-route REST/peer limits.
  • Explain migration for copied configs that still contain max: 0 or limit: 0.
  • Add reverse-proxy guidance for trustProxy, including the single immediate proxy boundary and rightmost X-Forwarded-For value.
  • Document client WebSocket connection, connection-attempt, subscription, and mutation limits.
  • Document node WebSocket handshake, nonce, live-session, and event limits.
  • Explain that counters are process-local and that multi-process deployments need an outer shared control.
  • Add client guidance for 429, Retry-After, rate-limit headers, and CORS exposure.

Related work

  • Adamant-im/adamant#218
  • Adamant-im/adamant#292

Acceptance criteria

  • The node configuration and WebSocket guide examples match config.default.json.
  • Migration behavior is explicit for existing operator configs.
  • Proxy and process-local limitations are documented before enabling the limits in production.
主要言語
CSS
スター
119
フォーク
2
PR マージ指標
30日以内にマージされた PR はありません

環境構築

このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

Adamant-im/docs のほかの issue

Adamant-im/docs の issue をすべて見る

似ている issue

Documentation の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。