Skip to content

Commit

Permalink
docs: fix bbr notes (#4002)
Browse files Browse the repository at this point in the history
## Overview

adds to the release notes to make sure folks know how to enable bbr
  • Loading branch information
evan-forbes authored Oct 24, 2024
1 parent 312def6 commit fae229c
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ system's kernel. The result should contain `bbr`:
sysctl net.ipv4.tcp_congestion_control
```

If not, enable it on Linux by calling the `make use-bbr` or by running:
If not, enable it on Linux by calling the `make enable-bbr` or by running:

```sh
sudo modprobe tcp_bbr
Expand Down
1 change: 1 addition & 0 deletions docs/release-notes/release-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ This guide provides notes for major version releases. These notes may be helpful
### Node Operators (v3.0.0)

- Consensus node operators must enable the BBR (Bottleneck Bandwidth and Round-trip propagation time) congestion control algorithm. See [#3774](https://github.com/celestiaorg/celestia-app/pull/3774).
- if using linux in docker, kubernetes, a vm or baremetal, this can be done by calling the `make enable-bbr` command on the host machine.
- Consensus node operators should manually configure their node's mempool `ttl-num-blocks = 12` in config.toml. An example command to do this:

```bash
Expand Down

0 comments on commit fae229c

Please sign in to comment.