Skip to content

Commit

Permalink
docs: add KOReader document matching method
Browse files Browse the repository at this point in the history
  • Loading branch information
gotson committed Jan 13, 2025
1 parent cd7cf71 commit 0812c6b
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 5 deletions.
23 changes: 18 additions & 5 deletions website/docs/guides/koreader.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,24 +22,37 @@ If you have multiple KOReader devices, it is recommended to use a different API

### Setup KOReader

#### Custom Sync Server

1. In the KOReader menu, go to _Progress sync_.
<img src="/assets/media/guides/koreader/koreader-progress-sync-menu.png" style={{maxHeight: '200px'}} alt="Progress sync menu in KOReader"/>
<img src="/assets/media/guides/koreader/koreader-progress-sync-menu.png" style={{maxHeight: '200px'}} alt="KOReader configuration menu"/>

2. Click on _Custom sync server_.
<img src="/assets/media/guides/koreader/koreader-custom-sync-server.png" style={{maxHeight: '70px'}} alt="Progress sync menu in KOReader"/>
<img src="/assets/media/guides/koreader/koreader-custom-sync-server.png" style={{maxHeight: '70px'}} alt="KOReader progress sync menu"/>

3. Enter your server address, following with `/koreader`. For example: `https://demo.komga.org/koreader`
3. Enter your Komga server address, followed by `/koreader`. For example: `https://demo.komga.org/koreader`

4. Click on _Register / Login_.
<img src="/assets/media/guides/koreader/koreader-sync-server-login.png" style={{maxHeight: '100px'}} alt="Progress sync menu in KOReader"/>
<img src="/assets/media/guides/koreader/koreader-sync-server-login.png" style={{maxHeight: '100px'}} alt="KOReader progress sync menu"/>

5. In the _Register/login_ dialog, input the following:
<img src="/assets/media/guides/koreader/koreader-sync-server-login-dialog.png" style={{maxHeight: '180px'}} alt="Progress sync menu in KOReader"/>
<img src="/assets/media/guides/koreader/koreader-sync-server-login-dialog.png" style={{maxHeight: '180px'}} alt="KOReader sync server login dialog"/>
- _username_: the Komga API key
- _password_: any dummy value, this field is not used by Komga

6. Click on _Login_.

#### Document Matching Method

1. In the KOReader menu, go to _Progress sync_.
<img src="/assets/media/guides/koreader/koreader-progress-sync-menu.png" style={{maxHeight: '200px'}} alt="KOReader configuration menu"/>

2. Click on _Document matching method_.
<img src="/assets/media/guides/koreader/koreader-progress-sync-menu-2.png" style={{maxHeight: '250px'}} alt="KOReader progress sync menu"/>

3. Select _Binary_.
<img src="/assets/media/guides/koreader/koreader-matching-method.png" style={{maxHeight: '100px'}} alt="KOReader document matching method options"/>

## Troubleshooting

### Komga logs
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 0812c6b

Please sign in to comment.