mirror of
https://github.com/outbackdingo/firezone.git
synced 2026-01-27 18:18:55 +00:00
2416d4f45c
Closes #4995 Closes #4925 Closes #4997 Closes #5047 Supersedes #4965 and #5004. NOT changing: - Page description for other Clients. That is still "Firezone Documentation" Need these Clients: - Windows GUI - Linux headless - Linux GUI to have these things documented: (with exact terms) - Prerequisites - Installation - Usage - Signing in - Accessing a Resource - Signing out - Quitting - Upgrading - Diagnostic logs - Uninstalling - Troubleshooting - DNS not reverted after exit - DNS Resource not accessible - Known issues ```[tasklist] ### Before merging - [x] Test Windows GUI instructions - [x] Add troubleshooting for #5027 - [x] Fill in troubleshooting sections - [x] Test Linux GUI instructions - [x] Linux headless - Make sure SIGTERM or Ctrl+C or whatever reverts resolv.conf - [x] Test Linux Headless instructions - [x] Page descriptions should be "How to install and use the Firezone $OS $UI client." - [x] ~~Linux headless - Confirm behaviors and default values of all env vars~~ (skipping - The ones that are used are exercised) - [x] Grep for TODOs - [x] Change "un-install" to "uninstall" - [x] Capitalize "Client" where needed - [x] Change "IPC service" to "Tunnel service" or something - [x] Change "SplitDNS" to "Split DNS" - [ ] Wait for next Client release to be cut ``` --------- Signed-off-by: Jamil <jamilbk@users.noreply.github.com> Signed-off-by: Reactor Scram <ReactorScram@users.noreply.github.com> Co-authored-by: Jamil Bou Kheir <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