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

Files

Jamil 573124bd2f Document relay gateway client CLIs (#2424 )

Fixes #2363 

* Rename `relay` package to `firezone-relay` so that binaries outputted
match the `firezone-*` cli naming scheme
* Rename `firezone-headless-client` package to `firezone-linux-client`
for consistency
* Add READMEs for user-facing CLI components (there will also be docs
later)

2023-10-19 00:59:17 +00:00

src

Document relay gateway client CLIs (#2424 )

2023-10-19 00:59:17 +00:00

Cargo.toml

Document relay gateway client CLIs (#2424 )

2023-10-19 00:59:17 +00:00

README.md

Document relay gateway client CLIs (#2424 )

2023-10-19 00:59:17 +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

To run the gateway:

firezone-gateway --portal_token <portal_token>

where portal_token is the token shown when creating a gateway group in the Firezone admin portal.

If you're running as an unprivileged 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.