[Docs] Document node anti-abuse limits and migration
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Aptitud para principiantes
- 72/100
- Tipo de issue
- Documentación
- Claridad
- Bien especificado
- Estado de actividad
- Activo
- Stack tecnológico
- javascript
- Área
- documentation
Línea de trabajo
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.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
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.
- Lenguaje dominante
- CSS
- Estrellas
- 119
- Forks
- 2
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Preparar el entorno
Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de Adamant-im/docs
-
APIs documentation Nodes Security
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
Adamant-im/docs#46 ·
-
documentation Guideline Nodes Security
Dificultad 4/5 3-5 días Aptitud para principiantes 52/100
Adamant-im/docs#41 ·
-
[Chore] Update dependencies to latest ncu versions and clear npm audit findingsPosiblemente ocupada @adamant-al la tomó hace 6 días. AbiertoCI/CD Security Task
Dificultad 4/5 3-5 días Aptitud para principiantes 48/100
Adamant-im/docs#40 ·
Todos los issues de Adamant-im/docs
Issues similares
-
review-followup
Dificultad 2/5 1-3 horas Aptitud para principiantes 84/100
griffinwork40/agent-afk#5180 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 1/5 1-3 horas Aptitud para principiantes 76/100
416rehman/Guardrails#1716 ·
-
Ep2: source of metadata?Abierto
Dificultad 1/5 1-3 horas Aptitud para principiantes 72/100
-
Document the service-mesh L7 authorization boundary: non-enrolled workloads and shared rulesAbiertoarea:kubernetes area:security documentation priority:medium size:small
Dificultad 1/5 1-3 horas Aptitud para principiantes 88/100
RonaldHensbergen/composable-data-stack#1339 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 74/100
Los mantenedores suelen responder en 1 día