Installation on reMarkable

Installation via Toltec

1. Install Toltec (check system version requirements on their website before attempting anything!)
2. Run:

opkg install koreader

• You may also install a launcher

Manual installation on reMarkable 1 & 2 (old firmware with rm2fb)

0. Install rm2fb (reMarkable 2 only; check system version requirements at the link first!)
1. Download the latest release of KOReader
2. Copy the file to your device:

scp koreader-remarkable-* root@10.11.99.1:

3. Log into your device:

ssh root@10.11.99.1

4. Extract the contents of the file:

tar -xf /home/root/koreader-remarkable-*

5. Copy the systemd unit file to the system directory:

cp /home/root/koreader/koreader.service /etc/systemd/system/

6. Launch KOReader:

systemctl start koreader

• To launch KOReader by holding down the middle button for 3 seconds (reMarkable 1):

cp /home/root/koreader/button-listen.service /etc/systemd/system/
systemctl enable --now button-listen

• To launch KOReader at startup:

systemctl disable --now xochitl && systemctl enable --now koreader

• To allow KOReader screensavers for poweroff and reboot events:

systemctl disable remarkable-shutdown remarkable-reboot

Manual Installation on reMarkable 1 & 2 on firmware 3.20 or later

Pre-installation steps

1. Install xovi by using included installation script.
2. Install qt-resource-rebuilder (from the xovi repo), and rm-appload. (copy qtfb-shim.so and qtfb-shim-32bit.so to /home/root/shims, you have to create the directory first)
3. (Re)build hashtab by running:

xovi/rebuild_hashtable

4. Run xovi by running (you must do this every time you reboot your device, or you can automate this by writing systemd service):

xovi/start

Installation steps

1. Download the latest release of KOReader.
2. Copy the file to your device:

scp koreader-remarkable-* root@10.11.99.1:

3. Log into your device:

ssh root@10.11.99.1

4. Extract the contents of the file:

tar -xf /home/root/koreader-remarkable-*

5. Create xovi/exthome/appload folder, and move KOReader into the directory by:

mkdir -p xovi/exthome/appload
mv koreader xovi/exthome/appload/

7. Launch KOReader by opening sidebar, touch "AppLoad", and launch KOReader from the AppLoad menu.

Manual Installation on reMarkable Paper Pro (Move)

Pre-installation steps

1. Install xovi by using included installation script.
2. Install qt-resource-rebuilder (from the xovi repo), and rm-appload. (copy qtfb-shim.so and qtfb-shim-32bit.so to /home/root/shims, you have to create the directory first)
3. (Re)build hashtab by running:

xovi/rebuild_hashtable

4. Run xovi by running (you must do this every time you reboot your device, or you can automate this by writing systemd service):

xovi/start

Installation steps

1. Download the latest release of KOReader (Use the nightly builds for now).
2. Copy the file to your device:

scp koreader-remarkable-aarch64-* root@10.11.99.1:

3. Log into your device:

ssh root@10.11.99.1

4. Extract the contents of the file:

tar -xf /home/root/koreader-remarkable-aarch64-*

5. Create xovi/exthome/appload folder, and move KOReader into the directory by:

mkdir -p xovi/exthome/appload
mv koreader xovi/exthome/appload/

7. Launch KOReader by opening sidebar, touch "AppLoad", and launch KOReader from the AppLoad menu.