diff options
| author | jwijenbergh <jeroenwijenbergh@protonmail.com> | 2024-04-22 16:48:35 +0200 |
|---|---|---|
| committer | jwijenbergh <jeroenwijenbergh@protonmail.com> | 2024-04-22 17:07:04 +0200 |
| commit | d44bfc135cfd4e8cc99696e1383d184ac8c6f90c (patch) | |
| tree | 6ed444c6fb5363e0575c3a066b0584812359dfe7 /docs/src/api/functiondocs.md | |
| parent | 8bc4f9badd3faa44e245fd3fb1e4cebdd215bc9c (diff) | |
Exports: Document ProxyGuard cleanup
Diffstat (limited to 'docs/src/api/functiondocs.md')
| -rw-r--r-- | docs/src/api/functiondocs.md | 11 |
1 files changed, 8 insertions, 3 deletions
diff --git a/docs/src/api/functiondocs.md b/docs/src/api/functiondocs.md index 9061515..42013ce 100644 --- a/docs/src/api/functiondocs.md +++ b/docs/src/api/functiondocs.md @@ -114,7 +114,8 @@ Signature: ```go func Cleanup(c C.uintptr_t) *C.char ``` -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 @@ -831,8 +832,12 @@ Signature: ```go func StartProxyguard(c C.uintptr_t, listen *C.char, tcpsp C.int, peer *C.char, proxySetup C.ProxySetup, proxyReady C.ProxyReady) *C.char ``` -StartProxyguard starts the 'proxyguard' procedure in -eduvpn-common. This proxies WireGuard UDP connections over HTTP: +StartProxyguard starts the 'proxyguard' procedure in eduvpn-common. 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 |