[Docs] Document node anti-abuse limits and migration
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
Summary
Document the operator-facing anti-abuse configuration implemented for Adamant-im/adamant#292.
Scope
- Explain the preferred
limitfield and the legacymaxcompatibility behavior. - Document aggregate surface limits and per-route REST/peer limits.
- Explain migration for copied configs that still contain
max: 0orlimit: 0. - Add reverse-proxy guidance for
trustProxy, including the single immediate proxy boundary and rightmostX-Forwarded-Forvalue. - 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
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di Adamant-im/docs
-
APIs documentation Nodes Security
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
Adamant-im/docs#46 ·
-
documentation Guideline Nodes Security
Difficoltà 4/5 3-5 giorni Idoneità per principianti 52/100
Adamant-im/docs#41 ·
-
[Chore] Update dependencies to latest ncu versions and clear npm audit findingsForse già presa @adamant-al l’ha presa 6 giorni fa. ApertaCI/CD Security Task
Difficoltà 4/5 3-5 giorni Idoneità per principianti 48/100
Adamant-im/docs#40 ·
Tutte le issue di Adamant-im/docs
Issue simili
-
review-followup
Difficoltà 2/5 1-3 ore Idoneità per principianti 84/100
griffinwork40/agent-afk#5180 ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 1/5 1-3 ore Idoneità per principianti 76/100
416rehman/Guardrails#1716 ·
-
Ep2: source of metadata?Aperta
Difficoltà 1/5 1-3 ore Idoneità per principianti 72/100
-
area:kubernetes area:security documentation priority:medium size:small
Difficoltà 1/5 1-3 ore Idoneità per principianti 88/100
RonaldHensbergen/composable-data-stack#1339 ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 74/100
I maintainer di solito rispondono entro 1 giorno