[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 test poche, a demo website is online : [demo.inthepoche.com](http://demo.inthepoche.com) (login poche, password poche).

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 : [https://groups.google.com/forum/#!forum/poche-users](https://groups.google.com/forum/#!forum/poche-users)

[![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/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.

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
e858ac27	8	To test poche, a demo website is online : [demo.inthepoche.com](http://demo.inthepoche.com) (login poche, password poche).
e858ac27	9
66ce09ba	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 : [https://groups.google.com/forum/#!forum/poche-users](https://groups.google.com/forum/#!forum/poche-users)
28cbf46c	11
0a0b9686	12	[![flattr](http://api.flattr.com/button/flattr-badge-large.png)](http://flattr.com/thing/1265480/poche-a-read-it-later-open-source-system)
28667ee7	13
1a268ba7	14	## Usage
28cbf46c	15	You can easily add a "poched" page with the bookmarklet.
1a268ba7	16
d178419c	17	poche save the entire content of a poched links : text and pictures are stored on your server.
d178419c	18
28cbf46c	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
1a268ba7	24
d178419c	25	## Requirements & installation
	26	You have to install [sqlite for php](http://www.php.net/manual/en/book.sqlite.php) on your server.
	27
8d5aab49	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.
d178419c	29
	30	That's all, poche works !
	31
a590ea55	32	## Security
a590ea55	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
dbb792bf GM	41	Nginx version:
	42	```nginx
	43	location ~ /(db) {
	44	deny all;
	45	return 404;
	46	}
	47	```
	48
0753bfef	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
1a268ba7	53	## License
634cf566	54	Copyright © 2010-2013 Nicolas Lœuillet <nicolas@loeuillet.org>
1a268ba7 NL	55	This work is free. You can redistribute it and/or modify it under the
1a268ba7 NL	56	terms of the Do What The Fuck You Want To Public License, Version 2,
dbb792bf	57	as published by Sam Hocevar. See the COPYING file for more details.