Skip to content

Installation on reMarkable

Noa Himesaka edited this page Feb 9, 2026 · 10 revisions

Installation via Vellum

  1. Install Vellum
  2. Run:
vellum install koreader

Installation via Toltec

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

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

  1. Install rm2fb (reMarkable 2 only; check system version requirements at the link first!)
  2. Download the latest release of KOReader
  3. Copy the file to your device:
scp koreader-remarkable-* root@10.11.99.1:
  1. Log into your device:
ssh root@10.11.99.1
  1. Extract the contents of the file:
tar -xf /home/root/koreader-remarkable-*
  1. Copy the systemd unit file to the system directory:
cp /home/root/koreader/koreader.service /etc/systemd/system/
  1. 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
  1. 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:
  1. Log into your device:
ssh root@10.11.99.1
  1. Extract the contents of the file:
tar -xf /home/root/koreader-remarkable-*
  1. Create xovi/exthome/appload folder, and move KOReader into the directory by:
mkdir -p xovi/exthome/appload
mv koreader xovi/exthome/appload/
  1. 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
  1. 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; take care to download the release with aarch64 in the name.
  2. Copy the file to your device:
scp koreader-remarkable-aarch64-* root@10.11.99.1:
  1. Log into your device:
ssh root@10.11.99.1
  1. Extract the contents of the file:
tar -xf /home/root/koreader-remarkable-aarch64-*
  1. Create xovi/exthome/appload folder, and move KOReader into the directory by:
mkdir -p xovi/exthome/appload
mv koreader xovi/exthome/appload/
  1. Launch KOReader by opening sidebar, touch "AppLoad", and launch KOReader from the AppLoad menu.

__* * *** =*** * ** ** ** * # [Installation](https://github.com/koreader/koreader/wiki#installationupgrading)=

  • * =*** * ** ** ** * * [Gestures](https://github.com/koreader/koreader/wiki/KOReader-Gestures)=
  • * =*** * ** ** ** * * [Press](https://github.com/koreader/koreader/wiki/Press-and-hold-function)=
  • * =*** * ** ** ** * * [Frontlight](https://github.com/koreader/koreader/wiki/Light-control)=
  • * =*** * ** ** ** * * [Multiswipe](https://github.com/koreader/koreader/wiki/multiswipes)=
  • * =*** * ** ** ** * * [Gamepad](https://github.com/koreader/koreader/wiki/Gamepad-support)=
  • * =*** * ** ** ** * * [Keymapping](https://github.com/koreader/koreader/wiki/Keymapping)=
  • * =*** * ** ** ** * * [Extended](https://github.com/koreader/koreader/wiki/Extended-keyboard---swipe-to-get-new-characters)=
  • * =*** * ** ** ** * </details>=
  • * =*** * ** ** ** * # [Tips](https://github.com/koreader/koreader/wiki/Tips-and-Tricks)=
  • * =*** * ** ** ** * * [Getting](https://github.com/koreader/koreader/wiki/Getting-Started)=
  • * =*** * ** ** ** * * [Gestures](https://github.com/koreader/koreader/wiki/KOReader-Gestures)=
  • * =*** * ** ** ** * * [Change](https://github.com/koreader/koreader/wiki/Change-defaults)=
  • * =*** * ** ** ** * * [DPI](https://github.com/koreader/koreader/wiki/DPI-control)=
  • * =*** * ** ** ** * * [Style](https://github.com/koreader/koreader/wiki/Style-tweaks)=
  • * =*** * ** ** ** * * [Reflowing](https://github.com/koreader/koreader/wiki/Reflowing-tweaks)=
  • * =*** * ** ** ** * * [Screenshots](https://github.com/koreader/koreader/wiki/KOReader-Screenshots)=
  • * =*** * ** ** ** * * [Troubleshooting](https://github.com/koreader/koreader/wiki/Troubleshooting)=
  • * =*** * ** ** ** * * [Android](https://github.com/koreader/koreader/wiki/Android-tips-and-tricks)=
  • * =*** * ** ** ** * [Features](https://github.com/koreader/koreader/wiki/Features-list)=
  • * =*** * ** ** ** * * [Dictionary](https://github.com/koreader/koreader/wiki/Dictionary-support)=
  • * =*** * ** ** ** * * [Highlight](https://github.com/koreader/koreader/wiki/Highlight-export)=
  • * =*** * ** ** ** * * [OPDS-support](https://github.com/koreader/koreader/wiki/OPDS-support)=
  • * =*** * ** ** ** * * [Progress-sync](https://github.com/koreader/koreader/wiki/Progress-sync)=
  • * =*** * ** ** ** * * [Wikipedia-support](https://github.com/koreader/koreader/wiki/Wikipedia-support)=
  • * =*** * ** ** ** * * [ZIP](https://github.com/koreader/koreader/wiki/ZIP)=
  • * =*** * ** ** ** * # [Plugins](https://github.com/koreader/koreader/wiki/Plugins-overview)=
  • * =*** * ** ** ** * * [Auto](https://github.com/koreader/koreader/wiki/Auto-frontlight)=
  • * =*** * ** ** ** * * [Auto](https://github.com/koreader/koreader/wiki/Auto-Standby)=
  • * =*** * ** ** ** * * [Auto](https://github.com/koreader/koreader/wiki/Auto-suspend)=
  • * =*** * ** ** ** * * [Background](https://github.com/koreader/koreader/wiki/Background-runner)=
  • * =*** * ** ** ** * * [Battery](https://github.com/koreader/koreader/wiki/Battery-statistics)=
  • * =*** * ** ** ** * * [Calibre](https://github.com/koreader/koreader/wiki/calibre)=
  • * =*** * ** ** ** * * [Cover](https://github.com/koreader/koreader/wiki/Cover-browser)=
  • * =*** * ** ** ** * * [Cover](https://github.com/koreader/koreader/wiki/Coverimage)=
  • * =*** * ** ** ** * * [Frontlight](https://github.com/koreader/koreader/wiki/Frontlight-gesture-controller)=
  • * =*** * ** ** ** * * [Goodreads](https://github.com/koreader/koreader/wiki/Goodreads)=
  • * =*** * ** ** ** * * [Highlight](https://github.com/koreader/koreader/wiki/Highlight-export)=
  • * =*** * ** ** ** * * [Japanese](https://github.com/koreader/koreader/wiki/Japanese-Support)=
  • * =*** * ** ** ** * * [Keep](https://github.com/koreader/koreader/wiki/Keep-alive)=
  • * =*** * ** ** ** * * [News](https://github.com/koreader/koreader/wiki/News-downloader)=
  • * =*** * ** ** ** * * [Perception](https://github.com/koreader/koreader/wiki/Perception-Expander-plugin)=
  • * =*** * ** ** ** * * [Progress](https://github.com/koreader/koreader/wiki/Progress-sync)=
  • * =*** * ** ** ** * * [Read](https://github.com/koreader/koreader/wiki/Read-timer) =
  • * =*** * ** ** ** * * [Reading](https://github.com/koreader/koreader/wiki/Statistics-plugin)=
  • * =*** * ** ** ** * * [Send2Ebook](https://github.com/koreader/koreader/wiki/Send2Ebook)=
  • * =*** * ** ** ** * * [SSH](https://github.com/koreader/koreader/wiki/SSH)=
  • * =*** * ** ** ** * * [System](https://github.com/koreader/koreader/wiki/System-statistics)=
  • * =*** * ** ** ** * * [Terminal](https://github.com/koreader/koreader/wiki/Terminal-emulator)=
  • * =*** * ** ** ** * * [Time](https://github.com/koreader/koreader/wiki/Time-sync)=
  • * =*** * ** ** ** * * [Vocabulary](https://github.com/koreader/koreader/wiki/Vocabulary-builder)=
  • * =*** * ** ** ** * * [Wallabag](https://github.com/koreader/koreader/wiki/Wallabag)=
  • * =*** * ** ** ** * [User](https://github.com/koreader/koreader/wiki/User-patches)=
  • * =*** * ** ** ** * * Overview=
  • * =*** * ** ** ** * * Installation=
  • * =*** * ** ** ** * * Available patches=
  • * =*** * ** ** ** * # [Development](https://github.com/koreader/koreader/wiki#hackers)=
  • * =*** * ** ** ** * * Building the emulator=
  • * =*** * ** ** ** * * Coding ** ** ** *** Style=
  • * =*** * ** ** ** * * Development and Debugging on Android=
  • * =*** * ** ** ** * * [How](http://koreader.rocks/doc/topics/Collaborating.html)=
  • * =*** * ** ** ** * * [How](http://koreader.rocks/doc/topics/Porting.md.html)=
  • * =*** * ** ** ** * * [Remote](https://github.com/koreader/koreader-base/wiki/Remote-debugging-with-gdbserver)=
  • * =*** * ** ** ** * * UI Events=
  • * =*** * ** ** ** * # [简体中文](https://github.com/koreader/koreader/wiki/KOReader-Wiki-CN)=
  • * =*** * ** ** ** * * [KOReader](https://github.com/koreader/koreader/wiki/KOReader手势操作)=
  • * =*** * ** ** ** * * [KOReader](https://github.com/koreader/koreader/wiki/KOReader用户手册)=
  • * =*** * ** ** ** * * [在](https://github.com/koreader/koreader/wiki/在Kindle上安装和运行KOReader)=
  • * =*** * ** ** ** * * [在](https://github.com/koreader/koreader/wiki/如何在Kobo上安装KOReader)=
  • * =*** * ** ** ** * * [更改默认设置](https://github.com/koreader/koreader/wiki/更改默认设置)=
  • * =*** * ** ** ** * * [笔画输入法](https://github.com/koreader/koreader/wiki/笔画输入法)=
  • * =*** * ** ** ** * * [更新日志](https://github.com/koreader/koreader/wiki/更新日志)=
  • * =*** * ** ** ** * * [进度同步](https://github.com/koreader/koreader/wiki/进度同步)=
  • * =*** * ** ** ** * * [云盘存储](https://github.com/koreader/koreader/wiki/云盘存储)=

Clone this wiki locally