lnd/docs
Olaoluwa Osuntokun ed717a120a
docs: add comprehensive gossip rate limiting guide
In this commit, we add detailed documentation to help node operators
understand and configure the gossip rate limiting system effectively.
The new guide addresses a critical knowledge gap that has led to
misconfigured nodes experiencing synchronization failures.

The documentation covers the token bucket algorithm used for rate
limiting, providing clear formulas and examples for calculating
appropriate values based on node size and network position. We include
specific recommendations ranging from 50 KB/s for small nodes to
1 MB/s for large routing nodes, with detailed calculations showing
how these values are derived.

The guide explains the relationship between rate limiting and other
configuration options like num-restricted-slots and the new
filter-concurrency setting. We provide troubleshooting steps for
common issues like slow initial sync and peer disconnections, along
with debug commands and log patterns to identify problems.

Configuration examples are provided for conservative, balanced, and
performance-oriented setups, giving operators concrete starting points
they can adapt to their specific needs. The documentation emphasizes
the importance of not setting rate limits too low, warning that values
below 50 KB/s can cause synchronization to fail entirely.
2025-08-01 11:20:21 -05:00
..
alloy-models docs/alloy-model: add linear fee function model 2024-08-01 17:42:31 -07:00
grpc Update ruby.md 2024-12-06 13:48:22 +01:00
release-notes Merge pull request #9625 from MPins/issue-8161 2025-07-30 09:14:06 -06:00
rest multi: Fix typos and grammar in multiple docs 2024-07-22 20:08:12 -07:00
code_contribution_guidelines.md docs: add development_guidelines.md 2025-04-14 17:08:56 +08:00
configuring_tor.md multi: Fix typos and grammar in multiple docs 2024-07-22 20:08:12 -07:00
debugging_lnd.md chore: fix some typos 2025-01-03 21:48:29 +08:00
development_guidelines.md docs: document previously implicit formatting rule 2025-05-12 07:00:51 +02:00
DOCKER.md multi: Fix typos and grammar in multiple docs 2024-07-22 20:08:12 -07:00
etcd.md multi: Fix typos and grammar in multiple docs 2024-07-22 20:08:12 -07:00
fuzz.md multi: Fix typos and grammar in multiple docs 2024-07-22 20:08:12 -07:00
gossip_rate_limiting.md docs: add comprehensive gossip rate limiting guide 2025-08-01 11:20:21 -05:00
INSTALL.md multi: update Go to 1.23.10 2025-07-16 01:19:58 -03:00
key_import.md multi: Fix typos and grammar in multiple docs 2024-07-22 20:08:12 -07:00
leader_election.md docs: fix leader node readiness probe example [skip ci] 2024-07-29 21:31:24 +02:00
macaroons.md docs: document deterministic macaroons, add release notes 2024-10-15 09:48:47 +02:00
MAKEFILE.md multi: Fix typos and grammar in multiple docs 2024-07-22 20:08:12 -07:00
musig2.md Update link in musig2.md 2024-10-02 10:17:16 -07:00
nat_traversal.md scripted-diff: replace ⛰ emoji with $ [skip ci] 2022-10-28 12:06:49 -04:00
postgres.md multi: Fix typos and grammar in multiple docs 2024-07-22 20:08:12 -07:00
psbt.md multi: Fix typos and grammar in multiple docs 2024-07-22 20:08:12 -07:00
recovery.md docs/recovery: add Last resort manual force close 2024-10-14 09:44:32 -03:00
release.md multi: Fix typos and grammar in multiple docs 2024-07-22 20:08:12 -07:00
remote-signing.md multi: Fix typos and grammar in multiple docs 2024-07-22 20:08:12 -07:00
review.md docs: add development_guidelines.md 2025-04-14 17:08:56 +08:00
ruby-thing.rb docs: update contribution guidelines to add section on commit structure 2018-12-18 20:59:46 -08:00
safety.md Merge pull request #8881 from mwaite-codes/fix-doc-grammar 2024-07-23 00:25:17 -06:00
signing_release_candidate.md chore: fix some typos 2025-01-03 21:48:29 +08:00
SphinxReplayDB.md docs: add sphinx replay description 2025-06-13 15:37:03 +02:00
sqlite.md docs: add sqlite instructions 2023-01-25 14:16:56 +02:00
wallet.md multi: Fix typos and grammar in multiple docs 2024-07-22 20:08:12 -07:00
watchtower.md multi: Fix typos and grammar in multiple docs 2024-07-22 20:08:12 -07:00
zero_conf_channels.md docs: add documentation for zero-conf channels 2022-08-10 14:25:11 -04:00