From 8056d41c5d6d3594e0e6602f7be7d7dcec0e0f97 Mon Sep 17 00:00:00 2001 From: FUJITA Tomonori Date: Mon, 31 Aug 2026 21:30:38 +0900 Subject: [PATCH] docs: document the listen address of the gRPC API The --api-hosts option was not documented anywhere. The default is :50051, that is, all interfaces with no authentication, and a client that can call the API can add peers, add and delete routes, and stop the daemon. Say so, and say how to restrict access. Assisted-by: Claude Opus 5 Signed-off-by: FUJITA Tomonori --- docs/sources/getting-started.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/sources/getting-started.md b/docs/sources/getting-started.md index 46e53f41c..50fa5b4a1 100644 --- a/docs/sources/getting-started.md +++ b/docs/sources/getting-started.md @@ -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