update INSTALL and UPGRADE file
[phpfspot.git] / INSTALL
1 phpfspot install howto:
2
3 * requirements
4  
5  - apache/apache2 (in fact any webserver which supports php)
6  - php5
7    - the following extensions must be available
8      (compiled in or as shared object):
9      * gd
10      * sqlite3 (native or as PDO driver)
11    - PEAR extensions (pear install %name%)
12      * Calendar
13      * Date
14      * HTML_AJAX
15  - Smarty (php template engine, http://smarty.php.net)
16  - sqlite3
17   
18 * installation
19
20  1. copy the sample phpfspot-config-file to your new config file
21
22     cp phpfspot_cfg.php.dist phpfspot_cfg.php
23
24  2. Edit phpfspot_cfg.php and edit the necessary configuration
25     parameters. This file also include explanation of each option.
26     Take care that the path to the f-spot database (photos.db)
27     and the f-spot photo base directory (usally Photos) is set
28     correctly.
29
30  3. Open phpfspot in our favourite browser. The URL depends what
31     you have specify as $webpath in the configuration var. But
32     usually it will be http://myserver/phpfspot (where myserver
33     is your webservers IP, server name, virtual host name, ...).
34
35  4. To pre-create all thumbnails invoke the script gen_thumbs.php
36
37     cd ${phpfspot_home}
38     "./gen_thumbs.php"
39     or 
40     "php gen_thumbs.php" (if execute-permission is not set)
41
42     thumbnails can also be created on-the-fly by the webserver but
43     this will take away a lot of resources of your system during
44     thumb-generation. pre-creation on the shell works faster.