Skip to content

Add KOReader Sync Server (kosync)#36

Merged
riccjohn merged 6 commits into
mainfrom
add-koreader-sync-server
Apr 20, 2026
Merged

Add KOReader Sync Server (kosync)#36
riccjohn merged 6 commits into
mainfrom
add-koreader-sync-server

Conversation

@riccjohn
Copy link
Copy Markdown
Owner

Summary

  • Adds ghcr.io/nperez0111/koreader-sync:v0.0.1 service to the stack so KOReader devices can sync reading progress to https://kosync.woggles.work without relying on the public sync.koreader.rocks service
  • Wires KOSYNC_PASSWORD_SALT env var (required for account creation; no empty-default fallback so startup fails loudly if unset)
  • Surfaces the service on the Homepage dashboard under the Reading category alongside Wallabag

Test Plan

  • ./scripts/lint-config.sh exits 0 (verified locally — all HOMEPAGE_VAR and .env.example checks pass)
  • docker compose config --quiet exits 0 (verified locally)
  • On server: add KOSYNC_PASSWORD_SALT=$(openssl rand -hex 32) to .env, then docker compose pull && docker compose up -d kosync
  • Verify https://kosync.woggles.work is reachable and GET /health returns 200
  • In KOReader app: Settings → Progress sync → Custom sync server → https://kosync.woggles.work → Register

🤖 Generated with Claude Code

riccjohn and others added 6 commits April 19, 2026 18:50
Adds ghcr.io/nperez0111/koreader-sync:v0.0.1 so KOReader devices can
sync reading progress to https://kosync.woggles.work without relying on
the public sync.koreader.rocks service.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Follows the same pattern as WALLABAG_SECRET generation.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
v0.0.1 tag does not exist on GHCR; only latest is published.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Remove icon and clarify description since there is no web UI.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@riccjohn riccjohn merged commit e366f7a into main Apr 20, 2026
1 check passed
@riccjohn riccjohn deleted the add-koreader-sync-server branch April 20, 2026 00:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant