Rename metadata.json files to something less generic, and add a "file format version" of some sort in the file #612

New Issue

2026-04-24T23:29:57+02:00

adam commented

2026-04-24 23:29:57 +02:00

Originally created by @CLHatch on GitHub (Jul 2, 2023).

Is your feature request related to a problem? Please describe.

Currently, when storing metadata alongside the books, it uses the filename metadata.json. This is a very generic name, and I know of at least one other app that uses that same name. This could cause an issue where the file gets over-written by another app at some point. Also (sort of a second feature request, but somewhat related), there should be a field in the file saying what "file format version" the file is. This could tell people looking at the contents of the file that it is for audiobookshelf, and also help you later if you need to migrate to a new file format. I believe the old metadata.abs files had something like this in a comment at the top of the file.

Describe the solution you'd like

Change the filename used to something like absmetadata.json, or metadata_abs.json, etc. For the second part, just add a field in the file saying it's for audiobookshelf and have some sort of "version number" that would help you down the line with migration (or even to check to be sure it IS for audiobookshelf to begin with before you do anything with it.

Describe alternatives you've considered

None, other than being careful that I don't run a program that will over-write the files.

Originally created by @CLHatch on GitHub (Jul 2, 2023). ### Is your feature request related to a problem? Please describe. Currently, when storing metadata alongside the books, it uses the filename `metadata.json`. This is a very generic name, and I know of at least one other app that uses that same name. This could cause an issue where the file gets over-written by another app at some point. Also (sort of a second feature request, but somewhat related), there should be a field in the file saying what "file format version" the file is. This could tell people looking at the contents of the file that it is for `audiobookshelf`, and also help you later if you need to migrate to a new file format. I believe the old `metadata.abs` files had something like this in a comment at the top of the file. ### Describe the solution you'd like Change the filename used to something like `absmetadata.json`, or `metadata_abs.json`, etc. For the second part, just add a field in the file saying it's for `audiobookshelf` and have some sort of "version number" that would help you down the line with migration (or even to check to be sure it IS for audiobookshelf to begin with before you do anything with it. ### Describe alternatives you've considered None, other than being careful that I don't run a program that will over-write the files.

adam added the enhancement label 2026-04-24 23:29:57 +02:00

adam closed this issue

2026-04-24 23:29:58 +02:00

adam commented

2026-04-24 23:29:59 +02:00

@CLHatch commented on GitHub (Jul 2, 2023):

Requested in wrong repo. Re-requested in the server repo.

@CLHatch commented on GitHub (Jul 2, 2023): Requested in wrong repo. Re-requested in the server repo.

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: starred/audiobookshelf-app#612

Rename metadata.json files to something less generic, and add a "file format version" of some sort in the file #612

Is your feature request related to a problem? Please describe.

Describe the solution you'd like

Describe alternatives you've considered

Rename `metadata.json` files to something less generic, and add a "file format version" of some sort in the file #612