From d44bfc135cfd4e8cc99696e1383d184ac8c6f90c Mon Sep 17 00:00:00 2001 From: jwijenbergh Date: Mon, 22 Apr 2024 16:48:35 +0200 Subject: Exports: Document ProxyGuard cleanup --- exports/exports.go | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) (limited to 'exports') diff --git a/exports/exports.go b/exports/exports.go index a955899..4b48d12 100644 --- a/exports/exports.go +++ b/exports/exports.go @@ -773,7 +773,8 @@ func DiscoOrganizations(c C.uintptr_t) (*C.char, *C.char) { return C.CString(s), getCError(err) } -// Cleanup sends a /disconnect to cleanup the connection +// Cleanup sends a /disconnect to cleanup the connection. +// Additionally, if ProxyGuard is active it cancels the running process // // This MUST be called when disconnecting, see https://docs.eduvpn.org/server/v3/api.html#application-flow // `c` is the Cookie that needs to be passed. Create a new Cookie using `CookieNew` @@ -882,7 +883,10 @@ func StartFailover(c C.uintptr_t, gateway *C.char, mtu C.int, readRxBytes C.Read } // StartProxyguard starts the 'proxyguard' procedure in eduvpn-common. -// This proxies WireGuard UDP connections over HTTP: https://codeberg.org/eduvpn/proxyguard. +// Note that you should cancel/delete the cookie for this function when ProxyGuard is no longer needed! +// eduvpn-common currently also cleans up the running ProxyGuard process in `cleanup`. +// +// This function proxies WireGuard UDP connections over HTTP: https://codeberg.org/eduvpn/proxyguard. // These input variables can be gotten from the configuration that is retrieved using the `proxy` JSON key // // - `c` is the cookie -- cgit v1.2.3