mirror of
https://github.com/advplyr/audiobookshelf.git
synced 2026-05-30 23:40:40 +02:00
[Enhancement]: Ignore file similar to .gitignore and .plexignore #1042
Assignees
adam (Adam Melkus)
Clear assignees
adam (Adam Melkus)
No Assignees
Notifications
Due Date
No due date set.
Dependencies
No dependencies set.
Reference: starred/audiobookshelf#1042
Reference in New Issue
Block a user
Delete Branch "%!s()"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Originally created by @hypnotoad08 on GitHub (Apr 1, 2023).
Describe the feature/enhancement
This is a minor feature request as it doesn't affect functionality. I noticed that the Library files section for some of the audiobook files I have moved to my shared Audiobook folder on my Synology NAS are showing some hidden files/folders that are created by the NAS. Can the Library files section filter out these hidden files/folders?
@CLHatch commented on GitHub (Apr 2, 2023):
This is handled by Plex with
.plexignorefiles that can be created to specify patterns of files/folders to be ignored. Something similar could be created for ABS. https://support.plex.tv/articles/201381883-special-keyword-file-folder-exclusion/@CLHatch commented on GitHub (Apr 2, 2023):
SyncThing has a similar file you can use to set files/folders to ignore.
@advplyr commented on GitHub (Apr 2, 2023):
You can use a
.ignorefile@raphpa commented on GitHub (Apr 14, 2023):
It is a little bit more complicated with the
@eaDirfolder. The NAS creates it automatically in every folder with media in it. So if you have your library sorted in subfolders you would have to manually put the.ignorefile manually into every single one of them.A global ignore option would be great for this case, especially if you autopopulate your library.
@hypnotoad08 commented on GitHub (Apr 14, 2023):
Yes I was hoping for a global fix
@theolike commented on GitHub (Apr 24, 2023):
Agreed. It has to be a configurable global filter. While this one is specifically a Synology quirk, there are many other systems that use a similar process for indexing, thumbnails, etc. For example, Windows and it's thumbs.db files. I haven't been through the indexer code yet (and I guess I should do that), but is there already filter logic in it, even if for only a hard coded list?
(Also, no matter what kind of spoon you are, "Journey before destination", Radiant.)
@CLHatch commented on GitHub (Apr 24, 2023):
Yeah, I actually just had to add an "ignore" option for one other folder in my SyncThing shares. I noticed that
.@__thumbfolders kept appearing in folders. It contained thumbnails of various sizes. Ends up, someone else in the share has a QNAP, it creates them. Added(?d).@__thumb, and all good (the(?d)tells SyncThing it's ok to delete the files if it's needed to delete the parent folder. Obviously flags like that aren't needed for ABS.)@DDriggs00 commented on GitHub (Jul 10, 2023):
Additionally, when deleting an item from the library only (not filesystem), it would be useful to add an option to create an ignore file on the offending directory.
@iconoclasthero commented on GitHub (Sep 17, 2023):
mpd also has this and it would be useful to have .absignore similar to .mpdignore
@nichwall commented on GitHub (Dec 9, 2023):
Doing a bit of research tonight looks like
node-ignoremay be a useful package for adding an ignore list. Just putting this here for reference. I couldn't find many resources for creating ignore list functionality (just kept getting references of how to use gitignore, plexignore, etc, not actual implementations)https://github.com/kaelzhang/node-ignore
Edit to add: To add this to the UI, I think this would fit best as a new tab on library settings (so library specific ignores and only one set of ignores per library). There can either be a few default values with a "reset to defaults button", or a link to some documentation with some "good default values" that users need to manually enter. Similar to the SyncThing interface as mentioned before.
@rage1337 commented on GitHub (Dec 28, 2023):
Found a workaround for my use case (described here):
This approach helps me to exclude my workfolder: Stackoverflow
Added the line
- /audiobooks/_the to the volume config of my docker-compose.yml
The folder is there, but empty inside the container.
@iconoclasthero commented on GitHub (Apr 5, 2024):
I think i put a FR in for this. I don't know what's going on above, but I could use this right now. Also, I'd want to behave the way that .mpdignore behaves so I could put
tmpin .absignore in the root of the library and be done with it.@chinajuanbob commented on GitHub (Dec 31, 2024):
Any updates or solution for this? Thx!
@nichwall commented on GitHub (Feb 24, 2025):
2.19.5 updated the ignore list. There is still not a user configurable option, but the framework is there to more easily add vendor specific folders and extensions.
https://github.com/advplyr/audiobookshelf/pull/4031
@SAS-1 commented on GitHub (Feb 24, 2025):
Nice one kicked off a scan and all the eadir is gone.
@thrandale commented on GitHub (Mar 17, 2026):
It's better now, but I'd still love to see the ability to specify a
.ignorefile in the base library directory, with the contents being what I'd like to ignore. Following the format of something like a.gitignore. Some example usecases:#recyclenot.recycle, meaning it isn't ignored.temp....wavfiles that I would like to be able to ignore.