commit current phpDocumentor docs

[phpfspot.git] / docs / ric_INSTALL.html
diff --git a/docs/ric_INSTALL.html b/docs/ric_INSTALL.html

new file mode 100644 (file)

index 0000000..d241378
--- /dev/null
+++ b/docs/ric_INSTALL.html
@@ -0,0 +1,62 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+  <html xmlns="http://www.w3.org/1999/xhtml">
+               <head>
+                       <!-- template designed by Marco Von Ballmoos -->
+                       <title></title>
+                       <link rel="stylesheet" href="media/stylesheet.css" />
+                       <meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
+               </head>
+               <body>
+                                               <div align="center"><h1>INSTALL</h1></div>
+<pre>
+phpfspot install howto:
+
+* requirements
+ 
+ - apache/apache2 (in fact any webserver which supports php)
+ - php5
+   - the following extensions must be available
+     (compiled in or as shared object):
+     * gd
+     * sqlite3 (native or as PDO driver)
+   - PEAR extensions (pear install %name%)
+     * Calendar
+     * HTML_AJAX
+ - Smarty (php template engine, http://smarty.php.net)
+ - sqlite3
+  
+* installation
+
+ 1. copy the sample phpfspot-config-file to your new config file
+
+    cp phpfspot_cfg.php.dist phpfspot_cfg.php
+
+ 2. Edit phpfspot_cfg.php and edit the necessary configuration
+    parameters. This file also include explanation of each option.
+    Take care that the path to the f-spot database (photos.db)
+    and the f-spot photo base directory (usally Photos) is set
+    correctly.
+
+ 3. Open phpfspot in our favourite browser. The URL depends what
+    you have specify as $webpath in the configuration var. But
+    usually it will be http://myserver/phpfspot (where myserver
+    is your webservers IP, server name, virtual host name, ...).
+
+ 4. To pre-create all thumbnails invoke the script gen_thumbs.php
+
+    cd ${phpfspot_home}
+    &quot;./gen_thumbs.php&quot;
+    or 
+    &quot;php gen_thumbs.php&quot; (if execute-permission is not set)
+
+    thumbnails can also be created on-the-fly by the webserver but
+    this will take away a lot of resources of your system during
+    thumb-generation. pre-creation on the shell works faster.
+
+</pre>
+       <p class="notes" id="credit">
+               Documentation generated on Sat, 12 Apr 2008 18:24:40 +0200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
+       </p>
+       </body>
+</html>
+\ No newline at end of file