OX6:OX Mobile Web Interface

Revision as of 14:19, 3 April 2012 by Mheiland (talk | contribs) (Theming)

Information and Installation of Open-Xchange Mobile Web Interface

Notice

This description is updated for version 1.1 of the Mobile Web Interface (Mobile Web Interface). If you are looking for the manual of version 1.0, visit this site [Old manual [1]]

Description

The Open-Xchange Mobile Web Interface provides you access to your data from the Open-Xchange Server 6 via your smartphone. The Open-Xchange Mobile Web Interface offers online and offline access to appointments, contacts and mails on the road using your smartphone's browser. Optimized for low bandwiths the Open-Xchange Mobile Web Interface offers instant and fast over the air access to your data, which are at the same time safely stored on Open-Xchange Server. The following modules are supported:

  • E-Mail
  • Calendar
  • Contacts

Moreover the web interface offers seamless integration to use your phones basic functions like phone calls. You can easily start calls from your Open-Xchange contacts on your smartphone or directly send E-Mails.

Features and Functions

Mail Module

  • Access to all Open-Xchange private mail folders
  • Creation of new e-mails
  • Answer, forward and delete e-mails
  • Move mails (since 1.1)
  • Mail attachments (Attachment handling/support is defined by mobile device)

Contact Module

  • Access to all Open-Xchange contact folders and contacts with details
  • Creation of e-mails directly from contact module
  • Start calls directly from contact module
  • Google Maps ® v. 3 integration for addresses (since 1.1)

Calendar Module

  • Access to all Open-Xchange calendar folders and appointments with details
  • Accept/Decline appointments
  • View participants, resources and notes each appointment

Persistence of the Mobile Web Interface

  • Offline capability
  • All contacts are available offline
  • All appointments are available offline
  • All mail header are available offline
  • All mails which are opened once are available offline

Configuration

  • Timeframe which will be checked for appointments (1 Week, 2 Weeks, 1 Month, 2 Months)
  • Subscription of contact folders
  • Subscription of mail folders

Themeability, branding and i18n

  • i18n for DE, EN, ES, FR, NL and PL, other languages can be added.
  • Themeability by CSS
  • JavaScript plugins for branding

Supported devices

The Open-Xchange Mobile Web Interface is designed to run on modern devices running Android or iOS. It can also used with modern desktop browsers.

Device Support    
Apple iOS iOS 3 - 5.1
Android yes, Android 2.2 - 4.0 Official Supported by OX: Google Nexus One (Android 2.3.3), Samsung Galaxy Nexus (Android 4.0.3). The web interface is optimized for a display size of 320 x 480 pixels. Smaller resolutions may result displaying issues of some UI elements
Windows Phone 7 not yet, scheduled for version 1.2

Technical overview

  • Based on HTML5, CSS, Javascript (Framework jQuery Mobile)
  • Optimized for Webkit browsers like Mobile Safari and Chrome. Will also work with restrictions on Firefox and Opera Mobile
  • Complete offline capability


Offline Mode details

The Open-Xchange Mobile Web Interface uses HTML5 to provide an offline mode for the user. To do this, there are two different kinds of storage mechanisms.

  • The whole web interface uses caching by incorporating the "HTML5 application cache". This will be done on the first visit/start of the web interface. After this initial download, all graphics, language files, js-files and everything else which is needed to run the web interface is stored locally on your phone in a storage managed by the browser.
  • The data from the OX server will be stored using the HTML5 storage mechanism which will be supportet by the users device. These can be a HTML5 local storage, session storage or an SQLite database. For the user there's no difference between these different storage modes.

Requirements

  • Open-Xchange Server >= v.6.20 rev 21

Install on OX AppSuite

Debian GNU/Linux 8.0

Add the following entry to /etc/apt/sources.list.d/open-xchange.list if not already present:

deb https://LDBACCOUNT:LDBPASSWD@software.open-xchange.com/OX6/OXtender-stable/MobileWebInterface/DebianJessie/ /

and run

$ apt-get update
$ apt-get install open-xchange-mobile open-xchange-mobile-theme-default open-xchange-mobile-config

Debian GNU/Linux 9.0

Add the following entry to /etc/apt/sources.list.d/open-xchange.list if not already present:

deb https://LDBACCOUNT:LDBPASSWD@software.open-xchange.com/OX6/OXtender-stable/MobileWebInterface/DebianStretch/ /

and run

$ apt-get update
$ apt-get install open-xchange-mobile open-xchange-mobile-theme-default open-xchange-mobile-config

SUSE Linux Enterprise Server 12

Add the package repository using zypper if not already present:

$ zypper ar https://LDBACCOUNT:LDBPASSWD@software.open-xchange.com/OX6/OXtender-stable/MobileWebInterface/SLE_12 MobileWebInterface


and run

$ zypper ref
$ zypper in open-xchange-mobile open-xchange-mobile-theme-default open-xchange-mobile-config

RedHat Enterprise Linux 6

Start a console and create a software repository file if not already present:

$ vim /etc/yum.repos.d/MobileWebInterface.repo

[MobileWebInterface]
name=Open-Xchange
baseurl=https://LDBACCOUNT:LDBPASSWD@software.open-xchange.com/OX6/OXtender-stable/MobileWebInterface/RHEL6/
gpgkey=https://software.open-xchange.com/oxbuildkey.pub
enabled=1
gpgcheck=1
metadata_expire=0m

and run

$ yum update
$ yum install open-xchange-mobile open-xchange-mobile-theme-default open-xchange-mobile-config

RedHat Enterprise Linux 7

Start a console and create a software repository file if not already present:

$ vim /etc/yum.repos.d/MobileWebInterface.repo

[MobileWebInterface]
name=Open-Xchange
baseurl=https://LDBACCOUNT:LDBPASSWD@software.open-xchange.com/OX6/OXtender-stable/MobileWebInterface/RHEL7/
gpgkey=https://software.open-xchange.com/oxbuildkey.pub
enabled=1
gpgcheck=1
metadata_expire=0m

and run

$ yum update
$ yum install open-xchange-mobile open-xchange-mobile-theme-default open-xchange-mobile-config

CentOS 6

Start a console and create a software repository file if not already present:

$ vim /etc/yum.repos.d/MobileWebInterface.repo

[MobileWebInterface]
name=Open-Xchange
baseurl=https://LDBACCOUNT:LDBPASSWD@software.open-xchange.com/OX6/OXtender-stable/MobileWebInterface/RHEL6/
gpgkey=https://software.open-xchange.com/oxbuildkey.pub
enabled=1
gpgcheck=1
metadata_expire=0m

and run

$ yum update
$ yum install open-xchange-mobile open-xchange-mobile-theme-default open-xchange-mobile-config

CentOS 7

Start a console and create a software repository file if not already present:

$ vim /etc/yum.repos.d/MobileWebInterface.repo

[MobileWebInterface]
name=Open-Xchange
baseurl=https://LDBACCOUNT:LDBPASSWD@software.open-xchange.com/OX6/OXtender-stable/MobileWebInterface/RHEL7/
gpgkey=https://software.open-xchange.com/oxbuildkey.pub
enabled=1
gpgcheck=1
metadata_expire=0m

and run

$ yum update
$ yum install open-xchange-mobile open-xchange-mobile-theme-default open-xchange-mobile-config

Installing Updates

Debian

$ apt-get update
$ apt-get dist-upgrade

If you want to see, what apt-get is going to do without actually doing it, you can run:

$ apt-get dist-upgrade -s

SUSE Linux Enterprise Server

$ zypper dup

You might need to run

$ zypper ref

to update the repository metadata before running zypper up.

RedHat Enterprise Linux

$ yum update

Upgrading from previous versions

If you have the previous version of the Mobile Web Interface installed (1.0), you can not upgrade to version 1.1 or later directly. Due to a package rename you have to remove the old packages before installing the new ones. The packages for version 1.0 are prefixed with "open-xchange-gui-mobile-v2", the new ones are prefixed with "open-xchange-mobile*".

Debian

$ apt-get purge open-xchange-gui-mobile-v2
$ apt-get purge open-xchange-gui-mobile-v2-gui open-xchange-gui-mobile-v2-theme-default

SUSE Linux Enterprise Server

$ zypper remove open-xchange-gui-mobile-v2
$ zypper remove open-xchange-gui-mobile-v2-gui open-xchange-gui-mobile-v2-theme-default

RedHat Enterprise Linux

$ yum remove open-xchange-gui-mobile-v2
$ yum remove open-xchange-gui-mobile-v2-gui open-xchange-gui-mobile-v2-theme-default

Please note, the package open-xchange-gui-mobile-v2 is located on your ox backend system, open-xchange-gui-mobile-v2-gui and open-xchange-gui-mobile-v2-theme-default are installed on your webserver machine. If both systems are the same you have to remove all packes on the same system.

After removing the old packages proceed with the installation of the new version 1.1 or later

Configuration

Installation on the Apache or another webserver:

  • You need to add a new mimetype to your webserver configuration to make sure the caching (offline mode) works.
    • On Apache servers you can add the mimetype either global or via ".htaccess" file.
    • For global configuration edit the file mime.conf under /etc/apache2/mods-enabled/
    • Add the line "AddType text/cache-manifest .manifest" to the file, save and restart apache
    • For configuration via .htaccess file just add a .htaccess file to the install directory. This should include the line "AddType text/cache-manifest .manifest'". Note: Either the global configuration or the .htaccess file should be used. (.htaccess files will only work if your Apache settings contain AllowOverride. For further information on mime types, please refer to your webservers user manual)
  • To direct to the correct host another site in apache is needed. Create a file named "mobile" in /etc/apache2/sites-available (and enable it by linking to it from sites-enabled, of course):
<VirtualHost *:80>
   ServerAdmin webmaster@localhost
   ServerName mobile.YOUR_DOMAINAME.TLD
   ServerAlias m.YOUR_DOMAINAME.TLD
   DocumentRoot /var/www/mobile
   <Directory />
       Options FollowSymLinks
       AllowOverride None
   </Directory>
   <Directory /var/www/mobile>
       Options Indexes FollowSymLinks MultiViews
       AllowOverride None
       Order allow,deny
       allow from all
   </Directory>
   ErrorLog /var/log/apache2/error.log
   # Possible values include: debug, info, notice, warn, error, crit,
   # alert, emerg.
   LogLevel warn
   CustomLog /var/log/apache2/access.log combined
</VirtualHost>
  • For more details and README see the systems documentation directory (/usr/share/doc).

Running the Open-Xchange Mobile Web Interface on your smartphone

After installation of the web interface on your webserver, a client can easily access the web interface via his phone's browser. We recommend to add a new subdomain to your web address to make access for clients easy. A short subdomain like https://m.example.com which points to your installation will save users from entering a long URL on their devices.

Like mentioned before, the Open-Xchange Mobile Web Interface is a pure web application. Due to this fact there is no installation or download needed to use this web interface on a smartphone. Just add a bookmark in your browser to access the web interface again later.

Especially on iOS devices there's a seamless integration within the native apps installed via the AppStore®. Just add a new bookmark to the Open-Xchange Mobile Web Interface and choose "Add to homescreen". After this, the Open-Xchange Mobile Web Interface will place a new app icon on the homescreen.

Using the offline mode

During the first run, the web interface is stored localy on your smartphone. These caching mechanism makes a later access to the web interface very fast and gives you the possibility to run the web interface even if there's no internet connection available.

The Open-Xchange Mobile Web Interface detects on startup whether there's an internet connection available or not. If not, the web interface will start in offline mode. In this case most features which need a internet connection are disabled. In offline mode you can access all your subscribed contacts and all of your appointments. Also all your mail headlines are available. Furthermore each email which was opened earlier is available in offline mode.

Known Issues

Client

  • The Open-Xchange Mobile Web Interface uses a custom, built-in navigation and history. To navigate back you will have to use the "back" buttons located on the top-left of the page. Using the browser's back button will sometimes not bring you back to the right page.
  • If you clean the browser cache on your device or reset it to defaults, all local stored data will be flushed.

Server

  • The Open-Xchange backend uses a security mechanism called "IP check". This feature is enabled by default for a OX Server. This feature will have an impact on the usage of the Open-Xchange Mobile Web Interface, especially the option "Stay logged in". This feature will only work if your IP address does not change between the restarts of the web interface. If you are changing your network connection often when you travel around (different GSM spots, WIFI connections), your phone will get new IP addresses to access the internet. This will cause the OX backend to refuse your auto-login attempt (which is performed on every start of the web interface) because your IP address has changed.

To avoid this you can either turn off the IP check feature on the OX backend or add the Open-Xchange Mobile Web Interface to the client whitelist table for IP-check. This will disable the IP check just for the web interface.

Theming

The Open-Xchange Mobile Web Interface is themed via CSS and HTML. To create your own theme you will have to create new graphics and edit the css file in the theme path. To do so follow the steps below:

  1. Locate the theme path under "path to your webroot/mobile/theme"
  2. To create your own theme make a copy of this folder and backup the original one
  3. The folder contains a css file which holds all editable values for the web interface. To change values edit the original file or create a new one which overwrites some of the old styles. Use Firebug or the Chrome/Safari developer tools to locate css classes and styles you want to edit.
  4. The folders "img" holds all graphics which are used in the web interface.
  5. Always remember: Your are designing for mobile. This means: Keep fonts clear and easy to read. Keep file sizes small due to small bandwiths. Keep buttons big enought the user can touch them easily.

Reporting Bugs

Open-Xchange is interested in learning about bugs, specifically in your runtime environment. If you experience any misbehaviors, please report bugs via our public bugzilla: Open-Xchange Bugzilla
Product: Mobile Web Interface

The Open-Xchange Mobile Web Interface logs all errors to a logfile which can be found under Settings -> System Messages

Please note

Please read the SDB article to inform you about the reasons and solution.