[Docs] Document node anti-abuse limits and migration

Aperta
#45 2 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
72/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
javascript
Ambito
documentation

Direzione di ricerca

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.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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.
Lingua principale
CSS
Stelle
119
Fork
2
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di Adamant-im/docs

Tutte le issue di Adamant-im/docs

Issue simili

Altre issue su Documentation

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.