mirror of https://github.com/outbackdingo/firezone.git synced 2026-01-27 10:18:54 +00:00

Files

Thomas Eizinger 6e2be658b0 chore(gateway): log unroutable packets only on DEBUG (#10897 )

Currently, the Gateway logs all kinds of errors during packet processing
on WARN. Whilst it is generally good to be aware of warnings / errors,
some of these scenarios are particularly noisy. For various reasons, we
may not be able to route a packet arriving from the TUN device.

In such cases, we now return an `UnroutablePacket` error to the
event-loop which is special-cased to only log on DEBUG. It also includes
the 5 tuple as variables, which should make log analysis a bit easier if
we want to filter on specific parts of the 5 tuple.

2025-11-18 04:23:14 +00:00

debian

fix(gateway): declare hard-dependency on systemd (#10803 )

2025-11-07 14:33:30 +00:00

src

chore(gateway): log unroutable packets only on DEBUG (#10897 )

2025-11-18 04:23:14 +00:00

Cargo.toml

chore: publish gateway 1.4.18 (#10823 )

2025-11-10 19:08:17 +11:00

README.md

feat(gateway): support systemd credentials (#10538 )

2025-10-14 00:07:49 +00:00

README.md

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.
Provide the token to the Gateway using one of these methods:
- Set the FIREZONE_TOKEN=<gateway_token> environment variable
- Set a systemd credential named FIREZONE_TOKEN.
Set FIREZONE_ID to a unique string to identify this gateway in the portal, e.g. export FIREZONE_ID=$(head -c 32 /dev/urandom | sha256sum | cut -d' ' -f1). The Gateway requires this variable at startup. We recommend this to be a 64 character hex string.
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.