eduVPN

https://docs.eduvpn.org
Admin
eduVPN is an open-source VPN server software that supports WireGuard and OpenVPN protocols with...
Tokens:97,021
Snippets:1,234
Trust Score:9.6
Update:5 months ago
Show doc for...
Tokens:
Raw
### Install eduVPN on Ubuntu 26.04 (Resolute)

Source: https://docs.eduvpn.org/client/linux/installation.html

Manually install the eduVPN client on Ubuntu 26.04 by adding the repository and installing the package.

```bash
$ sudo apt update
$ sudo apt install apt-transport-https wget
$ wget -O- https://app.eduvpn.org/linux/v4/deb/app+linux@eduvpn.org.asc | gpg --dearmor | sudo tee /usr/share/keyrings/eduvpn-v4.gpg >/dev/null
$ echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/eduvpn-v4.gpg] https://app.eduvpn.org/linux/v4/deb/ resolute main" | sudo tee /etc/apt/sources.list.d/eduvpn-v4.list
$ sudo apt update
$ sudo apt install eduvpn-client

```

--------------------------------

### Install eduVPN on Ubuntu 25.10 (Questing)

Source: https://docs.eduvpn.org/client/linux/installation.html

Manually install the eduVPN client on Ubuntu 25.10 by adding the repository and installing the package.

```bash
$ sudo apt update
$ sudo apt install apt-transport-https wget
$ wget -O- https://app.eduvpn.org/linux/v4/deb/app+linux@eduvpn.org.asc | gpg --dearmor | sudo tee /usr/share/keyrings/eduvpn-v4.gpg >/dev/null
$ echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/eduvpn-v4.gpg] https://app.eduvpn.org/linux/v4/deb/ questing main" | sudo tee /etc/apt/sources.list.d/eduvpn-v4.list
$ sudo apt update
$ sudo apt install eduvpn-client

```

--------------------------------

### Start nftables Service

Source: https://docs.eduvpn.org/server/v3/firewall.html

Use this command to start the nftables service.

```bash
$ sudo systemctl start nftables

```

--------------------------------

### Install eduVPN on Ubuntu 22.04 (Jammy)

Source: https://docs.eduvpn.org/client/linux/installation.html

Manually install the eduVPN client on Ubuntu 22.04 by adding the repository and installing the package.

```bash
$ sudo apt update
$ sudo apt install apt-transport-https wget
$ wget -O- https://app.eduvpn.org/linux/v4/deb/app+linux@eduvpn.org.asc | gpg --dearmor | sudo tee /usr/share/keyrings/eduvpn-v4.gpg >/dev/null
$ echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/eduvpn-v4.gpg] https://app.eduvpn.org/linux/v4/deb/ jammy main" | sudo tee /etc/apt/sources.list.d/eduvpn-v4.list
$ sudo apt update
$ sudo apt install eduvpn-client

```

--------------------------------

### Install EduVPN Client on Linux Mint (Debian-based)

Source: https://docs.eduvpn.org/client/linux/installation.html

Installs the EduVPN client using apt. Ensure you update your package list and add the GPG key before installing.

```bash
$ sudo apt update
$ sudo apt install apt-transport-https wget
$ wget -O- https://app.eduvpn.org/linux/v4/deb/app+linux@eduvpn.org.asc | gpg --dearmor | sudo tee /usr/share/keyrings/eduvpn-v4.gpg >/dev/null
$ echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/eduvpn-v4.gpg] https://app.eduvpn.org/linux/v4/deb/ bookworm main" | sudo tee /etc/apt/sources.list.d/eduvpn-v4.list
$ sudo apt update
$ sudo apt install eduvpn-client

```

```bash
$ sudo apt update
$ sudo apt install apt-transport-https wget
$ wget -O- https://app.eduvpn.org/linux/v4/deb/app+linux@eduvpn.org.asc | gpg --dearmor | sudo tee /usr/share/keyrings/eduvpn-v4.gpg >/dev/null
$ echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/eduvpn-v4.gpg] https://app.eduvpn.org/linux/v4/deb/ trixie main" | sudo tee /etc/apt/sources.list.d/eduvpn-v4.list
$ sudo apt update
$ sudo apt install eduvpn-client

```

```bash
$ sudo apt update
$ sudo apt install apt-transport-https wget
$ wget -O- https://app.eduvpn.org/linux/v4/deb/app+linux@eduvpn.org.asc | gpg --dearmor | sudo tee /usr/share/keyrings/eduvpn-v4.gpg >/dev/null
$ echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/eduvpn-v4.gpg] https://app.eduvpn.org/linux/v4/deb/ jammy main" | sudo tee /etc/apt/sources.list.d/eduvpn-v4.list
$ sudo apt update
$ sudo apt install eduvpn-client

```

```bash
$ sudo apt update
$ sudo apt install apt-transport-https wget
$ wget -O- https://app.eduvpn.org/linux/v4/deb/app+linux@eduvpn.org.asc | gpg --dearmor | sudo tee /usr/share/keyrings/eduvpn-v4.gpg >/dev/null
$ echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/eduvpn-v4.gpg] https://app.eduvpn.org/linux/v4/deb/ noble main" | sudo tee /etc/apt/sources.list.d/eduvpn-v4.list
$ sudo apt update
$ sudo apt install eduvpn-client

```

--------------------------------

### Install eduVPN Client via Pip

Source: https://docs.eduvpn.org/client/linux/installation.html

Installs the eduVPN client package, including GUI support, using Pip. Recommended if Pip installation fails due to environment management issues.

```bash
$ pip install "eduvpn-client[gui]"

```

--------------------------------

### Install eduVPN using a script

Source: https://docs.eduvpn.org/client/linux/installation.html

Use this script for a simplified installation on Debian, Ubuntu, Fedora, and CentOS. Ensure Curl is installed first.

```bash
$ curl --proto '=https' --tlsv1.2 https://docs.eduvpn.org/client/linux/install.sh -O
$ bash ./install.sh

```

--------------------------------

### Install EduVPN Client using Pip

Source: https://docs.eduvpn.org/client/linux/installation.html

Provides instructions for installing the EduVPN client via pip, useful for unsupported distributions.

```bash
pip install eduvpn-client

```

--------------------------------

### Install ProxyGuard Server on Debian/Ubuntu

Source: https://docs.eduvpn.org/server/v3/wireguard.html

Install the `proxyguard-server` package on Debian or Ubuntu systems. The service is automatically started and enabled.

```shell
$ sudo apt -y install proxyguard-server

```

--------------------------------

### Install EduVPN Client on Fedora

Source: https://docs.eduvpn.org/client/linux/installation.html

Installs the EduVPN client on Fedora using dnf. This involves importing the GPG key and setting up the repository.

```bash
$ curl https://app.eduvpn.org/linux/v4/rpm/app+linux@eduvpn.org.asc | sudo tee /etc/pki/rpm-gpg/RPM-GPG-KEY-python-eduvpn-client_v4 > /dev/null
$ cat << 'EOF' | sudo tee /etc/yum.repos.d/python-eduvpn-client_v4.repo
[python-eduvpn-client_v4]
name=eduVPN for Linux 4.x (Fedora $releasever)
baseurl=https://app.eduvpn.org/linux/v4/rpm/fedora-$releasever-$basearch
gpgkey=file:///etc/pki/rpm-gpg/RPM-GPG-KEY-python-eduvpn-client_v4
gpgcheck=1
enabled=1
EOF
$ sudo dnf install eduvpn-client

```

--------------------------------

### Install eduVPN Pre-release on AlmaLinux 9

Source: https://docs.eduvpn.org/client/linux/prerelease.html

Add the GPG key and repository for pre-release RPMs, install epel-release, and then install the eduvpn-client package. This is for AlmaLinux 9.

```bash
$ curl https://app.eduvpn.org/linux/v4-dev/rpm/app+linux+dev@eduvpn.org.asc | sudo tee /etc/pki/rpm-gpg/RPM-GPG-KEY-python-eduvpn-client_v4-dev > /dev/null
$ cat << 'EOF' | sudo tee /etc/yum.repos.d/python-eduvpn-client_v4-dev.repo
[python-eduvpn-client_v4-dev]
name=eduVPN for Linux 4.x Pre-releases (AlmaLinux 9)
baseurl=https://app.eduvpn.org/linux/v4-dev/rpm/alma+epel-9-$basearch
gpgkey=file:///etc/pki/rpm-gpg/RPM-GPG-KEY-python-eduvpn-client_v4-dev
gpgcheck=1
enabled=1
EOF
$ sudo dnf install epel-release
$ sudo dnf install eduvpn-client

```

--------------------------------

### Install Dependencies and Download Deploy Script

Source: https://docs.eduvpn.org/server/v3/deploy-debian.html

Installs necessary packages and downloads the EduVPN deployment script. Ensure you have sudo access and a stable internet connection.

```bash
$ sudo apt -y install ca-certificates wget
$ wget https://codeberg.org/eduVPN/deploy/archive/v3.tar.gz
$ tar -xzf v3.tar.gz
$ cd deploy

```

--------------------------------

### Install eduVPN on Ubuntu 25.04 (Plucky)

Source: https://docs.eduvpn.org/client/linux/installation.html

Manually install the eduVPN client on Ubuntu 25.04 by adding the repository and installing the package.

```bash
$ sudo apt update
$ sudo apt install apt-transport-https wget
$ wget -O- https://app.eduvpn.org/linux/v4/deb/app+linux@eduvpn.org.asc | gpg --dearmor | sudo tee /usr/share/keyrings/eduvpn-v4.gpg >/dev/null
$ echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/eduvpn-v4.gpg] https://app.eduvpn.org/linux/v4/deb/ plucky main" | sudo tee /etc/apt/sources.list.d/eduvpn-v4.list
$ sudo apt update
$ sudo apt install eduvpn-client

```

--------------------------------

### Install eduVPN Pre-release on Fedora

Source: https://docs.eduvpn.org/client/linux/prerelease.html

Add the GPG key and repository for pre-release RPMs, then install the eduvpn-client package. This is for Fedora 42 & 43.

```bash
$ curl https://app.eduvpn.org/linux/v4-dev/rpm/app+linux+dev@eduvpn.org.asc | sudo tee /etc/pki/rpm-gpg/RPM-GPG-KEY-python-eduvpn-client_v4-dev > /dev/null
$ cat << 'EOF' | sudo tee /etc/yum.repos.d/python-eduvpn-client_v4-dev.repo
[python-eduvpn-client_v4-dev]
name=eduVPN for Linux 4.x Pre-releases (Fedora $releasever)
baseurl=https://app.eduvpn.org/linux/v4-dev/rpm/fedora-$releasever-$basearch
gpgkey=file:///etc/pki/rpm-gpg/RPM-GPG-KEY-python-eduvpn-client_v4-dev
gpgcheck=1
enabled=1
EOF
$ sudo dnf install eduvpn-client

```

--------------------------------

### Install eduVPN on Ubuntu 24.04 (Noble)

Source: https://docs.eduvpn.org/client/linux/installation.html

Manually install the eduVPN client on Ubuntu 24.04 by adding the repository and installing the package.

```bash
$ sudo apt update
$ sudo apt install apt-transport-https wget
$ wget -O- https://app.eduvpn.org/linux/v4/deb/app+linux@eduvpn.org.asc | gpg --dearmor | sudo tee /usr/share/keyrings/eduvpn-v4.gpg >/dev/null
$ echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/eduvpn-v4.gpg] https://app.eduvpn.org/linux/v4/deb/ noble main" | sudo tee /etc/apt/sources.list.d/eduvpn-v4.list
$ sudo apt update
$ sudo apt install eduvpn-client

```

--------------------------------

### Install OpenVPN from Backports

Source: https://docs.eduvpn.org/server/v3/openvpn.html

Use this command to install OpenVPN from the trixie-backports repository. Ensure backports are enabled and understand the implications.

```bash
$ sudo apt install openvpn/trixie-backports

```

--------------------------------

### Install eduVPN on Debian 12 (Bookworm)

Source: https://docs.eduvpn.org/client/linux/installation.html

Manually install the eduVPN client on Debian 12 by adding the repository and installing the package.

```bash
$ sudo apt update
$ sudo apt install apt-transport-https wget
$ wget -O- https://app.eduvpn.org/linux/v4/deb/app+linux@eduvpn.org.asc | gpg --dearmor | sudo tee /usr/share/keyrings/eduvpn-v4.gpg >/dev/null
$ echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/eduvpn-v4.gpg] https://app.eduvpn.org/linux/v4/deb/ bookworm main" | sudo tee /etc/apt/sources.list.d/eduvpn-v4.list
$ sudo apt update
$ sudo apt install eduvpn-client

```

--------------------------------

### Install Shibboleth SP and Generate Keys

Source: https://docs.eduvpn.org/server/v3/shibboleth-sp.html

Installs the Shibboleth Apache module and generates necessary encryption and signing keys for the Service Provider.

```bash
$ sudo apt install libapache2-mod-shib
$ sudo shib-keygen -n sp-encrypt
$ sudo shib-keygen -n sp-signing

```

--------------------------------

### Install Tar on Fedora

Source: https://docs.eduvpn.org/server/v3/deploy-fedora.html

Ensure the 'tar' utility is installed, as it might be missing on minimal Fedora installations.

```bash
$ sudo dnf -y install tar

```

--------------------------------

### Install eduVPN Pre-release on Rocky Linux 9

Source: https://docs.eduvpn.org/client/linux/prerelease.html

Add the GPG key and repository for pre-release RPMs, install epel-release, and then install the eduvpn-client package. This is for Rocky Linux 9.

```bash
$ curl https://app.eduvpn.org/linux/v4-dev/rpm/app+linux+dev@eduvpn.org.asc | sudo tee /etc/pki/rpm-gpg/RPM-GPG-KEY-python-eduvpn-client_v4-dev > /dev/null
$ cat << 'EOF' | sudo tee /etc/yum.repos.d/python-eduvpn-client_v4-dev.repo
[python-eduvpn-client_v4-dev]
name=eduVPN for Linux 4.x Pre-releases (Rocky Linux 9)
baseurl=https://app.eduvpn.org/linux/v4-dev/rpm/rocky+epel-9-$basearch
gpgkey=file:///etc/pki/rpm-gpg/RPM-GPG-KEY-python-eduvpn-client_v4-dev
gpgcheck=1
enabled=1
EOF
$ sudo dnf install epel-release
$ sudo dnf install eduvpn-client

```

--------------------------------

### Start Ubuntu Release Upgrade

Source: https://docs.eduvpn.org/server/v3/upgrade-ubuntu-22.04-to-24.04.html

Initiates the Ubuntu release upgrade process. Ensure you have a full backup before proceeding.

```bash
$ sudo do-release-upgrade

```

--------------------------------

### Install eduVPN Portal Artwork on Debian/Ubuntu

Source: https://docs.eduvpn.org/server/v3/branding.html

Use these commands to install the Let's Connect! or eduVPN portal artwork packages on Debian or Ubuntu systems.

```bash
$ sudo apt -y install vpn-portal-artwork-lc
$ sudo apt -y install vpn-portal-artwork-eduvpn
```

--------------------------------

### Install php-saml-sp on Fedora

Source: https://docs.eduvpn.org/server/v3/php-saml-sp.html

Installs the php-saml-sp package and restarts the Apache web server.

```bash
$ sudo dnf -y install php-saml-sp
$ sudo systemctl restart httpd

```

--------------------------------

### Install EduVPN Client on openSUSE

Source: https://docs.eduvpn.org/client/linux/installation.html

Installs the EduVPN client on openSUSE using zypper. For Leap 15.6, a specific repository needs to be added.

```bash
$ sudo zypper install eduvpn-client

```

```bash
$ sudo zypper addrepo https://download.opensuse.org/repositories/network:vpn/openSUSE_Leap_15.6/network:vpn.repo
$ sudo zypper refresh
$ sudo zypper install eduvpn-client

```

--------------------------------

### Install eduVPN on Debian 13 (Trixie)

Source: https://docs.eduvpn.org/client/linux/installation.html

Manually install the eduVPN client on Debian 13 by adding the repository and installing the package.

```bash
$ sudo apt update
$ sudo apt install apt-transport-https wget
$ wget -O- https://app.eduvpn.org/linux/v4/deb/app+linux@eduvpn.org.asc | gpg --dearmor | sudo tee /usr/share/keyrings/eduvpn-v4.gpg >/dev/null
$ echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/eduvpn-v4.gpg] https://app.eduvpn.org/linux/v4/deb/ trixie main" | sudo tee /etc/apt/sources.list.d/eduvpn-v4.list
$ sudo apt update
$ sudo apt install eduvpn-client

```

--------------------------------

### Install Dependencies on Debian/Ubuntu

Source: https://docs.eduvpn.org/client/linux/installation.html

Installs required packages for eduVPN client on Debian or Ubuntu systems using apt.

```bash
$ sudo apt update
$ sudo apt install \
    gir1.2-nm-1.0 \
    gir1.2-secret-1 \
    gir1.2-gtk-3.0 \
    gir1.2-notify-0.7 \
    libcairo2-dev \
    libgirepository1.0-dev \
    python3-dev \
    python3-gi \
    python3-setuptools \
    python3-pytest \
    python3-wheel \
    network-manager-openvpn-gnome

```

--------------------------------

### Install ProxyGuard Server on Fedora/EL

Source: https://docs.eduvpn.org/server/v3/wireguard.html

Install the `proxyguard-server` package and enable its service on Fedora or EL-based systems. Manual configuration may be required.

```shell
$ sudo dnf -y install proxyguard-server
$ sudo systemctl enable --now proxyguard-server

```

--------------------------------

### Enable and Start Keepalived Service

Source: https://docs.eduvpn.org/server/v3/ha-portal.html

Enables Keepalived to start on boot and starts the service immediately on both master and backup nodes.

```bash
$ sudo systemctl enable --now keepalived

```

--------------------------------

### Install eduVPN Portal Artwork on Fedora/Enterprise Linux

Source: https://docs.eduvpn.org/server/v3/branding.html

Use these commands to install the Let's Connect! or eduVPN portal artwork packages on Fedora or Enterprise Linux systems.

```bash
$ sudo dnf -y install vpn-portal-artwork-LC
$ sudo dnf -y install vpn-portal-artwork-eduVPN
```

--------------------------------

### Install Dependencies on Fedora

Source: https://docs.eduvpn.org/client/linux/installation.html

Installs required packages for eduVPN client on Fedora systems using dnf.

```bash
$ sudo dnf install \
    libnotify \
    libsecret \
    gtk3 \
    python3-gobject \
    python3-pytest \
    python3-cairo-devel \
    gobject-introspection-devel \
    cairo-gobject-devel

```

--------------------------------

### Install php-saml-sp on Debian

Source: https://docs.eduvpn.org/server/v3/php-saml-sp.html

Installs the php-saml-sp package, enables its configuration, and restarts the Apache web server.

```bash
$ sudo apt -y install php-saml-sp
$ sudo a2enconf php-saml-sp
$ sudo systemctl restart apache2

```

--------------------------------

### Install Dependencies on openSUSE Tumbleweed

Source: https://docs.eduvpn.org/client/linux/installation.html

Installs required packages for eduVPN client on openSUSE Tumbleweed using zypper.

```bash
$ sudo zypper install \
    libnotify \
    libsecret \
    gtk3 \
    python3-gobject \
    python3-pytest \
    python3-cairo-devel \
    gobject-introspection-devel \
    typelib-1_0-Notify-0_7 \
    typelib-1_0-Secret-1 \
    typelib-1_0-Gtk-3_0

```

--------------------------------

### Install Memcached and PHP Extension

Source: https://docs.eduvpn.org/server/v3/ha-portal.html

Installs memcached and the PHP memcached extension, then restarts the PHP-FPM service. Ensure this is run on all Controller/Portal machines.

```bash
$ sudo apt -y install memcached php-memcached
$ sudo systemctl restart php$(/usr/sbin/phpquery -V)-fpm

```

--------------------------------

### Install ELevate and Leapp Packages

Source: https://docs.eduvpn.org/server/v3/upgrade-enterprise-linux-9-to-10.html

Install the necessary packages for the ELevate upgrade process, including the ELevate repository configuration and the Leapp utility for AlmaLinux.

```bash
$ sudo yum install -y http://repo.almalinux.org/elevate/elevate-release-latest-el$(rpm --eval %rhel).noarch.rpm
$ sudo yum install -y leapp-upgrade leapp-data-almalinux

```

--------------------------------

### Example ProfileList in PHP

Source: https://docs.eduvpn.org/server/v3/profile-config.html

This is an example of how the 'ProfileList' section might look in the PHP configuration file. Modify this section to define your VPN profiles.

```php
'ProfileList' => [
    [
        'profileId' => 'default',
        'displayName' => 'Default',
        ...
        ...
    ],
],
```

--------------------------------

### Install EduVPN Client on Arch Linux (AUR)

Source: https://docs.eduvpn.org/client/linux/installation.html

Installs the EduVPN client from the Arch User Repository (AUR). Requires importing the GPG key and using an AUR helper.

```bash
$ curl https://app.eduvpn.org/linux/v4/deb/app+linux@eduvpn.org.asc | gpg --import -

```

```bash
$ pamac build python-eduvpn-client

```

```bash
$ yay -S python-eduvpn-client

```

--------------------------------

### Example Guest Access Public Key

Source: https://docs.eduvpn.org/server/v3/guest-access.html

An example format of the OAuth public key found in the VPN portal's 'Info' tab, required for server registration.

```text
k7.pub.ozEaVoU0p1HezQ41.HmV1WLVuRDoPiYoa2pP0qxP1YpWdKr5AoMdV_ZWl4i4
```

--------------------------------

### Install EduVPN Client on NixOS

Source: https://docs.eduvpn.org/client/linux/installation.html

Installs the EduVPN client on NixOS using nix-env or nix run. Ensure NetworkManager is enabled and consider adding necessary plugins.

```bash
nix-env -iA nixpkgs.eduvpn-client

```

```bash
nix run nixpkgs#eduvpn-client

```

--------------------------------

### Install OpenVPN and WireGuard Tools on Debian/Ubuntu

Source: https://docs.eduvpn.org/server/v3/client-compat.html

Installs necessary packages for OpenVPN and WireGuard on Debian-based systems. Use 'dnf' instead of 'apt' on Fedora/Enterprise Linux.

```bash
$ sudo apt -y install openvpn wireguard-tools

```

--------------------------------

### Install LDAP Packages and PHP Module

Source: https://docs.eduvpn.org/server/v3/ldap.html

Install the `ldapsearch` command-line tool and the PHP LDAP module. These are required for LDAP integration.

```bash
$ sudo dnf install openldap-clients php-ldap  # Fedora / EL
$ sudo apt install ldap-utils php-ldap        # Debian / Ubuntu

```

--------------------------------

### Update System and Install VPN Packages

Source: https://docs.eduvpn.org/server/v3/upgrade-ubuntu-22.04-to-24.04.html

Update package lists, fix broken dependencies, perform a full system upgrade, and install the VPN user portal.

```bash
$ sudo apt update

```

```bash
$ sudo apt --fix-broken install

```

```bash
$ sudo apt -y dist-upgrade

```

```bash
$ sudo apt -y install vpn-user-portal

```

```bash
$ sudo a2enconf vpn-user-portal

```

```bash
$ sudo a2enconf php8.3-fpm

```

```bash
$ sudo systemctl restart php8.3-fpm

```

```bash
$ sudo systemctl restart apache2

```

--------------------------------

### Install eduVPN Pre-release on CentOS Stream 9

Source: https://docs.eduvpn.org/client/linux/prerelease.html

Add the GPG key and repository for pre-release RPMs, then install the eduvpn-client package. This is for CentOS Stream 9.

```bash
$ curl https://app.eduvpn.org/linux/v4-dev/rpm/app+linux+dev@eduvpn.org.asc | sudo tee /etc/pki/rpm-gpg/RPM-GPG-KEY-python-eduvpn-client_v4-dev > /dev/null
$ cat << 'EOF' | sudo tee /etc/yum.repos.d/python-eduvpn-client_v4-dev.repo
[python-eduvpn-client_v4-dev]
name=eduVPN for Linux 4.x Pre-releases (CentOS Stream 9)
baseurl=https://app.eduvpn.org/linux/v4-dev/rpm/centos-stream+epel-next-9-$basearch
gpgkey=file:///etc/pki/rpm-gpg/RPM-GPG-KEY-python-eduvpn-client_v4-dev
gpgcheck=1
enabled=1
EOF
$ sudo dnf install eduvpn-client

```

--------------------------------

### Enable and Start OpenVPN 'Always On' VPN on Linux

Source: https://docs.eduvpn.org/server/v3/client-compat.html

Enables and starts an OpenVPN client connection named 'uni' using systemd. The configuration file should be placed at /etc/openvpn/client/uni.conf.

```bash
$ sudo systemctl enable --now openvpn-client@uni

```

--------------------------------

### Example Default VPN Profile in JSON

Source: https://docs.eduvpn.org/server/v3/profile-config.html

An example of a default VPN profile configuration in JSON format. This replaces the configuration previously set in PHP. Ensure correct JSON syntax.

```json
{
    "displayName": "Default",
    "dnsServerList": [
        "9.9.9.9",
        "2620:fe::fe"
    ],
    "hostName": "vpn.example",
    "oRangeFour": "10.42.42.0/24",
    "oRangeSix": "fd42::/64",
    "profileId": "default",
    "wRangeFour": "10.43.43.0/24",
    "wRangeSix": "fd43::/64"
}
```

--------------------------------

### Install Linux Kernel from Backports

Source: https://docs.eduvpn.org/server/v3/openvpn.html

Install the Linux kernel from trixie-backports to enable DCO support. A reboot is required after installation.

```bash
$ sudo apt install linux-image-amd64/trixie-backports

```

--------------------------------

### Example OAuth Client Registrations

Source: https://docs.eduvpn.org/server/v3/api-client-registration.html

This JSON structure represents the full contents of the `/etc/vpn-user-portal/oauth_client_db.json` file, listing example OAuth client registrations for govVPN applications across different platforms.

```json
[
    {
        "client_id": "org.govvpn.app.windows",
        "client_name": "govVPN for Windows",
        "redirect_uris": [
            "http://127.0.0.1:{PORT}/callback",
            "http://[::1]:{PORT}/callback"
        ],
        "scope": "config"
    },
    {
        "client_id": "org.govvpn.app.android",
        "client_name": "govVPN for Android",
        "redirect_uris": [
            "org.govvpn.app:/api/callback",
            "org.govvpn.app.android:/api/callback"
        ],
        "scope": "config"
    },
    {
        "client_id": "org.govvpn.app.ios",
        "client_name": "govVPN for iOS",
        "redirect_uris": [
            "org.govvpn.app.ios:/api/callback"
        ],
        "scope": "config"
    },
    {
        "client_id": "org.govvpn.app.macos",
        "client_name": "govVPN for macOS",
        "redirect_uris": [
            "http://127.0.0.1:{PORT}/callback",
            "http://[::1]:{PORT}/callback"
        ],
        "scope": "config"
    },
    {
        "client_id": "org.govvpn.app.linux",
        "client_name": "govVPN for Linux",
        "redirect_uris": [
            "http://127.0.0.1:{PORT}/callback",
            "http://[::1]:{PORT}/callback"
        ],
        "scope": "config"
    }
]
```

--------------------------------

### Launch eduVPN GUI

Source: https://docs.eduvpn.org/client/linux/usage.html

Run the eduVPN graphical user interface. This is typically used after installing via a package manager.

```bash
$ eduvpn-gui

```

--------------------------------

### Start eduVPN CLI Interactive Mode

Source: https://docs.eduvpn.org/client/linux/usage.html

Launch the interactive mode of the eduVPN command-line interface for a more user-friendly experience.

```bash
$ eduvpn-cli interactive

```

--------------------------------

### Deploy VPN Server with Development Repository

Source: https://docs.eduvpn.org/server/v3/raspberry-pi.html

Execute the deployment script for the VPN server. Use `USE_DEV_REPO=y` to enable the development repository.

```bash
# USE_DEV_REPO=y ./deploy_fedora.sh

```

--------------------------------

### Configure Debian/Ubuntu Repository

Source: https://docs.eduvpn.org/server/v3/repo.html

Sets up the eduVPN v3 repository in APT sources. This configuration dynamically determines the distribution suite and architecture.

```bash
$ cat << EOF | sudo tee /etc/apt/sources.list.d/eduVPN_v3.sources >/dev/null
Types: deb
URIs: https://repo.eduvpn.org/v3/deb
Suites: $(lsb_release -cs)
Components: main
Signed-By: /etc/apt/keyrings/repo+v3@eduvpn.org.gpg
Architectures: $(dpkg --print-architecture)
EOF

```

--------------------------------

### Install Keepalived

Source: https://docs.eduvpn.org/server/v3/ha-portal.html

Installs the Keepalived package on Debian/Ubuntu-based systems.

```bash
$ sudo apt install keepalived

```

--------------------------------

### Install mod_auth_mellon on Debian/Ubuntu

Source: https://docs.eduvpn.org/server/v3/mod-auth-mellon.html

Installs the libapache2-mod-auth-mellon package using apt.

```bash
$ sudo apt -y install libapache2-mod-auth-mellon

```

--------------------------------

### Install mod_auth_mellon on Fedora/Enterprise Linux

Source: https://docs.eduvpn.org/server/v3/mod-auth-mellon.html

Installs the mod_auth_mellon package using dnf.

```bash
$ sudo dnf -y install mod_auth_mellon

```

--------------------------------

### EduVPN 3.x Profile Configuration Example

Source: https://docs.eduvpn.org/server/v3/from-2-to-3.html

Shows the updated profile configuration structure in EduVPN 3.x, with 'ProfileList' as the main key and 'profileId' as an element within the profile.

```php
'ProfileList' => [
    [
        'profileId' => 'foo',
        'displayName' => 'Foo Profile',
        ...
        ...
    ],
],
```

--------------------------------

### Create SSL Directory Structure

Source: https://docs.eduvpn.org/server/v3/multi-node.html

Prepare the necessary directories on the node(s) to store SSL certificates and keys for the VPN daemon.

```bash
sudo mkdir -p /etc/ssl/vpn-daemon/private
sudo mkdir -p /etc/systemd/system/vpn-daemon.service.d

```

--------------------------------

### Install Unbound on Debian/Ubuntu

Source: https://docs.eduvpn.org/server/v3/local-dns.html

Installs the Unbound DNS resolver package on Debian or Ubuntu systems.

```bash
$ sudo apt -y install unbound

```

--------------------------------

### Install mod_auth_openidc on Debian/Ubuntu

Source: https://docs.eduvpn.org/server/v3/mod-auth-openidc.html

Installs the libapache2-mod-auth-openidc package and restarts the apache2 service on Debian/Ubuntu based systems.

```bash
$ sudo apt install libapache2-mod-auth-openidc
$ sudo systemctl restart apache2

```

--------------------------------

### Initialize CA and Create Signing Certificate

Source: https://docs.eduvpn.org/server/v3/managed-devices.html

Use the vpn-ca tool to initialize a custom Certificate Authority and then create a client certificate and key for signing configuration profiles. Ensure the CA is trusted on target devices for seamless installation.

```bash
$ vpn-ca \
    -init-ca \
    -name "Apple Configuration Profile CA" \
    -domain-constraint vpn.example.org
```

```bash
$ vpn-ca \
    -client \
    -name "Apple Configuration Profile Signer" \
    -out-crt signer.crt \
    -out-key signer.key
```

--------------------------------

### Install mod_auth_openidc on EL/Fedora

Source: https://docs.eduvpn.org/server/v3/mod-auth-openidc.html

Installs the mod_auth_openidc package and restarts the httpd service on EL/Fedora based systems.

```bash
$ sudo dnf install mod_auth_openidc
$ sudo systemctl restart httpd

```

--------------------------------

### Create Server Backup

Source: https://docs.eduvpn.org/server/v3/server-backup.html

Run this command as root to create a compressed archive of the VPN server configuration and data. The `--selinux` flag is required on Fedora/EL systems and can be omitted on Debian/Ubuntu.

```bash
# tar --selinux -cpJf "/tmp/backup-$(date +%Y%m%d%H%M%S).tar.xz" \
    /etc/vpn-user-portal \
    /etc/vpn-server-node \
    /var/lib/vpn-user-portal

```

--------------------------------

### Install Unbound on Fedora/EL

Source: https://docs.eduvpn.org/server/v3/local-dns.html

Installs the Unbound DNS resolver package on Fedora or Enterprise Linux systems.

```bash
$ sudo dnf -y install unbound

```

--------------------------------

### Add Debian/Ubuntu Repository Key

Source: https://docs.eduvpn.org/server/v3/repo.html

Installs the eduVPN v3 repository GPG key to the system's apt keyrings. This command should be run before configuring the repository source.

```bash
$ sudo mkdir -p /etc/apt/keyrings
$ curl -s https://repo.eduvpn.org/v3/deb/repo+v3@eduvpn.org.gpg | sudo tee /etc/apt/keyrings/repo+v3@eduvpn.org.gpg >/dev/null

```

--------------------------------

### Install and Enable systemd-networkd on Debian/Ubuntu

Source: https://docs.eduvpn.org/server/v3/systemd-networkd.html

Installs and enables the systemd-networkd service on Debian-based systems. Ensure this service is running before proceeding with configuration.

```bash
$ sudo apt -y install systemd-networkd
$ sudo systemctl enable --now systemd-networkd

```

--------------------------------

### EduVPN 2.x Profile Configuration Example

Source: https://docs.eduvpn.org/server/v3/from-2-to-3.html

Illustrates the structure of profile configuration in EduVPN 2.x, where 'vpnProfiles' is the main key and 'profileId' is an array key.

```php
'vpnProfiles' => [
    'foo' => [
        'profileNumber' => 1,
        'displayName' => 'Foo Profile',
        ...
        ...
    ],
],
```

--------------------------------

### Get Info

Source: https://docs.eduvpn.org/server/v3/api.html

This call will show the available VPN profiles for this instance, allowing the application to display them to the user. This GET call has no parameters.

```APIDOC
## Info

This call will show the available VPN profiles for this instance. This will allow the application to show the user which profiles are available.
This `GET` call has no parameters.

### Request Example
```bash
$ curl \
    -H "Authorization: Bearer abcdefgh" \
    https://vpn.example.org/vpn-user-portal/api/v3/info

```

### Response
#### Success Response (200)
- **data** (object) - Contains a list of available VPN profiles.
  - **uuid** (string) - The unique identifier for the profile.
  - **name** (string) - The display name of the profile.
  - **description** (string) - A description of the profile.
  - **type** (string) - The type of the profile (e.g., "openvpn", "wireguard").
  - **server_list** (array) - A list of servers offering this profile.
    - **hostname** (string) - The hostname of the server.
    - **ip_address** (string) - The IP address of the server.
    - **port** (integer) - The port number of the server.
    - **region** (string) - The region where the server is located.
    - **country** (string) - The country where the server is located.
    - **city** (string) - The city where the server is located.

### Response Example
```json
{
  "data": {
    "profiles": [
      {
        "uuid": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
        "name": "Free VPN - New York",
        "description": "Connect to our fast VPN server in New York.",
        "type": "openvpn",
        "server_list": [
          {
            "hostname": "ny.vpn.example.org",
            "ip_address": "192.0.2.1",
            "port": 1194,
            "region": "us-east",
            "country": "USA",
            "city": "New York"
          }
        ]
      }
    ]
  }
}
```
```

--------------------------------

### Initialize and Generate Client Certificates

Source: https://docs.eduvpn.org/server/v3/client-cert-auth.html

Use the vpn-ca tool to initialize a Certificate Authority and generate client certificates for testing purposes. This creates certificates for users 'foo' and 'bar'.

```bash
$ mkdir CA
$ cd CA
$ vpn-ca -init-ca -name "My Test CA"
$ vpn-ca -client -name "foo"
$ vpn-ca -client -name "bar"
```

--------------------------------

### Show eduVPN CLI Help

Source: https://docs.eduvpn.org/client/linux/usage.html

Display available subcommands for the eduVPN command-line interface. Useful for discovering functionality.

```bash
$ eduvpn-cli --help

```

--------------------------------

### Install PHP GeoIP Module (Fedora/EL)

Source: https://docs.eduvpn.org/server/v3/geo-ip.html

Installs the necessary PHP module for GeoIP lookups and restarts the PHP-FPM service on Fedora/EL-based systems.

```bash
$ sudo dnf -y install php-maxminddb
$ sudo systemctl restart php-fpm

```

--------------------------------

### Install PHP GeoIP Module (Debian/Ubuntu)

Source: https://docs.eduvpn.org/server/v3/geo-ip.html

Installs the necessary PHP module for GeoIP lookups and restarts the PHP-FPM service on Debian-based systems.

```bash
$ sudo apt -y install php-maxminddb
$ sudo systemctl restart php$(/usr/sbin/phpquery -V)-fpm

```

--------------------------------

### Get VPN Server Info

Source: https://docs.eduvpn.org/server/v3/api.html

Request all available VPN profiles from the server. This GET call requires an Authorization header with a Bearer token.

```bash
$ curl \
    -H "Authorization: Bearer abcdefgh" \
    https://vpn.example.org/vpn-user-portal/api/v3/info

```

--------------------------------

### Example 404 Error Response

Source: https://docs.eduvpn.org/server/v3/api.html

This is an example of a 404 Not Found error response from the API, indicating a resource was not found or the user lacks permissions.

```http
HTTP/1.1 404 Not Found
Content-Type: application/json

{"error":"no such \"profile_id\""}

```

--------------------------------

### VPN Protocol Transport List Example

Source: https://docs.eduvpn.org/server/v3/api.html

Example JSON snippet showing the 'vpn_proto_transport_list' field, which specifies supported VPN protocols and their transports.

```json
{
    "vpn_proto_transport_list": [
        "openvpn+udp",
        "openvpn+tcp",
        "wireguard+udp"
    ]
}


```

--------------------------------

### Bad Request Error Response Example

Source: https://docs.eduvpn.org/server/v3/api-v4.html

Example JSON response for a 400 Bad Request error, specifically for an invalid or non-existent profile_id.

```json
{"error":"no such \"profile_id\""}
```

--------------------------------

### Reinstall and Enable VPN User Portal

Source: https://docs.eduvpn.org/server/v3/upgrade-debian-11-to-12.html

After `apt full-upgrade` might remove `vpn-user-portal`, reinstall it and re-enable its configuration.

```bash
$ sudo apt install vpn-user-portal
$ sudo a2enconf vpn-user-portal

```

--------------------------------

### Perform System Upgrade and Enable PHP

Source: https://docs.eduvpn.org/server/v3/upgrade-debian-12-to-13.html

Update package lists, perform a full system upgrade, and enable the new PHP version.

```bash
# perform update/upgrade
$ sudo apt update
$ sudo apt full-upgrade

# enable php-fpm 8.4 (upgrade from 8.2 in Debian 12)
$ sudo a2enconf php8.4-fpm

```

--------------------------------

### Install PostgreSQL PHP Extension

Source: https://docs.eduvpn.org/server/v3/database.html

Install the necessary PHP extension for PostgreSQL on Debian-based systems. This is required for the VPN server to connect to a PostgreSQL database.

```bash
$ sudo dnf install php-pgsql
$ sudo systemctl restart php-fpm


```

--------------------------------

### Deploy VPN Node Software

Source: https://docs.eduvpn.org/server/v3/multi-node.html

Navigate to the unpacked archive directory and execute the `deploy_debian_node.sh` script with root privileges to install the VPN server node software.

```bash
$ cd documentation-3
$ sudo -s
# ./deploy_debian_node.sh

```

--------------------------------

### Install and Enable systemd-networkd on Fedora/Enterprise Linux

Source: https://docs.eduvpn.org/server/v3/systemd-networkd.html

Installs and enables the systemd-networkd service on Fedora and Enterprise Linux systems. This service must be active for systemd-networkd management.

```bash
$ sudo dnf -y install systemd-networkd
$ sudo systemctl enable --now systemd-networkd

```

--------------------------------

### Download and Extract Deploy Script

Source: https://docs.eduvpn.org/server/v3/deploy-fedora.html

Download the v3 deployment script archive and extract it. Navigate into the extracted directory to prepare for execution.

```bash
$ curl -L -O https://codeberg.org/eduVPN/deploy/archive/v3.tar.gz
$ tar -xzf v3.tar.gz
$ cd deploy

```

--------------------------------

### Install MariaDB/MySQL PHP Extension

Source: https://docs.eduvpn.org/server/v3/database.html

Install the necessary PHP extension for MariaDB/MySQL on Debian-based systems. This is required for the VPN server to connect to a MariaDB or MySQL database.

```bash
$ sudo dnf install php-mysqlnd
$ sudo systemctl restart php-fpm


```

--------------------------------

### Enable Live Permissions with LDAP (Bind DN Template)

Source: https://docs.eduvpn.org/server/v3/live-permissions.html

Configure the LDAP authentication module to use Live Permissions. This example assumes users authenticate using their 'uid' and the 'bindDnTemplate' is used. Ensure anonymous LDAP binds are allowed or configure 'searchBindDn' and 'searchBindPass'.

```php
[ 
    // ...

    'authModule' => 'LdapAuthModule',

    'LdapAuthModule' => [
        // the user's "uid" is part of the DN, so we can use the 
        // 'bindDnTemplate'
        'ldapUri' => 'ldap://ldap.example.org',
        'bindDnTemplate' => 'uid={{UID}},ou=people,dc=example,dc=org',
        'userIdAttribute' => 'uid',
        'permissionAttributeList' => ['eduPersonAffiliation'],

        // in case "anonymous bind" is not allowed, set these
        // **NOTE** use a read-only search-only account, not the actual admin 
        // account!
        //'searchBindDn' => 'cn=admin,dc=home,dc=arpa',
        //'searchBindPass' => 's3r3t',

        // explicitly enable "Live Permissions" for LDAP
        'isLivePermissionSource' => true,
    ],

    // ...
]

```

--------------------------------

### Add User with vpn-user-portal-account

Source: https://docs.eduvpn.org/server/v3/db-auth.html

Use this command to add a new user to the local database. You will be prompted to enter the password twice.

```bash
$ sudo vpn-user-portal-account --add foo

```

--------------------------------

### Connected Users API Response Example

Source: https://docs.eduvpn.org/server/v3/admin-api.html

Example JSON response showing connected users for different profiles. The response structure changed in vpn-user-portal >= 3.5.2.

```json
{
    "connected_users": {
        "employees": [],
        "students": [
            "ellis",
            "remi",
            "charlie"
        ]
    }
}

```

--------------------------------

### Initialize Database

Source: https://docs.eduvpn.org/server/v3/database.html

Initialize the database for the VPN server. This command ensures the database schema is set up correctly. Ensure the database specified in your configuration exists before running this command.

```bash
$ sudo /usr/libexec/vpn-user-portal/db --init


```
Tokens:
Raw