diff options
-rw-r--r-- | INSTALL.md | 47 | ||||
-rw-r--r-- | README.md | 20 |
2 files changed, 47 insertions, 20 deletions
diff --git a/INSTALL.md b/INSTALL.md new file mode 100644 index 00000000..bbac44ba --- /dev/null +++ b/INSTALL.md | |||
@@ -0,0 +1,47 @@ | |||
1 | # Installing poche | ||
2 | |||
3 | Get the [latest twig version](https://github.com/inthepoche/poche/archive/twig.zip) of poche on github. Unzip it and upload it on your server. | ||
4 | |||
5 | your datas can be stored on sqlite, postgres or mysql databases. | ||
6 | |||
7 | Edit /inc/poche/config.inc.php : | ||
8 | |||
9 | ```php | ||
10 | define ('STORAGE','sqlite'); # postgres, mysql, sqlite | ||
11 | define ('STORAGE_SERVER', 'localhost'); # leave blank for sqlite | ||
12 | define ('STORAGE_DB', 'poche'); # only for postgres & mysql | ||
13 | define ('STORAGE_SQLITE', './db/poche.sqlite'); | ||
14 | define ('STORAGE_USER', 'user'); # leave blank for sqlite | ||
15 | define ('STORAGE_PASSWORD', 'pass'); # leave blank for sqlite | ||
16 | ``` | ||
17 | |||
18 | poche must have write access on assets, cache and db directories. | ||
19 | |||
20 | [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. | ||
21 | |||
22 | ## storage in sqlite | ||
23 | You have to install [sqlite for php](http://www.php.net/manual/en/book.sqlite.php) on your server. | ||
24 | |||
25 | Copy /install/poche.sqlite in /db | ||
26 | |||
27 | ## storage in mysql | ||
28 | Execute /install/mysql.sql file in your database. | ||
29 | |||
30 | ## storage in postgres | ||
31 | Execute /install/postgres.sql file in your database. | ||
32 | |||
33 | Install composer in your project : | ||
34 | ```bash | ||
35 | curl -s http://getcomposer.org/installer | php | ||
36 | ``` | ||
37 | Install via composer : | ||
38 | ```bash | ||
39 | php composer.phar install | ||
40 | ``` | ||
41 | |||
42 | ## updating from poche 0.3 | ||
43 | With poche <= 0.3, all your datas were stored in a sqlite file. The structure of this file changed. | ||
44 | |||
45 | You have to execute http://yourpoche/install/update_sqlite_from_0_to_1.php before using this new version. | ||
46 | |||
47 | That's all, you can use poche ! \ No newline at end of file | ||
@@ -11,26 +11,6 @@ To get news from poche, [follow us on twitter](http://twitter.com/getpoche) or [ | |||
11 | 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) | 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 | 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 | 14 | ## Security |
35 | You **have** to protect your db/poche.sqlite file. Modify the virtual host of your website to add this condition : | 15 | You **have** to protect your db/poche.sqlite file. Modify the virtual host of your website to add this condition : |
36 | ```apache | 16 | ```apache |