MarcoBuster/Magisk
1
1
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
1ad7a6fe93
Magisk/docs/install.md
topjohnwu d80c6b42a6 Update README
2020-10-03 04:28:43 -07:00

10 KiB
Raw Blame History

Installation

If you already have Magisk installed, it is strongly recommended to upgrade directly via Magisk Manager using the "Direct Install" method. The following tutorial is only for initial installation.

Getting Started

Before you start:

  • This tutorial assumes you understand how to use adb and fastboot
  • Your device's bootloader has to be unlocked
  • Make sure to remove any "boot image mods" such as other root solutions before installing Magisk. The easiest way is to restore the boot image with factory images, or reflash a non-prerooted custom ROM
  • If you plan to also install custom kernels, install it after Magisk

Download and install the latest Magisk Manager. We use the app to gather some information about your device. In the home screen, you should see this:

Pay special attention to the Ramdisk info. If the result is Yes, congratulations, your device is perfect for installing Magisk! However, if the result is No, this means your device's boot partition does NOT include ramdisk, and unfortunately you would have to go through some hoops to make Magisk work properly.

If your device does not have boot ramdisk, read the Magisk in Recovery section after installing. The information in that section is VERY important!

If you are using a Samsung device and the SAR result is Yes, please check its own section.

If you are using a Huawei device and the SAR result is Yes, please check its own section.

Otherwise, continue to Patching Images.

(P.S.1 If your device have boot ramdisk, you can also install with Custom Recovery)
(P.S.2 If you are interested in how Android boots and how it affects Magisk, check out this document)

Patching Images

If your device have boot ramdisk, you need a copy of the boot.img
If your device does NOT have boot ramdisk, you need a copy of the recovery.img

You should be able to extract either of them from official firmware packages, your custom ROM zip (if using one), or go to XDA-Developers and seek for resources, guides, discussions, or ask for help in your device's forum.

  • Copy the boot/recovery image to your device
  • Press the Install button in the Magisk card
  • If you are patching a recovery image, make sure "Recovery Mode" is checked in options.
    In most cases it should already be automatically checked.
  • Choose "Select and Patch a File" in method, and select the stock boot/recovery image
  • Magisk Manager will patch the image to [Internal Storage]/Download/magisk_patched.img.
  • Copy the patched image to your PC with ADB:
    adb pull /sdcard/Download/magisk_patched.img
  • Flash the patched boot/recovery image to your device.
    For most devices, reboot into fastboot mode and flash with command:
    fastboot flash boot /path/to/magisk_patched.img or
    fastboot flash recovery /path/to/magisk_patched.img if flashing a recovery image
  • Reboot and voila!

Custom Recovery

In some custom recoveries of modern devices, the installer scripts either cannot properly detect the correct device info, or the recovery environment does not meet its expectation, causing the installation to fail (or looks like success but actually bootloops). If you face any issues, use the Patch Image method as it is guaranteed to work 100% of the time. Due to this reason, we no longer recommend installing Magisk through custom recoveries on modern devices. The custom recovery installation method exists mostly for legacy support.

  • Download the Magisk installer zip
  • Reboot to custom recovery
  • Flash the zip and reboot
  • Check whether Magisk Manager is installed. If it isn't installed automatically, manually install the APK.

Magisk in Recovery

If your device does not have ramdisk in boot images, Magisk has no choice but to be installed in the recovery partition. For these devices, you will have to reboot to recovery every time you want Magisk.

When Magisk is installed in your recovery, you CANNOT use custom recoveries to install/upgrade Magisk! The only way to install/upgrade Magisk is through Magisk Manager. The app will be aware of your device state and install to the correct partition and reboot into the correct mode.

Since Magisk now hijacks the recovery of the device, there is a mechanism to let you actually boot into recovery mode when needed: it is determined by how long you press volume up.

Each device has its own key combo to boot into recovery, as an example for Galaxy S10 it is (Power + Bixby + Volume Up). A quick Google search should easily get you this info of your device. As soon as you press the combo and the device vibrates with a splash screen, release all buttons to boot into Magisk. If you decide to boot into actual recovery mode, continue to press volume up until you see the recovery screen.

After installing Magisk in recovery (starting from power off):

  • (Power up normally) → (System with NO Magisk)
  • (Recovery Key Combo) → (Splash screen) → (Release all buttons) → (System with Magisk)
  • (Recovery Key Combo) → (Splash screen) → (Keep pressing volume up) → (Recovery Mode)

Samsung (System-as-root)

If your device is NOT launched with Android 9.0 or higher, you are reading the wrong section.

Before Installing Magisk

  • Installing Magisk WILL trip KNOX
  • Installing Magisk for the first time REQUIRES a full data wipe (this is NOT counting the data wipe when unlocking bootloader). Backup your data before continue.

Unlocking Bootloader

Unlocking BL on modern Samsung devices have some caveats, so I figure this would be helpful.

  • Allow bootloader unlocking in Developer options → OEM unlocking
  • Reboot to download mode: reboot and press the download mode key combo for your device.
  • Long press volume up to unlock the bootloader. This will wipe your data and automatically reboot.

If you think the bootloader is fully unlocked, it is actually not! Samsung introduced VaultKeeper, meaning the bootloader will still reject any unofficial partitions before VaultKeeper explicitly allows it.

  • Go through the initial setup. Skip through all the steps since data will be wiped again later when we are installing Magisk. Connect the device to Internet during the setup.
  • Enable developer options, and confirm that the OEM unlocking option exists and is grayed out. This means the VaultKeeper service has unleashed the bootloader.
  • Your bootloader now accepts unofficial images in download mode.

Instructions

  • Use either Frija or Samloader to download the latest firmware zip of your device directly from Samsung servers.
  • Unzip the firmware and copy the AP tar file to your device. It is normally named as AP_[device_model_sw_ver].tar.md5
  • Press the Install button in the Magisk card
  • If your device does NOT have boot ramdisk, make sure "Recovery Mode" is checked in options.
    In most cases it should already be automatically checked.
  • Choose "Select and Patch a File" in method, and select the AP tar file
  • Magisk Manager will patch the whole firmware file to [Internal Storage]/Download/magisk_patched.tar
  • Copy the patched tar file to your PC with ADB:
    adb pull /sdcard/Download/magisk_patched.tar
    Do NOT use MTP as it is reported to corrupt files.
  • Reboot to download mode. Open Odin on your PC, and flash magisk_patched.tar as AP, together with BL, CP, and CSC (NOT HOME_CSC because we want to wipe data) from the original firmware.
  • After Odin is done, your device should reboot. You may continue with standard initial setup.
  • If your device does NOT have boot ramdisk, reboot to recovery now to boot Android with Magisk (reason stated in Magisk in Recovery).
  • Although Magisk is installed, it still need some additional setup. Please connect to the Internet.
  • Install the latest Magisk Manager and open the app. It should show a dialog asking for additional setups. Let it do its job and the app will automatically reboot your device.
  • Voila! Enjoy Magisk 😃

Additional Notes

  • Never, ever try to restore either boot or recovery partitions back to stock! You can easily brick your device by doing so, and the only way out is to do a full Odin restore with data wipe.
  • To upgrade your device with a new firmware, NEVER directly use the stock AP tar file with reasons mentioned above. Always pre-patch AP in Magisk Manager before flashing in Odin.
  • Use HOME_CSC to preserve your data when doing a firmware upgrade. Using CSC is only necessary for the initial installation.
  • Never just flash only AP, or else Odin can shrink your /data filesystem. Flash full AP + BL + CP + HOME_CSC when upgrading.

Huawei

Magisk no longer officially support modern Huawei devices as the bootloader on their devices are not unlockable, and more importantly they do not follow standard Android partitioning schemes. The following are some general guidance for the few who managed to unlock their bootloader and really want to root it.

Huawei devices using Kirin processors have a different partitioning method from most common devices. Magisk is usually installed to the boot partition of the device, however Huawei devices do not have this partition.

Generally, follow Patching Images with some differences from the original instructions:

  • After downloading your firmware zip (you may find a lot in Huawei Firmware Database), you have to extract images from UPDATE.APP in the zip with Huawei Update Extractor (Windows only!)
  • Regarding patching images:
    • If your device has boot ramdisk, patch RAMDISK.img instead of boot.img
    • If your device does NOT have boot ramdisk, patch RECOVERY_RAMDIS.img (this is not a typo) instead of recovery.img
  • When flashing the image back with fastboot
    • If you patched RAMDISK.img, flash with command fastboot flash ramdisk magisk_patched.img
    • If you patched RECOVERY_RAMDIS.img, flash with command fastboot flash recovery_ramdisk magisk_patched.img