From edfc46d1ecfcbf206c9fdb2e27d324cb9a52df8f Mon Sep 17 00:00:00 2001 From: Jeroen Wijenbergh Date: Mon, 18 Apr 2022 14:28:22 +0200 Subject: Docs: Move to mdbook --- docs/src/about.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 docs/src/about.md (limited to 'docs/src/about.md') diff --git a/docs/src/about.md b/docs/src/about.md new file mode 100644 index 0000000..ac61279 --- /dev/null +++ b/docs/src/about.md @@ -0,0 +1,16 @@ +# About +This chapter contains background information for the library. + +## eduVPN introduction +eduVPN-common is a library for [eduVPN](https://www.eduvpn.org/), which is a VPN by [Surf](https://www.surf.nl) for research institutions such as Universities. Each institution that uses eduVPN has its own server. To discover these servers and establish a VPN connection with them, eduVPN clients are used. eduVPN has clients for each common platform: +- [Android](https://github.com/eduvpn/android) +- [Linux](https://github.com/eduvpn/python-eduvpn-client) +- [MacOS/iOS](https://github.com/eduvpn/apple) +- [Windows](https://github.com/Amebis/eduVPN) + +## The problem +However, as these clients are rather similar in functionality, apart from platform specific differences, right now there is duplicate code between them. For example, the process to discover institution's servers, the authorization process (OAuth) and Wireguard key generation. +This goal of this library is to provide the common functionality between these clients into one codebase. The library is written in the [Go](https://go.dev/) language and has wrapper code for each of the languages that are used by the current clients. + +## Authors +This library is written by [Steven Wallis de Vries](https://github.com/stevenwdv) and [Jeroen Wijenbergh](https://github.com/jwijenbergh), two Radboud University students that worked at Surf for their research internship. -- cgit v1.2.3