first import
[projectpier.git] / readme.txt
blobccbe25facfdce1e116bea6d0222689bfbd16ec88
1                         \r
2 ~~~~~~~~~~~~~~~~~~~\r
3 System requirements\r
4 ~~~~~~~~~~~~~~~~~~~\r
5         \r
6 ProjectPier requires a web server, PHP (5.0.2 or greater with MySQL, GD, and \r
7 SimpleXML extensions) and MySQL with InnoDB support. The recommended web \r
8 server is Apache, but IIS 5 and above have been reported to work also.\r
9         \r
10 ProjectPier is not PHP4 compatible and it will not run on PHP versions prior\r
11 to PHP 5.0.2.\r
12         \r
13 Recommended configuration:\r
14         \r
15 : PHP 5.1 or greater\r
16 : MySQL 4.1 or greater with InnoDB support (see notes below)\r
17 : Apache 2.0 or greater\r
18         \r
19 If you do not have these installed on a server or your personal computer, \r
20 you can visit the sites below to learn more about how to download and install\r
21 them.  They are all licensed under various compatible Open Source licenses.     \r
22 : PHP    : http://www.php.net/\r
23 : MySQL  : http://www.mysql.com/\r
24 : Apache : http://www.apache.org/\r
25         \r
26 ~~~~~~~~~\r
27 Upgrading\r
28 ~~~~~~~~~\r
30 If you are upgrading from ProjectPier 0.8.0-dev or activeCollab 0.7.1, do not\r
31 follow the installation steps below, instead see upgrade.txt for an upgrade procedure.\r
32 It is not possible to upgrade from older versions of activeCollab.\r
34 ~~~~~~~~~~~~\r
35 Installation\r
36 ~~~~~~~~~~~~\r
37         \r
38 1. Make sure your server meets the requirements, see notes below regarding\r
39    enabling InnoDB support.\r
40 2. Download ProjectPier from the project website - http://www.projectpier.org/.\r
41 3. Unpack and upload the files to your web server.\r
42 4. Direct your browser to the /public/install directory and follow the installation\r
43    procedure.\r
45 ~~~~~~~~~~~~~~~~~~~~~~~\r
46 Enabling InnoDB Support\r
47 ~~~~~~~~~~~~~~~~~~~~~~~\r
49 Some installations of MySQL don't support InnoDB by default.  The ProjectPier installer \r
50 will tell you if your server is not configured to support InnoDB. This is easy to fix: \r
52 1. Open your MySQL options file, the file name is my.cnf (Linux) - usually at /etc/my.cnf \r
53    or my.ini (Windows) - usually at c:/windows/my.ini.  If you are using the Uniform Server\r
54    on Windows, the file will be named 'my-small' and will need to be edited with a unix \r
55    compatible editor such as PSPad or EditPad Lite.\r
56 2. Comment the skip-innodb line by adding # in front of it (like #skip-innodb). \r
57 3. It would also be good to increase max_allowed_packet to ensure that \r
58    you'll be able to upload files larger than 1MB. Just add this \r
59    line bellow #skip-innodb line: \r
60    set-variable = max_allowed_packet=64M\r
62 ~~~~~~~~~~~~~~~~~~~~~\r
63 Changing the Language\r
64 ~~~~~~~~~~~~~~~~~~~~~\r
66 ProjectPier installation screens are in English and English is the default language\r
67 for the program.  However, ProjectPier is distributed with 13 other language options.\r
69 After installation is complete, the language can be changed by manually editing the\r
70 file /config/config.php. \r
72 How: Find this line in your config.php file: define('DEFAULT_LOCALIZATION', 'en_us');\r
73      Change en_us to the appropriate language abbreviation (select from the list below).\r
74      Example for German: define('DEFAULT_LOCALIZATION', 'de_de');\r
76 The following languages are available:\r
77 da_dk = Danish\r
78 de_de = German\r
79 el_gr = Greek\r
80 en_us = English (US)\r
81 es_ar = Argentinian Spanish\r
82 hu_formal = Hungarian (formal)\r
83 hu_informal = Hungarian (informal)\r
84 nl_nl = Dutch\r
85 pl_pl = Polish\r
86 pt_br = Bralilian Portuguese\r
87 pt_pt = Continental Portuguese\r
88 sl_si = Slovenian\r
89 sv_sv = Swedish\r
90 tr_tr = Turkish\r
91 zn_ch = Simplified Chinese\r
93 ~~~~~~~~~~~~~~~~~\r
94 About ProjectPier\r
95 ~~~~~~~~~~~~~~~~~\r
96         \r
97 ProjectPier is an Open Source project management and collaboration\r
98 tool that you can install on your own server. It is released under the \r
99 terms of the Honest Public License - HPL (see license.txt for details).  \r
100         \r
101 : http://www.projectpier.org