summaryrefslogtreecommitdiff
path: root/doc/install.php.txt
authorGiulio Cesare Solaroli <giulio.cesare@clipperz.com>2011-10-02 23:56:18 (UTC)
committer Giulio Cesare Solaroli <giulio.cesare@clipperz.com>2011-10-02 23:56:18 (UTC)
commitef68436ac04da078ffdcacd7e1f785473a303d45 (patch) (unidiff)
treec403752d66a2c4775f00affd4fa8431b29c5b68c /doc/install.php.txt
parent597ecfbc0249d83e1b856cbd558340c01237a360 (diff)
downloadclipperz-ef68436ac04da078ffdcacd7e1f785473a303d45.zip
clipperz-ef68436ac04da078ffdcacd7e1f785473a303d45.tar.gz
clipperz-ef68436ac04da078ffdcacd7e1f785473a303d45.tar.bz2
First version of the newly restructured repository
Diffstat (limited to 'doc/install.php.txt') (more/less context) (ignore whitespace changes)
-rw-r--r--doc/install.php.txt31
1 files changed, 31 insertions, 0 deletions
diff --git a/doc/install.php.txt b/doc/install.php.txt
new file mode 100644
index 0000000..d3a40e8
--- a/dev/null
+++ b/doc/install.php.txt
@@ -0,0 +1,31 @@
1Instructions on how to install and configure your personal instance of the Clipperz application
2
3Configure the settings on the /php/configuration.php file.
4The most important configuration options are the one to connect to the MySQL database:
5 - $configuration['db'] = 'clipperz'; //database name
6 - $configuration['host'] = 'localhost'; //database host
7 - $configuration['user'] = 'root'; //database user
8 - $configuration['pass'] = 'pass'; //database password
9 - $configuration['port'] = '3306'; //database port
10
11
12The MySQL database configured above, should already exists, but the setup procedure will take care of creating all the tables used by the application.
13
14Once the configuration are setup, you should load the /php/setup/index.php page.
15Following the instructions, the script will generate all the database objects, and run some tests to double-check that everything works fine.
16In the first page you have to press the "POG me up!" button at the bottom of the page; in the next page, if all the checks are successful, a "Proceed" button will be enabled below the main text area. Clicking the "Proceed" button you will access the tab of the POG application that enable you to inspect and edit the content of the database used by the Clipperz application.
17
18Once the application is successfully installed, it is probably a good idea to remove, disable or protect the whole "/php/setup/" folder, in order to avoid anyone from deleting random records from the database. Your data will not be leaked, but it would be possible to delete them anyway.
19
20At this point the database should be ready to run.
21
22The PHP code is quite simple, but there are a few dependency on external library that you may have to include, depending of the version of PHP you are using.
23
24- PDO: http://ca.php.net/pdo
25- JSON: http://aurore.net/projects/php-json/
26- BCMath: http://it.php.net/bc
27
28The code has been compiled using PHP 5.1.6
29The POG class definitions have been configure for use with PHP 5.1+
30
31For added convenience, we have added a page at /php/test.php that reports the detailed PHP configuration available on your computer. \ No newline at end of file