| This manual is deprecated. Please visit https://groupoffice.readthedocs.io for the latest documentation. |
Difference between revisions of "Z-push 2.1"
(→Known issues per device) |
(→Debugging) |
||
| Line 78: | Line 78: | ||
=Debugging= | =Debugging= | ||
| + | |||
| + | ==Creating a synchronisation log file== | ||
| + | When the synchronisation is not working anymore for a user, then you can create a logfile of the synchronisation of that particular user. | ||
| + | You can enable thit by adding the following configuration variable to the Group-Office config.php file. | ||
| + | <pre> | ||
| + | $config['zpush2_special_log_users']=array('username','username2'); | ||
| + | </pre> | ||
| + | |||
| + | After you have done that, a log file wit the name: {username}.log will be created on the following location: {go_file_storage_path}/log/z-push/ | ||
| + | Sometimes you can find more information about the synchronisation problem in that log. | ||
| + | If you don't understand what's happening then you can create a ticket at our ticketsystem. Please add the generated logfile to the ticket so we have some debug information. | ||
| + | |||
| + | * Don't forget to remove the users from the GO configuration variable after the log is created so the logfiles will not grow to huge files anymore. | ||
| + | |||
| + | ==Z-Push admin commandline tool== | ||
Sometimes it can happen that an item is not synced to the device. | Sometimes it can happen that an item is not synced to the device. | ||
Revision as of 17:03, 11 December 2013
Contents
Overview
This module can be used to synchronize Emails, Contacts, Tasks and Calendars to a mobile device/tablet.
Dependencies
Apache modules
Some apache modules cannot be enabled because Z-Push is NOT working when they are enabled.
- mod_pagespeed (source: http://z-push.sourceforge.net/phpbb/viewtopic.php?f=2&t=2286&p=8480&hilit=pagespeed#p8480)
Requirements
Installation
Automatic
To install the z-push module automatically, you can use the script that is provided with the "Sync" module. (install.sh)
The script is located in the "modules/sync/z-push21" folder.
Manual
ActiveSync support does not work out of the box. We use the third party library z-push. To add support of ActiveSync take the following steps (Step 1 to 5 can be done with modules/sync/z-push2/install.sh too):
1. Download z-push from http://zarafa-deutschland.de/z-push-download/final/2.1/. We used version 2.1.0-1750 (But it's probably best to take the latest stable 2.1.x version of z-push).
2. Unpack the archive and put it in the "modules" directory of Group-Office.
3. rename the folder to "z-push21"
4. Copy the folder modules/sync/z-push21/backend/go/ to modules/z-push2/backend/
5. Copy modules/sync/z-push21/config.php to modules/z-push21/config.php
6. Now, you must configure Apache to redirect the URL 'Microsoft-Server-ActiveSync' to the index.php file in the modules/z-push2/ directory.
This can be done by adding the line:
Alias /Microsoft-Server-ActiveSync /path/to/groupoffice/modules/z-push21/index.php
Don't use a symlink, this won't work.
7. Restart apache2 and configure your mobile device with the servername, username and password and you should be in sync!
Known issues per device
| Device | OS | Issue |
|---|---|---|
| Iphone | All IOS versions | Removing participant from a recurring event on the phone that will be saved as an exception event will also delete the participants on the main event |
| IOS 7 | New tasklists that are created on the device will not be synced to Group-Office. The list will be kept on the phone but the tasks itself will also be added to the main tasklist. | |
| HTC | HERO (maybe more) | Contacts that are synced to the phone and then marked as favorite on the phone will add HTC xml data to the comments field. |
CGI mode
By default z-push only works when PHP is loaded as an Apache module. If you use PHP in CGI mode you'll have to follow this workaround:
Uninstall
Remove the z-push21 folder from the modules directory of Group-Office and remove the apache alias that is described above.
User Manual
Visit the following page for client instructions:
Additional Notes
For debugging change modules/z-push21/config.php:
define('LOGLEVEL', LOGLEVEL_ALL);
A log will be generated in /home/groupoffice/log/
Debugging
Creating a synchronisation log file
When the synchronisation is not working anymore for a user, then you can create a logfile of the synchronisation of that particular user. You can enable thit by adding the following configuration variable to the Group-Office config.php file.
$config['zpush2_special_log_users']=array('username','username2');
After you have done that, a log file wit the name: {username}.log will be created on the following location: {go_file_storage_path}/log/z-push/ Sometimes you can find more information about the synchronisation problem in that log. If you don't understand what's happening then you can create a ticket at our ticketsystem. Please add the generated logfile to the ticket so we have some debug information.
- Don't forget to remove the users from the GO configuration variable after the log is created so the logfiles will not grow to huge files anymore.
Z-Push admin commandline tool
Sometimes it can happen that an item is not synced to the device.
Then you get an error in the "z-push-error.log" file that is located in the {go_file_storage_path}/log/z-push/ folder.
The error can look like this:
01/02/2013 12:22:31 [24372] [ERROR] [john@doe.com] Ignored broken message (SyncAppointment). Reason: '4' Folderid: 'a/GroupOfficeCalendar' message id '25' 01/02/2013 12:33:53 [28717] [ERROR] [john@doe.com] Ignored broken message (SyncMail). Reason: '2' Folderid: 'm/INBOX' message id '1674' 01/02/2013 12:34:02 [28717] [ERROR] [john@doe.com] Ignored broken message (SyncMail). Reason: '2' Folderid: 'm/INBOX' message id '1674' 01/02/2013 12:36:35 [13733] [ERROR] [john@doe.com] Ignored broken message (SyncMail). Reason: '2' Folderid: 'm/INBOX' message id '1674'
When this happens you can usually find more info on this error by using the "z-push-admin.php" file that is located in the z-push folder.
This is a commandline tool that is shipped with the z-push2 package.
You can use it like this:
cd /usr/share/groupoffice/modules/z-push21
php z-push-admin.php -a list -u {go_username}
- Note: You need to go to the directory of z-push2 first because otherwise the GO config file cannot be loaded.
If the config file still cannot be found then add this line directly after the <?php open tag in the z-push-admin.php file:
define('GO_CONFIG_FILE',{absolute_path_to_config_file});
When you have ran the z-push-admin tool then you can find a better error description for each device in the result of the "list" command.
