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

Feature/tls docs #10

Merged
merged 2 commits into from
Aug 22, 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
5 changes: 4 additions & 1 deletion docs/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,7 @@ You can create a first user on the user page. The `admin` user cannot create VPN
* Log-out and Log-in using the new credentials
* Create a new connection on the Connections page
* Download the configuration
* Import the configuration in a WireGuard® Client. See [https://www.wireguard.com/install/](https://www.wireguard.com/install/) for WireGuard® clients.
* Import the configuration in a WireGuard® Client. See [https://www.wireguard.com/install/](https://www.wireguard.com/install/) for WireGuard® clients.

# Access for existing users in Identity Providers
To allow access for users created in Active Directory, Okta, Onelogin, or other Identity Providers, navigate to the [OIDC](oidc.md), [SAML](saml.md), or [Provisioning (SCIM)](scim.md) pages to setup an IdP connection.
2 changes: 2 additions & 0 deletions docs/release-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@
* UI: ability to reload WireGuard® configuration
* UI: modify client/server WireGuard® configuration files using templates

Note: after upgrading, make sure to close any old browser tab to ensure the new UI version is loaded.

## Version v1.0.41
* UI: axios version bump
* UI: disable https forwarding when request is served over http
Expand Down
16 changes: 16 additions & 0 deletions docs/tls.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# TLS

## Configuration

You can enable TLS (https) in the VPN Settings. TLS only works if you have a hostname configured as the "VPN Server Hostname". Make sure you have created a DNS record like vpn.yourcompany.com to the IP address of the VM instance. Once you enable the TLS setting, let's encrypt will be activated. An API call will be made to [letsencrypt.com](https://letsencrypt.org/), which will then make an HTTP call on your hostname to verify ownership. Only when this call succeeds, the TLS certificate will be issued, and the VPN Server will be accessible over https.

## http to https forward
Make sure to only enable the http to https forwarding when https is fully working. If you enabled the http to https forwarding, but can't access the VPN Server over https, you can still disable the forwarding manually.

Log in using SSH to the VPN Server and cd into the /vpn/config directory. The config.json file contains an attribute `redirectToHttps` that will be set to `true`. You can either remove the attribute and value or set the value to false. Also make sure that the attribute `protocol` is set back to `http` instead of `https`. Restart the VPN server using `systemctl restart vpn-rest-server`.

## Alternatives
On Cloud providers like AWS a Load Balancer can be created to ensure access between the client and the AWS Load Balancer is using TLS.

## VPN Traffic
VPN Traffic between client and VPN Server using WireGuard® is always encrypted. The TLS solution using Let's Encrypt is only to encrypt web traffic between the client (the browser) and the VPN Server Admin Web Interface.
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ nav:
- 'User Guide':
- 'Installation': 'install.md'
- 'Quick Start': 'quickstart.md'
- 'TLS (https)': 'tls.md'
- Upgrade: 'upgrade.md'
- FAQ: faq.md
- 'Authentication & Provisioning':
Expand Down
Loading