hosting/mash-playbook
1
0
Fork 0
Code Pull requests Activity

docs: Add networking and usage section

Browse source
This commit is contained in:
Julian-Samuel Gebühr 2023-03-24 10:51:48 +01:00
parent 5bc947858c
commit 90b146b7d1
1 changed files with 14 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
docs/services/firezone.md
View file

@ -10,7 +10,7 @@ To enable Firezone add the following to your `vars.yml`:
############## ##############
firezone_enabled: true firezone_enabled: true
firezone_hostname: example.org firezone_hostname: vpn.example.org
firezone_default_admin_email: "user@invalid.org" firezone_default_admin_email: "user@invalid.org"
firezone_default_admin_password: "<securepassword>" firezone_default_admin_password: "<securepassword>"
@ -21,3 +21,16 @@ firezone_database_encryption_key: "<secret>"
Use `just run-tags firezone-create-or-reset-admin` to create the configured Use `just run-tags firezone-create-or-reset-admin` to create the configured
admin account or reset the password to the password set in `vars.yml`. admin account or reset the password to the password set 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 your 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 you started the service you can login at vpn.example.org with the credentials set in `firezone_default_admin_email/password`.
After that refer to the [official documentation](https://www.firezone.dev/docs/user-guides/add-devices/) to add devices and more.