diff --git a/docs/services/firezone.md b/docs/services/firezone.md index df231e8..3b3e574 100644 --- a/docs/services/firezone.md +++ b/docs/services/firezone.md @@ -10,7 +10,7 @@ To enable Firezone add the following to your `vars.yml`: ############## firezone_enabled: true -firezone_hostname: example.org +firezone_hostname: vpn.example.org firezone_default_admin_email: "user@invalid.org" firezone_default_admin_password: "" @@ -21,3 +21,16 @@ firezone_database_encryption_key: "" 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`. + +### 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.