https://github.com/oldnomad/calibre_opds

Nextcloud app to access your Calibre library via OPDS. This is a mirror, the primary repository is on GitLab.
https://github.com/oldnomad/calibre_opds

calibre nextcloud opds

Last synced: 15 days ago
JSON representation

Nextcloud app to access your Calibre library via OPDS. This is a mirror, the primary repository is on GitLab.

• Host: GitHub
• URL: https://github.com/oldnomad/calibre_opds
• Owner: oldnomad
• Created: 2023-10-09T12:08:22.000Z (about 1 year ago)
• Default Branch: master
• Last Pushed: 2023-10-29T13:11:19.000Z (about 1 year ago)
• Last Synced: 2024-10-16T22:40:46.674Z (29 days ago)
• Topics: calibre, nextcloud, opds
• Language: PHP
• Homepage: https://gitlab.com/oldnomad/calibre_opds
• Size: 157 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSES/AGPL-3.0-or-later.txt

Awesome Lists containing this project

README

        

# Calibre2OPDS app

The Calibre2OPDS app provides access to user's [Calibre](https://calibre-ebook.com/) library

stored in Nextcloud via [OPDS](https://specs.opds.io/opds-1.2).

[OpenSearch](https://github.com/dewitt/opensearch) is supported for searching in the library.

The source code is [available on GitLab](https://gitlab.com/oldnomad/calibre_opds/).

## Usage

This app is intended to be used in situation where you are storing your whole

Calibre library directory in your Nextcloud instance.

The app exposes Calibre library contents as OPDS feeds. If your Nextcloud is at URL

`https://example.com/index.php`, then the root OPDS feed is available at URL

`https://example.com/index.php/apps/calibre_opds/`. Note that accessing your OPDS feed

requires authentication in Nextcloud.

Correspondence between Calibre metadata and OPDS fields is described in [a separate document](OPDS.md).

### Settings

This app has no administrator settings.

Personal settings for this app are in settings section "Sharing". The only parameter that

can be modified at the moment is path to Calibre library folder (by default `Books`).

## Installation

Since this app is not in the Nextcloud App Store yet, you'll have to install it manually:

First, clone this repository:

```sh

git clone https://gitlab.com/oldnomad/calibre_opds.git

```

Then run Composer and create a tarball:

```sh

composer update --no-dev

make appstore

```

The tarball is created in subdirectory `build/artifacts/appstore`. Copy it to your Nextcloud

instance and unpack into your apps directory (typically, subdirectory `apps` under your Nextcloud

root directory).

Now you can go to your Nextcloud apps manager and enable this app.