[Docs] Document node anti-abuse limits and migration

Abierto
#45 2 comentarios 0 reacciones 0 asignados Ver en GitHub

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

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

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.
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

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de Adamant-im/docs

Todos los issues de Adamant-im/docs

Issues similares

Más issues de Documentation

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.