Stump Docs

Permission required

This functionality is gated behind the ACCESS_KOBO_SYNC and ACCESS_API_KEYS user permissions. To learn more about permissions, see the permissions guide.

You can automatically sync books to your Kobo device with Stump.

How it works

You can configure your Kobo to retrieve books from Stump, rather than from the Kobo store.

Setup

To set up Kobo sync with Stump, you need to:

Enable the Kobo routes on your Stump instance

Kobo sync is disabled by default. To enable it, you need to set the ENABLE_KOBO_SYNC environment variable to true, or directly set enable_kobo_sync=true in the Stump.toml configuration file.

See the configuration guide for more information.

Create an API key for your Kobo

Permission required

This step requires the ACCESS_API_KEYS user permissions.

This API key will be stored in plaintext on the Kobo.

Navigate to the app settings (/settings)
Click the API keys tab (/settings/api-keys)
Click the Create API key button
Select the ACCESS_KOBO_SYNC and DOWNLOAD_FILE permissions.
Create your key and save the full value after creation

Configure your Kobo to sync with Stump

Connect your Kobo to your computer. On the device there is a file named .kobo/Kobo/Kobo eReader.conf.

Open this file in a text editor. Somewhere in this file will be a line that reads:

api_endpoint=https://storeapi.kobo.com

Edit it to read:

api_endpoint=http(s)://your-server(:{port})(/{baseUrl})/kobo/{api_key}

For example:

api_endpoint=http://192.168.4.100:10801/kobo/98765432109876543210876543210987

Future improvements

The current implementation is very basic. It does not support:

syncing read progress in either direction
converting EPUBs to KEPUBs: page turns take significantly longer with an EPUB
proxying to the Kobo store: if you point your device at Stump, you will not be able to sync books from the Kobo store
selecting which books should be synced to the Kobo: all EPUBs available to a user will be synced to the Kobo

Kobo Sync