Skip to content

docs: document the listen address of the gRPC API #3576

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
fujita merged 1 commit into from
Aug 31, 2026
+7 −0
Merged

docs: document the listen address of the gRPC API #3576

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions docs/sources/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,13 @@ $ sudo -E gobgpd -t yaml -f gobgpd.yml
Sending the `SIGHUP` signal to `gobgpd` triggers a configuration reload.
The `-a` option enables the auto reloading of the configuration whenever a change is detected.

`gobgpd` also listens for the gRPC management API. The default listen address
is `:50051`, that is, all interfaces with no authentication. A client that can
call the API can add peers, add and delete routes, and stop the daemon.
Restricting access to the API is your responsibility. The `--api-hosts` option
changes the listen address. For example, `--api-hosts 127.0.0.1:50051` accepts
local clients only.

Let's show the information of all the peers.

```bash
Expand Down