diff options
Diffstat (limited to 'docs/src')
| -rw-r--r-- | docs/src/api/functiondocs.md | 20 |
1 files changed, 16 insertions, 4 deletions
diff --git a/docs/src/api/functiondocs.md b/docs/src/api/functiondocs.md index 4f7e455..8aa2138 100644 --- a/docs/src/api/functiondocs.md +++ b/docs/src/api/functiondocs.md @@ -417,7 +417,8 @@ Signature: ```go func GetConfig(c C.uintptr_t, _type C.int, id *C.char, pTCP C.int, startup C.int) (*C.char, *C.char) ``` -GetConfig gets a configuration for the server +GetConfig gets a configuration for the server. It returns additional +information in case WireGuard over Proxyguard is used (see the last example) `c` is the cookie that is used for cancellation. Create a cookie first with CookieNew, this same cookie is also used for replying to state transitions @@ -526,10 +527,21 @@ Example Input (3=custom server): ```GetConfig(myCookie, 3, Example Output (2=WireGuard): + { + "config": "[Interface]\nPrivateKey = ...\nAddress = ...\nDNS = ...\n\n[Peer]\nPublicKey = ...=\nAllowedIPs = 0.0.0.0/0,::/0\nEndpoint = ...", + "protocol": 2, + "default_gateway": true, + "should_failover": true, <- whether or not the failover procedure should happen + } + +Example Output (3=WireGuard + Proxyguard): + { - "config": "https://demo.eduvpn.nl/\n# Profile: ...\n# Expires: ...\n\n[Interface]\nPrivateKey = ...\nAddress = ...\nDNS = ...\n\n[Peer]\nPublicKey = ...=\nAllowedIPs = 0.0.0.0/0,::/0\nEndpoint = ...", - "protocol": 2, - "default_gateway": true + "config":"[Interface]\nMTU = ...\nAddress = ...\nDNS = ...\nPrivateKey = ...\n[Peer]\nPublicKey = ...\nAllowedIPs = ...\nEndpoint = 127.0.0.1:x\n", + "protocol":3, + "default_gateway":true, + "should_failover":true, + "proxy":{"source_port":38683,"listen":"127.0.0.1:59812","peer":"https://..."} } ## InState |