cops/README

90 lines
3 KiB
Plaintext
Raw Normal View History

2012-05-28 08:01:33 +03:00
= COPS =
2012-07-02 21:27:46 +03:00
COPS stands for Calibre OPDS (and HTML) Php Server.
2012-05-28 08:01:33 +03:00
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.
2012-07-22 15:49:57 +03:00
Later I added an simple HTML catalog that should be usable on my Kobo.
2012-07-02 21:27:46 +03:00
2012-05-28 08:01:33 +03:00
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.
2012-07-02 21:27:46 +03:00
* With Dropbox / owncloud it's very easy to have an up to date OPDS server.
2012-05-28 08:01:33 +03:00
* It was fun to code.
2013-01-06 10:36:19 +02:00
If you want to use the OPDS feed don't forget to specify feed.php at the end of your URL.
2012-05-28 08:01:33 +03:00
= Prerequisites =
2012-07-02 21:27:46 +03:00
1. PHP 5.3 or 5.4 with GD image processing & SQLite3 support.
2. A web server with PHP support. I only tested with various version of Nginx.
Other people reported it working with Apache and Cherokee.
2012-05-28 08:01:33 +03:00
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).
2013-01-25 22:04:10 +02:00
2. If a first-time install, copy config_local.php.example to config_local.php
2012-05-28 08:01:33 +03:00
3. Edit config_local.php to match your config.
2013-01-25 22:04:10 +02:00
4. If needed add other configuration item from config_default.php
2012-05-28 08:01:33 +03:00
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;
2013-01-25 22:04:10 +02:00
= Known problems =
2012-10-11 22:14:28 +03:00
2013-01-25 22:04:10 +02:00
Not a lot ;)
2012-07-02 21:42:55 +03:00
2013-01-25 22:04:10 +02:00
Please see https://github.com/seblucas/cops/issues for open issues
2012-07-02 21:42:55 +03:00
2013-01-25 22:04:10 +02:00
= Need help =
2012-05-28 08:01:33 +03:00
2013-01-25 22:04:10 +02:00
Please read https://github.com/seblucas/cops/wiki
2012-05-28 08:01:33 +03:00
= Disclaimer =
2013-01-25 22:04:10 +02:00
It's tested by me and many other users but there's still some little bugs around ;)
2012-05-28 08:05:05 +03:00
= Credits =
* All localization informations come from Calibre2OPDS (http://calibre2opds.com/)
* 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://fortawesome.github.io/Font-Awesome/
* Thanks to all testers
2012-10-20 06:41:19 +03:00
External libraries used :
* JQuery : http://jquery.com/
2013-06-25 12:54:06 +03:00
* 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
2013-06-25 12:54:06 +03:00
* DoT.js : http://olado.github.io/doT/index.html
* PHPMailer : https://github.com/PHPMailer/PHPMailer
* js-lru : https://github.com/rsms/js-lru
2012-05-28 08:01:33 +03:00
= Copyright & License =
2013-01-02 21:53:17 +02:00
COPS - 2012-2013 (c) S<>bastien Lucas <sebastien@slucas.fr>
2012-05-28 08:01:33 +03:00
See COPYING and file headers for license info