X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=README.md;h=65e2f03affd85f261d7a30c8e6b0fc276a8027a6;hb=b161295d0b53a5ae194e236b0a7c662e9ac2ff9a;hp=e0712addc5633fc46c862946e0f886b197eabf6e;hpb=634cf566f5d6aa92ca2c409932181a76bcfb91d0;p=github%2Fwallabag%2Fwallabag.git diff --git a/README.md b/README.md old mode 100755 new mode 100644 index e0712add..65e2f03a --- a/README.md +++ b/README.md @@ -1,10 +1,55 @@ # poche +Abandon Pocket, Instapaper and other Readability service : adopt poche. It is the same, but it is open source. Moreover, you can migrate from Pocket & Readability. -Abandon Pocket, Instapaper and other Readability service : adopt poche. It is the same, but it is open source. +![poche](http://inthepoche.com/img/logo.png) -## Usage +The website of poche is [inthepoche.com](http://inthepoche.com). + +To test poche, a demo website is online : [demo.inthepoche.com](http://demo.inthepoche.com) (login poche, password poche). + +To get news from poche, [follow us on twitter](http://twitter.com/getpoche) or [read the poche blog](http://inthepoche.com/blog). A Google Group is also available : [poche-users](https://groups.google.com/forum/#!forum/poche-users). + +[![flattr](http://api.flattr.com/button/flattr-badge-large.png)](http://flattr.com/thing/1265480/poche-a-read-it-later-open-source-system) + +## Requirements & installation +You have to install [sqlite for php](http://www.php.net/manual/en/book.sqlite.php) on your server. + +[PHP cURL](http://www.php.net/manual/en/book.curl.php) & [tidy_parse_string](http://www.php.net/manual/en/tidy.parsestring.php) are recommended. + +Get the [latest version](https://github.com/inthepoche/poche) of poche on github. Unzip it and upload it on your server. poche must have write access on assets, cache and db directories. -... +Copy db/poche.sqlite.in to db/poche.sqlite + +Install composer in your project : +```bash +curl -s http://getcomposer.org/installer | php +``` +Install via composer : +```bash +php composer.phar install +``` + +That's all, you can use poche ! + +## Security +You **have** to protect your db/poche.sqlite file. Modify the virtual host of your website to add this condition : +```apache + + Order allow,deny + Deny from all + +``` + +Nginx version: +```nginx +location ~ /(db) { + deny all; + return 404; +} +``` + +## Usage +See the documentation on our website : [inthepoche.com](http://inthepoche.com). ## License Copyright © 2010-2013 Nicolas Lœuillet