~fkooman/vpn-documentation

ref: b609977fb14b1f6da23d14a3537b24a1621a7a56 vpn-documentation/OVERVIEW.md -rw-r--r-- 4.8 KiB
b609977fFrançois Kooman additional comments 4 months ago

This document lists all available documentation with a description.

#How To

List of documents in order to configure the VPN server or perform common tasks.

Document Description
DEPLOY_CENTOS Install and Maintain eduVPN/Let's Connect! on CentOS
DEPLOY_DEBIAN Install and Maintain eduVPN/Let's Connect! on Debian
DEPLOY_FEDORA Install and Maintain eduVPN/Let's Connect! on Fedora
LDAP Enable LDAP Authentication
RADIUS Enable RADIUS Authentication
SAML Enable SAML Authentication
2FA Configure 2FA (Two Factor Authentication) (DEPRECATED)
ACL Configure ACL (Access Control Lists) to manage access to VPN profiles
BRANDING Configure Branding/Themes (eduVPN/Let's Connect!)
CUSTOM_BRANDING Apply your own Branding/Themes
GUEST_USAGE Setup and Enable Guest Usage (VPN Federation)
LOCAL_DNS Run Local DNS Resolver on VPN server
ADD_NODE Add a VPN node for handling OpenVPN connections
DNS_FILTERING Block malware/tracking/advertisement domains with Local DNS Resolver
MULTI_PROFILE Configure VPN Profiles on VPN Server
MULTI_NODE Set up a controller with two nodes
ADD_DAEMON_NODE Add additional VPN nodes for handling OpenVPN connections
PUBLIC_ADDR Use Public IP Addresses for VPN Clients
PORT_SHARING Use common ports for your VPN server that enable its use in many restricted networks
USER_DELETE Manually fully Delete a User
CONTRIBUTE_TRANSLATIONS Contribute Translations for the User and Admin portal(s)
BGP Use BGP announcements
PORTAL_ADMIN How to configure admin users for the portal
VPN_DAEMON Use VPN Daemon for OpenVPN Management
SOURCE_ROUTING Setup Source/Policy Routing
RASPBERRY_PI Setup a VPN server on a Raspberry Pi
MONITORING VPN Server Monitoring

#Documentation

Extended documentation about various topics.

Document Description
PROFILE_CONFIG List of all VPN Server Configuration Options
SCALING Performance/Scaling Notes
SECURITY Security Notes
SELINUX SELinux Notes
STATS Statistics Notes
ARCH Description of Service Architecture
CLIENT_COMPAT List of Supported VPN Client
FIREWALL Configure the VPN Firewall

#Development

Documentation specific for developers.

Document Description
API API Documentation for (Native) Application Developers
SERVER_DISCOVERY Obtain a list of VPN server Instances (NEW)
INSTANCE_DISCOVERY Obtain a list of VPN server Instances (CURRENT)
DEVELOPMENT_SETUP Setup a Developer Environment
DEVELOPMENT_PRACTICES Developer Guidelines
ROADMAP Development of Let's Connect! / eduVPN 3.0