Koodo Reader

Getting Started

Learn how Koodo Reader stores data, syncs across devices, deploys the web version, and which version to install.

How sync works

Koodo Reader is local-first: your books and reading data stay on your device unless you enable sync. Sync can use cloud storage, WebDAV, object storage, or a self-hosted Docker server. See Using the Sync Feature for setup instructions.

Where Koodo Reader stores your data

Desktop

Open Settings > Data and click the locate button next to the storage location option. This opens your library folder in the file manager.

Web

If you use a Chromium-based browser such as Chrome or Edge, you will be asked to choose a data storage location on your first visit. You can save data in a local folder or in the browser cache. Other browsers store data in the browser cache only.

Back up your data

Browser caches may be cleared automatically when they exceed a certain size, which can cause data loss. Back up your data regularly, or upgrade to the Pro version to sync it to cloud storage, WebDAV, object storage, or Docker.

Mobile

Your data is stored in the application data folder assigned to Koodo Reader by the operating system. This folder is usually not directly accessible. To clear the cache or delete all data, open Settings and scroll to the bottom.

Deploy the web version

Download the repository, install Node.js and Yarn, then run the following commands in the project root:

yarn
yarn build

The build folder contains the static files for deployment. Upload its contents to your web server's document root.

Back up to Synology WebDAV

  1. Install the WebDAV Server package in Synology DSM and enable HTTP.

  2. Set the user permissions for the shared folder you want to use to Read/Write.

  3. In Koodo Reader, enter the server address in this format:

    http://[NAS-IP-or-domain]:[WebDAV-port, default 5005]/[shared-folder-name]
  4. Enter your Synology username and password.

Only English folder paths are supported. Use a shared folder with an English name.

Contact the developer

Visit Support to contact the developer or report an issue.

Roadmap

See the Roadmap for the features we are working on and what is planned next.

Stable vs. developer version

Koodo Reader provides two download options on GitHub: the stable version and the developer version.

  • Stable version: released after the developer version has received enough testing and fixes. It is the best choice for most users.
  • Developer version: receives new features and bug fixes first, but may contain unknown bugs. It is only available from GitHub Releases.

Regular users only receive stable updates. If you want the latest features and fixes and can tolerate occasional bugs, try the developer version. Otherwise, stay on the stable version and wait for the update notification.

Download the developer version

Open the Download page and choose the developer build for your platform. Developer builds are also published on the GitHub Releases page.

On this page