wallabag/README.md

56 lines
2.1 KiB
Markdown
Raw Normal View History

2013-04-03 13:14:01 +00:00
# poche
2013-08-04 20:35:08 +00:00
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.
2013-04-03 13:14:01 +00:00
2013-04-13 09:08:31 +00:00
![poche](http://inthepoche.com/img/logo.png)
2013-04-04 20:16:33 +00:00
2013-04-12 12:56:06 +00:00
The website of poche is [inthepoche.com](http://inthepoche.com).
2013-04-12 12:55:41 +00:00
2013-04-22 06:32:30 +00:00
To test poche, a demo website is online : [demo.inthepoche.com](http://demo.inthepoche.com) (login poche, password poche).
2013-07-31 09:50:38 +00:00
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).
2013-04-04 20:15:48 +00:00
2013-04-18 19:47:39 +00:00
[![flattr](http://api.flattr.com/button/flattr-badge-large.png)](http://flattr.com/thing/1265480/poche-a-read-it-later-open-source-system)
2013-04-11 09:00:59 +00:00
2013-04-17 13:32:57 +00:00
## Requirements & installation
You have to install [sqlite for php](http://www.php.net/manual/en/book.sqlite.php) on your server.
2013-08-04 20:35:08 +00:00
[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.
2013-04-23 13:18:22 +00:00
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.
2013-04-17 13:32:57 +00:00
2013-08-04 20:35:08 +00:00
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 !
2013-04-17 13:32:57 +00:00
## 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;
}
```
2013-08-04 20:35:08 +00:00
## Usage
See the documentation on our website : [inthepoche.com](http://inthepoche.com).
2013-04-17 08:35:50 +00:00
2013-04-03 13:14:01 +00:00
## License
2013-04-03 13:23:00 +00:00
Copyright © 2010-2013 Nicolas Lœuillet <nicolas@loeuillet.org>
2013-04-03 13:14:01 +00:00
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,
2013-08-04 20:35:08 +00:00
as published by Sam Hocevar. See the COPYING file for more details.