Release 2026.06.0

If you are running any version of KOsync before 2026.05.0, you MUST update to 2026.05.0 first!
Do NOT update from before 2026.05.0 to this version (2026.06.0), otherwise you will have an empty database.

Added

• Extensive Debug Logging
• Write to Logfile and Logfile path settings
• Experimental WebSocket API with RPC and PubSub
• WebUI updates automatically upon progress sync (PubSub)
• JSON Web Tokens for Authorization: Bearer
• New Environment Variables:
  • LOG_TO_FILE: Enable writing logs to a file.
  • LOG_FILE: Path to the log file (defaults to ./kosync.log)
  • ENABLE_WEBSOCKET_API: Enable WebSocket API for WebUI (RPC/PubSub)
  • PRINT_CRYPTO_KEYS: Print JWT Keys in PEM format at startup
  • CRYPTO_KEYS_SEED: 32-Character Seed for JWT Keys (will be random if unset or empty)
  • JWT_DURATION: JWT validity duration in seconds (defaults to 6 hours)
• Automatic backups before applying migrations
• --restore Argument to restore the database (see doc/backup.md for details)

Changed

• Migrated to Fiber v3
• Updated Go to 1.25.7
• Updated Bun to 1.3.9
• Updated dependencies
• last_read_at is now a float for sub-seconds
• WebUI uses JWT instead of username+password_hash
• WebUI login is time-bound. JWT's expire after JWT_DURATION seconds AND after KOsync restart (unless a CRYPTO_KEYS_SEED is set)
• BREAKING: Environment Variables have been renamed:
  • ENABLE_IP_VALIDATION -> PROXY_IP_VALIDATION
• BREAKING: The docker image no uses 1000:1000 as user instead of root:root

Removed

• BREAKING: Migration from database.json to kosync.db

Fixed

• Unique constraint dead-lock between documents and document_history with multiple causes

Docker Image
docker.obth.eu/atjontv/kosync:2026.06.0

Release 2026.05.0

• New SQLite database (kosync.db)
• New Environment configuration mechanism (kosync.env)
• Automatic database.json to kosync.db migration
• Automatic database.json to kosync.env migration
• Removal of backup and restore mechanism (stop KOsync and copy/replace the kosync.db)

Docker Image
docker.obth.eu/atjontv/kosync:2026.05.0

Release 2026.04.1

• Fix Pretty Name getting lost on progress push

Docker Image
docker.obth.eu/atjontv/kosync:2026.04.1

Release 2026.04.0

• Simple WebUI for viewing read progress
• Via the WebUI a Pretty Name can be set for Documents
• Fixes a bug that database migrations would not be persisted if no sync push happened before restart, causing endless backups
• New CI validation staticcheck
• Documentation improvements

Docker Image
docker.obth.eu/atjontv/kosync:2026.04.0

Release 2026.03.1

• Fix progress push being broken
• Fix wrong backup file name
• Return the same HTTP Status Code as KORSS for registration-disabled response
• Add backup_on_startup feature as alternative to always starting KOsync with --backup

Docker Image
docker.obth.eu/atjontv/kosync:2026.03.1

Release 2026.03.0

• Rewrote the HTTP Handler parts for fiber
• Refactored code to make use of fiber features
• Improved documentation
• Database Restore and manual Backup feature
• Alternative Database Backup encoding with msgpack (default)
• Docker compose.yml and Caddy Caddyfile for deployment
• Add GitLab CI integration
• Introduce SAST (Static Application Security Testing) powered by Bearer
• Introduce License validation powered by WWHRD
• Fixed issues found by SAST

Docker Image
docker.obth.eu/atjontv/kosync:2026.03.0

Release 2026.02.0

• Config store_history to create a document progress history
• Database schema for database schema migrations

The progress history is currently unused, but I have plans to use them for reading analytics at a later date.

Docker Image
docker.obth.eu/atjontv/kosync:2026.02.0

Release 2026.01.1

• Refactored the server for readability with documentation comments
• Changed database.json to have all config entries in a config object
• New config -> enable_debug_log configuration to enable/disable the debug logs

Docker Image
docker.obth.eu/atjontv/kosync:2026.01.1

Release 2026.01.0

Initial Release

This is the first release of KOsync, a KOReader compatible Progress Sync Server written in pure Go without any dependencies other than the Go standard library.

Docker Image
docker.obth.eu/atjontv/kosync:2026.01.0