Add Koreader Integration Page

pages/guides.mdx

@@ -12,4 +12,5 @@ Here you can find walkthroughs and all the various settings of Kavita.
 [Custom Themes](guides/themes/) - How to change the theme that Kavita uses. <br/>
 [Library Scanner](guides/scanner/) - Detailed information on how the scanning process works. <br/>
 [OPDS](guides/opds/) - Information on how the OPDS protocol works within Kavita. <br/>
+[Koreader Integration](guides/koreader) - Instructions on how to sync progress between Kavita and Koreader devices. <br/>
 [API](guides/api/) - Discusses the API and how you can access it to make custom programs or scripts that interface with Kavita. <br/>

pages/guides/koreader.mdx

@@ -0,0 +1,18 @@
+---
+title: Koreader Integration
+---
+
+Kavita supports the Koreader Progress Sync plugin for epubs.
+
+
+Koreader Settings
+Custom server address to 'https://your-kavita.com/api/koreader/{api-key}'.
+Use your username on the login page, but the password can be anything.
+
+It's recommended to use (ODPS)[./odps] to download the desired book to your Koreader, as it will ensure the book is an exact copy of the file hosted on Kavita.
+
+Some Caveats:
+* You must have the book in kavita. Books are determined to be the same if their hashes match. (essentially, they must be an exact copy.)
+* You may need to rescan your library if updating from a previous version that doesn't support koreader progress sync.
+* Kavita only supports progress sync using binary matching. Koreader sets this by default, but if you experience any issues, make sure Binary is selected in the Koreader's document matching method.
+* Kavita does not (and will never) support user registration via Koreader.