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

Files

Jamil bbab37f1e1 chore(android): Remove i686 android target (#3547 )

This increases our app bundle size with no real benefit. ~~I'm also
encountering an issue where the `x86` shared library is being loaded
instead of the appropriate x86_64 one, causing a crash.~~ Edit: The
crash appears to be coming from somewhere else, still investigating.
Still it would be good to remove this as the Rust dependency in the
Android build is built serially.

2024-02-03 17:41:31 +00:00

app

chore(android): Remove i686 android target (#3547 )

2024-02-03 17:41:31 +00:00

gradle/wrapper

Use larger builders for CPU-bound workflows (#2256 )

2023-10-07 08:07:24 -07:00

images

Update Android README dev instructions (#2814 )

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

.gitignore

fix(android): Allow bypassing AlwaysOn VPN (#3522 )

2024-02-02 06:27:05 +00:00

build.gradle.kts

feat(ci): Standardize matrix job names to prevent dupes, move jobs to macos-14 (#3447 )

2024-01-31 22:12:23 +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

Use larger builders for CPU-bound workflows (#2256 )

2023-10-07 08:07:24 -07:00

gradlew.bat

Use larger builders for CPU-bound workflows (#2256 )

2023-10-07 08:07:24 -07:00

LICENSE

Add android client to the repo (#1738 )

2023-07-07 04:54:51 -07:00

README.md

chore(android): Remove i686 android target (#3547 )

2024-02-03 17:41:31 +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: ../../rust/connlib/clients/android/connlib/build.gradle.kts

Set the following ENV variables in the start up config for your shell:

JAVA_HOME=/Applications/Android\ Studio.app/Contents/jbr/Contents/Home
ANDROID_HOME=/Users/<username>/Library/Android/sdk
NDK_HOME=$ANDROID_HOME/ndk-bundle
PATH=$PATH:$ANDROID_HOME/platform-tools:$ANDROID_HOME/tools:$ANDROID_HOME/tools/bin

Make sure the following Rust targets are installed into the correct toolchain.
```
aarch64-linux-android
arm-linux-androideabi
armv7-linux-androideabi
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 x86_64-linux-android
```
Perform a test build: ./gradlew assembleDebug.
Add your debug signing key's SHA256 fingerprint to the portal's assetlinks.json file. This is required for the App Links to successfully intercept the Auth redirect.
```
./gradlew signingReport
```

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