Skip to content

Commit

Permalink
doc: update doc with new services option
Browse files Browse the repository at this point in the history
Signed-off-by: Luca Stocchi <[email protected]>
  • Loading branch information
lstocchi committed Nov 29, 2024
1 parent b39fa09 commit 8bd45cb
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

```
Expand All @@ -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.
Expand All @@ -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:
```
Expand Down

0 comments on commit 8bd45cb

Please sign in to comment.