mirror of https://github.com/outbackdingo/firezone.git synced 2026-01-27 10:18:54 +00:00

Files

Thomas Eizinger 66fcf8734c fix(android): handle exceptions when creating a new session (#10667 )

The `Session.newAndroid` constructor can throw an exception.
Unfortunately, the Kotlin compiler didn't warn us about that and thus,
any errors when creating a new session caused the service process to
crash.

We fix this by wrapping the entire thing in a `try-catch-finally` block.

Resolves: #10289

2025-10-21 21:01:41 +00:00

app

fix(android): handle exceptions when creating a new session (#10667 )

2025-10-21 21:01:41 +00:00

gradle/wrapper

chore(android): bump gradlew to 8.14.3 (#10033 )

2025-07-28 21:37:07 +00:00

images

Update Android README dev instructions (#2814 )

2023-12-07 13:45:21 +00:00

.gitignore

feat(android): Managed configuration (#9227 )

2025-05-26 23:37:02 +00:00

build.gradle.kts

build(deps): bump com.google.gms.google-services from 4.4.3 to 4.4.4 in /kotlin/android (#10563 )

2025-10-14 00:17:09 +00:00

gradle.properties

Github Actions cache on main and scope caches for all languages/runtimes (#2233 )

2023-10-04 17:29:04 -07:00

gradlew

chore(android): Bump gradlew to 8.11.1 (#8653 )

2025-04-04 06:04:12 +00:00

gradlew.bat

chore(android): Bump gradlew to 8.11.1 (#8653 )

2025-04-04 06:04:12 +00:00

LICENSE

chore: Update copyright date (#4044 )

2024-03-08 01:55:27 +00:00

README.md

fix(docs): fix spacing due to new prettier (#9630 )

2025-06-23 05:52:57 +00:00

settings.gradle.kts

fix(android): Simplify connlib gradle build configuration to ensure libconnlib.so is packaged (#3207 )

2024-01-12 08:16:43 -08:00

README.md

Firezone Android client

This README contains instructions for building and testing the Android client locally.

Dev Setup

Install Rust
Install Android Studio
Install your JDK 17 of choice. We recommend just updating your CLI environment to use the JDK bundled in Android Studio to ensure you're using the same JDK on the CLI as Android Studio.
Install the Android SDK through Android Studio.
- Open Android studio, go to Android Studio > Preferences
- Search for sdk
- Find the Android SDK nav item under System Settings and select
- Click the Edit button next to the Android SDK Location field
- Follow the steps presented to install Android SDK
Install NDK using Android Studio

To see which version is installed, make sure to select the Show Package Details checkbox in the Android SDK settings page in Android Studio

Make sure the correct NDK version is installed by looking at: ./app/build.gradle.kts
Set the following properties in your local.properties file:
```
sdk.dir=/Users/<username>/Library/Android/sdk
```
Make sure the following Rust targets are installed into the correct toolchain.
```
aarch64-linux-android
arm-linux-androideabi
armv7-linux-androideabi
i686-linux-android
x86_64-linux-android
```
Ensure you've activated the correct toolchain version for your local environment with rustup default <toolchain> (find this from the root /rust/rust-toolchain.toml file), then run:
```
rustup target add aarch64-linux-android arm-linux-androideabi armv7-linux-androideabi i686-linux-android x86_64-linux-android
```
Perform a test build: ./gradlew assembleDebug.

If you get errors about rustc or cargo not being found, it can help to explicitly specify the path to these in your shell environment. For example:

# ~/.zprofile or ~/.bash_profile
export RUST_ANDROID_GRADLE_RUSTC_COMMAND=$HOME/.cargo/bin/rustc
export RUST_ANDROID_GRADLE_CARGO_COMMAND=$HOME/.cargo/bin/cargo

Release Setup

We release from GitHub CI, so this shouldn't be necessary. But if you're looking to test the release variant locally:

Download the keystore from 1Pass and save to app/.signing/keystore.jks dir.
Download firebase credentials from 1Pass and save to app/.signing/firebase.json
Now you can execute the *Release tasks with:

export KEYSTORE_PATH="$(pwd)/app/.signing/keystore.jks"
export FIREBASE_CREDENTIALS_PATH="$(pwd)/app/.signing/firebase.json"
HISTCONTROL=ignorespace # prevents saving the next line in shell history
 KEYSTORE_PASSWORD='keystore_password' KEYSTORE_KEY_PASSWORD='keystore_key_password' ./gradlew assembleRelease

Logs

To see all connlib related logs via ADB use:

adb logcat --format color "connlib *:S"

This will show logs of all levels from the connlib tag and silence logs from other tags (*:S).