update documentation
[phpfspot.git] / docs / ric_INSTALL.html
1 <?xml version="1.0" encoding="iso-8859-1"?>
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3   <html xmlns="http://www.w3.org/1999/xhtml">
4                 <head>
5                         <!-- template designed by Marco Von Ballmoos -->
6                         <title></title>
7                         <link rel="stylesheet" href="media/stylesheet.css" />
8                         <meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
9                 </head>
10                 <body>
11                                                 <div align="center"><h1>INSTALL</h1></div>
12 <pre>
13 phpfspot install howto:
14
15 * requirements
16  
17  - apache/apache2 (in fact any webserver which supports php)
18  - php5
19    - the following extensions must be available
20      (compiled in or as shared object):
21      * gd
22      * sqlite3 (native or as PDO driver)
23    - PEAR extensions (pear install %name%)
24      * Calendar
25      * HTML_AJAX
26  - Smarty (php template engine, http://smarty.php.net)
27  - sqlite3
28   
29 * installation
30
31  1. copy the sample phpfspot-config-file to your new config file
32
33     cp phpfspot_cfg.php.dist phpfspot_cfg.php
34
35  2. Edit phpfspot_cfg.php and edit the necessary configuration
36     parameters. This file also include explanation of each option.
37     Take care that the path to the f-spot database (photos.db)
38     and the f-spot photo base directory (usally Photos) is set
39     correctly.
40
41  3. Open phpfspot in our favourite browser. The URL depends what
42     you have specify as $webpath in the configuration var. But
43     usually it will be http://myserver/phpfspot (where myserver
44     is your webservers IP, server name, virtual host name, ...).
45
46  4. To pre-create all thumbnails invoke the script gen_thumbs.php
47
48     cd ${phpfspot_home}
49     &quot;./gen_thumbs.php&quot;
50     or 
51     &quot;php gen_thumbs.php&quot; (if execute-permission is not set)
52
53     thumbnails can also be created on-the-fly by the webserver but
54     this will take away a lot of resources of your system during
55     thumb-generation. pre-creation on the shell works faster.
56
57 </pre>
58         <p class="notes" id="credit">
59                 Documentation generated on Sat, 12 Apr 2008 18:39:11 +0200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
60         </p>
61         </body>
62 </html>