From 8bd45cb1973a581d3339bb9358f6102d468e07ba Mon Sep 17 00:00:00 2001 From: Luca Stocchi Date: Fri, 22 Nov 2024 10:38:25 +0100 Subject: [PATCH] doc: update doc with new services option Signed-off-by: Luca Stocchi --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b9d39090f..63cd17226 100644 --- a/README.md +++ b/README.md @@ -112,7 +112,7 @@ With the executable: ### API -When `gvproxy` is started with the `--listen` option, it exposes a HTTP API on the host. +When `gvproxy` is started with the `--listen` or `--services` option, it exposes a HTTP API on the host. This API can be used with curl. ``` @@ -127,6 +127,8 @@ $ curl --unix-socket /tmp/network.sock http:/unix/stats ... ``` +N.B: The `--services` option exposes the same HTTP API as the `--listen` option, but without the `/connect` endpoint. This is useful for scenarios where the `gvforwarder`/`vm` tool is not run on the guest but you still want to expose services and stats endpoints. + ### Gateway The executable running on the host runs a virtual gateway that can be used by the VM. @@ -144,7 +146,7 @@ nameserver 192.168.127.1 ### Port forwarding Dynamic port forwarding is supported over the host HTTP API when `gvproxy` was -started with `--listen`, but also in the VM over http://192.168.127.1:80. +started with `--listen` or `--services`, but also in the VM over http://192.168.127.1:80. Expose a port: ```