COPS

COPS stands for Calibre OPDS (and HTML) Php Server.

See : COPS's home for more details.

Don't forget to check the Wiki.

Why ?

In my opinion Calibre is a marvelous tool but is too big and has too much dependencies to be used for its content server.

That's the main reason why I coded this OPDS server. I needed a simple tool to be installed on a small server (Seagate Dockstar in my case).

I initially thought of Calibre2OPDS but as it generate static file no search was possible.

Later I added an simple HTML catalog that should be usable on my Kobo.

So COPS's main advantages are :

No need for many dependencies.
No need for a lot of CPU or RAM.
Not much code.
Search is available.
With Dropbox / owncloud it's very easy to have an up to date OPDS server.
It was fun to code.

If you want to use the OPDS feed don't forget to specify feed.php at the end of your URL.

Prerequisites

PHP 5.3, 5.4, 5.5, 5.6 or hhvm with GD image processing, Libxml, Intl, Json & SQLite3 support.
A web server with PHP support. I only tested with various version of Nginx. Other people reported it working with Apache and Cherokee. You can also use PHP embedded server (https://github.com/seblucas/cops/wiki/Howto---PhpEmbeddedServer)
The path to a calibre library (metadata.db, format, & cover files).

On any Debian base Linux you can use : aptitude install php5-gd php5-sqlite php5-json php5-intl

On Centos you may have to add : yum install php-xml

Install

Extract the zip file to a folder in web space (visible to the web server).
If you're doing a first-time install, copy config_local.php.example to config_local.php
Edit config_local.php to match your config.
If needed add other configuration item from config_default.php

If you choose to put your Calibre directory inside your web directory then you will have to edit /etc/nginx/mime.types to add this line : application/epub+zip epub;

If you like Docker, you can also this project

Known problems

Not a lot, except for the bad quality of the code (first PHP project ever) ;)

Please see https://github.com/seblucas/cops/issues for open issues

Need help

Please read https://github.com/seblucas/cops/wiki and check the FAQ.

Credits

Locale message handling is inspired of http://www.mind-it.info/2010/02/22/a-simple-approach-to-localization-in-php/
str_format function come from http://tmont.com/blargh/2010/1/string-format-in-php
All icons come from Font Awesome : http://fontawesome.github.io/Font-Awesome/
The unofficial OPDS validator : http://opds-validator.appspot.com/
Thanks to all testers, translators and contributors.
Feed icons made by Freepik from Flaticon website licensed under Creative Commons BY 3.0 http://www.flaticon.com and http://www.freepik.com

External libraries used :

JQuery : http://jquery.com/
Magnific Popup : http://dimsemenov.com/plugins/magnific-popup/
Php-epub-meta : https://github.com/splitbrain/php-epub-meta with some modification by me https://github.com/seblucas/php-epub-meta
TbsZip : http://www.tinybutstrong.com/apps/tbszip/tbszip_help.html
DoT.js : http://olado.github.io/doT/index.html
PHPMailer : https://github.com/PHPMailer/PHPMailer
js-lru : https://github.com/rsms/js-lru

Copyright & License

COPS - 2012-2016 (c) S<>bastien Lucas

See COPYING and file headers for license info

4 KiB Raw Blame History Unescape Escape