ZenStream Mobile

An Android client for ZenStream.

Submit Issues · Releases

How it fits together

ZenStream has one Orchestrator backend and two clients:

• Web client
• Android client
• Orchestrator

Offline playback

Movies, episodes, and music can be saved in the Android app for playback without a server connection. See the offline downloads guide for download choices, offline mode, account access, and synchronization behavior.

Configuration

Enter the Orchestrator URL when the app starts.

• version.properties contains the semantic version used for builds.
• ANDROID_RELEASE_STORE_FILE, ANDROID_RELEASE_STORE_PASSWORD, ANDROID_RELEASE_KEY_ALIAS, and ANDROID_RELEASE_KEY_PASSWORD configure signed release builds.

Do not commit keystore files or signing credentials.

Quick start

Requires Android Studio, JDK 21, and Android SDK 37. Open the project in Android Studio or build the debug APK with:

./gradlew assembleDebug

Deployment

Install a local debug build on a connected device or emulator with:

./gradlew installDebug

Signed release APKs are published through GitHub Releases.

Development checks

./gradlew spotlessCheck lint test assembleDebug

Developer documentation

• Contributing

• Issue and pull request triage

• Documentation index

• Architecture and ownership

• Android interface design

• Playback and audio

• Offline downloads

Troubleshooting

• For an Android emulator connecting to an Orchestrator running on the host, use http://10.0.2.2:<port> and ensure the server is bound to an address the emulator can reach.
• For a physical device, use the host computer's LAN address instead of 127.0.0.1, and allow the port through the firewall.
• If a release build fails, verify the four ANDROID_RELEASE_* signing settings and the keystore path.

Releases

The latest signed APK is available from GitHub Releases. Download the asset named zenstream-mobile-vX.Y.Z.apk.

License

AGPL-3.0-or-later. See LICENSE.