Kavita-Database-Migration

Codex_Migration.py

Codex to Kavita reading progress migration.

Usage: python Codex_Migration.py --codex-db /path/to/codex.sqlite --kavita-db /path/to/kavita.db --username "KavitaUsername" --codex-user "CodexUsername"

I highly recommend running with --dry-run and --report report.txt together so you get an idea of what will happen. If you need to map libraries between different mount points, then use --path-map (old=new) to get the script to look at different mounts.

ComicRack_Migration.py

ComicRack to Kavita Migration Script

This script migrates reading progress from ComicRack XML database to Kavita database. ComicRack stores its data in XML format, typically in ComicDB.xml file.

The script matches comics by:

• Series name (normalized)
• Volume number/year
• Issue/Chapter number

A ComicRack series name is usually ambiguous on its own ("Avengers" has dozens of runs). Candidates are therefore hard-gated on actually containing the issue number, then scored on how well the run identity lines up. Ambiguous ties are reported.

Usage: python ComicRack_Migration.py --comicrack-xml /path/to/ComicDB.xml --kavita-db /path/to/kavita.db --username "KavitaUsername"

Kavita_Migrate_Progress.py

This is mainly for taking a really old install of Kavita and migrating to a brand new install As with the other 2 scripts, I suggest running with --dry-run and --report report.txt together.

It isn't the most straight forward process, but you need to start up a brand new fresh instance and add your libraries and let Kavita scan in the initial ingest.

Usage: python Kavita_Migrate_Progress.py --old-db /path/to/old/kavita.db --new-db /path/to/new/kavita.db [--dry-run] [--report]

Requirements: - Python 3.7+ - No external dependencies

---

This script migrates users and their progress events / settings from an old Kavita database to a new Kavita database. It handles user accounts, reading progress, bookmarks, reading sessions, and other user-related data.

The migration script allows you to:

• Transfer user accounts from an old Kavita database to a new one
• Migrate user preferences and settings
• Transfer reading progress and bookmarks
• Migrate reading sessions and history
• Map content between old and new libraries

This is useful when:

• Setting up a new Kavita instance with reorganized libraries
• Consolidating multiple Kavita instances
• Recovering from database corruption
• Migrating to a new server with different file paths

There is some steps to make this script work or run properly:

1. Shut down your old install of Kavita that has all your historical data in it.
2. Move your database out of Kavita's config folder and put it in a safe location.
3. Start up your fresh new instance of Kavita you will be migrating to
4. Create the new admin user
5. Add back your libraries you want your instance to have. Use the same names as they had before, but they don't have to be in the same locations. -ie; If your old instance had a "Manga" library, the new instance should be "Manga"
6. Once the scan finishes, shut down the new instance.
7. Move the new instance database to the local machine where the script resides
8. Run the script and point it at both files.
9. Watch as it maps the libraries, then the files, then asks you what users you want to move over.
10. Once it is completed your new Kavita database will have the mapped progress and read events in it.
11. Take your new database file and put it back in your new Kavita instance
12. Start Kavita.

Do NOT run this script over the network or SMB share. Both databases must be local files.

What Gets Migrated

User Account Data

• Username and email
• Password hash (user can log in with same password)
• User roles (Admin, User, etc.)
• Library Access: Access to the same libraries (if they exist in new database)
• API Keys: OPDS and integration API keys for external applications
• Age restrictions
• External service tokens (AniList, MAL)
• Profile settings

Reading Data

• Progress Events: Pages read per chapter
• Bookmarks: Saved pages with thumbnails
• Reading Sessions: Time spent reading
• Reading History: Daily reading statistics
• Ratings: Series and chapter ratings
• Reviews: User reviews of series

What Doesn't Get Migrated (But might in the future)

• Reading Lists (user-created)
• Collections (user-created)
• Want to Read lists
• Annotations/highlights