dexperix/abs-opds repository overview

⁠abs-opds

Audiobookshelf Custom Metadata Provider for OPDS⁠ book catalogs. Usually, OPDS is a catalog of ebooks - actual text books, without audio. But it might be a good fallback for a metadata like cover, description etc. abs-opds supports both remote and locally hosted on your server OPDS catalogs. inpx-web⁠ OPDS server is supported.

Paper books have rectangular covers by default. abs-opds.php could make them square for you.

GitHub: DeXP/abs-opds⁠

⁠Supported fields:

• Cover
• Title
• Author
• Genres
• Description

⁠Installation via Docker

If you don't have a server with PHP, you can use alternative installation method: Docker. docker-composite example:

services:
  abs-opds:
    image: dexperix/abs-opds:latest
    container_name: abs-opds
    restart: unless-stopped
    ports:
      - 8000:8000

You don't need to put abs-opds.php into your URL in that case - the functionality will be served directly at exposed port's root.

⁠Basic Usage

Add a new custom metadata provider in Audiobookshelf settings. URL template:

https://your-server.com/your-path/abs-opds.php?opds=OPDS_URL&do=

Use correct URL of your server and put actual URL instead of OPDS_URL. Example:

http://192.168.0.1/metadata/abs-opds.php?opds=https://flibusta.is/opds&do=

If you use Docker, or renamed the file to index.php, the URL can look like:

https://your-server.com/?opds=OPDS_URL&do=

⁠Cover cropping

Add crop parameter with value: top, bottom, left, right or center.

Another optional parameter is skip with values from 0 to 100 - percentage of image to skip, starting from the crop side. Default value is 0. It is ignored for center cropping.

Examples of cover cropping configurations. Usually it's a good idea to add few of them to your Audiobookshelf:

⁠Credits

Dmitry Hrabrov - https://dexp.in⁠

⁠License

The MIT License (MIT)

Copyright (c) 2025 Dmitry Hrabrov

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.