diff options
| author | jwijenbergh <jeroenwijenbergh@protonmail.com> | 2022-05-05 17:47:36 +0200 |
|---|---|---|
| committer | jwijenbergh <jeroenwijenbergh@protonmail.com> | 2022-05-05 17:47:36 +0200 |
| commit | 7bb7885f6eb19547b906513d2664e3730ef5b593 (patch) | |
| tree | ce387ad24da5e3ba3b4d1604d07a5b11d9e68a2e /docs/src/api/overview/flow.md | |
| parent | 657776055cd07c1f9279e982fbfef88dca1ca71b (diff) | |
Docs: Add API and building improvements
Diffstat (limited to 'docs/src/api/overview/flow.md')
| -rw-r--r-- | docs/src/api/overview/flow.md | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/docs/src/api/overview/flow.md b/docs/src/api/overview/flow.md new file mode 100644 index 0000000..14b5a72 --- /dev/null +++ b/docs/src/api/overview/flow.md @@ -0,0 +1,8 @@ +# Typical flow +A typical flow of creating a client is calling the methods that we talked about in order that we introduced them: + +- The client starts, it registers with the library +- A list of discovery servers/organizations is obtained using the library +- The client selects an URL to connect to and calls the function to get an OpenVPN/Wireguard config from the library +- The client uses the OS specific libraries and programs to use the OpenVPN/Wireguard config to establish a tunnel and calls the function to connect or disconnect +- When the client is done it calls the deregister method to save all configuration and clean up |