[Docs] Document node anti-abuse limits and migration
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ả
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.
- 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
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- 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.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Issue khác của Adamant-im/docs
-
APIs documentation Nodes Security
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 78/100
Adamant-im/docs#46 ·
-
documentation Guideline Nodes Security
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 52/100
Adamant-im/docs#41 ·
-
[Chore] Update dependencies to latest ncu versions and clear npm audit findingsCó thể đã có người làm @adamant-al đã nhận 6 ngày trước. Đang mởCI/CD Security Task
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 48/100
Adamant-im/docs#40 ·
Tất cả issue của Adamant-im/docs
Issue tương tự
-
review-followup
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 84/100
griffinwork40/agent-afk#5180 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 1/5 1-3 giờ Mức phù hợp với người mới 76/100
416rehman/Guardrails#1716 ·
-
Ep2: source of metadata?Đang mở
Độ khó 1/5 1-3 giờ Mức phù hợp với người mới 72/100
-
Document the service-mesh L7 authorization boundary: non-enrolled workloads and shared rulesĐang mởarea:kubernetes area:security documentation priority:medium size:small
Độ khó 1/5 1-3 giờ Mức phù hợp với người mới 88/100
RonaldHensbergen/composable-data-stack#1339 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 74/100
Maintainer thường phản hồi trong vòng 1 ngày