History

Evan Reichard 2c90377cf7 All checks were successful continuous-integration/drone/push Build is passing Details [add] wip service worker & offline reader		2023-10-28 20:07:24 -04:00
..
syncninja.koplugin	[add] wip service worker & offline reader	2023-10-28 20:07:24 -04:00
README.md	[add] settings (pw & time offset), [fix] PWA issues, [fix] misc styling issues	2023-09-27 19:14:02 -04:00

README.md

Book Manager - SyncNinja KOReader Plugin

This is BookManagers KOReader Plugin called syncninja.koplugin. Features include:

Syncing read activity
Uploading documents
Configurable sync settings

Installation

Copy the syncninja.koplugin directory to the plugins directory for your KOReader installation. Restart KOReader and SyncNinja will be accessible via the Tools menu.

Configuration

You must configure the BookManager server and credentials in SyncNinja. Afterwhich you'll have the ability to configure the sync cadence as well as whether you'd like the plugin to sync your activity, document metadata, and/or documents themselves.

KOSync Compatibility

BookManager implements API's compatible with the KOSync plugin. This means that you can utilize this server for KOSync (and it's recommended!). SyncNinja provides an easy way to merge configurations between both KOSync and itself in the menu.

The KOSync compatible API endpoint is located at: http(s)://<SERVER>/api/ko. You can either use the previous mentioned merge feature to automatically configure KOSync once SyncNinja is configured, or you can manually set KOSync's server to the above.