meshtastic/docs/software/android/installation.mdx
rcarteraz c721450949
Update installation.mdx
Added a section for using obtainium to install/update directly from the Meshtastic GitHub releases page.
2022-11-09 16:12:14 -07:00

66 lines
3.4 KiB
Plaintext

---
id: installation
title: Android Application Installation
sidebar_label: Installation
sidebar_position: 1
---
## Installation Methods
Our Android application is available on our F-Droid repo and Google Play Store. This allows you to connect to your Meshtastic device from your Android phone.
The minimum Android version is 5.0 (Lollipop 2014, first BLE support), however Android 6 (Marshmallow 2015) is recommended as Bluetooth is more stable.
### Install with F-Droid
<p float="center">
<a href="https://mesh.tastic.app/fdroid/repo">
<img alt="Get it on F-Droid"
src="https://fdroid.gitlab.io/artwork/badge/get-it-on.png"
width="49%"/>
</a>
</p>
1. Download and Install the F-Droid app from [f-droid.org](https://f-droid.org/)
2. Open the F-Droid app and navigate to `Settings > Repositories`.
3. Click on the `+` icon to add a new repo.
3. Enter the Meshtastic repo address as follows: `https://mesh.tastic.app/fdroid/repo/` (no fingerprint required)
4. Navigate to the `Categories` page and refresh (scroll down).
5. Search for and install the `Meshtastic` App.
### Install from Play Store
<p float="center">
<a href="https://play.google.com/store/apps/details?id=com.geeksville.mesh">
<img alt="Download at https://play.google.com/store/apps/details?id=com.geeksville.mesh"
src="https://play.google.com/intl/en_us/badges/static/images/badges/en_badge_web_generic.png"
width="49%"/>
</a>
</p>
There is a Play Store [testing program](https://play.google.com/apps/testing/com.geeksville.mesh) with the latest cutting edge changes, though this may come with extra bugs.
It is recommended that you follow the [Meshtastic Discourse Alpha Testers](https://meshtastic.discourse.group/c/development/alpha-testers) channel if you decide to join.
_Google Play and the Google Play logo are trademarks of Google LLC._
### Install with Obtainium
1. Download and Install the Obtanium app from [Github](https://github.com/ImranR98/Obtainium).
2. Open the Obtanium app and navigate to `+ Add App`.
3. Enter the Meshtastic Android Github Releases address as follows: `https://github.com/meshtastic/Meshtastic-Android/releases`.
4. Under `Additional Options for Github` toggle as desired `Include prereleases`* or `Fallback to older releases` and press `Add`.
5. The first time you add an application, obtainium will prompt you for permission to install unknown apps, you will need to toggle `Allow from this source` and press back. Obtainium will download the Android .APK from the Github release page.
6. Press `Install`. Android Installer will prompt "Do you want to install this app?" press `Install`.
7. Press `Open`.
Obtanium will provide notifications when a new release version of the Meshtastic App is available and allow you to update it from within the app.
*Alpha releases include the latest cutting edge changes which may come with extra bugs. It is recommended that you follow the [Meshtastic Discourse Alpha Testers](https://meshtastic.discourse.group/c/development/alpha-testers) channel if you decide to use these versions.
### Install by Sideloading
The app can also be sideloaded by downloading the .APK from the [Github Releases](https://github.com/meshtastic/Meshtastic-Android/releases/latest) page.
If you do sideload, you may have to give your browser permissions to run a package installer. If you wish to view the code or contribute to development of the app, please visit the app's [GitHub page](https://github.com/meshtastic/Meshtastic-Android)