Relays: explain main use cases and per-protocol limits
还没有人认领这个 Issue。
评估
- 难度
- 2/5
- 预计耗时
- 1-3 小时
- 新手友好度
- 55/100
- Issue 类型
- 文档
- 描述清晰度
- 描述清楚
- 活跃度
- 停滞
调研方向
从 docs.libp2p.io/concepts/nat/circuit-relay/ 中引用的 circuit-relay 页面开始。更新该页面，说明默认的时间和字节限制、允许的协议、自定义 relay 规则，以及不受限制的 relay 带来的安全和成本风险。完成的标准是该页面清楚涵盖每个列出的用例和警告。
由索引模型根据 Issue 内容生成。
描述
Ref. https://docs.libp2p.io/concepts/nat/circuit-relay/
The page should mention that
- relays are limited by default (time/bytes)
- relays only allow specific libp2p protocols to be relays (e.g. ping, identify, hole punching ones)
- relays do not allow protocols like bitswap by default
- one can run own relay with different rules
- lift bandwidth / time limits for specific IPs
- allow extra protocols
- NOTE: there should be warning this is a potential cost center and implementers should be very careful / have logic ensuring only their "blessed" clients use their "unlimited" relays
- 主要语言
- HTML
- 星标
- 72
- 派生
- 97
- PR 合并指标
- 30 天内没有已合并 PR
环境准备
这个项目没有提供开发容器、Dockerfile 或贡献指南，环境需要你自己搭建：先看它的 README，通用步骤见我们的新手贡献指南。
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
libp2p/docs 的其他 Issue
-
Broken Link未关闭
难度 1/5 1 小时以内 新手友好度 68/100
-
难度 1/5 1 小时以内 新手友好度 65/100
-
难度 2/5 1-3 小时 新手友好度 55/100
-
难度 5/5 一周以上 新手友好度 25/100
-
难度 3/5 1-2 天 新手友好度 45/100
相似的 Issue
-
documentation
难度 1/5 1-3 小时 新手友好度 88/100
维护者通常 1 天内回复
-
sync-en
难度 2/5 1-3 小时 新手友好度 78/100
维护者通常 2 天内回复
-
bug docs
难度 2/5 1-3 小时 新手友好度 88/100
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 78/100
维护者通常 1 天内回复
-
bug
难度 2/5 1-3 小时 新手友好度 68/100
维护者通常 1 天内回复