tedvdb/ebooklib

eBookLib with OPDS Catalog 1.1 support.

0.1.4.2-beta 2021-01-06 08:23 UTC

Requires

• php: >=7.0.0
• bican/roles: 2.1.*
• choccybiccy/mobi: ^0.1.2
• chumper/zipper: 1.0.x
• fideloper/proxy: ~3.3
• intervention/image: ^2.4
• laravel/framework: 5.5.*
• laravel/scout: ^4.0
• maennchen/zipstream-php: ^0.5.2
• spatie/array-to-xml: ^2.7
• yab/laravel-scout-mysql-driver: ^2.0

Requires (Dev)

• filp/whoops: ~2.0
• fzaninotto/faker: ~1.4
• mockery/mockery: ~1.0
• phpunit/phpunit: ~6.0
• symfony/thanks: ^1.0

GPL-3.0-only

• Ted van den Brink

• ebook
• epub
• OPDS

README

• Get the source and dependencies to specified folder: composer create-project tedvdb/ebooklib <install path>
• Then in the root folder, copy .env.example to .env
• Create a mysql user and database for eBookLib and correct database settings in .env.
• Set the APP_URL variable in the .env file.
• Make sure the webservice (or php process in case of php-fpm) has write permissions to the /storage folder.
• Then, init the database:

php artisan key:generate
php artisan migrate
php artisan db:seed

The installation is now complete.

First use

• Add path to search_paths table (no GUI yet)
• Start first indexing action:

php artisan ebooks:reindex

Now you can navigate in the browser to the url you've configured, and login with the default username '[e-mail]' and the password 'secret'.

Filetypes

Currently only .epub and .mobi files are supported.

OPDS

The library is now available in the url via OPDS1.1 protocol on <url>/opds/. OPDS support is experimental! Anly basic authentication is implemented.