From bf40283432a73a8e3b16f41f1046a1fc9c42e003 Mon Sep 17 00:00:00 2001 From: Edward Viaene Date: Tue, 20 Aug 2024 15:56:41 +0200 Subject: [PATCH] manual install documentation (#7) --- README.md | 24 +++++++++++++++++++++++- provisioning/scripts/install_vpn.sh | 2 +- 2 files changed, 24 insertions(+), 2 deletions(-) mode change 100644 => 100755 provisioning/scripts/install_vpn.sh diff --git a/README.md b/README.md index ad9f1f7..ab0d80f 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,31 @@ ## Usage You can launch the WireGuard® based VPN server for production use from the [AWS Marketplace](https://aws.amazon.com/marketplace/pp/prodview-dymnyb6a2pq72), the [Azure Marketplace]( -https://azuremarketplace.microsoft.com/en-us/marketplace/apps/in4it.vpn-server), the [DigitalOcean Marketplace](https://marketplace.digitalocean.com/apps/vpn-server), or install the VPN manually. Personal use is allowed under BSL (Business Source License). +https://azuremarketplace.microsoft.com/en-us/marketplace/apps/in4it.vpn-server), the [DigitalOcean Marketplace](https://marketplace.digitalocean.com/apps/vpn-server), the [GCP Marketplace](https://console.cloud.google.com/marketplace/product/in4it-public/vpn-server) or install the VPN manually. Personal use is allowed under BSL (Business Source License). ## Features * Easy to use admin UI * SAML, OpenID Connect, SCIM support * WireGuard® as VPN technology, a fast and modern VPN Solution + +## Bugs or Issues +Use the GitHub Issues to report any bugs or issues. We are monitoring new issues and will respond in a timely matter. + +## Manual install +You can install the VPN Server manually if you can't use one of the cloud marketplace options. Make sure you have an Ubuntu 24.04 Linux instance running with open ports 80/tcp, 443/tcp, and 51820/udp. Clone this repository, then run: + +``` +make +mv restserver-linux-amd64 /tmp # you can change amd64 to arm64 if you are on arm64 +mv reset-admin-password-linux-amd64 /tmp +mv configmanager-linux-amd64 /tmp +provisioning/scripts/install_vpn.sh +``` + +You can now start the VPN server using the following commands: +``` +systemctl enable vpn-configmanager +systemctl enable vpn-rest-server +``` + +The VPN Server admin frontend should be available at `http://` \ No newline at end of file diff --git a/provisioning/scripts/install_vpn.sh b/provisioning/scripts/install_vpn.sh old mode 100644 new mode 100755 index d0fef9b..71a985f --- a/provisioning/scripts/install_vpn.sh +++ b/provisioning/scripts/install_vpn.sh @@ -1,5 +1,5 @@ #!/bin/bash -ARCHITECTURE="amd64" +ARCHITECTURE=$(uname -m) if [ -e "/usr/bin/cloud-init" ] ; then cloud-init status --wait fi