Installation

Before you start, go through Prerequisites and Backing up your device, and extract the image as described in Downloads.

There are two ways to install RestlessOS: from a custom recovery (TWRP / OrangeFox) or with fastboot. Both erase all data on the device, including internal storage.

Method 1: TWRP / OrangeFox

You need a patched vbmeta.img, see Patching vbmeta.

1. Boot into recovery.

2. Go to Wipe > Format Data, type yes and confirm. This removes encryption and erases internal storage.

3. Go to Reboot > Recovery, so /data is mounted again.

4. Copy the image to the device. Internal storage was just formatted, so copy it now:

   adb push RestlessOS-arm64-ab-<version>.img /sdcard/

   An SD card or USB OTG drive works too.

5. Go to Install > Install Image, select the patched vbmeta.img and flash it to Vbmeta.

6. Go to Install > Install Image, select the RestlessOS .img and flash it to System Image.

7. Reboot to system. The first boot takes longer than usual.

If the recovery reports there is not enough space for the system image, use the fastboot method.

Method 2: Fastboot

1. Install ADB and fastboot

Windows: download SDK Platform-Tools, extract it and open a terminal inside the platform-tools folder.

macOS:

brew install --cask android-platform-tools
# or with MacPorts
sudo port install android-platform-tools

Linux:

sudo apt install adb fastboot            # Debian / Ubuntu
sudo pacman -S android-tools             # Arch
sudo dnf install android-tools           # Fedora

Distro packages can be outdated. If flashing fails, use the official Platform-Tools instead.

2. Boot into fastbootd

system is a logical partition, so everything is flashed from fastbootd, not from the bootloader:

adb reboot fastboot
fastboot getvar is-userspace

is-userspace: yes means you're in fastbootd. If you're in the bootloader instead, run fastboot reboot fastboot. Some devices also have an Enter fastboot option in their stock recovery.

3. Flash vbmeta with verification disabled

fastboot --disable-verity --disable-verification flash vbmeta vbmeta.img

Use the vbmeta.img from your current stock firmware. fastboot disables verification while flashing, see Patching vbmeta. Skip this step if your vbmeta is already patched.

4. Flash the system image

fastboot erase system
fastboot flash system RestlessOS-arm64-ab-<version>.img

If flashing fails with a "not enough space" error, delete the product partition of the active slot and flash again:

fastboot delete-logical-partition product_a     # product_b on slot b, product on A-only devices

5. Format data and reboot

fastboot -w
fastboot reboot

fastboot -w formats userdata and erases internal storage. The first boot takes longer than usual.

After installing

To update without wiping data, see Updating. If something doesn't work, see Reporting issues and logs.