mirror of
https://github.com/outbackdingo/firezone.git
synced 2026-01-27 10:18:54 +00:00
1b5076fa57
Currently, the gateway only handles an `init` message on startup. For clients, we handle `init` messages also during operation so it only makes sense to do the same thing for gateways. This allows us to remove some old code from `phoenix_channel`. In particular, the `init` function which used to wait for the `init` message before continuing. In https://github.com/firezone/firezone/pull/4594, we refactored `phoenix-channel` to reconnect internally on errors. As a result, the `connect` function became synchronous and no longer needed an `async` context. At the time, the gateway wasn't updated to make use of this. We can now simplify the gateway code and resolve the outstanding TODO of handling `init` messages during operation.
gateway
This crate houses the Firezone gateway.
Building
You can build the gateway using: cargo build --release --bin firezone-gateway
You should then find a binary in target/release/firezone-gateway.
Running
The Firezone Gateway supports Linux only. To run the Gateway binary on your Linux host:
- Generate a new Gateway token from the "Gateways" section of the admin portal and save it in your secrets manager.
- Ensure the
FIREZONE_TOKEN=<gateway_token>environment variable is set securely in your Gateway's shell environment. The Gateway requires this variable at startup. - Set
FIREZONE_IDto a unique string to identify this gateway in the portal, e.g.export FIREZONE_ID=$(uuidgen). The Gateway requires this variable at startup. - Now, you can start the Gateway with:
firezone-gateway
If you're running as a non-root user, you'll need the CAP_NET_ADMIN capability
to open /dev/net/tun. You can add this to the gateway binary with:
sudo setcap 'cap_net_admin+eip' /path/to/firezone-gateway
Ports
The gateway requires no open ports. Connections automatically traverse NAT with STUN/TURN via the relay.