package/gvisor-tap-vsock
1
0
Fork 0
mirror of https://github.com/containers/gvisor-tap-vsock.git synced 2025-09-26 21:01:42 +08:00
Code Issues Packages Projects Releases Wiki Activity

doc: update doc with new services option

Browse Source 
Signed-off-by: Luca Stocchi <lstocchi@redhat.com>
This commit is contained in:
Luca Stocchi
2025-01-21 17:37:17 +01:00
parent d1a7ed9c3d
commit ab9bbf4bb1
1 changed files with 4 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@@ -112,7 +112,7 @@ With the executable:
### API ### 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. 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 ### Gateway
The executable running on the host runs a virtual gateway that can be used by the VM. 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 ### Port forwarding
Dynamic port forwarding is supported over the host HTTP API when `gvproxy` was 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: Expose a port:
``` ```