Funambol
Introduction
The Funambol middleware allows you to synchronize mobile devices with SOGo through the use of the Funambol SOGo Connector. The connector allows any SyncML enabled devices to fully synchronize contacts, events and tasks with SOGo.
This HOWTO describes the installation procedure for installing Funambol with the SOGo Connector on an SME8b5 installation.
Download & Install Funambol
Goto https://www.forge.funambol.org/DomainHome.html to download Funambol 8.0. The latest GNU/Linux 32bit funambol server is 8.5, but this has not been confirmed yet for use with SOGO.
wget http://download.forge.objectweb.org/sync4j/funambol-8.0.2.bin
Run the binary to install:
chmod +x funambol-8.0.2.bin ./funambol-8.0.2.bin
Agree on the licence terms and accept /opt as the directory to extract Funambol. This will install it in:
/opt/Funambol
At the end of the install, answer NO on the question if you want to start the server.
Setup Funambol to use MySQL
Download & Configure MySQL JDBC driver
Funambol by installation defaults to use the Hypersonic DB engine, but SOGo uses MySQL and for Funambol to access the SOGo databases it needs to be setup to also use MySQL for the Funambol database.
Goto http://dev.mysql.com/downloads/connector/j/5.0.html to download the JDBC driver for MySQL. The current version is mysql-connector-java-5.0.8.zip.
unzip mysql-connector-java-5.0.8.zip mkdir -p /opt/Funambol/tools/mysql/lib cp mysql-connector-java-5.0.8/mysql-connector-java-5.0.8-bin.jar /opt/Funambol/tools/mysql/lib rm -rf mysql-connector-java-5.0.8
Edit the /opt/Funambol/ds-server/install.properties file to change the Funambol DB connector to MySQL.
vim /opt/Funambol/ds-server/install.properties
Change the line with dbms= to:
# The DBMS name. One of: # - hypersonic # - postgresql # - mysql # dbms=mysql
Comment out the existing jdbc driver for Hypersonic and add the MySQL connection information:
# MySQL # ===== jdbc.classpath=../tools/mysql/lib/mysql-connector-java-5.0.8-bin.jar jdbc.driver=com.mysql.jdbc.Driver jdbc.url=jdbc:mysql://localhost/funambol?characterEncoding=UTF-8 jdbc.user=funambol jdbc.password=yourpassword
Reconfigure MySQL for InnoDB and access from the local network
Funambol uses MySQL with the InnoDB engine and uses networking for access.
/sbin/e-smith/config setprop mysqld InnoDB enabled /sbin/e-smith/config setprop mysqld LocalNetworkingOnly no /sbin/e-smith/expand-template /etc/my.cnf /etc/rc.d/rc7.d/S50mysqld restart
Creating MYSQL user and database
To create the Funambol Database, you'll need to perform each of the following steps:
mysqladmin create funambol --default-character-set=utf8 mysql -e "grant all privileges on funambol.* to funambol@localhost identified by 'yourpassword'" mysql -e "flush privileges"
Disable Hypersonic JDBC driver
Edit /opt/Funambol/bin/funambol and change COMED=true to COMED=false somewhere around line 44.
This prevents the start/stop script from trying to start or stop the Hypersonic database, since we’re are now using MySQL.
Optionally you can rm -rf /opt/Funambol/tools/hypersonic to save a bit of disk space.
Create Funambol user and group
groupadd funambol useradd -g funambol -d /opt/Funambol funambol chmod 770 /opt/Funambol/
Set Funambol to start on system startup
To make Funambol start automagically, create
vim /etc/init.d/funambol
with the following content:
#! /bin/bash # # funambol Start the funambol services # NAME="Funambol 8.0 with SOGO Connector" FUNAMBOL_HOME=/opt/Funambol/bin FUNAMBOL_USER=funambol case "$1" in start) echo -ne "Starting $NAME.\n" cd $FUNAMBOL_HOME /bin/su $FUNAMBOL_USER funambol start ;; stop) echo -ne "Stopping $NAME.\n" cd $FUNAMBOL_HOME /bin/su $FUNAMBOL_USER funambol stop ;; *) echo "Usage: /etc/init.d/funambol {start|stop}" exit 1 ;; esac exit 0
complete it with:
chmod 755 /etc/init.d/funambol ln -s /etc/init.d/funambol /etc/rc.d/rc7.d/S98funambol ln -s /etc/init.d/funambol /etc/rc.d/rc6.d/K02funambol ln -s /etc/init.d/funambol /etc/rc.d/rc2.d/K02funambol ln -s /etc/init.d/funambol /etc/rc.d/rc1.d/K02funambol ln -s /etc/init.d/funambol /etc/rc.d/rc0.d/K02funambol
Add the SOGo Connector
At this stage the core Funambol installation is complete with the exception of the creation of the Funambol database tables. The sections below add the SOGo parts before doing so.
Apache Commons Components
The Funambol SOGo Connector requires Apache commons collections (v3.2.1), confguration (v1.6), logging (v1.1), lang (v2.4) and the JSON.simple package. The following subsections have the command required to download and insert the .jar files into the Funambol installation.
These components can be downloaded from here:
http://commons.apache.org/
and are copied into the following directory
cd /opt/Funambol/tools/tomcat/lib/
collections (v3.2.1)
wget http://www.apache.org/dist/commons/collections/binaries/commons-collections-3.2.1-bin.zip unzip commons-collections-3.2.1-bin.zip cp -p commons-collections-3.2.1/commons-collections-3.2.1.jar /opt/Funambol/tools/tomcat/lib/ rm -rf commons-collections-3.2.1
confguration (v1.6)
wget http://www.apache.org/dist/commons/configuration/binaries/commons-configuration-1.6.zip unzip commons-configuration-1.6.zip cp -p commons-configuration-1.6/commons-configuration-1.6.jar /opt/Funambol/tools/tomcat/lib/ rm -rf commons-configuration-1.6
logging (v1.1)
wget http://www.apache.org/dist/commons/logging/binaries/commons-logging-1.1.1-bin.zip unzip commons-logging-1.1.1-bin.zip cp -p commons-logging-1.1.1/commons-logging-1.1.1.jar /opt/Funambol/tools/tomcat/lib/ rm -rf commons-logging-1.1.1
lang (v2.4)
wget http://www.apache.org/dist/commons/lang/binaries/commons-lang-2.5-bin.zip unzip commons-lang-2.5-bin.zip cp -p commons-lang-2.5/commons-lang-2.5.jar /opt/Funambol/tools/tomcat/lib/ rm -rf commons-lang-2.5
json-simple
wget http://json-simple.googlecode.com/files/json_simple.jar cp json_simple.jar /opt/Funambol/tools/tomcat/lib/
Download & Configure Funambol SOGo Connector
Check here: http://www.sogo.nu/english/downloads/backend.html for the latest version of the Funambol SOGo Connector
wget http://www.scalableogo.org/uploads/Funambol/funambol-sogo-1.0.7.s4j cp funambol-sogo-1.0.7.s4j /opt/Funambol/ds-server/modules
Then, open the /opt/Funambol/ds-server/install.properties file
vim /opt/Funambol/ds-server/install.properties
and add funambol-sogo-1.0.7 at the end of the "modules-to-install" line.
Install Modules and Create Funambol Database Tables
With Funambol ready to go and the SOGo modules in place, Funambol needs to be configured and the database tables created by issuing the following commands :
cd /opt/Funambol/ ./bin/install
Answer 'yes' to all questions.
Once complete, update file ownerships for all files in the /opt/Funambol tree (the install creates a couple of configuration and log files in the /opt/Funambiol tree):
chown -R funambol:funambol /opt/Funambol/
Funambol is now installed. Start the Funambol server as the funambol user using:
/etc/init.d/funambol start
Verify Funambol Installation
Have a quick look if Funambol is running correctly by accessing the web page on:
http://<server_domain_name>:8080/funambol/ds
if the server is running, a web page with Funambol Data Synchronization Service information will appear.
Change Funambol Admin Password
The default Funambol admin password is sa. This can be changed with the admin-passwd utility but it needs a small fix to load the MySQL connector correctly.
Edit /opt/Funambol/bin/admin-passwd
vim /opt/Funambol/bin/admin-passwd
and change the line with JDBC_JAR near the top of the file to:
JDBC_JAR=/opt/Funambol/tools/mysql/lib/mysql-connector-java-5.0.8-bin.jar
Save and run:
cd /opt/Funambol ./bin/admin-passwd
and follow the prompts.
Public Access to Funambol
And if you want to access Funambol outside your local network, you must open port 8080:
config set funambol service access public status enabled TCPPort 8080 signal-event remoteaccess-update
Create SOGo Sync Sources
The SOGo-Funambol documentation describes how to create the sogo-cal, sogo-card and sogo-todo sync sources through the Funambol administration tool. There are Windows versions of this tool that can be run from a PC and connect to the Funambol server we just installed.
However, the commands below emulate this process and creates entries in the funambol database and the sections below create templated versions of the required XML files, as this allows the SOGo database password to be inserted into these XML files.
The section below inserts the required entries into the funambol database. The next sections create and expand the template files as needed to complete the configuration for SOGo.
Create Funambol Database Sync Source Entries
Create a temporary SQL file:
vim sogo-sync-source-insert.sql
and insert:
INSERT INTO `fnbl_sync_source` (`uri`, `config`, `name`, `sourcetype`) VALUES ('sogo-cal', 'sogo/sogo/sogo/sogo-cal.xml', 'sogo-cal', 'sogo'), ('sogo-card', 'sogo/sogo/sogo/sogo-card.xml', 'sogo-card', 'sogo'), ('sogo-todo', 'sogo/sogo/sogo/sogo-todo.xml', 'sogo-todo', 'sogo');
save the file and then insert the SQL into the funambol database:
mysql funambol --user=funambol --password=yourpassword < sogo-sync-source-insert.sql
Configuring the Calendar Sync connection
mkdir -p /opt/Funambol/config/sogo/sogo/sogo mkdir -p /etc/e-smith/templates/opt/Funambol/config/sogo/sogo/sogo/sogo-cal.xml cd /etc/e-smith/templates/opt/Funambol/config/sogo/sogo/sogo/sogo-cal.xml touch template-begin
Edit a new file with:
vim sogo-cal.xml
And insert the following. Note the $sogod{'DbPassword'} in the scripts below. This pulls in the the database password that SOGO uses to access the MySQL database.
<?xml version="1.0" encoding="UTF-8"?> <java version="1.5.0_10" class="java.beans.XMLDecoder"> <object class="ca.inverse.sogo.engine.source.SOGoSyncSource"> <void property="databasePassword"> <string>{$sogod{'DbPassword'}}</string> </void> <void property="databaseURL"> <string>jdbc:mysql://localhost/sogo</string> </void> <void property="databaseUsername"> <string>sogo</string> </void> <void property="info"> <object class="com.funambol.framework.engine.source.SyncSourceInfo"> <void property="supportedTypes"> <array class="com.funambol.framework.engine.source.ContentType" length="1"> <void index="0"> <object class="com.funambol.framework.engine.source.ContentType"> <void property="type"> <string>text/x-vevent</string> </void> <void property="version"> <string>1</string> </void> </object> </void> </array> </void> </object> </void> <void property="name"> <string>sogo-cal</string> </void> <void property="sourceURI"> <string>sogo-cal</string> </void> </object> </java>
And don't forget to:
expand-template /opt/Funambol/config/sogo/sogo/sogo/sogo-cal.xml
Configuring the Address Book Sync connection
mkdir -p /etc/e-smith/templates/opt/Funambol/config/sogo/sogo/sogo/sogo-card.xml cd /etc/e-smith/templates/opt/Funambol/config/sogo/sogo/sogo/sogo-card.xml touch template-begin vim sogo-card.xml
Insert the following:
<?xml version="1.0" encoding="UTF-8"?> <java version="1.5.0_10" class="java.beans.XMLDecoder"> <object class="ca.inverse.sogo.engine.source.SOGoSyncSource"> <void property="databasePassword"> <string>{$sogod{'DbPassword'}}</string> </void> <void property="databaseURL"> <string>jdbc:mysql://localhost/sogo</string> </void> <void property="databaseUsername"> <string>sogo</string> </void> <void property="info"> <object class="com.funambol.framework.engine.source.SyncSourceInfo"> <void property="supportedTypes"> <array class="com.funambol.framework.engine.source.ContentType" length="1"> <void index="0"> <object class="com.funambol.framework.engine.source.ContentType"> <void property="type"> <string>text/x-vcard</string> </void> <void property="version"> <string>1</string> </void> </object> </void> </array> </void> </object> </void> <void property="name"> <string>sogo-card</string> </void> <void property="sourceURI"> <string>sogo-card</string> </void> </object> </java>
And
expand-template /opt/Funambol/config/sogo/sogo/sogo/sogo-card.xml
Configuring the Todo List Sync connection
mkdir -p /etc/e-smith/templates/opt/Funambol/config/sogo/sogo/sogo/sogo-todo.xml cd /etc/e-smith/templates/opt/Funambol/config/sogo/sogo/sogo/sogo-todo.xml touch template-begin vim sogo-todo.xml
Insert the following:
<?xml version="1.0" encoding="UTF-8"?> <java version="1.5.0_10" class="java.beans.XMLDecoder"> <object class="ca.inverse.sogo.engine.source.SOGoSyncSource"> <void property="databasePassword"> <string>{$sogod{'DbPassword'}}</string> </void> <void property="databaseURL"> <string>jdbc:mysql://localhost/sogo</string> </void> <void property="databaseUsername"> <string>sogo</string> </void> <void property="info"> <object class="com.funambol.framework.engine.source.SyncSourceInfo"> <void property="supportedTypes"> <array class="com.funambol.framework.engine.source.ContentType" length="1"> <void index="0"> <object class="com.funambol.framework.engine.source.ContentType"> <void property="type"> <string>text/x-vtodo</string> </void> <void property="version"> <string>1</string> </void> </object> </void> </array> </void> </object> </void> <void property="name"> <string>sogo-todo</string> </void> <void property="sourceURI"> <string>sogo-todo</string> </void> </object> </java>
And
expand-template /opt/Funambol/config/sogo/sogo/sogo/sogo-todo.xml
Auto-create Funambol user accounts
Edit the Funambol config file
vim /opt/Funambol/config/Funambol.xml
And change the officer parameter:
<void property="officer"> <string>ca/inverse/sogo/security/SOGoOfficer.xml</string> </void>
Then create the SOGoOfficer.xml file
vim /opt/Funambol/config/ca/inverse/sogo/security/SOGoOfficer.xml
and insert or update to:
<?xml version="1.0" encoding="UTF-8"?> <java version="1.4.0" class="java.beans.XMLDecoder"> <object class="ca.inverse.sogo.security.SOGoOfficer"> <void property="host"> <string>localhost</string> </void> <void property="port"> <string>20000</string> </void> </object> </java>
Cleanup and Restart
Once complete, update file ownerships for all files again in the /opt/Funambol tree
chown -R funambol:funambol /opt/Funambol/
Stop and Start the Funambol server as the funambol user using:
/etc/init.d/funambol stop /etc/init.d/funambol start
Funambol Client Configuration
The URL for accessing the Funambol server from mobile devices is:
http://<server_domain_name>:8080/funambol/ds
To connect to the SOGO Funambol sync items use:
- Contacts: sogo-card
- Calendar: sogo-cal
- Tasks: sogo-todo
References
- Funambol Documentation: https://www.forge.funambol.org/download/documentation.html
- SOGo Documentation: http://www.sogo.nu/english/downloads/documentation.html