[Docs] Document node anti-abuse limits and migration

Đang mở
#45 2 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
3/5
Thời gian dự kiến
1-2 ngày
Mức phù hợp với người mới
72/100
Loại issue
Tài liệu
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
javascript
Lĩnh vực
documentation

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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.
Ngôn ngữ chính
CSS
Star
119
Fork
2
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

Chuẩn bị môi trường

Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của Adamant-im/docs

Tất cả issue của Adamant-im/docs

Issue tương tự

Thêm issue về Documentation

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.