mirror of
https://github.com/outbackdingo/firezone.git
synced 2026-01-27 10:18:54 +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>
gui-client
This crate houses a GUI client for Linux and Windows.
Setup (Ubuntu)
To compile natively for x86_64 Linux:
- Install rustup
- Install pnpm
sudo apt-get install at-spi2-core gcc libwebkit2gtk-4.0-dev libssl-dev libgtk-3-dev libayatana-appindicator3-dev librsvg2-dev pkg-config xvfb
Setup (Windows)
To compile natively for x86_64 Windows:
- Install rustup
- Install pnpm
Recommended IDE Setup
(From Tauri's default README)
Building
Builds are best started from the frontend tool pnpm. This ensures typescript
and css is compiled properly before bundling the application.
See the package.json script for more details as to what's
going on under the hood.
# Builds a release exe
pnpm build
# Linux:
# The release exe and deb package are up in the workspace.
stat ../target/release/firezone
stat ../target/release/bundle/deb/*.deb
# Windows:
# The release exe and MSI installer should be up in the workspace.
# The exe can run without being installed
stat ../target/release/Firezone.exe
stat ../target/release/bundle/msi/Firezone_0.0.0_x64_en-US.msi
Running
From this dir:
# This will start the frontend tools in watch mode and then run `tauri dev`
pnpm dev
# You can call debug subcommands on the exe from this directory too
# e.g. this is equivalent to `cargo run -- debug hostname`
cargo tauri dev -- -- debug hostname
# The exe is up in the workspace
stat ../target/debug/Firezone.exe
The app's config and logs will be stored at
C:\Users\$USER\AppData\Local\dev.firezone.client.
Platform support
Ubuntu 20.04 and newer is supported.
Tauri says it should work on Windows 10, Version 1803 and up. Older versions may work if you manually install WebView2
x86_64 architecture is supported at this time. See
this issue for aarch64
support.
Threat model
See Security