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 get news from poche, [follow us on twitter](http://twitter.com/getpoche).
   9
  10 [If you want to flattr poche, it's here.](https://flattr.com/thing/1225780/nicosombpoche-on-GitHub)
  11
  12 ## Usage
  13 You can easily add a "poched" page with the bookmarklet.
  14
  15 poche save the entire content of a poched links : text and pictures are stored on your server.
  16
  17 You can :
  18 * read a page in a comfortable reading view
  19 * archive a link
  20 * put a link in favorite
  21 * delete a link
  22
  23 ## Requirements & installation
  24 You have to install [sqlite for php](http://www.php.net/manual/en/book.sqlite.php) on your server.
  25
  26 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.
  27
  28 That's all, **poche works** !
  29
  30 ## Security
  31 You **have** to protect your db/poche.sqlite file. Modify the virtual host of your website to add this condition :
  32 ```apache
  33 <Files ~ "\.sqlite$">
  34     Order allow,deny
  35     Deny from all
  36 </Files>
  37 ```
  38
  39 Nginx version:
  40 ```nginx
  41 location ~ /(db) {
  42     deny all;
  43     return 404;
  44 }
  45 ```
  46
  47 ## Import from Pocket
  48
  49 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.
  50
  51 ## License
  52 Copyright © 2010-2013 Nicolas Lœuillet <nicolas@loeuillet.org>
  53 This work is free. You can redistribute it and/or modify it under the
  54 terms of the Do What The Fuck You Want To Public License, Version 2,
  55 as published by Sam Hocevar. See the COPYING file for more details.