Personal/cops
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Readme update

Browse source
This commit is contained in:
Sébastien Lucas 2012-07-02 20:27:46 +02:00
parent 3e393c3d10
commit 3f8693ba4a
1 changed files with 25 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

32
README
View file

@ -1,6 +1,6 @@
= COPS = = COPS =
COPS stands for Calibre OPDS Php Server. COPS stands for Calibre OPDS (and HTML) Php Server.
COPS output is valid the unofficial OPDS validator : COPS output is valid the unofficial OPDS validator :
http://opds-validator.appspot.com/ http://opds-validator.appspot.com/
@ -16,19 +16,21 @@ 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 I initially thought of Calibre2OPDS but as it generate static file no
search was possible. search was possible.
Later I added an HTML catalog.
So COPS's main advantages are : So COPS's main advantages are :
* No need for many dependencies. * No need for many dependencies.
* No need for a lot of CPU or RAM. * No need for a lot of CPU or RAM.
* Not much code. * Not much code.
* Search is available. * Search is available.
* With Dropbox it's very easy to have an up to date OPDS server. * With Dropbox / owncloud it's very easy to have an up to date OPDS server.
* It was fun to code. * It was fun to code.
= Prerequisites = = Prerequisites =
1. PHP 5.3 with GD image processing & SQLite3 support. 1. PHP 5.3 or 5.4 with GD image processing & SQLite3 support.
2. A web server with PHP support. I only tested with Nginx 1.1.14. For now 2. A web server with PHP support. I only tested with various version of Nginx.
there is support for X-Accel-Redirect which is Nginx specific. Other people reported it working with Apache and Cherokee.
3. The path to a calibre library (metadata.db, format, & cover files). 3. The path to a calibre library (metadata.db, format, & cover files).
On any Debian base Linux you can use : On any Debian base Linux you can use :
@ -52,6 +54,19 @@ server {
root /var/www/opds; root /var/www/opds;
index feed.php; index feed.php;
location /download/ {
rewrite ^/download/(\d+)/.*\.(.*)$ /fetch.php?id=$1&type=$2 last;
break;
}
location ~ ^/images.*\.(gif|png|ico|jpg)$ {
expires 31d;
}
location ~ .(js|css)$ {
expires 31d;
}
location ~ \.php$ { location ~ \.php$ {
include /etc/nginx/fastcgi_params; include /etc/nginx/fastcgi_params;
fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name; fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
@ -67,6 +82,10 @@ server {
Beware in this case my Calibre database is in /home/calibre/Dropbox/Calibre/ so Beware in this case my Calibre database is in /home/calibre/Dropbox/Calibre/ so
the internal location of nginx has to split like that. the internal location of nginx has to split like that.
I use a Kobo eReader Touch and its browser cannot download through php file (the
extension has to be known). To allow downloading on my ereader I added some
url rewriting (location /download/).
If your Calibre database is inside your web directory then there is no need for If your Calibre database is inside your web directory then there is no need for
an internal location. an internal location.
@ -84,9 +103,8 @@ any other custom OPDS catalog.
= Known problems = = Known problems =
* Only tested by me with Nginx but confirmed to work with Apache. * Only tested by me with Nginx but confirmed to work with Apache and Cherokee.
* Contain Nginx specific code (that could be changed with a config item). * Contain Nginx specific code (that could be changed with a config item).
* Only works with EPUB, MOBI and PDF.
* certainly many many more. * certainly many many more.
= Disclaimer = = Disclaimer =