Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

VPN-6839 - add updater info #10241

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

VPN-6839 - add updater info #10241

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
297e07f
VPN-6839 - add updater info
mcleinman Jan 31, 2025
706552b
linter fixes
mcleinman Jan 31, 2025
017389d
add more detail
mcleinman Jan 31, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .dictionary
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ APIs
Adblock
AdjustSdk
Affero
Balrog
Bodymovin
CHACHA
CLI
Expand Down Expand Up @@ -86,6 +87,7 @@ TOTP
TP
TaskGetFeatureList
UniFFI
VersionAPI
VpnService
VPN's
WebAssembly
Expand Down Expand Up @@ -115,6 +117,7 @@ att
auth
backend
backgrounded
balrog
bea's
bool
boolean
Expand Down
9 changes: 9 additions & 0 deletions docs/Components/updater.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# How the client updates itself

The client has 2 “force update” mechanisms. Both the `VersionAPI` class and the `Balrog` class can emit `updateRequired` and `updateRecommended` signals.

`Updater.cpp` is what decides which of three systems to use to check the latest version: `Balrog` (uses the service balrog), `VersionAPI` (uses a Guardian API that seems to feed from the product details repository), or `WebUpdater` (which sends the user to a web page).

- `Balrog`: Windows and macOS use Balrog (controlled by the `MVPN_BALROG` flag defined in the macOS and Windows cmake files) if the `enableUpdateServer` feature is `true`. (This feature defaults to `true` for all platforms that support Balrog.)
- `VersionAPI`: It is believed that all other platforms use VersionAPI. (This will be confirmed in [VPN-6836](https://mozilla-hub.atlassian.net/browse/VPN-6836).)
- `WebUpdater`: It is believed that this is unused code, but that will be confirmed (and removed) in [VPN-6836](https://mozilla-hub.atlassian.net/browse/VPN-6836).
Loading