mirror of
https://github.com/outbackdingo/firezone.git
synced 2026-01-27 18:18:55 +00:00
36cd9a18d2
We have RPM builds and instructions for installing them, so I've moved this to our docs. Identified #7646 as a known issue.
112 lines
3.6 KiB
Markdown
112 lines
3.6 KiB
Markdown
# gui-client
|
|
|
|
This crate houses a GUI client for Linux and Windows.
|
|
|
|
## Setup (Ubuntu)
|
|
|
|
To compile natively for x86_64 Linux:
|
|
|
|
1. [Install rustup](https://rustup.rs/)
|
|
1. Install [pnpm](https://pnpm.io/installation)
|
|
1. `sudo apt-get install build-essential curl file libayatana-appindicator3-dev librsvg2-dev libssl-dev libwebkit2gtk-4.1-dev libxdo-dev wget`
|
|
|
|
## Setup (Windows)
|
|
|
|
To compile natively for x86_64 Windows:
|
|
|
|
1. [Install rustup](https://rustup.rs/)
|
|
1. Install [pnpm](https://pnpm.io/installation)
|
|
|
|
### Recommended IDE Setup
|
|
|
|
(From Tauri's default README)
|
|
|
|
- [VS Code](https://code.visualstudio.com/)
|
|
- [Tauri](https://marketplace.visualstudio.com/items?itemName=tauri-apps.tauri-vscode)
|
|
- [rust-analyzer](https://marketplace.visualstudio.com/items?itemName=rust-lang.rust-analyzer)
|
|
|
|
## 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`](./package.json) script for more details as to what's
|
|
going on under the hood.
|
|
|
|
```bash
|
|
# 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
|
|
```
|
|
|
|
## Signing the Windows MSI in GitHub CI
|
|
|
|
The MSI is signed in GitHub CI using the `firezone/firezone` repository's
|
|
secrets. This was originally set up using these guides for inspiration:
|
|
|
|
- https://melatonin.dev/blog/how-to-code-sign-windows-installers-with-an-ev-cert-on-github-actions/
|
|
- https://support.globalsign.com/code-signing/code-signing-using-azure-key-vault
|
|
|
|
Renewing / issuing a new code signing certificate and associated Azure entities is outside the scope of this section. Use the guides above if this needs to be done.
|
|
|
|
Instead, you'll most likely simply need to rotate the Azure `CodeSigning` Application's client secret.
|
|
|
|
To do so, login to [the Azure portal](https://portal.azure.com) using your `@firezoneprod.onmicrosoft.com` account.
|
|
Try to access it via the following [deep-link](https://portal.azure.com/#view/Microsoft_AAD_RegisteredApps/ApplicationMenuBlade/~/Credentials/appId/51da0daa-39dd-4890-9018-e02609efc9c8).
|
|
If that doesn't work:
|
|
|
|
- Go to the `Microsoft Entra ID` service
|
|
- Click on `App Registrations`
|
|
- Make sure the tab `All applications` is selected
|
|
- Find and navigate to the `CodeSigning` app registration
|
|
- Client on `client credentials`
|
|
- Click `New client secret`
|
|
- Note down the secret value. This should be entered into the GitHub repository's secrets as `AZURE_CLIENT_SECRET`.
|
|
|
|
## Running
|
|
|
|
From this dir:
|
|
|
|
```powershell
|
|
# 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 22.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](https://tauri.app/v1/guides/getting-started/prerequisites#2-webview2)
|
|
|
|
`x86_64` architecture is supported for Windows. `aarch64` and `x86_64` are supported for Linux.
|
|
|
|
## Threat model
|
|
|
|
See [Security](docs/security.md)
|
|
|
|
## Testing
|
|
|
|
See [Intended behavior](docs/intended_behavior.md)
|