SourceForge.net

 OpenGroupware.org Installation Guide

 ====================================

 Prerequisites

 =============

 - SOPE >= 1.3.11

   - download from: http://www.sogo.nu/english/downloads/backend.html

 - gnustep-make >= 2.6.1

   - download from: ftp://ftp.gnustep/org/pub/gnustep/core

 - libobjc2 (optional)

   - download from: http://download.gna.org/gnustep/

 - gnustep-base

   - when compiling with gcc < 4.6 or clang then gnustep-base >= 1.22.1

   - when compiling with gcc >= 4.6, then from svn

   - download from: ftp://ftp.gnustep/org/pub/gnustep/core

 - dependent packages: The names are from OpenSUSE 12.1, and may differ

   depending on your Linux distribution

 - libxml2/libxml2-devel

 - openldap2/openldap2-devel

 - postgresql/postgresql-devel

 - libffi/libffi-devel

 - apache2/apache2-devel and corresponding devel packages

 - libapr1/libapr1-devel

 Installing dependencies

 =======================

 If you OS/Distribution has packages of the required dependencies, then

 its recommended to install those. 

 Otherwise install the dependencies, following their installation instructions

 in the following order:

 libxml2/openldap2/postgresql

 libobjc2 (optional)

 gnustep-make

 gnustep-base

 SOPE

 Building

 ========

 If the prerequisites are properly fulfilled, building OpenGroupware.org is

 as simple as:

   $ ./configure

   $ make

 Installation should only take a couple of minutes/seconds, depending on the speed

 of your machine.

 In case make fails while building mod_ngobjweb, then its likely that it cannot

 find the apr-utils. You can specify those as parameters, for example on OpenSUSE:

   $ make APXS=/usr/bin/apr-1-config APXS=/usr/sbin/apxs2

 Installation:

   $ sudo make install

 Configuration

 =============

 TODO: write configuration guide for OGo

 - mod_ngobjweb setup

 - init script

 - starting OGo on the shell

 - ZideStore

 database

 ********

   su - postgres

   createuser OGo

   createdb   OGo

   psql -h localhost OGo OGo (must work)

     => if this doesn't work, you need to allow TCP/IP in pg_hba.conf, eg:

        "host OGo OGo 127.0.0.1 255.255.255.255 trust"

        (you should use appropriate password auth in deployments!)

   > ALTER ROLE "OGo" WITH PASSWORD  'abc123';

   cd Database/PostgreSQL/

   psql -h localhost OGo OGo < pg-build-schema.psql

 OGo system user

 ===============

 You should not run OGo as root, therefore create a system user:

  sudo groupadd ogo

  sudo useradd -d /var/opengroupware -g ogo ogo

  sudo mkdir /var/opengroupware

  sudo mkdir /var/log/opengroupware

  sudo chown ogo:ogo /var/opengroupware /var/log/opengroupware

 Apache Configuration

 ====================

 You have to edit your httpd.conf file, or whatever is appropriate for

 your OS/Distribution.

 Load the ngobjweb module:

 LoadModule ngobjweb_module    /usr/lib/apache/modules/mod_ngobjweb.so

 Then you can add the following to your VirtualHost entry:

 <IfModule ngobjweb_module.c>

   <LocationMatch "^/OpenGroupware55*">

     SetHandler NONE

   </LocationMatch>

   <LocationMatch "^/OpenGroupware*">

     SetAppPort 20000

     SetHandler ngobjweb-adaptor

   </LocationMatch>

   <LocationMatch ^/zidestore/*>

     SetAppPort 21000

     SetHandler ngobjweb-adaptor

   </LocationMatch>

   <LocationMatch ^/xmlrpcd/*>

     SetAppPort 22000

     SetHandler ngobjweb-adaptor

   </LocationMatch>

 </IfModule>

 Configuring OGo

 ===============

   as ogo system user do:

   $ defaults write ogo-webui WOPidFile /var/opengroupware/ogo-webui.pid

   $ defaults write ogo-zidestore WOPidFile /var/opengroupware/ogo-zidestore.pid

   $ defaults write ogo-xmlrpcd WOPidFile /var/opengroupware/ogo-xmlrpcd.pid

   $ defaults write ogo-webui WOLogFile /var/log/opengroupware/ogo-webui.log

   $ defaults write ogo-zidestore WOLogFile /var/log/opengroupware/ogo-zidestore.log

   $ defaults write ogo-xmlrpcd WOLogFile /var/log/opengroupware/ogo-xmlrpcd.log

   $ defaults write ogo-webui WOPort 20000

   $ defaults write ogo-zidestore WOPort 21000

   $ defaults write ogo-xmlrpcd WOPort 22000

   $ defaults write NSGlobalDomain imap_host 127.0.0.1

   $ defaults write NSGlobalDomain UseSkyrixLoginForImap YES

   $ defaults write NSGlobalDomain LDAPInitialBindSpecific YES

   $ defaults write NSGlobalDomain LDAPLoginAttributeName uid

   $ defaults write NSGlobalDomain LSAuthLDAPServerPort 389

   $ defaults write NSGlobalDomain LSAuthLDAPServerRoot ou=People,dc=MyDomain

   $ defaults write NSGlobalDomain LSAuthLDAPServer 127.0.0.1

   $ defaults write NSGlobalDomain LSConnectionDictionary \

     '{userName="OGo"; databaseName="OGo";hostName="localhost";password="abc123";}'

   For more information consult the WMOGAG (WiteMice OGo Admin Guide).

 Starting OGo

 ============

  $ sudo su - ogo

  $ /usr/local/sbin/ogo-webui

  $ /usr/local/sbin/ogo-zidestore

  $ /usr/local/sbin/ogo-xmlrpcd 

 init-scripts

 ============

 Init-Scripts depend on the actual platform, so you need to

 come up with an own. The templates used for the RPM packages can

 be found in:

   maintenance/rpm_buildenvironment/initscript_templates/

 Upgrading from older versions to 5.5

 ====================================

   NOTE: In case you had the commercial snsd running with old version

         of OGo, this will not work anymore. There may be a replacement

         in the future, but for now it is not supported.

   If you are upgrading, removing defaults should work fine if you use

   defaults values, thats is:

     defaults delete NSGlobalDomain LSModelName

     defaults delete NSGlobalDomain NGBundlePath

     defaults delete NSGlobalDomain LSAdaptor

   Since the names of the binaries do not have the version number

   included anymore, you may have to change the defaults to match

   the new names of the binaries.

 Documentation for new features

 ==============================

 Location based services

 =======================

 Show addresses on Google Maps

 +++++++++++++++++++++++++++++

 You can now show an address, or multiple addresses with markers on Google Maps, 

 via the Google Maps API. To do so, you have to register an KEY for your domain.

 You have to register your domain here: http://code.google.com/apis/maps/signup.html

 defaults write NSGlobalDomaon GoogleMapsURL http://maps.google.com/maps?file=api&v=2&key=<YOUR KEY GOES HERE>

 You have to define a center for the map, when multiple markers are shown:

 defaults write NSGLobalDomain NSGlobalDomain GoogleMapsCenterCoordinates 52.000,12.0000

 For each address shown on the MAP, OGo will create a little XML file, which is cached on the

 server. The web server should be able to read that directory, and the OGo system user

 should be able to write to that directory:

 defaults write NSGlobalDomain GoogleMapsXMLCoordinatesWebBaseURL https://www.l00-bugdead-prods.de/coordinates

 defaults write NSGlobalDomain GoogleMapsXMLCoordinatesFileBaseURL /var/www/htdocs/coordinates

 To be able to access location based services that needs the coordinates. OGo must be able to

 resolve the coordinates from the addresses via the Google Geocoding API.

 You have to define the following default:

 defaults write NSGlobalDomain GoogleGeocodingURL http://maps.google.com/maps/geo?q=$STREET$+$CITY$+$ZIP$+$COUNTRY$&output=csv&key=<YOUR KEY GOES HERE>

 To access location based services related to an address, you have to define the OGoAddressMapLinks default.

 Take this as an example:

 NSGlobalDomain OGoAddressMapLinks '{

     GeoCaching = {

         UseGoogleMapsAPI = YES;

         icon = "GeoCaching.png";

         target = "_new";

         url = "http://www.geocaching.com/seek/nearest.aspx?origin_lat=$LATITUDE$&origin_long=$LONGITUDE$";

     };

     GermanWeatherService = {

         UseGoogleMapsAPI = NO;

         icon = "Wetter.png";

         target = "_new";

         url = "http://wetter.rtl.de/shared/php/search_plz_ort.php?in=$ZIP$";

     };

     GoogleMaps = {

         UseGoogleMapsAPI = NO;

         icon = "GoogleMaps.png";

         target = "_new";

         url = "http://maps.google.de/maps?f=q&output=html&q=$COUNTRY$+$ZIP$+$CITY$+$STREET$&btnG=Maps-Suche";

     };

     OpenStreetMap = {

         UseGoogleMapsAPI = YES;

         icon = "OpenStreetMap.png";

         target = "_new";

         url = "http://www.openstreetmap.org/?lat=$LATITUDE$&lon=$LONGITUDE$&zoom=15&layers=B00FF";

     };

 }'

 Each entry in the list defines a location based service, the parameters are as follows:

  * UseGoogleMapsAPI: YES/NO - set to YES in case LAT/LON needs to be used to access the service, otherwise NO

  * icon: The name of the icon to be used for this service

    * a copy of the icon has to be placed into each Themes icon directory

  * target: the name of the new window/tab that will be opened

  * url: the URL to access the service

 CTI Integration with Asterisk

 =============================

 It is now possible to trigger phone calls via Asterisk PBX.

 Since the CTI integration is a plugin, there can be multiple dialers in the future, so for

 now you have to choose the AsteriskDialer:

 defaults write NSGlobalDomain CTIDialer AsteriskDialer

 In case you need to suffix the number to dial with something you can use the 

 CTIPersonTelephoneFieldSuffix, otherwise, leave it empty:

 defaults write NSGlobalDomain CTIPersonTelephoneFieldSuffix ''

 To define, weather your phones are IAX2, SIP or others, you have to specify 

 this in the CTIPersonTelephoneFieldPrefix default. This limits the group

 of possible telephones to one client type, but will possibly change in the

 future:

 defaults write NSGlobalDomain CTIPersonTelephoneFieldPrefix 'IAX2/'

 In case you need to add a 0 to dial out, you have to configure the following:

 defaults write NSGlobalDomain AsteriskDialOutPrefix '0'

 In case you need to differentiate when between outgoing and internal calls, i.e. 

 when you need to prefix the call with 0, you have to specify the lenght of internal

 extensions:

 defaults write NSGlobalDomain AsteriskInternalExtensionLength 4

 You have to specify the outgoing and internal contexts:

 defaults write NSGlobalDomain AsteriskOutgoingContext default

 defaults write NSGlobalDomain AsteriskInternalContext internal

 You have to set the CTIPreferTelephoneField default to YES when you want to use

 the numbers stored in a telephone field. Otherwise you have to define a mapping

 of computers IP addresses with telephones.

 defaults write NSGlobalDomain CTIPreferTelephoneField YES

 You have to define the telephone field you want to use:

 defaults write CTIPersonTelephoneField 04_tel_ext

 In case you chose a non standard telephone field, you have to define the 

 chosen telephone field in the LSTeleType default for the Person:

 NSGlobalDomain LSTeleType '{

     Enterprise = (

         "01_tel",

         "02_tel",

         "10_fax",

         "80_tel_parts",

         "81_fax_parts"

     );

     Person = (

         "01_tel",

         "02_tel",

         "03_tel_funk",

         "04_tel_ext",

         "05_tel_private",

         "10_fax",

         "15_fax_private"

     );

 }'

 The connection to the asterisk is configured using the AsteriskCommands and 

 the OGoAsteriskConnectionDictionary defaults:

 NSGlobalDomain OGoAsteriskConnectionDictionary '{

     hostName = "127.0.0.1";

     port = 5038;

 }'

 NSGlobalDomain AsteriskCommands '{

     Login = {

         Action = login;

         ExpectedResult = Success;

         Parameters = {

             Events = off;

             Secret = <YOUR AGI PASSWORD GOES HERE>;

             Username = <YOUR AGI USERNAME GOES HERE>;

         };

     };

     Originate = {

         Action = originate;

         ExpectedResult = Success;

         Parameters = {

             Channel = "";

             Context = default;

             Exten = "";

             Priority = 1;

             Timeout = 30000;

         };

     };

     Ping = {

         Action = ping;

         ExpectedResult = Pong;

     };

 }'