diff options
| author | Christian Breunig <christian@breunig.cc> | 2023-11-21 08:22:37 +0100 |
|---|---|---|
| committer | Christian Breunig <christian@breunig.cc> | 2023-11-21 08:23:54 +0100 |
| commit | 2c61e8fa889b695121773ff60a06bd485f411d52 (patch) | |
| tree | f01b970d2f0c03afc1f7335491ae66c9847adf3f | |
| parent | 2e905f826ef778dac256dab6f7c56a2ff757e12b (diff) | |
| download | vyos-documentation-2c61e8fa889b695121773ff60a06bd485f411d52.tar.gz vyos-documentation-2c61e8fa889b695121773ff60a06bd485f411d52.zip | |
http: T5762: api: make API socket backend communication the one and only default
Why: Smoketests fail as they can not establish IPv6 connection to uvicorn
backend server.
https://github.com/vyos/vyos-1x/pull/2481 added a bunch of new smoketests.
While debugging those failing, it was uncovered, that uvicorn only listens on
IPv4 connections
vyos@vyos# netstat -tulnp | grep 8080
(Not all processes could be identified, non-owned process info
will not be shown, you would have to be root to see it all.)
tcp 0 0 127.0.0.1:8080 0.0.0.0:* LISTEN -
As the CLI already has an option to move the API communication from an IP to a
UNIX domain socket, the best idea is to make this the default way of
communication, as we never directly talk to the API server but rather use the
NGINX reverse proxy.
(cherry picked from commit 12ffd3e638dc00ae672b47c9dd2a64e0e68d0c01)
| -rw-r--r-- | docs/configuration/service/https.rst | 13 |
1 files changed, 2 insertions, 11 deletions
diff --git a/docs/configuration/service/https.rst b/docs/configuration/service/https.rst index 08b16575..b767cb77 100644 --- a/docs/configuration/service/https.rst +++ b/docs/configuration/service/https.rst @@ -20,23 +20,14 @@ Configuration .. cfgcmd:: set service https api debug - To enable debug messages. Available via :opcmd:`show log` or + To enable debug messages. Available via :opcmd:`show log` or :opcmd:`monitor log` -.. cfgcmd:: set service https api port - - Set the listen port of the local API, this has no effect on the - webserver. The default is port 8080 - -.. cfgcmd:: set service https api socket - - Use local socket for API - .. cfgcmd:: set service https api strict Enforce strict path checking -.. cfgcmd:: set service https virtual-host <vhost> listen-address +.. cfgcmd:: set service https virtual-host <vhost> listen-address <ipv4 or ipv6 address> Address to listen for HTTPS requests |