source: contrib/z-push/INSTALL @ 4898

Revision 4898, 4.3 KB checked in by thiagoaos, 13 years ago (diff)

Ticket #2180 - Adicionado código fonte completo do zpush

Line 
1Installing Z-Push
2======================
3
4Requirements
5------------
6
7Z-Push runs on either PHP4 or PHP5.
8Version prior to 1.2.2 require the 'Mail' package from PEAR.
9Newer versions don't have this dependency anymore.
10
11Additional informations can be found in the Zarafa Administrator Manual:
12http://doc.zarafa.com/trunk/Administrator_Manual/en-US/html/index.html
13
14
15How to install
16--------------
17
18To Install Z-Push, simply untar the z-push tar to your webroot,
19e.g. with
20
21tar -xzvf z-push-<version>.tar.gz -C /var/www
22
23Now, edit the config.php file in the directory to reflect your local system.
24For MAPI use with Zarafa, you needn't change any settings and should work
25as-is.
26
27Please also set your timezone in the config.php file.
28
29Make sure that the 'state' directory is writeable for your webserver
30process, so either change the owner of the 'state' directory to the UID of
31your apache process, or make the directory world writeable:
32
33chmod 777 /var/www/z-push/state
34
35Now, you must configure Apache to redirect the URL
36'Microsoft-Server-ActiveSync' to the index.php file in the Z-Push
37directory. This can be done by adding the line
38
39Alias /Microsoft-Server-ActiveSync /var/www/z-push/index.php
40
41to your httpd.conf file. Make sure that you are adding the line to the
42correct part of your Apache configuration, taking care of virtual hosts and
43other Apache configurations.
44
45*WARNING* You CANNOT simply rename the z-push directory to
46Microsoft-Server-ActiveSync. This will cause Apache to send redirects to the
47PDA, which will definitely break your PDA synchronisation.
48
49Lastly, make sure that PHP has the following settings:
50
51php_flag magic_quotes_gpc off
52php_flag register_globals off
53php_flag magic_quotes_runtime off
54php_flag short_open_tag on
55
56You can set this in the httpd.conf, in php.ini or in an .htaccess file in
57the root of z-push. If you don't set this up correctly, you will not be
58able to login correctly via z-push.
59
60After doing this, you should be able to synchronize from your PDA.
61
62
63Update to newer Z-Push versions
64-------------------------------
65
66Upgrading to a newer Z-Push version follows the same path as the initial
67installation.
68
69When upgrading to a new minor version e.g. from Z-Push 1.4 to Z-Push 1.4.1,
70the existing Z-Push directory can be overwritten when extracting the archive.
71When installing a new major version it is recommended to extract the tarball
72to another directory and to copy the state from the existing installation.
73
74IMPORTANT: It is crucial to always keep the data of the state directory in
75order to ensure data consistency on already synchronized mobiles.
76
77Without the state information mobile devices, which already have an ActiveSync
78profile, will receive duplicate items or the synchronization will break completely.
79
80Please also observe the published release notes of the new Z-Push version.
81For some releases it is necessary to e.g. resynchronize the mobile.
82
83
84Setting up your PocketPC
85------------------------
86
87This is simply a case of adding an 'exchange server' to your activesync
88server list, specifying the IP address of the Z-Push apache server,
89disabling SSL, unless you have already setup SSL on your Apache server,
90setting the correct username & password (the domain is ignored, you can
91simply specify 'domain' or some other random string), and then going through
92the standard activesync settings.
93
94Once you have done this, you should be able to synchronise your PocketPC
95simply by clicking the 'Sync' button in ActiveSync on your PocketPC.
96
97Troubleshooting
98---------------
99
100Most problems will be caused by incorrect Apache settings. To test whether
101your Apache setup is working correctly, you can simply type the Z-Push URL
102in your browser, to see if apache is correctly redirecting your request to
103z-push. You can simply use:
104
105http://<serverip>/Microsoft-Server-ActiveSync
106
107If correctly configured, you should see a username/password request, and
108when you specify a valid username & password, you should see a string like
109
110"Your device requested the Z-Push URL without the required GET parameters"
111
112If not, then check your PHP and Apache settings.
113
114If you have other synchronisation problems, you can create the file
115'debug.txt' in the root directory of z-push, which should also be
116world-writable:
117
118touch /var/www/z-push/debug.txt
119chmod 777 /var/www/z-push/debug.txt
120
121The debug.txt file will then collect debug information from your
122synchronisation.
Note: See TracBrowser for help on using the repository browser.