X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=README.md;h=0bcce535085cd090348ba91ac00a6f7b7f18f37d;hb=176d733a445cebe6160633494f9b88dca41223d0;hp=b66aba185871c9723e39fbd6f68604121214d92d;hpb=1a268ba710b2cdb4ede98af3368c43d66c4c5e53;p=github%2Fwallabag%2Fwallabag.git diff --git a/README.md b/README.md old mode 100755 new mode 100644 index b66aba18..0bcce535 --- a/README.md +++ b/README.md @@ -1,13 +1,55 @@ # poche +Abandon Pocket, Instapaper and other Readability service : adopt poche. It is the same, but it is open source. -Abandon Pocket, Instapaper and other Readibility service : adopt poche. It is the same, but it is open source. +![poche](http://inthepoche.com/img/logo.png) + +The website of poche is [inthepoche.com](http://inthepoche.com). + +To get news from poche, [follow us on twitter](http://twitter.com/getpoche) or [read the poche blog](http://inthepoche.com/blog). + +[![flattr](http://api.flattr.com/button/flattr-badge-large.png)](http://flattr.com/thing/1265480/poche-a-read-it-later-open-source-system) ## Usage +You can easily add a "poched" page with the bookmarklet. + +poche save the entire content of a poched links : text and pictures are stored on your server. + +You can : +* read a page in a comfortable reading view +* archive a link +* put a link in favorite +* delete a link + +## Requirements & installation +You have to install [sqlite for php](http://www.php.net/manual/en/book.sqlite.php) on your server. + +Get the [latest version](https://github.com/nicosomb/poche) of poche on github. Unzip it and upload it on your server. poche must have write access on assets, cache and db directories. + +That's all, **poche works** ! + +## 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; +} +``` + +## Import from Pocket -... +If you want to import your Pocket datas, [export them here](https://getpocket.com/export). Put the HTML file in your poche directory, execute import.php file locally by following instructions. Be careful, the script can take a very long time. ## License -Copyright © 2010-2013 Nicolas Lœuillet +Copyright © 2010-2013 Nicolas Lœuillet This work is free. You can redistribute it and/or modify it under the terms of the Do What The Fuck You Want To Public License, Version 2, -as published by Sam Hocevar. See the COPYING file for more details. \ No newline at end of file +as published by Sam Hocevar. See the COPYING file for more details.