Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

manual install documentation #7

Merged
merged 1 commit into from
Aug 20, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 23 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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://<ip of instance>`
2 changes: 1 addition & 1 deletion provisioning/scripts/install_vpn.sh
100644 → 100755
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
#!/bin/bash
ARCHITECTURE="amd64"
ARCHITECTURE=$(uname -m)
if [ -e "/usr/bin/cloud-init" ] ; then
cloud-init status --wait
fi
Expand Down
Loading