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

Files

Jamil dd2de0440e refactor(android): Remove excessive debug logging from kotlin codebase (#5748 )

- Why: This prevents logging potentially sensitive data to Logcat or
Firebase. For critical codepaths we rely on a non-null `!!` check
anyhow, which will be reported with a crash to Firebase. Now that we
have some confidence the app is reliable, I think we can reflect that
confidence in our code.
- This moves the `loadLibrary` call to the app start, which will surface
issues immediately when launching the app and not when trying to
connect. This also makes connect very slightly faster.
- Finally, `BootShutdownReceiver` is removed since it was essentially a
no-op. There are a few ways we can connect on boot, but this isn't a
good approach since it would ignore Android's Always-on VPN setting.

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

app

refactor(android): Remove excessive debug logging from kotlin codebase (#5748 )

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

gradle/wrapper

chore(deps): bump gradle to 8.8 (#5198 )

2024-06-03 08:31:33 -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

fix(android): Bump AGP to 8.5.0 and reorder rust gradle plugin (#5693 )

2024-07-03 15:26:57 +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(deps): bump gradle to 8.8 (#5198 )

2024-06-03 08:31:33 -07:00

gradlew.bat

chore(deps): bump gradle to 8.8 (#5198 )

2024-06-03 08:31:33 -07:00

LICENSE

chore: Update copyright date (#4044 )

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

README.md

feat(portal): Billing system (#3642 )

2024-02-20 15:01:17 -06: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
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.

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