README.md

   1 # poche
   2 Abandon Pocket, Instapaper and other Readability service : adopt poche. It is the same, but it is open source.
   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 ## Usage
  15 You can easily add a "poched" page with the bookmarklet.
  16
  17 poche save the entire content of a poched links : text and pictures are stored on your server.
  18
  19 You can :
  20 * read a page in a comfortable reading view
  21 * archive a link
  22 * put a link in favorite
  23 * delete a link
  24
  25 ## Requirements & installation
  26 You have to install [sqlite for php](http://www.php.net/manual/en/book.sqlite.php) on your server.
  27
  28 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.
  29
  30 That's all, **poche works** !
  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 ## Import from Pocket
  50
  51 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.
  52
  53 ## License
  54 Copyright © 2010-2013 Nicolas Lœuillet <nicolas@loeuillet.org>
  55 This work is free. You can redistribute it and/or modify it under the
  56 terms of the Do What The Fuck You Want To Public License, Version 2,
  57 as published by Sam Hocevar. See the COPYING file for more details.