Code

Resolve bug of writeGlobalAddressBook and cosmetic changes to README.
[gosa.git] / doc / README.openxchange
1 ### Small tutorial for use GOsa with open-xchange ###
3 Once installed open-xchange (http://www.open-xchange.org) and php4-pgsql 
4 module we must do some changes to get open-xchange running with GOsa.
6 - php.ini must have extension=pg_sql.so
8 - The webserver must have access to the Postgresql server.
10 - In the connectivity section of gosa.conf must have something like this:
11                 <tab class="oxchangeAccount"
12                         pghost="server"
13                         pguser="openexchange"
14                         pgpasswd="test"
15                         pgdbname="openexchange"
16                 />
18 -Make this changes to admintools.conf:
20 USERS_BASEDN="ou=people,dc=example,dc=org"
21 GROUP_BASEDN="ou=groups,dc=example,dc=org"
23 We suppose that the Base is "dc=example,dc=org"
25 - If you are using as rdn "uid=..", You must change in ldap.properties:
26 com.openexchange.groupware.ldap.OXUserObjectAttributeuserCountryName=userCountry
27  to
28 com.openexchange.groupware.ldap.OXUserObjectAttributeuserCountryName=st
30 com.openexchange.groupware.ldap.OXUserObjectAttributeimapServerName=imapServer
31  to
32 com.openexchange.groupware.ldap.OXUserObjectAttributeimapServerName=gosaMailServer
34 com.openexchange.groupware.ldap.OXUserObjectAttributesmtpServerName=smtpServer
35  to 
36 com.openexchange.groupware.ldap.OXUserObjectAttributesmtpServerName=gosaMailServer
40 - If you are using as rdn "cn=..", the ldap.properties configuration of open-xchange must be like this:
41 com.openexchange.groupware.ldap.inetOrgPersonAttributebusinessCategoryName=businessCategory
43 com.openexchange.groupware.ldap.inetOrgPersonAttributecnName=cn
45 com.openexchange.groupware.ldap.OXUserObjectAttributeCountryName=c
47 com.openexchange.groupware.ldap.inetOrgPersonAttributedescriptionName=description
49 com.openexchange.groupware.ldap.inetOrgPersonAttributedisplayNameName=displayName
51 com.openexchange.groupware.ldap.inetOrgPersonAttributeemployeeNumberName=employeeNumber
53 com.openexchange.groupware.ldap.inetOrgPersonAttributeemployeeTypeName=employeeType
55 com.openexchange.groupware.ldap.OXUserObjectAttributecoName=co
57 com.openexchange.groupware.ldap.inetOrgPersonAttributehomePhoneName=homePhone
59 com.openexchange.groupware.ldap.inetOrgPersonAttributehomePostalAddressName=homePostalAddress
61 com.openexchange.groupware.ldap.OXUserObjectAttributeInfoName=info
63 com.openexchange.groupware.ldap.inetOrgPersonAttributeinitialsName=initials
65 com.openexchange.groupware.ldap.inetOrgPersonAttributeinternationaliSDNNumberName=internationaliSDNNumber
67 com.openexchange.groupware.ldap.OXUserObjectAttributeIPPhoneName=IPPhone
69 com.openexchange.groupware.ldap.OXUserObjectAttributeotherfacsimiletelephonenumberName=otherfacsimiletelephonenumber
71 com.openexchange.groupware.ldap.inetOrgPersonAttributeroomNumberName=roomNumber
73 com.openexchange.groupware.ldap.inetOrgPersonAttributetelexNumberName=telexNumber
75 com.openexchange.groupware.ldap.inetOrgPersonAttributeuidName=uid
77 com.openexchange.groupware.ldap.inetOrgPersonClassName=inetOrgPerson
79 com.openexchange.groupware.ldap.OXUserObjectAttributebirthDayName=birthDay
81 com.openexchange.groupware.ldap.OXUserObjectAttributeDistributionListName=OXUserDistributionList
83 com.openexchange.groupware.ldap.OXUserObjectAttributeAnniversaryName=OXUserAnniversary
85 com.openexchange.groupware.ldap.OXUserObjectAttributeBranchesName=OXUserBranches
87 com.openexchange.groupware.ldap.OXUserObjectAttributeCategoriesName=OXUserCategories
89 com.openexchange.groupware.ldap.OXUserObjectAttributeChildrenName=OXUserChildren
91 com.openexchange.groupware.ldap.OXUserObjectAttributeCityName=OXUserCity
93 com.openexchange.groupware.ldap.OXUserObjectAttributeCommentName=OXUserComment
95 com.openexchange.groupware.ldap.OXUserObjectAttributeComRegName=OXUserComReg
97 com.openexchange.groupware.ldap.OXUserObjectAttributeEmail2Name=OXUserEmail2
99 com.openexchange.groupware.ldap.OXUserObjectAttributeEmail3Name=OXUserEmail3
101 com.openexchange.groupware.ldap.OXUserObjectAttributeInstantMessenger2Name=OXUserInstantMessenger2
103 com.openexchange.groupware.ldap.OXUserObjectAttributeInstantMessengerName=OXUserInstantMessenger
105 com.openexchange.groupware.ldap.OXUserObjectAttributeMaritalStatusName=OXUserMaritalStatus
107 com.openexchange.groupware.ldap.OXUserObjectAttributeNickNameName=OXUserNickName
109 com.openexchange.groupware.ldap.OXUserObjectAttributeOtherCityName=OXUserOtherCity
111 com.openexchange.groupware.ldap.OXUserObjectAttributeOtherCountryName=OXUserOtherCountry
113 com.openexchange.groupware.ldap.OXUserObjectAttributeOtherPostalCodeName=OXUserOtherPostalCode
115 com.openexchange.groupware.ldap.OXUserObjectAttributeOtherStateName=OXUserOtherState
117 com.openexchange.groupware.ldap.OXUserObjectAttributeOtherStreetName=OXUserOtherStreet
119 com.openexchange.groupware.ldap.OXUserObjectAttributePositionName=OXUserPosition
121 com.openexchange.groupware.ldap.OXUserObjectAttributePostalCodeName=OXUserPostalCode
123 com.openexchange.groupware.ldap.OXUserObjectAttributeProfessionName=OXUserProfession
125 com.openexchange.groupware.ldap.OXUserObjectAttributeSalesVolumeName=OXUserSalesVolume
127 com.openexchange.groupware.ldap.OXUserObjectAttributeSpouseNameName=OXUserSpouseName
129 com.openexchange.groupware.ldap.OXUserObjectAttributeStateName=OXUserState
131 com.openexchange.groupware.ldap.OXUserObjectAttributesuffixName=OXUserSuffix
133 com.openexchange.groupware.ldap.OXUserObjectAttributeTaxIDName=OXUserTaxID
135 com.openexchange.groupware.ldap.OXUserObjectAttributeTeleAssistantName=OXUserTeleAssistant
137 com.openexchange.groupware.ldap.OXUserObjectAttributeTeleBusiness2Name=OXUserTeleBusiness2
139 com.openexchange.groupware.ldap.OXUserObjectAttributeTeleCallbackName=OXUserTeleCallback
141 com.openexchange.groupware.ldap.OXUserObjectAttributeTeleCarName=OXUserTeleCar
143 com.openexchange.groupware.ldap.OXUserObjectAttributeTeleCompanyName=OXUserTeleCompany
145 com.openexchange.groupware.ldap.OXUserObjectAttributeTeleFax2Name=OXUserTeleFax2
147 com.openexchange.groupware.ldap.OXUserObjectAttributeTeleHome2Name=OXUserTeleHome2
149 com.openexchange.groupware.ldap.OXUserObjectAttributeTeleMobile2Name=OXUserTeleMobile2
151 com.openexchange.groupware.ldap.OXUserObjectAttributeTeleOtherName=OXUserTeleOther
153 com.openexchange.groupware.ldap.OXUserObjectAttributeTelePrimaryName=OXUserTelePrimary
155 com.openexchange.groupware.ldap.OXUserObjectAttributeTeleRadioName=OXUserTeleRadio
157 com.openexchange.groupware.ldap.OXUserObjectAttributeTeleTTYName=OXUserTeleTTY
159 com.openexchange.groupware.ldap.OXUserObjectAttributeurlName=url
161 com.openexchange.groupware.ldap.OXUserObjectAttributeUserUndef01Name=OXUserUserUndef01
163 com.openexchange.groupware.ldap.OXUserObjectAttributeUserUndef02Name=OXUserUserUndef02
165 com.openexchange.groupware.ldap.OXUserObjectAttributeUserUndef03Name=OXUserUserUndef03
167 com.openexchange.groupware.ldap.OXUserObjectAttributeUserUndef04Name=OXUserUserUndef04
169 com.openexchange.groupware.ldap.OXUserObjectAttributeUserUndef05Name=OXUserUserUndef05
171 com.openexchange.groupware.ldap.OXUserObjectAttributeUserUndef06Name=OXUserUserUndef06
173 com.openexchange.groupware.ldap.OXUserObjectAttributeUserUndef07Name=OXUserUserUndef07
175 com.openexchange.groupware.ldap.OXUserObjectAttributeUserUndef08Name=OXUserUserUndef08
177 com.openexchange.groupware.ldap.OXUserObjectAttributeUserUndef09Name=OXUserUserUndef09
179 com.openexchange.groupware.ldap.OXUserObjectAttributeUserUndef10Name=OXUserUserUndef10
181 com.openexchange.groupware.ldap.OXUserObjectAttributeUserUndef11Name=OXUserUserUndef11
183 com.openexchange.groupware.ldap.OXUserObjectAttributeUserUndef12Name=OXUserUserUndef12
185 com.openexchange.groupware.ldap.OXUserObjectAttributeUserUndef13Name=OXUserUserUndef13
187 com.openexchange.groupware.ldap.OXUserObjectAttributeUserUndef14Name=OXUserUserUndef14
189 com.openexchange.groupware.ldap.OXUserObjectAttributeUserUndef15Name=OXUserUserUndef15
191 com.openexchange.groupware.ldap.OXUserObjectAttributeUserUndef16Name=OXUserUserUndef16
193 com.openexchange.groupware.ldap.OXUserObjectAttributeUserUndef17Name=OXUserUserUndef17
195 com.openexchange.groupware.ldap.OXUserObjectAttributeUserUndef18Name=OXUserUserUndef18
197 com.openexchange.groupware.ldap.OXUserObjectAttributeUserUndef19Name=OXUserUserUndef19
199 com.openexchange.groupware.ldap.OXUserObjectAttributeUserUndef20Name=OXUserUserUndef20
201 com.openexchange.groupware.ldap.OXUserObjectClassName=OXUserObject
203 com.openexchange.groupware.ldap.AllContactUIDSearch=(&(objectClass\u003DinetOrgPerson)(objectClass\u003DOXUserObject))
205 !com.openexchange.groupware.ldap.AllContactUIDSearchScope=1
207 com.openexchange.groupware.ldap.credentialsBaseDN=[credentialsBaseDN]
209 com.openexchange.groupware.ldap.credentialsDN=cn\u003D[uid],[userBaseDN],[credentialsBaseDN]
211 com.openexchange.groupware.ldap.groupOfNamesAttributememberName=member
213 com.openexchange.groupware.ldap.AddressAdminsDN=cn\u003DAddressAdmins,[globalAddressBookBaseDN]
215 com.openexchange.groupware.ldap.globalAddressBookBaseDN=o\u003DAddressBook
217 com.openexchange.groupware.ldap.GlobalAddressBookEntryDN=cn\u003D[contactid],[globalAddressBookBaseDN]
219 com.openexchange.groupware.ldap.InternalUsersForeSureNameUIDPatternSearchFilter=(&(objectClass\u003DinetOrgPerson)(objectClass\u003DOXUserObject)(|(sn\u003D[pattern])(givenname\u003D[pattern])(cn\u003D[pattern]))(mailEnabled\u003Dok))
221 com.openexchange.groupware.ldap.InternalUsersStartingLetterSearchFilter=(&(objectClass\u003DinetOrgPerson)(objectClass\u003DOXUserObject)(sn\u003D[letter]*)(mailEnabled\u003Dok))
223 com.openexchange.groupware.ldap.UserAddressBookEntryDN=cn\u003D[contactid],[UserAddressBookDN]
225 com.openexchange.groupware.ldap.localDomainsBaseDN=ou\u003DDNSObjects,ou\u003DAdminObjects
227 com.openexchange.groupware.ldap.OXVDomainAttributedomainNameName=domainName
229 com.openexchange.groupware.ldap.LocalDomainsSearchFilter=(&(objectClass\u003DOXVDomainObject)(MTALocaldomain\u003Dtrue))
231 com.openexchange.groupware.ldap.OXIMAPFolderAttributefnName=fn
233 com.openexchange.groupware.ldap.sharedFolderBaseDN=ou\u003DSharedFolder
235 com.openexchange.groupware.ldap.SharedFolderSearchFilter=(&(objectclass\u003DOXIMAPFolderObject)(mailenabled\u003Dok))
237 !com.openexchange.groupware.ldap.sharedFolderSearchScope=1
239 com.openexchange.groupware.ldap.OXResourceGroupAttributeresourceGroupAvailableName=resourceGroupAvailable
241 com.openexchange.groupware.ldap.OXResourceGroupAttributeresourceGroupMemberName=resourceGroupMember
243 com.openexchange.groupware.ldap.OXResourceGroupAttributeresourceGroupNameName=resourceGroupName
245 com.openexchange.groupware.ldap.ResourceGroupDN=resourceGroupName\u003D[group],[resourceGroupBaseDN]
247 com.openexchange.groupware.ldap.ResourceGroupPatternSearchFilter=(&(objectclass\u003DOXResourceGroupObject)(resourceGroupName\u003D[pattern]))
249 com.openexchange.groupware.ldap.ResourceGroupSearchFilter=(objectclass\u003DOXResourceGroupObject)
251 !com.openexchange.groupware.ldap.ResourceGroupSearchScope=1
253 com.openexchange.groupware.ldap.OXResourceAttributeresourceNameName=resourceName
255 #Where are the resources?
256 com.openexchange.groupware.ldap.resourceBaseDN=ou\u003DResources,ou\u003DResourceObjects
258 com.openexchange.groupware.ldap.ResourceDN=resourceName\u003D[resource],[resourceBaseDN]
260 #Where are the resource groups?
261 com.openexchange.groupware.ldap.resourceGroupBaseDN=ou\u003DResourceGroups,ou\u003DResourceObjects
263 #Searches resources with the a pattern.
264 com.openexchange.groupware.ldap.ResourcePatternSearchFilter=(&(objectclass\u003DOXResourceObject)(resourceName\u003D[pattern]))
266 !com.openexchange.groupware.ldap.ResourceSearchScope=1
268 com.openexchange.groupware.ldap.DNForDefaultMail=cn\u003Dmailadmin,[userBaseDN]
270 com.openexchange.groupware.ldap.Factory.AuthenticationSupport=com.openexchange.groupware.ldap.DefaultAuthenticationSupport
272 com.openexchange.groupware.ldap.Factory.ContactSupport=com.openexchange.groupware.ldap.DefaultContactSupport
274 com.openexchange.groupware.ldap.Factory.MailSupport=com.openexchange.groupware.ldap.DefaultMailSupport
276 com.openexchange.groupware.ldap.Factory.ResourcesHandle=com.openexchange.groupware.ldap.DefaultResourcesHandle
278 #Class, that implementes UserGroupHandle, ResourcesHandle
279 com.openexchange.groupware.ldap.Factory.UserGroupHandle=com.openexchange.groupware.ldap.DefaultUserGroupHandle
281 #Where to search for groups?
282 com.openexchange.groupware.ldap.groupBaseDN=ou\u003DGroups
284 #Complete dn of a group.
285 com.openexchange.groupware.ldap.GroupDN=cn\u003D[gid],[groupBaseDN]
287 com.openexchange.groupware.ldap.GroupSearchFilter=(objectclass\u003DposixGroup)
289 #Searches all groups for the user
290 com.openexchange.groupware.ldap.GroupsForUserSearchFilter=(&(objectclass\u003DposixGroup)(memberUid\u003D[uid]))
292 com.openexchange.groupware.ldap.GroupsPatternSearchFilter=(&(objectclass\u003DposixGroup)(cn\u003D[pattern]))
294 !com.openexchange.groupware.ldap.GroupSearchScope=1
296 com.openexchange.groupware.ldap.inetOrgPersonAttributefacsimileName=facsimileTelephoneNumber
298 com.openexchange.groupware.ldap.inetOrgPersonAttributegivenNameName=givenName
300 com.openexchange.groupware.ldap.inetOrgPersonAttributelabeledURIName=labeledURI
302 com.openexchange.groupware.ldap.inetOrgPersonAttributelName=l
304 com.openexchange.groupware.ldap.inetOrgPersonAttributemailName=mail
306 com.openexchange.groupware.ldap.inetOrgPersonAttributemobileName=mobile
308 com.openexchange.groupware.ldap.inetOrgPersonAttributeoName=o
310 com.openexchange.groupware.ldap.inetOrgPersonAttributeouName=ou
312 com.openexchange.groupware.ldap.inetOrgPersonAttributepagerName=pager
314 com.openexchange.groupware.ldap.inetOrgPersonAttributepostalCodeName=postalCode
316 com.openexchange.groupware.ldap.inetOrgPersonAttributepreferredLanguageName=preferredLanguage
318 com.openexchange.groupware.ldap.inetOrgPersonAttributesnName=sn
320 com.openexchange.groupware.ldap.inetOrgPersonAttributestName=st
322 com.openexchange.groupware.ldap.inetOrgPersonAttributestreetName=street
324 com.openexchange.groupware.ldap.inetOrgPersonAttributetelephoneNumberName=telephoneNumber
326 com.openexchange.groupware.ldap.inetOrgPersonAttributetitleName=title
328 com.openexchange.groupware.ldap.OXUserObjectAttributealiasName=alias
330 com.openexchange.groupware.ldap.OXUserObjectAttributeappointmentDaysName=OXAppointmentDays
332 com.openexchange.groupware.ldap.OXUserObjectAttributeimapServerName=gosaMailServer
334 com.openexchange.groupware.ldap.OXUserObjectAttributemailDomainName=mailDomain
336 com.openexchange.groupware.ldap.OXUserObjectAttributesmtpServerName=gosaMailServer
338 com.openexchange.groupware.ldap.OXUserObjectAttributetaskDaysName=OXTaskDays
340 com.openexchange.groupware.ldap.OXUserObjectAttributetimeZoneName=OXTimeZone
342 com.openexchange.groupware.ldap.OXUserObjectAttributeuserCountryName=st
344 com.openexchange.groupware.ldap.OXUserObjectAttributevaddressName=vaddress
346 com.openexchange.groupware.ldap.posixAccountAttributecnName=cn
348 com.openexchange.groupware.ldap.posixAccountAttributeuidName=uid
350 com.openexchange.groupware.ldap.posixGroupAttributecnName=cn
352 com.openexchange.groupware.ldap.posixGroupAttributememberUidName=memberUid
354 com.openexchange.groupware.ldap.UserAddressBookDN=ou\u003Daddr,cn\u003D[uid],[userBaseDN]
356 com.openexchange.groupware.ldap.UserAttributeOpenLDAPaciName=OpenLDAPaci
358 com.openexchange.groupware.ldap.userBaseDN=ou\u003Dpeople
360 #DN to the user object
361 com.openexchange.groupware.ldap.UserDN=cn\u003D[uid],[userBaseDN]
363 com.openexchange.groupware.ldap.UsersCNPatternSearchFilter=(&(objectclass\u003DposixAccount)(objectClass\u003DinetOrgPerson)(|(cn\u003D[pattern])(givenName\u003D[pattern])(cn\u003D[pattern])))
365 com.openexchange.groupware.ldap.UserSearchFilter=(&(cn\u003D[uid])(objectClass\u003DOXUserObject))
367 !com.openexchange.groupware.ldap.UserSearchScope=1
369 com.openexchange.groupware.ldap.UsersForeSureNamePatternSearchFilter=(&(objectclass\u003DposixAccount)(|(givenName\u003D[pattern])(sn\u003D[pattern])))
371 com.openexchange.groupware.ldap.UsersForeSureNameUIDPatternSearchFilter=(&(objectclass\u003DposixAccount)(objectClass\u003DinetOrgPerson)(|(givenName\u003D[pattern])(sn\u003D[pattern])(cn\u003D[pattern])))
373 com.openexchange.groupware.ldap.UsersPatternSearchFilter=(&(objectclass\u003DposixAccount)(cn\u003D[pattern]))
375 #Define the objectClasses an user object should belong to if you are performing pattern searches.
376 com.openexchange.groupware.ldap.UsersPatternSearchObjectClasses=posixAccount,inetOrgPerson,OXUserObject
378 com.openexchange.groupware.ldap.GlobalAddressBookSearchScope=1
380 com.openexchange.groupware.ldap.inetOrgPersonAttributejpegPhotoName=jpegPhoto
382 com.openexchange.groupware.ldap.OXUserObjectAttributeDayViewEndTimeName=OXDayViewEndTime
384 com.openexchange.groupware.ldap.OXUserObjectAttributeDayViewStartTimeName=OXDayViewStartTime
386 com.openexchange.groupware.ldap.OXUserObjectAttributeDayViewIntervalName=OXDayViewInterval
388 !com.openexchange.groupware.ldap.LocalDomainsSearchScope=1
396 This configuration is based in documentation gets from 
397 http://www.open-xchange.org/oxwiki/OX_20with_20existing_20LDAP_20DIT