Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README: Clarify that the host HTTP API is not always there #346

Merged
merged 1 commit into from
May 16, 2024
Merged

README: Clarify that the host HTTP API is not always there #346

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,9 +112,12 @@ With the executable:

### API

The executable running on the host, `gvproxy`, exposes a HTTP API. It can be used with curl.
When `gvproxy` is started with the `--listen` option, it exposes a HTTP API on the host.
This API can be used with curl.

```
$ gvproxy --listen unix:///tmp/network.sock .... &

$ curl --unix-socket /tmp/network.sock http:/unix/stats
{
"BytesSent": 0,
Expand All @@ -140,7 +143,8 @@ nameserver 192.168.127.1

### Port forwarding

Dynamic port forwarding is supported.
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.

Expose a port:
```
Expand Down
Loading