OpenAndroidInstaller

Makes installing alternative Android distributions nice and easy!

[](https://github.com/openandroidinstaller-dev/openandroidinstaller/blob/main/LICENSE) [](https://github.com/openandroidinstaller-dev/openandroidinstaller/releases) [](https://github.com/openandroidinstaller-dev/openandroidinstaller/releases) [](https://flathub.org/apps/org.openandroidinstaller.OpenAndroidInstaller) [](https://twitter.com/OAInstaller) [](https://fosstodon.org/@openandroidinstaller)

The OpenAndroidInstaller project helps Android users to keep their smartphone's operating system up to date with free software and to continue using the device even though the manufacturer no longer offers updates. With a graphical installation software, users are easily guided through the installation process of free Android operating systems like LineageOS.

Website · Report Bugs · Request Feature

[!WARNING] This application is currently in beta state, so use at your own risk! While many people tested the application so far and we heard of no bricked devices, things might still go wrong.

[!IMPORTANT] Unlocking the bootloader will erase all data on your device! This also includes your DRM keys, which are stored in the Trim Area partition (also called TA) in case your device is fairly recent and supports DRM L1. Those devices will be downgraded to DRM L3. Devices on DRM L3 by default will not be affected. Depending on your device you might be able to back up the TA partition using exploits and gaining temporary root access. On Sony Xperia 1/5 series phones DRM L1 will return once the bootloader is relocked. Before proceeding, ensure the data you would like to retain is backed up to your PC and/or your Google account, or equivalent. Please note that OEM backup solutions like Samsung and Motorola backup may not be accessible from LineageOS once installed.

Usage

Linux is currently the best supported platform (tested with Ubuntu 20.04/22.04 LTS). Windows and macOS are also supported, but you might experience more issues.

1. Download OpenAndroidInstaller

[!WARNING] ARM-based systems are not supported.

OpenAndroidInstaller support all three major operating systems, namely Linux, macOS and Windows. You can download the correct version for you system from the GitHub Releases.

The executables are compressed inside .zip files, so you'll have to extract them first (make sure you have extracting software installed). If you get prompted to, you'll have to adjust the permission of the executable to ensure its proper functionality.

If you run Windows, you might also need to install the Universal USB Drivers and other potentially drivers needed for your device.

For Linux, a Flatpak version is available in Flathub, org.openandroidinstaller.OpenAndroidInstaller.

2. Download the custom ROM, recovery image & optional add-ons

Here are the official links for:

• some custom ROMs:
  • BlissRoms
  • CalyxOS
  • DivestOS
  • /e/OS
  • GrapheneOS
  • LineageOS
  • LineageOS for MicroG
  • PixelExperience
• Recovery:
  • TWRP recovery
• Optional Add-ons:
  • There are different packages of Google Apps available:
    • MindTheGapps
    • NikGApps
  • MicroG
    • The recommended way to install MicroG is from the .zip file provided here: MinMicroG-abuse-CI/releases.
  • F-Droid App-Store.
• or you can just search the web or the XDA Developers forum to find an appropriate version for your device.

3. Start OpenAndroidInstaller

After starting the app you will be prompted to plug your device into your computer and you will be given a step-by-step tutorial on how to install your new OS for your specific device.

Officially supported devices

Currently, the we support 86 devices by various vendors and working on adding more soon!

Support for these devices is provided as best effort, but things might still go wrong. Help to improve the tool by reporting any issues you might face.

... and more to come!

Tutorials

• Unlocking the bootloader: docs/unlocking_the_bootloader.md

• Building the application for your platform: docs/building_the_application_for_your_platform.md

• Contributing your own installation configurations: docs/how_to_contribute_your_own_installation_configurations.md

Contributing

All kinds of contributions are welcome. These include and are not limited to:

• Fixing and improving texts in configs and in the application
• Testing the tool for a supported device
• Creating a config for a new device
• Testing the application on your computer and/or device
• Contributing an application build for a new platform
• Adding features and/or improving the codebase
• Reporting bugs

Make sure to check if your issue or PR has already been fixed or implemented before opening a new one!

More sources:

• Details on how to contribute: CONTRIBUTING.md
• More ways to contribute: openandroidinstaller.org/#contribute

Acknowledgements

• The project received financial support from the German Federal Ministry for Education and Research under the grant identifier 01IS22S26 from September 2022 until February 2023.

Credits

• The Android SDK Platform Tools (such as adb and fastboot) are Apache-licensed universal Android utilities
• Heimdall is an MIT-licensed replacement for the leaked ODIN tool to flash Samsung devices.
• libusb-1.0 is a LGPL-2.1-licensed library for USB device access from Linux, macOS, Windows and others.
• copy-partitions-20220613-signed.zip The copy-partitions script was created by LineageOS developer erfanoabdi and filipepferraz and released under LGPL. (It's used when the partitions need to be copied before flashing)

License

Original development by Tobias Sterbak. Copyright (C) 2022-2024.

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see gnu.org/licenses.