[github/wallabag/wallabag.git] / README.md

# poche
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)

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
<Files ~ "\.sqlite$">
    Order allow,deny
    Deny from all
</Files>
```

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 <nicolas@loeuillet.org>
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.
Commit	Line	Data
1a268ba7	1	# poche
c4fb6f01	2	Abandon Pocket, Instapaper and other Readability service : adopt poche. It is the same, but it is open source.
1a268ba7	3
421b65eb	4	![poche](http://inthepoche.com/img/logo.png)
33e38dd0	5
9232dd8b	6	The website of poche is [inthepoche.com](http://inthepoche.com).
2bbeb778	7
98e7d681	8	To get news from poche, [follow us on twitter](http://twitter.com/getpoche) or [read the poche blog](http://inthepoche.com/blog).
28cbf46c	9
0a0b9686	10	[![flattr](http://api.flattr.com/button/flattr-badge-large.png)](http://flattr.com/thing/1265480/poche-a-read-it-later-open-source-system)
28667ee7	11
1a268ba7	12	## Usage
28cbf46c	13	You can easily add a "poched" page with the bookmarklet.
1a268ba7	14
d178419c	15	poche save the entire content of a poched links : text and pictures are stored on your server.
d178419c	16
28cbf46c	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
1a268ba7	22
d178419c	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
a590ea55	30	## Security
a590ea55	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
dbb792bf GM	39	Nginx version:
	40	```nginx
	41	location ~ /(db) {
	42	deny all;
	43	return 404;
	44	}
	45	```
	46
0753bfef	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
1a268ba7	51	## License
634cf566	52	Copyright © 2010-2013 Nicolas Lœuillet <nicolas@loeuillet.org>
1a268ba7 NL	53	This work is free. You can redistribute it and/or modify it under the
1a268ba7 NL	54	terms of the Do What The Fuck You Want To Public License, Version 2,
dbb792bf	55	as published by Sam Hocevar. See the COPYING file for more details.