Add v0.0.1

2012-05-28 07:01:33 +02:00 · 2012-05-28 07:01:33 +02:00 · e47631b1d8
commit e47631b1d8
parent ecca561693
12 changed files with 1308 additions and 0 deletions
--- a/96
+++ b/96
@ -0,0 +1,96 @@
+= 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 
+dependancies 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.
+
+So COPS's main advantages are :
+ * No need for many dependancies.
+ * 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;
+
+= Known problems =
+
+ * Only tested with Nginx.
+ * Contain Nginx specific code.
+ * Only works with EPUB (not MOBI or PDF).
+ * 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.
+
+= Copyright & License =
+
+COPS - 2012 (c) Sébastien Lucas <sebastien@slucas.fr>
+
+See COPYING and file headers for license info
+