hosting/mash-playbook
1
0
Fork 0
Code Pull requests Activity
mash-playbook/docs/services/firezone.md
Slavi Pantaleev b0c0a31527
Update firezone.md
2023-03-24 12:05:24 +02:00

2.4 KiB
Raw Blame History

Firezone

Firezone is a self-hosted VPN server (based on WireGuard) with Web UI that this playbook can install, powered by the moan0s/role-firezone Ansible role.

Configuration

To enable this service, add the following configuration to your vars.yml file and re-run the installation process:

########################################################################
#                                                                      #
# firezone                                                             #
#                                                                      #
########################################################################

firezone_enabled: true

firezone_hostname: vpn.example.org

firezone_default_admin_email: "user@invalid.org"
firezone_default_admin_password: "<securepassword>"

# Generate this with `openssl rand -base64 32`
firezone_database_encryption_key: "<secret>"

########################################################################
#                                                                      #
# /firezone                                                            #
#                                                                      #
########################################################################

After installation, you can use just run-tags firezone-create-or-reset-admin any time to:

  • create the configured admin account
  • or, reset the password to the current password configured in vars.yml

Networking

By default, the following ports will be exposed by the container on all network interfaces:

  • 51820 over UDP, controlled by firezone_wireguard_bind_port - used for Wireguard connections

Docker automatically opens these ports in the server's firewall, so you likely don't need to do anything. If you use another firewall in front of the server, you may need to adjust it.

Usage

After installing, you can login at the URL specified in firezone_hostname, with the credentials set in firezone_default_admin_email and firezone_default_admin_password.

Refer to the official documentation to figure out how to add devices, etc.