Install LineageOS on ivy

keyboard_arrow_left Back to the overview

Warning: These instructions only work if you follow every section and step precisely.
Do not continue after something fails!

Basic requirements

Read through the instructions at least once before actually following them, so as to avoid any problems due to any missed steps!
Make sure your computer has adb and fastboot. Setup instructions can be found here.
Enable USB debugging on your device.
Boot your device with the stock OS at least once and check every functionality.
Warning: Make sure that you can send and receive SMS and place and receive calls (also via WiFi and LTE, if available), otherwise it won’t work on LineageOS either! Additionally, some devices require that VoLTE/VoWiFi be utilized once on stock to provision IMS.
LineageOS is provided as-is with no warranty. While we attempt to verify everything works you are installing this at your own risk!

Unlocking the bootloader

Note: The steps below only need to be run once per device.

Warning: 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). 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. If you wish to backup the TA partition first, you can find tutorials related to your device on the internet.

On the device, dial *#*#7378423#*#* (*#*#SERVICE#*#*) to launch the service menu.
Go to service info > configuration and check rooting status - you can only continue if it says Bootloader unlock allowed: Yes.
Connect the device to your PC via USB.
On the computer, open a command prompt (on Windows) or terminal (on Linux or macOS) window, and type:
```
adb reboot bootloader
```
You can also boot into fastboot mode via a key combination:
- With the device powered off, hold Volume Up and connect the USB cable. The notification light should turn blue.
Once the device is in fastboot mode, verify your PC finds it by typing:
```
fastboot devices
```
Tip: If you see no permissions fastboot while on Linux or macOS, try running fastboot as root.
Follow the instructions on Sony’s official unlocking website to generate an unlock code for your bootloader.
Use your code to unlock the bootloader of your device:
```
fastboot oem unlock <your_unlock_code>
```
Since the device resets completely, you will need to re-enable USB debugging to continue.

Installing a custom recovery using `fastboot`

Download a custom recovery - you can download TWRP. Simply download the latest recovery file, named something like twrp-x.x.x-x-ivy.img.
Important: Other recoveries may not work for installation or updates. We strongly recommend to use the one linked above!
Connect your device to your PC via USB if it isn’t already.
If your device isn’t already in fastboot mode, on the computer, open a command prompt (on Windows) or terminal (on Linux or macOS) window, and type:
```
adb reboot bootloader
```
You can also boot into fastboot mode via a key combination:
- With the device powered off, hold Volume Up and connect the USB cable. The notification light should turn blue.
Once the device is in fastboot mode, verify your PC finds it by typing:
```
fastboot devices
```
If you don’t get any output or an error:
- on Windows: make sure the device appears in the device manager without a triangle. Try other drivers until the command above works!
- on Linux or macOS: If you see no permissions fastboot try running fastboot as root. When the output is empty, check your USB cable and port!
Tip: Some devices have buggy USB support while in bootloader mode, if you see fastboot hanging with no output when using commands such as fastboot getvar ..., fastboot boot ..., fastboot flash ... you may want to try a different USB port (preferably a USB Type-A 2.0 one) or a USB hub.
Flash recovery onto your device (replace <recovery_filename> with the actual filename!):
```
fastboot flash recovery <recovery_filename>.img
```
Now reboot into recovery to verify the installation. Do not reboot into the existing OS, since it will overwrite the recovery you just installed!
- With the device powered off, hold Volume Down + Power.
  
  Note: If you can’t power down the device, try long-pressing the key-combination (if any was used in the instructions above) until the device reboots and follow the instructions above

Installing LineageOS from recovery

Build a LineageOS installation package.
- (Optionally): If you want to install an application package add-on such as Google Apps (use the arm64 architecture), please read and follow the instructions on Google Apps page
If you are not in recovery, reboot into recovery:
- With the device powered off, hold Volume Down + Power.
Now tap Wipe.
Now tap Format Data and continue with the formatting process. This will remove encryption and delete all files stored in the internal storage.
Return to the previous menu and tap Advanced Wipe, then select the Cache and System partitions and then Swipe to Wipe.
Sideload the LineageOS .zip package:
- On the device, select “Advanced”, “ADB Sideload”, then swipe to begin sideload.
- On the host machine, sideload the package using: adb sideload filename.zip.
  Tip: Normally, adb will report Total xfer: 1.00x, but in some cases, even if the process succeeds the output will stop at 47% and report adb: failed to read command: Success. In some cases it will report adb: failed to read command: No error or adb: failed to read command: Undefined error: 0 which is also fine.
(Optionally): If you want to install any add-ons, repeat the sideload steps above for those packages in sequence.

Note: If you want the Google Apps add-on on your device, you must follow this step before booting into LineageOS for the first time!
(Optionally): Root your device by installing LineageOS’ AddonSU, (use the arm64 package) or by using any other method you prefer.
Once you have installed everything successfully, run ‘adb reboot’.

Note: The first boot usually takes no longer than 15 minutes, depending on the device. If it takes longer, you may have missed a step, otherwise feel free to get assistance.

Warning: Depending on which recovery you use, you may be prompted to install additional apps and services. We strongly advise you to opt out of installing these, as they may cause your device to bootloop, as well as attempt to access or corrupt your data.

Get assistance

After you’ve double checked that you followed the steps precisely, didn’t skip any and still have questions or got stuck, feel free to ask on our subreddit or in #LineageOS on Libera.Chat.