mirror of
https://github.com/outbackdingo/firezone.git
synced 2026-01-27 18:18:55 +00:00
1ef775dee1
Ready for review. Closes #3712. Supersedes #4940. Refs #4963. I haven't figured out if it needs any new automated tests (unit, integration, etc.) but the code itself is ready for review. There is more refactoring that could be done, or could be left for later. ```[tasklist] - [x] Move wintun setup from GUI to IPC service / headless client - [x] Make sure the device ID is in a sensible place - [x] Export IPC service logs in the zips - [x] Test GUI + SC IPC service on Windows (f4db808919a passed) - [x] Make sure IPC service does not busy-loop - [x] Test un-install checklist for Windows - [x] Test upgrade checklist for Windows - [x] Test GUI + systemd IPC service on Linux (c4ab7e7 passed) - [x] Test upgrade checklist for Linux - [x] Test un-install checklist for Linux - [x] Make sure the IPC service logs out and deactivates DNS control if the GUI crashes - [x] Test network changing - [x] (it's intended behavior) ~~Look into spurious `on_update_resources` (fad86babd7)~~ - [x] ~~Test max partition time on offline laptop~~ (I ended up just setting a 30-day default in the code) - [x] Make sure headless Client does not busy-loop - [x] Test standalone headless on Linux - [ ] Add unit / integration tests - [ ] Think about security a bit #3971 ``` --------- Signed-off-by: Reactor Scram <ReactorScram@users.noreply.github.com> Co-authored-by: Jamil <jamilbk@users.noreply.github.com>
Rust development guide
Firezone uses Rust for all data plane components. This directory contains the Linux and Windows clients, and low-level networking implementations related to STUN/TURN.
We target the last stable release of Rust using rust-toolchain.toml.
If you are using rustup, that is automatically handled for you.
Otherwise, ensure you have the latest stable version of Rust installed.
Reading Client logs
The Client logs are written as JSONL for machine-readability.
To make them more human-friendly, pipe them through jq like this:
cd path/to/logs # e.g. `$HOME/.cache/dev.firezone.client/data/logs` on Linux
cat *.log | jq -r '"\(.time) \(.severity) \(.message)"'
Resulting in, e.g.
2024-04-01T18:25:47.237661392Z INFO started log
2024-04-01T18:25:47.238193266Z INFO GIT_VERSION = 1.0.0-pre.11-35-gcc0d43531
2024-04-01T18:25:48.295243016Z INFO No token / actor_name on disk, starting in signed-out state
2024-04-01T18:25:48.295360641Z INFO null