README.md

   1 # poche
   2 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.
   3
   4 ![poche](http://inthepoche.com/img/logo.png)
   5
   6 The website of poche is [inthepoche.com](http://inthepoche.com).
   7
   8 To test poche, a demo website is online : [demo.inthepoche.com](http://demo.inthepoche.com) (login poche, password poche).
   9
  10 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).
  11
  12 [![flattr](http://api.flattr.com/button/flattr-badge-large.png)](http://flattr.com/thing/1265480/poche-a-read-it-later-open-source-system)
  13
  14 ## Requirements & installation
  15 You have to install [sqlite for php](http://www.php.net/manual/en/book.sqlite.php) on your server.
  16
  17 [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.
  18
  19 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.
  20
  21 Install composer in your project :
  22 ```bash
  23 curl -s http://getcomposer.org/installer | php
  24 ```
  25 Install via composer :
  26 ```bash
  27 php composer.phar install
  28 ```
  29
  30 That's all, you can use poche !
  31
  32 ## Security
  33 You **have** to protect your db/poche.sqlite file. Modify the virtual host of your website to add this condition :
  34 ```apache
  35 <Files ~ "\.sqlite$">
  36     Order allow,deny
  37     Deny from all
  38 </Files>
  39 ```
  40
  41 Nginx version:
  42 ```nginx
  43 location ~ /(db) {
  44     deny all;
  45     return 404;
  46 }
  47 ```
  48
  49 ## Usage
  50 See the documentation on our website : [inthepoche.com](http://inthepoche.com).
  51
  52 ## License
  53 Copyright © 2010-2013 Nicolas Lœuillet <nicolas@loeuillet.org>
  54 This work is free. You can redistribute it and/or modify it under the
  55 terms of the Do What The Fuck You Want To Public License, Version 2,
  56 as published by Sam Hocevar. See the COPYING file for more details.