2012-05-28 08:01:33 +03:00
|
|
|
|
= COPS =
|
|
|
|
|
|
|
|
|
|
|
|
COPS stands for Calibre OPDS Php Server.
|
|
|
|
|
|
|
|
|
|
|
|
COPS output is valid the unofficial OPDS validator :
|
|
|
|
|
|
http://opds-validator.appspot.com/
|
|
|
|
|
|
|
|
|
|
|
|
= Why ? =
|
|
|
|
|
|
|
|
|
|
|
|
In my opinion Calibre is a marvelous tool but is too big and has too much
|
2012-05-28 08:05:05 +03:00
|
|
|
|
dependencies to be used for its content server.
|
2012-05-28 08:01:33 +03:00
|
|
|
|
|
|
|
|
|
|
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.
|
|
|
|
|
|
|
|
|
|
|
|
So COPS's main advantages are :
|
2012-05-28 08:05:05 +03:00
|
|
|
|
* No need for many dependencies.
|
2012-05-28 08:01:33 +03:00
|
|
|
|
* No need for a lot of CPU or RAM.
|
|
|
|
|
|
* Not much code.
|
|
|
|
|
|
* Search is available.
|
|
|
|
|
|
* With Dropbox it's very easy to have an up to date OPDS server.
|
|
|
|
|
|
* It was fun to code.
|
|
|
|
|
|
|
|
|
|
|
|
= Prerequisites =
|
|
|
|
|
|
|
|
|
|
|
|
1. PHP 5.3 with GD image processing & SQLite3 support.
|
|
|
|
|
|
2. A web server with PHP support. I only tested with Nginx 1.1.14. For now
|
|
|
|
|
|
there is support for X-Accel-Redirect which is Nginx specific.
|
|
|
|
|
|
3. 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
|
|
|
|
|
|
|
|
|
|
|
|
= Install =
|
|
|
|
|
|
|
|
|
|
|
|
1. Extract the zip file to a folder in web space (visible to the web server).
|
|
|
|
|
|
2. If a first-time install, copy config_default.php to config_local.php
|
|
|
|
|
|
3. Edit config_local.php to match your config.
|
|
|
|
|
|
|
|
|
|
|
|
In my case I installed COPS in a subdomain. Here is my nginx config file :
|
|
|
|
|
|
server {
|
|
|
|
|
|
|
|
|
|
|
|
listen [::]:80;
|
|
|
|
|
|
|
|
|
|
|
|
server_name opds.mydomain.com;
|
|
|
|
|
|
|
|
|
|
|
|
access_log /var/log/nginx/opds.access.log;
|
|
|
|
|
|
error_log /var/log/nginx/opds.error.log;
|
|
|
|
|
|
root /var/www/opds;
|
|
|
|
|
|
index feed.php;
|
|
|
|
|
|
|
|
|
|
|
|
location ~ \.php$ {
|
|
|
|
|
|
include /etc/nginx/fastcgi_params;
|
|
|
|
|
|
fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
|
|
|
|
|
|
fastcgi_pass unix:/tmp/fcgi.sock;
|
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
location /Calibre {
|
|
|
|
|
|
root /home/calibre/Dropbox;
|
|
|
|
|
|
internal;
|
|
|
|
|
|
}
|
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
Beware in this case my Calibre database is in /home/calibre/Dropbox/Calibre/ so
|
|
|
|
|
|
the internal location of nginx has to split like that.
|
|
|
|
|
|
|
|
|
|
|
|
If your Calibre database is inside your web directory then there is no need for
|
|
|
|
|
|
an internal location.
|
|
|
|
|
|
|
|
|
|
|
|
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;
|
|
|
|
|
|
|
2012-05-28 08:06:12 +03:00
|
|
|
|
= Notes on Opensearch =
|
|
|
|
|
|
|
|
|
|
|
|
Opensearch allow searching through an OPDS catalog. After many tests, I've been
|
|
|
|
|
|
able to make it work with FBReader and Mantano Reader.
|
|
|
|
|
|
|
|
|
|
|
|
It seems that Aldiko didn't implement it properly so it won't work with COPS or
|
|
|
|
|
|
any other custom OPDS catalog.
|
|
|
|
|
|
|
2012-05-28 08:01:33 +03:00
|
|
|
|
= Known problems =
|
|
|
|
|
|
|
|
|
|
|
|
* Only tested with Nginx.
|
2012-05-28 08:05:05 +03:00
|
|
|
|
* Contain Nginx specific code (that could be changed with a config item).
|
|
|
|
|
|
* Only works with EPUB, MOBI and PDF.
|
2012-05-28 08:01:33 +03:00
|
|
|
|
* certainly many many more.
|
|
|
|
|
|
|
|
|
|
|
|
= Disclaimer =
|
|
|
|
|
|
|
|
|
|
|
|
I only tested on Debian with Nginx so I have stricly no idea if it works
|
|
|
|
|
|
with Apache or any other web server.
|
|
|
|
|
|
|
|
|
|
|
|
On the OPDS client side I mainly tested with FBReader and Aldiko on Android.
|
|
|
|
|
|
|
2012-05-28 08:05:05 +03:00
|
|
|
|
It also seems to work with Stanza.
|
|
|
|
|
|
|
2012-05-28 08:01:33 +03:00
|
|
|
|
= Copyright & License =
|
|
|
|
|
|
|
|
|
|
|
|
COPS - 2012 (c) S<>bastien Lucas <sebastien@slucas.fr>
|
|
|
|
|
|
|
|
|
|
|
|
See COPYING and file headers for license info
|
|
|
|
|
|
|
