aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
-rw-r--r--INSTALL.md47
-rw-r--r--README.md20
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
3Get 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
5your datas can be stored on sqlite, postgres or mysql databases.
6
7Edit /inc/poche/config.inc.php :
8
9```php
10define ('STORAGE','sqlite'); # postgres, mysql, sqlite
11define ('STORAGE_SERVER', 'localhost'); # leave blank for sqlite
12define ('STORAGE_DB', 'poche'); # only for postgres & mysql
13define ('STORAGE_SQLITE', './db/poche.sqlite');
14define ('STORAGE_USER', 'user'); # leave blank for sqlite
15define ('STORAGE_PASSWORD', 'pass'); # leave blank for sqlite
16```
17
18poche 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
23You have to install [sqlite for php](http://www.php.net/manual/en/book.sqlite.php) on your server.
24
25Copy /install/poche.sqlite in /db
26
27## storage in mysql
28Execute /install/mysql.sql file in your database.
29
30## storage in postgres
31Execute /install/postgres.sql file in your database.
32
33Install composer in your project :
34```bash
35curl -s http://getcomposer.org/installer | php
36```
37Install via composer :
38```bash
39php composer.phar install
40```
41
42## updating from poche 0.3
43With poche <= 0.3, all your datas were stored in a sqlite file. The structure of this file changed.
44
45You have to execute http://yourpoche/install/update_sqlite_from_0_to_1.php before using this new version.
46
47That's all, you can use poche ! \ No newline at end of file
diff --git a/README.md b/README.md
index f4015620..25385da8 100644
--- a/README.md
+++ b/README.md
@@ -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
15You 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
19Get 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
21Copy db/poche.sqlite.in to db/poche.sqlite
22
23Install composer in your project :
24```bash
25curl -s http://getcomposer.org/installer | php
26```
27Install via composer :
28```bash
29php composer.phar install
30```
31
32That's all, you can use poche !
33
34## Security 14## Security
35You **have** to protect your db/poche.sqlite file. Modify the virtual host of your website to add this condition : 15You **have** to protect your db/poche.sqlite file. Modify the virtual host of your website to add this condition :
36```apache 16```apache