[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. Moreover, you can migrate from Pocket & Readability.

![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 : [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)

## Requirements & installation
You have to install [sqlite for php](http://www.php.net/manual/en/book.sqlite.php) on your server.

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

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.

Copy db/poche.sqlite.in to db/poche.sqlite

Install composer in your project : 
```bash
curl -s http://getcomposer.org/installer | php
```
Install via composer : 
```bash
php composer.phar install
```

That's all, you can use poche ! 

## 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;
}
```

## Usage
See the documentation on our website : [inthepoche.com](http://inthepoche.com).

## 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
	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	Copy db/poche.sqlite.in to db/poche.sqlite
	22
	23	Install composer in your project :
	24	```bash
	25	curl -s http://getcomposer.org/installer \| php
	26	```
	27	Install via composer :
	28	```bash
	29	php composer.phar install
	30	```
	31
	32	That's all, you can use poche !
	33
	34	## Security
	35	You have to protect your db/poche.sqlite file. Modify the virtual host of your website to add this condition :
	36	```apache
	37	<Files ~ "\.sqlite$">
	38	Order allow,deny
	39	Deny from all
	40	</Files>
	41	```
	42
	43	Nginx version:
	44	```nginx
	45	location ~ /(db) {
	46	deny all;
	47	return 404;
	48	}
	49	```
	50
	51	## Usage
	52	See the documentation on our website : [inthepoche.com](http://inthepoche.com).
	53
	54	## License
	55	Copyright © 2010-2013 Nicolas Lœuillet <nicolas@loeuillet.org>
	56	This work is free. You can redistribute it and/or modify it under the
	57	terms of the Do What The Fuck You Want To Public License, Version 2,
	58	as published by Sam Hocevar. See the COPYING file for more details.