diff options
Diffstat (limited to 'index.html')
| -rw-r--r-- | index.html | 84 |
1 files changed, 84 insertions, 0 deletions
diff --git a/index.html b/index.html new file mode 100644 index 0000000..4b8579d --- /dev/null +++ b/index.html @@ -0,0 +1,84 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="UTF-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <link rel="stylesheet" href="css/simple.css"> + <link rel="stylesheet" href="css/screen.css"> + <title>About - Documentation</title> +</head> +<body> + <header> + <h1>Documentation</h1> + + <p>eduVPN for Linux</p> + + + <nav> + + <a href="index.html">About</a> + + <a href="building.html">Building</a> + + <a href="testing.html">Testing</a> + + <a href="building-client.html">Building a client</a> + + <a href="apidocs.html">API Docs</a> + + </nav> + + </header> + <main> + + <aside> + + <ul> + + <li class="nav-item" data-level="2"><a href="#eduvpn-introduction" class="nav-link">EduVPN introduction</a> + <ul class="nav flex-column"> + </ul> + </li> + + <li class="nav-item" data-level="2"><a href="#the-problem" class="nav-link">The problem</a> + <ul class="nav flex-column"> + </ul> + </li> + + <li class="nav-item" data-level="2"><a href="#license" class="nav-link">License</a> + <ul class="nav flex-column"> + </ul> + </li> + + <li class="nav-item" data-level="2"><a href="#authors" class="nav-link">Authors</a> + <ul class="nav flex-column"> + </ul> + </li> + </ul> + </aside> + + <h1 id="about">About<a class="headerlink" href="#about" title="Permanent link">#</a></h1> +<p>This chapter contains background information for the library. We give a general introduction to eduVPN and explain what problems this library aims to solve.</p> +<h2 id="eduvpn-introduction">EduVPN introduction<a class="headerlink" href="#eduvpn-introduction" title="Permanent link">#</a></h2> +<p>eduVPN-common is a library for <a href="https://www.eduvpn.org/">eduVPN</a>, which is a VPN by <a href="https://www.surf.nl">SURF</a> and a project by <a href="https://geant.org/">GÉANT</a>, for research institutes and universities. Each institute 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: +- <a href="https://codeberg.org/eduVPN/android">Android</a> +- <a href="https://github.com/eduvpn/python-eduvpn-client">Linux</a> +- <a href="https://github.com/eduvpn/apple">MacOS/iOS</a> +- <a href="https://codeberg.org/eduVPN/windows">Windows</a></p> +<h2 id="the-problem">The problem<a class="headerlink" href="#the-problem" title="Permanent link">#</a></h2> +<p>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 <a href="https://go.dev/">Go</a> language and aims to have wrapper code for each of the languages that are used by the current clients. </p> +<p>The main goal is thus the following: +<img alt="" src="godifferences.png" /></p> +<p>This library tries to remove non-platform specific common functionality. This way eduVPN clients have less duplicate code. The building blocks that are removed by the library is not just the four depicted in this figure. You can think of other building blocks, such as logging and local configuration file saving. As can be seen in the figure, no User Interface (UI) code will be implemented. This is left to the eduVPN clients, on top of platform-specific code.</p> +<h2 id="license">License<a class="headerlink" href="#license" title="Permanent link">#</a></h2> +<p><a href="https://codeberg.org/eduVPN/eduvpn-common/src/branch/main/LICENSE">MIT</a></p> +<h2 id="authors">Authors<a class="headerlink" href="#authors" title="Permanent link">#</a></h2> +<p>This library is written by <a href="https://github.com/stevenwdv">Steven Wallis de Vries</a> and <a href="https://github.com/jwijenbergh">Jeroen Wijenbergh</a> at the <a href="https://www.surf.nl/">SURF</a> and <a href="https://geant.org/">GÉANT</a> organization.</p> + </main> + + <footer> + <p>Documentation - eduVPN for Linux</p> + </footer> +</body> +</html>
\ No newline at end of file |