This manual is deprecated. Please visit https://groupoffice.readthedocs.io for the latest documentation.

Z-push 2.1

From Group-Office Groupware and CRM Documentation
Revision as of 16:32, 21 November 2013 by Wsmits (Talk | contribs) (Known issues per device)

Jump to: navigation, search

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.

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-push2" 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.0/. We used version 2.0.7 (But it's probably best to take the latest stable 2.0.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-push2"

4. Copy the folder modules/sync/z-push2/backend/go/ to modules/z-push2/backend/

5. Copy modules/sync/z-push2/config.php to modules/z-push2/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-push2/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
HTC HERO (maybe more) Contacts that are synced to the phone and then marked as favorite on the phone will not be synced after that anymore. (This will break synchronisation)

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:

http://z-push.sourceforge.net/phpbb/viewtopic.php?f=4&t=1245&p=4762&hilit=apache_request_headers#p4762

Uninstall

Remove the z-push 2 folder from the modules directory of Group-Office.

User Manual

Visit the following page for client instructions:

Synchronization

Additional Notes

For debugging change modules/z-push/config.php:

define('LOGLEVEL', LOGLEVEL_ALL);

A log will be generated in /home/groupoffice/log/

Debugging

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-push2
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 runned the z-push-admin tool then you can find a better error description for each device in the result of the "list" command.