https://oxpedia.org/wiki/api.php?action=feedcontributions&user=Sgabler&feedformat=atomOpen-Xchange - User contributions [en]2024-03-29T15:14:28ZUser contributionsMediaWiki 1.31.0https://oxpedia.org/wiki/index.php?title=AppSuite:7_10_Database_Migration&diff=24366AppSuite:7 10 Database Migration2018-11-09T18:00:35Z<p>Sgabler: /* Update Task Exclusion */</p>
<hr />
<div>{{Version|7.10.0}}<br />
<br />
= Database Migration with OX App Suite v7.10.0 =<br />
<br />
OX App Suite v7.10.0 introduces significant changes regarding the underlying MySQL database system that require special attention in case of upgrades from former versions. Please read this paper carefully to ensure a smooth and clean upgrade process.<br />
<br />
== Change Overview ==<br />
<br />
The most significant changes are:<br />
* New version and configuration requirements.<br />
* Most VARCHAR columns need to be migrated to utf8mb4 character encoding.<br />
* A major rewrite of the calendar application requires full data migration.<br />
<br />
We strongly recommend to thoroughly plan and test the upgrade procedure. To gain insights about update task runtimes and the expected load, our recommendation is to clone ConfigDB and the biggest UserDB and perform an isolated test upgrade that especially covers the calendar migration and character encoding changes. Update task durations can be significantly longer than with previous upgrades and the migrations might cause noticeable higher I/O load. Also some additional disk space is needed during and after the migrations.<br />
<br />
== Database System ==<br />
<br />
MySQL Server is supported in versions 5.6 and 5.7 with recent patch levels only and MariaDB Server 10.1 and 10.2 respectively. Support for 5.6/10.1 exists for compatibility reasons and is transitional. We recommend upgrading to 5.7/10.2 as soon as possible. Any database system upgrade must happen before App Suite is upgraded to OX App Suite v7.10.0. Please follow the respective guides of your database vendor carefully.<br />
<br />
Different App Suite and database system versions require different configurations of the DBMS, please follow [[My.cnf]] to have your database configured in a sane way. Especially the following items require some attention with the upgrade to App Suite 7.10.0 and upgrades of the DBMS itself:<br />
<br />
* Supported SQL modes are only <code>NO_ENGINE_SUBSTITUTION</code> and <code>NO_AUTO_CREATE_USER</code>. Starting with App Suite 7.10.0, <code>ONLY_FULL_GROUP_BY</code> is also supported for MySQL 5.7. It is still not with older versions of MySQL or any MariaDB version! To review the current value, use <code>SHOW GLOBAL VARIABLES WHERE Variable_name = 'sql_mode';</code>.<br />
* Ensure that <code>character_set_server</code> is set to <code>utf8</code> for App Suite 7.8.x. Again the current global default value can be obtained via <code>SHOW GLOBAL VARIABLES WHERE Variable_name = 'character_set_server';</code>. With 7.10.0 being fully rolled out, this setting must then be changed to <code>utf8mb4</code>. If <code>collation_server</code> is configured explicitly, it must be set to a matching value according to the character set in either case!<br />
<br />
Note that App Suite <= 7.8.4 did not support MySQL 5.7/MariaDB 10.2 so far. While we recommend it for 7.10.0, this leaves a lack of definition during the upgrade process. We consider running 7.8.4 on top of MySQL 5.7/MariaDB 10.2 a valid scenario as long as it is transitional during the upgrade phase. Please take our configuration recommendations seriously to mitigate potential user-facing issues as far as possible.<br />
<br />
== Upgrade Procedure ==<br />
<br />
The upgrade to OX App Suite v7.10.0 can be performed like any other major upgrade before. However, the duration of blocking database update tasks for the mentioned charset and calendar migrations could conflict with customers’ availability demands. Therefore it is possible to decouple these special time- and resource-intensive tasks from the plain version upgrade. In this section a multi-step approach is described that performs the version upgrade before and independently from the migrations. Every step always results in a working system that is ready to serve user traffic. Some functional implications that affect user experience are outlined in the according subsections.<br />
<br />
'''Important:''' Even though the first step leads to a basically working OX App Suite v7.10.0 environment, the subsequent steps are not optional but mandatory! Skipping the migrations will leave a few calendar features dysfunctional and can lead to issues with certain SQL queries that use explicit collations for searching and sorting. Running OX App Suite v7.10.0 in production without having all parts of the migration fulfilled is not supported – OX support will request you to complete the migration tasks when reporting issues that are not related to the migration itself. <br />
<br />
== Initial OX App Suite v7.10.0 Rollout ==<br />
If not done so far, upgrade your MySQL installation to a version supported with OX App Suite v7.10.0 but configure it to be compatible with OX App Suite v7.8.x as described in the “Database System” section.<br />
<br />
Despite the fact that the two special migrations for calendar and character sets are explicitly skipped, this section assumes that the “Rolling Upgrade with breaking Hazelcast upgrade” is applied as described in [[AppSuite:Running_a_cluster#Updating_a_Cluster]]. For the application server upgrade, the common guide from [[AppSuite:UpdatingOXPackages]] can be followed.<br />
<br />
Prepare a dedicated App Suite middleware node that will be used to perform the database update tasks. The node must not be serving any user traffic and be prepared with<br />
<br />
* OX App Suite v7.10.0 packages<br />
* Configuration according to the user production nodes<br />
* The Hazelcast rolling upgrade compatibility package (see [[AppSuite:Running_a_cluster#Rolling_Upgrade_with_breaking_Hazelcast_upgrade]])<br />
* Exclude the update tasks for both mentioned migrations (i.e. calendar and character encoding). See “Update Task Exclusion” for details.<br />
* Execute update tasks according to your preferred strategy. More on this can be found at [[UpdateTasks]].<br />
<br />
By default (if using the "runallupdate" tool") update tasks operate on database schemas sequentially, one at a time. All users from all contexts of a given schema are logged out and locked out. Then, DB schema changes are executed. Finally, users are unlocked and able to login again. Schemas typically contain a few thousand users (if our recommended sizing is being followed) and thus executing update tasks means bunches of a few thousand users will be affected sequentially. You will not have a full downtime. For each update task execution process the following statements hold true:<br />
<br />
* All users got service for nearly all the time (all the time but the time where their schema is upgraded)<br />
* For each point in time, nearly all users got service (all but the ones from the currently updated schema)<br />
* When update tasks are completed, all users will have been affected by one "logout" - "locked out" cycle<br />
<br />
After complete and successful update task execution, roll out OX App Suite v7.10.0 to one node after another. After complete rollout, reconfigure MySQL if appropriate as described in the “Database System” section.<br />
<br />
=== Update Task Exclusion ===<br />
<br />
Add the following lines to <code>/opt/open-xchange/etc/excludedupdatetasks.properties</code> or remove the leading # character if already included, so that it contains these two lines:<br />
<br />
# Character Encoding Migration<br />
com.openexchange.groupware.update.excludedUpdateTasks=groupware.utf8mb4<br />
<br />
# Calendar Migration<br />
com.openexchange.chronos.storage.rdb.migration.ChronosStorageMigrationTask<br />
<br />
#Update tasks depending on the 2 above<br />
com.openexchange.chronos.storage.rdb.groupware.CalendarEventCorrectFilenamesTask<br />
com.openexchange.chronos.storage.rdb.groupware.CalendarEventCorrectRangesTask<br />
<br />
The first line does not denote one dedicated update task, but a whole list of tasks. To make exclusion more convenient, the concept of update task namespaces has been introduced. All update tasks belonging to the character encoding migration are part of the <code>groupware.utf8mb4</code> namespace. The denoted property takes care of excluding them all at once. You can list all according tasks with the <code>/opt/open-xchange/sbin/listUpdateTaskNamespaces</code> tool.<br />
<br />
== Character Encoding Migration ==<br />
<br />
The default character encoding for Unicode (named character set by MySQL) of MySQL will become <code>utf8mb4</code> in the near future. MariaDB on Debian Stretch (9) already has an according default configuration set when installing it from distribution packages. So far all VARCHAR columns are supposed to store at max. 3-byte UTF-8 characters due to the nature of MySQL’s utf8 character encoding. This leads to the fact that for example emojis cannot be saved as part of any App Suite entities. In a mixed-mode scenario (App Suite considers MySQL to operate in utf8mb4 mode due to the <code>character_set_server</code> setting, while columns are specified with utf8 encoding), this leads to issues whenever certain collations during SELECT statements are enforced. To avoid such issues generally and also increase user experience by finally allowing characters from the Unicode astral plane, Open-Xchange has decided to migrate existing data structures to the utf8mb4 character encoding.<br />
<br />
This migration can be executed before or after the calendar migration, while it is recommend to execute it before.<br />
<br />
The upgrade procedure is basically the same as above in terms executing update tasks, while the server software is already up to date and needs no further upgrades:<br />
<br />
* Again prepare one dedicated node that doesn’t serve any user traffic<br />
* Remove the according namespace property from <code>excludedupdatetasks.properties</code> again, but still keep the “ChronosStorageMigrationTask”. Afterwards restart the open-xchange daemon.<br />
* Execute update tasks according to your preferred strategy.<br />
<br />
'''Important:''' The update tasks require a lot of tables to be copied and re-created, leading to high I/O and especially sequential read and write operations. For every copied table the needed MySQL disk space doubles during the update task, so ensure enough free space before running the migration.<br />
<br />
== Calendar Data Migration ==<br />
<br />
The new calendar stack in OX App Suite v7.10.0 comes along with a new data model using its very own tables in MySQL. To preserve users calendar data, an update task <code>com.openexchange.chronos.storage.rdb.migration.ChronosStorageMigrationTask</code> has been introduced, that reads all data from the old tables, applies transformations to match the new stack and writes it into the new tables. The approach and upgrade process is described in detail at https://documentation.open-xchange.com/7.10.0/middleware/components/calendar/data_migration.html. Please read that article carefully before continuing. Especially we want to emphasize again the recommendation to test the migration with a copy of your real data to exclude or determine any issues beforehand.<br />
<br />
Before executing this update task, OX App Suite v7.10.0 uses the new calendar stack on top of the old database tables through a compatibility layer. As the old storage layout lacks certain functionality, not all features are functional in between the application upgrade and execution of the update task. Due to this fact, a few spots are affected where not all appointment data that the user interface allows to enter can be persisted. This includes:<br />
<br />
* Reminders, where still only one notification prior the appointment start is possible<br />
* Colors, that cannot be mapped to the previously used labels<br />
* 4-byte UTF-8 characters (emojis) are not yet possible<br />
* Secret appointments, that are still stored as private ones<br />
* An appointment's end timezone can't be applied, if it's different from the start timezone<br />
<br />
Operators of ''non-Galera'' MySQL setups - i.e. Master-Slave replication - can potentially speed up the migration by configuring <code>com.openexchange.calendar.migration.intermediateCommits = false</code>. Per default the migration is performed in batches that separately committed, as Galera does not cope well with large transactions. By changing the setting to <code>false</code>, a single transaction with batch-mode enabled is used.<br />
<br />
'''Important:''' The migrating of calendar data actually leads to a duplication of that data. Also with OX App Suite v7.10.0 every new calendar data is written to both, the old and the new tables redundantly to preserve to ability to roll back to OX App Suite v7.8.4. However, only the parts can preserved that match the old data model. I.e. additional features like multiple reminders or subscriptions of external calendars (Google Calendar, SchedJoules) cannot be preserved during a rollback.<br />
<br />
A repeated OX App Suite v7.10.0 upgrade after a former rollback to OX App Suite v7.8.4 requires to force re-execution of this update task!</div>Sgablerhttps://oxpedia.org/wiki/index.php?title=AppSuite:Quick_launcher&diff=24223AppSuite:Quick launcher2018-08-10T15:22:24Z<p>Sgabler: </p>
<hr />
<div>With OX App Suite 7.10 a new concept of starting applications was introduced and replaced the tabs from previous versions.<br />
<br />
By default you can switch the applications in the upper right part of the screen on the icon which looks like a numeric keypad.<br />
<br />
It is however possible to enable a quick launcher to have the most used applications on the left side.<br />
<br />
First you have to set the default configuration:<br />
<br />
<code>vim /opt/open-xchange/etc/settings/appsuite.properties</code> and add:<br />
<br />
<pre><br />
io.ox/core//apps/quickLaunchCount=3<br />
io.ox/core//apps/quickLaunch=io.ox/mail/main,io.ox/calendar/main,io.ox/files/main<br />
</pre><br />
<br />
This will enable three new quick launchers, mail, calendar and drive. 3 is the maximum.<br />
<br />
In case you really want to have a 4th, you can set the OX logo as a quickLauncher for your "Default app after sign in":<br />
<pre><br />
#OX-logo mail app<br />
io.ox/core//logoAction=autoStart<br />
</pre><br />
<br />
if your "Default app after sign in" is mail you can change: <br />
<pre><br />
io.ox/core//apps/quickLaunch=io.ox/mail/main,io.ox/calendar/main,io.ox/files/main<br />
</pre><br />
to<br />
<pre><br />
io.ox/core//apps/quickLaunch=io.ox/contacts/main,io.ox/calendar/main,io.ox/files/main<br />
</pre><br />
<br />
To make it possible for the user to change the applications you have to un-protect the setting:<br />
<br />
<code>vim /opt/open-xchange/etc/meta/appsuite.yaml</code><br />
<br />
<pre><br />
io.ox/core//apps/quickLaunch:<br />
protected: false<br />
</pre><br />
<br />
'''Note''': as in all yaml files: the leading spaces (4) on the second line are important. <br />
<br />
After a restart or <code>reloadconfiguration</code> of OX App Suite and a re-login you should see three new icons on the left. If you also un-protected the setting you can change the applications in Settings/Basic settings.</div>Sgablerhttps://oxpedia.org/wiki/index.php?title=AppSuite:Quick_launcher&diff=24222AppSuite:Quick launcher2018-08-10T15:21:20Z<p>Sgabler: </p>
<hr />
<div>With OX App Suite 7.10 a new concept of starting applications was introduced and replaced the tabs from previous versions.<br />
<br />
By default you can switch the applications in the upper right part of the screen on the icon which looks like a numeric keypad.<br />
<br />
It is however possible to enable a quick launcher to have the most used applications on the left side.<br />
<br />
First you have to set the default configuration:<br />
<br />
<code>vim /opt/open-xchange/etc/settings/appsuite.properties</code> and add:<br />
<br />
<pre><br />
io.ox/core//apps/quickLaunchCount=3<br />
io.ox/core//apps/quickLaunch=io.ox/mail/main,io.ox/calendar/main,io.ox/files/main<br />
</pre><br />
<br />
This will enable three new quick launchers, mail, calendar and drive. 3 is the maximum.<br />
<br />
In case you really want to have a 4th, you can set the OX logo as a quickLauncher for your "Default app after sign in":<br />
<pre><br />
#OX-logo mail app<br />
io.ox/core//logoAction=autoStart<br />
</pre><br />
<br />
and you can change <br />
<pre><br />
io.ox/core//apps/quickLaunch=io.ox/mail/main,io.ox/calendar/main,io.ox/files/main<br />
</pre><br />
to<br />
<pre><br />
io.ox/core//apps/quickLaunch=io.ox/contacts/main,io.ox/calendar/main,io.ox/files/main<br />
</pre><br />
<br />
To make it possible for the user to change the applications you have to un-protect the setting:<br />
<br />
<code>vim /opt/open-xchange/etc/meta/appsuite.yaml</code><br />
<br />
<pre><br />
io.ox/core//apps/quickLaunch:<br />
protected: false<br />
</pre><br />
<br />
'''Note''': as in all yaml files: the leading spaces (4) on the second line are important. <br />
<br />
After a restart or <code>reloadconfiguration</code> of OX App Suite and a re-login you should see three new icons on the left. If you also un-protected the setting you can change the applications in Settings/Basic settings.</div>Sgablerhttps://oxpedia.org/wiki/index.php?title=AppSuite:Quick_launcher&diff=24221AppSuite:Quick launcher2018-08-10T14:52:27Z<p>Sgabler: </p>
<hr />
<div>With OX App Suite 7.10 a new concept of starting applications was introduced and replaced the tabs from previous versions.<br />
<br />
By default you can switch the applications in the upper right part of the screen on the icon which looks like a numeric keypad.<br />
<br />
It is however possible to enable a quick launcher to have the most used applications on the left side.<br />
<br />
First you have to set the default configuration:<br />
<br />
<code>vim /opt/open-xchange/etc/settings/appsuite.properties</code> and add:<br />
<br />
<pre><br />
io.ox/core//apps/quickLaunchCount=3<br />
io.ox/core//apps/quickLaunch=io.ox/mail/main,io.ox/calendar/main,io.ox/files/main<br />
</pre><br />
<br />
This will enable three new quick launchers, mail, calendar and drive. 3 is the maximum.<br />
<br />
In case you really want to have a 4th, you can set the OX logo as a quickLauncher for mail by adding:<br />
<pre><br />
#OX-logo mail app<br />
io.ox/core//logoAction=autoStart<br />
</pre><br />
<br />
and you can change <br />
<pre><br />
io.ox/core//apps/quickLaunch=io.ox/mail/main,io.ox/calendar/main,io.ox/files/main<br />
</pre><br />
to<br />
<pre><br />
io.ox/core//apps/quickLaunch=io.ox/contacts/main,io.ox/calendar/main,io.ox/files/main<br />
</pre><br />
<br />
To make it possible for the user to change the applications you have to un-protect the setting:<br />
<br />
<code>vim /opt/open-xchange/etc/meta/appsuite.yaml</code><br />
<br />
<pre><br />
io.ox/core//apps/quickLaunch:<br />
protected: false<br />
</pre><br />
<br />
'''Note''': as in all yaml files: the leading spaces (4) on the second line are important. <br />
<br />
After a restart or <code>reloadconfiguration</code> of OX App Suite and a re-login you should see three new icons on the left. If you also un-protected the setting you can change the applications in Settings/Basic settings.</div>Sgablerhttps://oxpedia.org/wiki/index.php?title=AppSuite:OX_Outlook_Uploader&diff=22251AppSuite:OX Outlook Uploader2016-08-02T18:28:57Z<p>Sgabler: /* Download and installation */</p>
<hr />
<div>=Open-Xchange Microsoft Outlook® Uploader=<br />
<br />
Open-Xchange provides Open-Xchange Microsoft Outlook® Uploader (short: ''OXUploader''), a migration tool to export data from Microsoft Outlook® or from a Microsoft Exchange Server® to the Open-Xchange Server.<br />
<br />
=Features=<br />
* Migration of E-Mails, appointments, contacts, distribution lists, tasks and sticky notes<br />
* Folder structure is preserved, subfolders are created as necessary<br />
* Attachments of E-Mails and other objects are migrated<br />
* Support for recurring appointments and participants<br />
* Migration of .pst-files<br />
* Migration of data files from installed mail profiles<br />
* Migration of Microsoft Exchange mailboxes<br />
* Migration of Microsoft Exchange Public Stores<br />
* Easy to use 3-step interactive wizard to configure the migration<br />
* Unattended mode to perform migrations without user interaction<br />
* Commandline interface to automate batch migrations<br />
<br />
<br />
=Prerequisites=<br />
The OXUploader migration tool is installed on a windows system having access to the data that should be migrated. The data is then migrated from there to the Open-Xchange server. Please ensure that the following requirements are met before installing the tool:<br />
<br />
==Windows System==<br />
* Windows XP and newer ''or'' Windows Server 2003 and newer, including Windows Vista and 7<br />
* Microsoft® Office® Outlook (2002/XP, 2003, 2007 or 2010, 32-bit and 64-bit) or Microsoft® Exchange Server or standalone versions of Extended MAPI (Exchange 5.5 through 2010)<br />
* Microsoft® .NET Framework 2.0<br />
* Each requiring the latest service packs and patches<br />
<br />
==Open-Xchange Server==<br />
* Latest Version of the Open-Xchange App Suite<br />
* The user account(s) for which the data should be migrated should already have been created<br />
<br />
<br />
=Download and installation=<br />
<br />
To download the Open-Xchange Microsoft Outlook® Uploader installation packages and Release Notes, follow this [http://software.open-xchange.com/components/outlookuploader/6.20.5/ link]<br />
<br />
After the download of the package, you can start the installation by double-clicking on the package. Please follow the installation steps in the wizard. The installation does not require administrative rights.<br />
<br />
=Usage (interactive mode)=<br />
<br />
{| <br />
| [[image:OXUploader_Wizard_1.png|thumb]] || <br />
==1. Choose the migration source==<br />
* First, either choose to migrate a personal storage file (.pst file), a data store from the local mail profiles, or an Exchange server mailbox.<br />
* Depending on your choice, you can specify the migration source in the next step.<br />
|-<br />
| [[image:OXUploader_Wizard_2a.png|thumb]] || <br />
==2a. Select a personal storage file to migrate==<br />
* When clicking on Browse the standard folder for saving .pst files opens.<br />
* As some .pst files are password protected the password can be entered in the second field.<br />
* When having chosen a file, click on Next.<br />
|-<br />
| [[image:OXUploader_Wizard_2b.png|thumb]] || <br />
==2b. Select a data file from a profile to migrate==<br />
* Select one of the existing profiles from the drop-down menu.<br />
* Select a store from the profile.<br />
* Finally, enter a password if needed.<br />
* To proceed, click Next.<br />
|-<br />
| [[image:OXUploader_Wizard_2c.png|thumb]] || <br />
==2c. Select an Exchange Server mailbox to migrate==<br />
* Enter the URL of the Microsoft Exchange server.<br />
* Select the username of the the account on the Exchange server.<br />
* Click on "Logon..." to connect to the Exchange server and fetch the available mailboxes.<br />
* When being asked, enter your password to logon to the Exchange server<br />
* Select one of the existing mailboxes from the drop-down menu.<br />
* To proceed, click Next.<br />
|-<br />
| [[image:OXUploader_Wizard_3.png|thumb]] || <br />
==3. Please enter information about the server==<br />
* In the Server URL field, enter the Open-Xchange Server address.<br />
* Enter your username in the second field.<br />
* Enter your password in the third field.<br />
* In order to make further settings, activate the "Configure advanced settings" checkbox.<br />
* To proceed, click on Next.<br />
|-<br />
| [[image:OXUploader_Wizard_4a.png|thumb]] || <br />
==4a. Configure advanced options==<br />
* If the folders should be migrated into a subfolder, enter it's name in the first field.<br />
* In case not all mail folders are to be exported, the folders can be selected by clicking on the "Select..." button.<br />
* Select the type of items to be migrated by marking the apporpiate checkboxes, and optionally define a minimum date for the items.<br />
|-<br />
| [[image:OXUploader_Wizard_4b.png|thumb]] || <br />
==4b. Configure advanced options==<br />
* If no notification mails for appointments and tasks should be generated activate the respective checkbox.<br />
* If mails with non resolved recipients should be skipped activate the respective checkbox.<br />
* In order to ignore the "Trash", "Junk" or "Sync Issues" folders for the migration, activate the respective checkbox.<br />
* If empty folders should be skipped, activate the respective checkbox.<br />
* If the target folders should be emptied before items are migrated into them, activate the respective checkbox.<br />
|-<br />
| [[image:OXUploader_Wizard_5.png|thumb]] ||<br />
<br />
==5. Migration in process==<br />
* This window displays the status and a log protocol of the migration.<br />
* When the process is finished, click on Next.<br />
|-<br />
| [[image:OXUploader_Wizard_6.png|thumb]] || <br />
<br />
==6. Migration completed==<br />
* This window displays an overview of the migration and you can view the log file by clickin on the respective button.<br />
* To close the wizard, click on Finish.<br />
|}<br />
<br />
<br />
=Usage (unattended mode)=<br />
<br />
The migration tool can be started in a special "batch mode", where no user interaction is necessary. The options for the migration can be set in the configuration files, or passed via the commandline when starting the tool, see (3). When the parameter "batchmode" is "true", the migration starts automatically. In this case, at least the following settings have to be available, either supplied via the commandline or defined in the configuration file:<br />
* Username<br />
* ServerURL<br />
* (PSTFile ''or'' ProfileName) and (StoreName ''or'' ExchangeServerURL)<br />
* Password ''or'' AdminUser and AdminPassword<br />
<br />
For example, to migrate the .pst-file "c:\test.pst", a command could look <br />
like:<br />
<pre>OXUploaderC.exe -batchmode true -pstfile "c:\test.pst" -serverurl "http://ox.example.invalid" -username test -password secret</pre><br />
<br />
Multiple instances of the tool can be run simultaneously from one or multiple client machines, more information can be found in (6).<br />
<br />
<br />
=Configuration=<br />
<br />
==Configuration files==<br />
<br />
The application's configuration settings can be adjusted in config files, both for the OXUploader.exe main application for interactive mode and for the commandline version of the tool OXUploaderC.exe (see below). The files are named as the corresponding executable, with the file extension ".config": OXUploader.exe.config and OXUploaderC.exe.config respectively. A description of each parameter can be found in [[#Configuration parameters|Configuration parameters]]<br />
<br />
==Commandline parameters==<br />
<br />
Furthermore, the application can be started with commandline parameters. All supplied options overwrite the default settings from the configuration file, which are assumed if an option is missing. The following parameters are recognized:<br />
<pre>-adminuser <Admin username on the OX server (for admin migration)><br />
-adminpassword <Admin password on the OX server (for admin migration)><br />
-appointmentsmindate <Minimum date of appointments to be migrated><br />
-batchmode <true/false><br />
-clearfolders <true/false><br />
-emailssmindate <Minimum date of e-mails to be migrated><br />
-exchangemailboxname <Name of the Exchange mailbox to migrate><br />
-exchangeserverurl <URL of the Exchange server><br />
-exchangeserverusername <Username on the Exchange server><br />
-exportappointmentparticipants <true/false><br />
-exportappointmentuids <true/false><br />
-ignorejunkfolder <true/false><br />
-ignoresyncissuesfolder <true/false><br />
-ignoretrashfolder <true/false><br />
-importfoldername <Name of the migration target subfolder><br />
-logautoflush <true/false><br />
-logconsole <true/false><br />
-loglevel <off/error/warning/info/verbose><br />
-logonexchangemailbox <true/false><br />
-logpostdata <true/false><br />
-logtextfile <Path to logfile><br />
-migrateappointments <true/false><br />
-migratecontacts <true/false><br />
-migrateemails <true/false><br />
-migratenotes <true/false><br />
-migratetasks <true/false><br />
-password <Password on the OX server><br />
-profilename <Name of the profile><br />
-pstfile <Path to PST file><br />
-pstpassword <Password for the PST file><br />
-serverurl <URL of the OX server><br />
-skipemptyfolders <true/false><br />
-storename <Name of the store inside the profile><br />
-tasksmindate <Minimum date of tasks to be migrated><br />
-uploadchunksize <Number of uploaded mails per request><br />
-uploadthresholdbytes <Threshold of bytes for sending forced><br />
-username <Username on the OX server><br />
-recoverableexceptionmaxretries <max. retries after recoverable error><br />
-suppressnotificationmails <true/false><br />
-skipmailswithnonresolvedrecipients <true/false><br />
</pre><br />
<br />
=Misc=<br />
<br />
The following chapters contain some advanced information and configration options for the OXUploader migration tool.<br />
<br />
==Performance considerations==<br />
<br />
The time needed to perform a migration correspondends with the size of the .pst file, of course. So, for large mailboxes, this could be a quite time intensive task, and may be improved in knowledge of the following observations, especially when performing multiple simultaneous batch migrations. <br />
The I/O-ratio is about the following: Per each byte read from disk, about 0.65 bytes are written to disk, and 0.12 bytes are sent to the server. This is caused by the fact that the messages read out from the .pst-file are exported to RFC822 .eml files first, then those files are loaded again before finally sending them to the server. Therefore, the throughput of the local file system should be as fast as possible. Since the temporary created RFC822 e-mail files are created in the user's temp folder, it would be best to move the location to a separate location as the .pst-file - another hdd, maybe even a ramdisk for the temp directory would make sense for heavy batch migrations. It's also recommended to temporarily disable virus protection and indexing services during the migration, and Outlook 2007 should be preferred against Outlook 2003.<br />
<br />
==Limitations when running multiple instances==<br />
<br />
When executing multiple migrations simulataneously from one machine, each instance of the tool must have exclusive access to the .pst-file it is migrating. Furthermore, each instance must use a different logfile. The tool relies on Outlook, and so it also can't work around Outlooks own limitations, especially as Outlook is designed as client application. More details can be found at the knowledge base article here: http://support.microsoft.com/kb/257757/en-us .<br />
<br />
==Admin migration==<br />
<br />
When the server is configured appropiate, the migration tool can also be used to import .pst-files into the OX account of the specified user, without the need to supply the user's password. Therefore, the username and password of a special admin user is needed for authentication against the OX server. <br />
For example, to migrate the .pst-file "c:\test.pst" into the account "test", a command could look like:<br />
<pre>OXUploaderC.exe -batchmode true -pstfile "c:\test.pst" -serverurl "http://ox.example.invalid" -username test -adminuser admin -adminpassword secret</pre><br />
<br />
==Personal storage files==<br />
<br />
Sometimes .pst-files are broken our corrupted, and the migration tool may not be able to open them correctly, or opening them takes a very long time when the internal repair operations take place. <br />
To reduce the impact of broken .pst-files, it's recommended to check the integrity of the files using Microsofts SCANPST.exe tool, see http://support.microsoft.com/kb/287497 . Sadly this utility is designed to run interactively, but there are some utilities out there that automate the SCANPST.exe tool to be run from the commandline, pointing to the .pst-file to scan, for example cmdscan.exe from http://www.olfolders.de/Lang/English/OLfix/download.htm . Doing so, one would be able to incorporate a SCANPST.exe launch prior a batch call to the migration tool, e.g. the following command could be invoked to scan and repair the .pst file "c:\test.pst", passing the path to the SCANPST.exe location:<br />
<pre>cmdscan.exe -rename "c:\Program Files (x86)\Microsoft Office\Office12\SCANPST.EXE" "c:\test.pst"</pre><br />
<br />
==Duplicated items==<br />
<br />
Migrating the same items into the same target folder multiple times usually results in the items getting duplicated on the server. <br />
An exception to this rule are appointments with unique identifiers (UIDs), see http://www.ietf.org/rfc/rfc2445.txt, chapter 4.8.4.7, for details. To avoid importing an appointment with the same identifier multiple times, the server rejects an appointment when the UID already exists on the server. To force the migration of appointments regardless of their UIDs, the tool optionally removes the UIDs from the appointment. The relevant setting is named "ExportAppointmentUIDs", when set to "False", existing UIDs are removed before sending them to the server.<br />
Furthermore, the migration tool has an option to clear the folder contents before triggering the export. When "ClearFolders" is set to "True", the target folder is emptied prior to the items being exported. Note that any existing data in these folders will be permanently lost. <br />
<br />
==Exchange mailboxes==<br />
<br />
Instead of using a local mail profile or a .pst file for migration, it's also possible to logon to and migrate an Exchange mailbox directly. It's recommeded that the migration tool is executed inside the exchange domain by the owner of the mailbox.<br />
To perform an administrative migration for other user's mailboxes, the following preconditions must be met:<br />
* Ensure the target account already has been created on the OX server<br />
* Grant the administrating user "Receive As" permissions to the mailbox store of all accounts that should be migrated, details can be found at http://support.microsoft.com/default.aspx?scid=kb;EN-US;821897 and http://msexchangeteam.com/archive/2006/01/25/418099.aspx<br />
* The migration tool is ececuted by the administrative user, who already should be logged on to the exchange domain<br />
The administrative migration can only be executed from the commandline in "batch mode", see (5) for details. The mailbox or the name of the user that is going to be migrated needs to be specified inside the commandline parameter "exchangemailboxname". For example, to migrate the mailbox of exchange user "test" to the Open-Xchange account with username "test", combined with admin migration at the OX server (see (6c) for details), one could execute the migration tool in the following way:<br />
<pre>OXUploaderC.exe -batchmode true -exchangeserverurl 192.168.0.4 -exchangemailboxname test -serverurl "http://ox.example.invalid" -username test -adminuser admin -adminpassword secret</pre><br />
Or, if the password of the OX user is available:<br />
<pre>OXUploaderC.exe -batchmode true -exchangeserverurl 192.168.0.4 -exchangemailboxname test -serverurl "http://ox.example.invalid" -username test -password secret</pre><br />
<br />
==Administrative installation==<br />
<br />
The OXUploader migration tool itself can be installed without the need for elevated access rights by the end user, as the installer only accesses the local non-roaming application data directory and the HKCU hive in the registry. It can't be installed 'per machine', which means that it is not allowed to set the value of the ALLUSERS msi property to "1". <br />
The tool can be pre-configured for the end-users by setting public properties at the commandline for the installation process. These are processed by the installer and then written into the tool's config-file. The following parameters can be adjusted (the values in square brackets that are listed below indicate the default values of the properties when not overridden by the msi commandline - so that would be the default pre-configuration):<br />
<pre>ADMINUSER []<br />
ADMINPASSWORD []<br />
BATCHMODE [False]<br />
CLEARFOLDERS [False]<br />
EXPORTAPPOINTMENTPARTICIPANTS [True]<br />
EXPORTAPPOINTMENTUIDS [True]<br />
IGNOREJUNKFOLDER [True]<br />
IGNORETRASHFOLDER [True]<br />
IMPORTFOLDERNAME []<br />
LOGAUTOFLUSH [True]<br />
LOGCONSOLE [False]<br />
LOGLEVEL [Info]<br />
LOGTEXTFILE [.\pst2ox.log]<br />
MIGRATEAPPOINTMENTS [True]<br />
MIGRATECONTACTS [True]<br />
MIGRATEEMAILS [True]<br />
MIGRATENOTES [True]<br />
MIGRATETASK [True]<br />
PASSWORD []<br />
PROFILENAME []<br />
PSTFILE []<br />
PSTPASSWORD []<br />
SERVERURL [http://]<br />
SKIPEMPTYFOLDERS [True]<br />
STORENAME []<br />
UPLOADCHUNKSIZE [25]<br />
UPLOADTHRESHOLDBYTES [2097152]<br />
OXUSERNAME []<br />
RECOVERABLEEXCEPTIONMAXRETRIES [3]<br />
SUPPRESSNOTIFICATIONMAILS [True]<br />
SKIPMAILSWITHNONRESOLVEDRECIPIENTS [False]<br />
</pre><br />
<br />
For example, to predefine a Server URL that should be used for the<br />
migration afterwards, one would execute e.g.:<br />
<pre> "Open-Xchange Outlook Uploader.msi" SERVERURL="http://ox.example.invalid"</pre><br />
<br />
==Address Resolution==<br />
<br />
While the Open-Xchange server uses SMTP as the only recipient address type, data from Microsoft Exchange might contain several additional address types. To migrate such Exchange data to the Open-Xchange server, each e-mail recipient or particpiant of an appointment or task needs a valid SMTP address. While the migration tool tries to retrieve the SMTP address of message recipients in different ways, sometimes there might be recipients that can't be resolved without a connection to the Microsoft Exchange server / Active Directory and it's global address lists. Especially, this may happen with .pst-files that were created using Microsofts EXMERGE tool. <br />
In order to resolve that issue, the OXUploader migration tool can establish a connection to the exchange server and to it's global address list prior migrating a .pst-file to the Open-Xchange server, so that the recipient's SMTP addresses can be resolved. To do so, there are two parameters that can be set to logon to the exchange server prior migrating the .pst-file: [[#ExchangeServerURL|ExchangeServerURL]] and [[#ExchangeServerUsername|ExchangeServerUsername]]. The username parameter is optional (if not defined, the identity of the current windows user is used) and normally should not need to be set in batch-mode to prevent a windows logon prompt. <br />
For example, to logon to the exchange server at "192.168.0.4" and perform an admin migration for the username "test" in unattended mode, a command could look like:<br />
<pre>OXUploaderC.exe -batchmode true -exchangeserverurl 192.168.0.4 -serverurl "http://ox.example.invalid" -username test -adminuser admin -adminpassword secret -pstfile ".\test.pst" -logtextfile ".\test.log"</pre><br />
<br />
==Public Folders==<br />
<br />
When migrating an Exchange Public Folders store, the folders are migrated below the root Public Folders folder on the Open-Xchange server. To do so, the user performing the migration must have appropiate permissions to create public folders on the server. Since access rights of the folders are not migrated, custom permissions on the folders should be applied manually afterwards.<br />
<br />
=Configuration parameters=<br />
This chapter describes all possible configuration parameters that can be found in the OXUploader.exe.config / OXUploaderC.exe.config configuration files or can be passed to the migration tool from the commandline.<br />
<br />
; <span id="AdminPassword">AdminPassword</span>: The password associated with the administrator user ([[#AdminUser|AdminUser]]) on the Open-Xchange server. Only used when performing [[#Admin_migration|admin migration]].<br />
; <span id="AdminUser">AdminUser</span>: The username of the administrator user on the Open-Xchange server. Only used when performing [[#Admin_migration|admin migration]].<br />
; <span id="AppointmentsMinDate">AppointmentsMinDate</span>: If defined, only appointments that end after this date are migrated. Recurring appointments are migrated, if the end date of the series has not been set, or if the end date of the series is not after this defined value. Date format should be ''yyy-MM-dd''.<br />
; <span id="BatchMode">BatchMode</span>: Specifies whether the tool should be run in a special batchmode without user interaction or not, see [[#Usage_(unattended_mode)|unattended mode]] for details.<br />
; <span id="ClearFolders">ClearFolders</span>: When set to 'True', the migration tool clears the target folder contents before exporting items to that folders. Existing subfolders are not affected by this setting, only the folder's contents. Also, the folder clear-command is only executed for folders that are actually migrated, not for ignored or skipped folders.<br />
; <span id="EMailsMinDate">EMailsMinDate</span>: If defined, only e-mails that were sent or received after this date are migrated. Date format should be ''yyyy-MM-dd''.<br />
; <span id="ExchangeMailboxName">ExchangeMailboxName</span>: Specifies the mailbox name on the Microsoft Exchange server that should be used for migration. Used in combination with the [[#ExchangeServerURL|ExchangeServerURL]] and [[#ExchangeServerUsername|ExchangeServerUsername]] parameters. If not defined, the default mailbox for the Exchange user is used. This parameter is also used to define a shared Exchange mailbox, see [[#Exchange mailboxes|Exchange mailboxes]] for details.<br />
; <span id="ExchangeServerURL">ExchangeServerURL</span>: The URL of the Microsoft Exchange server that hosts the mailbox to be migrated. Only used, when [[#PSTFile|PSTFile]] and [[#ProfileName|ProfileName]] are not defined.<br />
; <span id="ExchangeServerUsername">ExchangeServerUsername</span>: The username of the Exchange account to migrate. Used in combination with the [[#ExchangeServerURL|ExchangeServerURL]] and [[#ExchangeMailboxName|ExchangeMailboxName]] parameters. If not defined, the current windows identity is used. <br />
; <span id="ExportAppointmentParticipants">ExportAppointmentParticipants</span>: Specifies whether the participants (recipients) of appointments should be migrated or not. If set to 'False', only the Open-Xchange user ([[#Username|Username]]) will participate the exported appointments, otherwise all original participants will be added to the migrated appointment, too.<br />
; <span id="ExportAppointmentUIDs">ExportAppointmentUIDs</span>: Specifies whether the unique identifiers (UIDs) of appointments should be migrated or not. Details can be found in the chapter [[#Duplicated items|Duplicated items]].<br />
; <span id="HistoryFile">HistoryFile</span>: The path to the file where the migration tool stores the migration results internally to keep track of which folders already have been migrated successfully.<br />
; <span id="IgnoreJunkFolder">IgnoreJunkFolder</span>: Whether to ignore the ''Junk'' folder during the migration or not.<br />
; <span id="IgnoreSyncIssuesFolder">IgnoreSyncIssuesFolder</span>: Whether to ignore the ''Sync Issues'' folder during the migration or not.<br />
; <span id="IgnoreTrashFolder">IgnoreTrashFolder</span>: Whether to ignore the ''Trash'' folder during the migration or not.<br />
; <span id="ImportFolderName">ImportFolderName</span>: Specifies the name of an additional subfolder below the OX default folders that is used as target for the migrated folders. If left blank, the OX default folders are used as target directly.<br />
; <span id="LogAutoFlush">LogAutoFlush</span>: Specifies whether the log should be flushed to disk automatically after each entry.<br />
; <span id="LogConsole">LogConsole</span>: Whether to output the log to the console or not.<br />
; <span id="LogLevel">LogLevel</span>: Specifies the verbosity of the generated log, possible values are ''Error'', ''Warning'', ''Info'' and ''Verbose''.<br />
; <span id="LogonExchangeMailbox">LogonExchangeMailbox</span>: It's possible to establish a connection to the an MS Exchange server and to it's global address list prior migrating .pst-files, so that the recipient's SMTP addresses can be resolved. When set to ''True'', the URL of the Exchange server has to be defined in [[#ExchangeServerURL|ExchangeServerURL]].<br />
; <span id="LogPOSTData">LogPOSTData</span>: For debugging reasons, this option enables or disables logging of the complete POST data that is sent to the Open-Xchange server during migration.<br />
; <span id="LogTextFile">LogTextFile</span>: Specifies the path to the logfile. <br />
; <span id="MigrateAppointments">MigrateAppointments</span>: Whether to migrate appointments or not.<br />
; <span id="MigrateContacts">MigrateContacts</span>: Whether to migrate contacts and distribution lists or not.<br />
; <span id="MigrateEMails">MigrateEMails</span>: Whether to migrate e-mail or not.<br />
; <span id="MigrateNotes">MigrateNotes</span>: Whether to migrate sticky notes or not.<br />
; <span id="MigrateTasks">MigrateTasks</span>: Whether to migrate tasks or not.<br />
; <span id="Password">Password</span>: The password for the target account ([[#UserName|UserName]]) on the Open-Xchange server.<br />
; <span id="ProfileName">ProfileName</span>: The name of the local mail profile to be migrated. Used in combination with the [[#StoreName|StoreName]] parameter.<br />
; <span id="PSTFile">PSTFile</span>: The path to the .pst-file to be migrated.<br />
; <span id="PSTPassword">PSTPassword</span>: The password to access the .pst-file, only needed if the .pst has been protected with a password.<br />
; <span id="RecoverableExceptionMaxRetries">RecoverableExceptionMaxRetries</span>: Specifies how often a request is repeated in case of possibly recoverable errors.<br />
; <span id="ServerURL">ServerURL</span>: The URL of the Open-Xchange server.<br />
; <span id="SkipEmptyFolders">SkipEmptyFolders</span>: Whether to include folders that don't contain any items or not. Subfolders in empty folders are not affected by this setting.<br />
; <span id="StoreName">StoreName</span>: The name of the message store inside the local mail profile. Used in combination with the [[#ProfileName|ProfileName]] parameter.<br />
; <span id="TasksMinDate">TasksMinDate</span>: If defined, only tasks with a due date after this date are migrated. Date format should be ''yyyy-MM-dd''.<br />
; <span id="UploadChunkSize">UploadChunkSize</span>: Specifies the number of e-mail items that are sent to the Open-Xchange server during the migration per each request.<br />
; <span id="UploadThresholdBytes">UploadThresholdBytes</span>: Specifies a value in bytes after which an e-mail message chunk is sent to the server, even if when the [[#UploadChunkSize|UploadChunkSize]] is not yet exceeded.<br />
; <span id="Username">Username</span>: The user name of the target account on the Open-Xchange server.<br />
; <span id="SuppressNotificationMails">SuppressNotificationMails</span>: Whether to suppress server generated notification mails for new appointments/tasks or not.<br />
; <span id="SkipMailsWithNonResolvedRecipients">SkipMailsWithNonResolvedRecipients</span>: Whether the OXUploader skips migrating mails with at least one non resolved recipient or not.<br />
<br />
=Functional limitations=<br />
* Due to differences in handling recurring tasks between the Open-Xchange server and Microsoft Exchange, recurring tasks are not supported.<br />
* Folder permissions are not transferred to the Open-Xchange server; each new subfolder that is created during the migration gets a set of default permissions (target user has admin permissions).<br />
<br />
=Reporting of Bugs=<br />
Please report bugs and missing features via [https://bugzilla.open-xchange.com/enter_bug.cgi?product=Open-Xchange%20MS%20Outlook%20Uploader Open-Xchange Bugzilla]. Many thanks in advance for your support.<br />
<br />
Product: Open-Xchange MS Outlook Uploader<br />
<br />
=Open-Xchange Microsoft Outlook® Uploader (Open Source via SVN)=<br />
<br />
Portions of the Software may use, include third party software, other copyrighted material or Open Source Software. Acknowledgements, licensing terms and disclaimers for such material are contained in separate agreements. Licensee’s use of such material is governed by the terms of the applicable agreements and can be found on the OX web site, are listed under: [http://www.open-xchange.com/de/licenses/open-xchange-microsoft-outlookr-uploader.html http://www.open-xchange.com/de/licenses/open-xchange-microsoft-outlookr-uploader.html]<br />
<br />
==Compile from sources==<br />
<br />
=== Download and install Outlook Redemption ===<br />
<br />
The Open-Xchange Microsoft Outlook Uploader requires the Outlook Redemption library® by Dmitry Streblechenko. As the distributable version of Redemption cannot be used in open source projects, it is not included in the repository. However, for development purposes only, you can download a copy of the library at [http://www.dimastr.com/redemption/ http://www.dimastr.com/redemption/] and install it on your development PC.<br />
<br />
=== Checkout the sources from Subversion ===<br />
<br />
The source code for the Open-Xchange Microsoft Outlook® Uploader is available in a public Subversion repository. To checkout the latest sources, use the following command:<br />
<br />
svn --username anonymous checkout https://svn.open-xchange.com/migration/OXUploader<br />
<br />
=== Build using Visual Studio® === <br />
<br />
The Open-Xchange Microsoft Outlook® Uploader can be compiled easily using Visual Studio 2008®. For both the interactive and the commandline version of the migration tool, there are C# project files (.csproj) in the PST2OX and the PST2OXc subdirectories (PST2OX is the 'codename' of the migration tool). Just open the project file in Visual Studio and build the project.<br />
<br />
[[Category: OX7]]<br />
[[Category: AppSuite]]</div>Sgablerhttps://oxpedia.org/wiki/index.php?title=OX_Permission_Level&diff=15881OX Permission Level2013-10-08T12:06:12Z<p>Sgabler: /* Matrix - Permission Levels */</p>
<hr />
<div>= OX Permission Level Matrix=<br />
<br />
OX HE/SE/App Suite allows to provide different permission levels to the users. <br />
<br />
The levels start with pure webmail-only functionality and end with the full featured groupware product including all connectors and are described in the first table.<br />
<br />
* '''Webmail''' contains pure webmail functionality including a private addressbook<br />
* '''PIM''' (Private Information Management) adds private calendar and private tasks, no group or sharing capabilities are available<br />
* '''PIM + Mobility''' adds mobile synchronisation to the PIM level<br />
* '''PIM + InfoStore''' adds private InfoStore functionality to the PIM level<br />
* '''Groupware Standard''' includes all group and sharing capabilities as well as the InfoStore<br />
* '''Groupware Premium''' adds all external connectors and mobile synchronisation to Groupware Standard<br />
<br />
In addition to this levels, OX HE/SE/App Suite contains several functions, which can flexible be used with every level. This functions are described in the second table.<br />
<br />
<br />
== How to read the Matrix ==<br />
<br />
{|<br />
|-<br />
! !! Definition<br />
|-<br />
| '''Mandatory''' || This column defines the options, which must not be changed for this level. '''This is a technical requirement and necessary for the correct functioning of OX HE/SE/App Suite'''<br />
|-<br />
| '''Default''' || This column lists the options, which are activated per default for this level<br />
|-<br />
| '''API Parameter''' || Related parameter in the RMI, SOAP and CLT API - described in the [http://software.open-xchange.com/OX6/doc/OX6-Provisioning.pdf Provisioning Documentation]<br />
|-<br />
|&nbsp; || &nbsp;<br />
|-<br />
| '''and/or''' || Minimum one of this options need to be activated in this level<br />
|-<br />
|style="background-color:#C0C0C0" | &nbsp;|| Fields in this color define the most important differentiator to the next lower level<br />
|}<br />
<br />
== Matrix - Permission Levels ==<br />
<br />
This table describes the mandatory parameters for the different permission levels.<br />
<br />
{|<br />
|-<br />
! OX Base Levels !! Functionality !! Mandatory (technical requirement) !! Default !! Requirements / Description !! &nbsp; !! API Parameter<br />
|-<br />
| rowspan="2" | '''Webmail'''<br />
Webmail only <br />
|style="background-color:#F0F0F0" | Email ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || &nbsp;|| &nbsp;|| webmail<br />
|-<br />
|style="background-color:#F0F0F0" | Contacts ||style="background-color:#F0F0F0" | [ile:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || &nbsp;|| &nbsp; || contacts<br />
|-<br />
| &nbsp; || &nbsp; || &nbsp; || &nbsp; || &nbsp; || &nbsp; || &nbsp;<br />
|-<br />
| rowspan="5" | '''PIM'''<br>Private use only<br>No sharing, no group functions. <br />
|style="background-color:#F0F0F0" | Email ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || rowspan="3" | The absence of other features defines this level || &nbsp; || webmail<br />
|-<br />
|style="background-color:#F0F0F0" | Contacts ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || &nbsp; || contacts<br />
|-<br />
|style="background-color:#F0F0F0" | Calendar ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || &nbsp; || calendar<br />
|-<br />
|Global Addressbook || &nbsp; || [[File:Cross_gray.gif]] || &nbsp;|| &nbsp; || globaladdressbookdisabled<br />
|-<br />
|Tasks || &nbsp; || [[File:check.gif]] || &nbsp;|| &nbsp; || tasks<br />
|-<br />
| &nbsp; || &nbsp; || &nbsp; || &nbsp; || &nbsp; || &nbsp; ||&nbsp;<br />
|-<br />
| rowspan="9" | '''PIM + Mobility'''<br>Private use only<br>No sharing, no group functions<br>Enabled for mobile synchronization <br />
|style="background-color:#F0F0F0" | Email ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || &nbsp; || &nbsp; || webmail<br />
|-<br />
|style="background-color:#F0F0F0" | Contacts ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || &nbsp;|| &nbsp; || contacts<br />
|-<br />
|style="background-color:#F0F0F0" | Calendar ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || &nbsp;|| &nbsp; || calendar<br />
|-<br />
|style="background-color:#F0F0F0" | USM ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || &nbsp; || &nbsp; || usm<br />
|-<br />
|style="background-color:#C0C0C0" | Active Sync ||style="background-color:#C0C0C0" | and/or ||style="background-color:#C0C0C0" | [[File:check.gif]] || rowspan="2" | This defines the level<br>At least one of these needs to be set<br>Typically "Active Sync"|| &nbsp; || activesync<br />
|-<br />
|style="background-color:#C0C0C0" | SyncML ||style="background-color:#C0C0C0" | and/or ||style="background-color:#C0C0C0" | [[File:check.gif]] || &nbsp; || syncml (deprecated)<br />
|-<br />
|Global Addressbook || &nbsp;|| [[File:Cross_gray.gif]] || &nbsp;|| &nbsp; || globaladdressbookdisabled<br />
|-<br />
|Tasks || &nbsp; || [[File:check.gif]] || &nbsp;|| &nbsp; || tasks<br />
|-<br />
| &nbsp; || &nbsp; || &nbsp; || &nbsp; || &nbsp; || &nbsp;<br />
|-<br />
| rowspan="6" | '''PIM + InfoStore''' <br>Private use only<br>No sharing, no group functions<br>Enabled for document storage. <br />
|style="background-color:#F0F0F0" | Email ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || &nbsp;|| &nbsp; || webmail<br />
|-<br />
|style="background-color:#F0F0F0" | Contacts ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || &nbsp;|| &nbsp; || contacts<br />
|-<br />
|style="background-color:#F0F0F0" | Calendar ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || &nbsp;|| &nbsp; || calendar<br />
|-<br />
|style="background-color:#C0C0C0" | InfoStore ||style="background-color:#C0C0C0" | [[File:check.gif]] ||style="background-color:#C0C0C0" | [[File:check.gif]] || This combined with the absence of other switches defines the level <br> || &nbsp; || infostore<br />
|-<br />
|Global Addressbook || &nbsp; || [[File:Cross_gray.gif]] || &nbsp;|| &nbsp; || globaladdressbookdisabled<br />
|-<br />
|Tasks || &nbsp; || [[File:check.gif]] || &nbsp;|| &nbsp; || tasks<br />
|-<br />
| &nbsp; || &nbsp; || &nbsp; || &nbsp; || &nbsp; || &nbsp; || &nbsp;<br />
|-<br />
| rowspan="9" | '''Groupware Standard'''<br>Full Groupware functionality<br>Access restricted to Web GUI <br />
|style="background-color:#F0F0F0" | Email ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || &nbsp; || &nbsp; || webmail<br />
|-<br />
|style="background-color:#F0F0F0" | Contacts ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || &nbsp;|| &nbsp; || contacts<br />
|-<br />
|style="background-color:#F0F0F0" | Calendar ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || &nbsp;|| &nbsp; || calendar<br />
|-<br />
|style="background-color:#F0F0F0" | Tasks ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || &nbsp;|| &nbsp; || tasks<br />
|-<br />
|style="background-color:#C0C0C0" | Shared Folders ||style="background-color:#C0C0C0" | [[File:check.gif]] ||style="background-color:#C0C0C0" | [[File:check.gif]] || rowspan="3" | This defines the level<br>All need to be set together || &nbsp; || readcreatesharedfolders<br />
|-<br />
|style="background-color:#C0C0C0" | Public Folders ||style="background-color:#C0C0C0" | [[File:check.gif]] ||style="background-color:#C0C0C0" | [[File:check.gif]] || &nbsp; || editpublicfolders<br />
|-<br />
|style="background-color:#C0C0C0" | Task Delegation ||style="background-color:#C0C0C0" | [[File:check.gif]] ||style="background-color:#C0C0C0" | [[File:check.gif]] || &nbsp; || delegatetask<br />
|-<br />
|style="background-color:#F0F0F0" | Global Addressbook ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || &nbsp; || &nbsp; || globaladdressbookdisabled<br />
|-<br />
|InfoStore || &nbsp; || [[File:check.gif]] || &nbsp;|| &nbsp; || infostore<br />
|-<br />
| &nbsp; || &nbsp; || &nbsp; || &nbsp; || &nbsp; || &nbsp; || &nbsp;<br />
|-<br />
| rowspan="16" | '''Groupware Premium'''<br>Full Groupware functionality<br>All external clients enabled (Mobility, Outlook, Mac)<br />
|style="background-color:#F0F0F0" | Email ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || &nbsp; || &nbsp; || webmail<br />
|-<br />
|style="background-color:#F0F0F0" | Contacts ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || &nbsp;|| &nbsp; || contacts<br />
|-<br />
|style="background-color:#F0F0F0" | Calendar ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || &nbsp;|| &nbsp; || calendar<br />
|-<br />
|style="background-color:#F0F0F0" | Tasks ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || &nbsp;|| &nbsp; || tasks<br />
|-<br />
|style="background-color:#F0F0F0" | Shared Folders ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || &nbsp; || &nbsp; || readcreatesharedfolders<br />
|-<br />
|style="background-color:#F0F0F0" | Public Folders ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || &nbsp; || &nbsp; || editpublicfolders<br />
|-<br />
|style="background-color:#F0F0F0" | Task Delegation ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || &nbsp; || &nbsp; || delegatetask<br />
|-<br />
|style="background-color:#F0F0F0" | Global Addressbook ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || &nbsp; || &nbsp; || globaladdressbookdisabled<br />
|-<br />
|style="background-color:#F0F0F0" | USM ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || &nbsp; || &nbsp; || usm<br />
|-<br />
|style="background-color:#C0C0C0" | OLOX2 ||style="background-color:#C0C0C0" | and/or ||style="background-color:#C0C0C0" | [[File:check.gif]] || rowspan="4" | This defines the level<br>At least one of these needs to be set.<br>Typically OLOX2 and Active Sync || &nbsp; || olox20<br />
|-<br />
|style="background-color:#C0C0C0" | OLOX (Legacy) ||style="background-color:#C0C0C0" | and/or ||style="background-color:#C0C0C0" | [[File:check.gif]] || &nbsp; || webdavxml (deprecated)<br />
|-<br />
|style="background-color:#C0C0C0" | Active Sync ||style="background-color:#C0C0C0" | and/or ||style="background-color:#C0C0C0" | [[File:check.gif]] || &nbsp; || activesync<br />
|-<br />
|style="background-color:#C0C0C0" | SyncML ||style="background-color:#C0C0C0" | and/or ||style="background-color:#C0C0C0" | [[File:check.gif]] || &nbsp; || syncml (deprecated)<br />
|-<br />
|InfoStore || &nbsp; || [[File:check.gif]] || &nbsp;|| &nbsp; || infostore<br />
|-<br />
|iCal Access || &nbsp; || [[File:check.gif]] || &nbsp;|| &nbsp; || ical (deprecated)<br />
|-<br />
|vCard Access || &nbsp; || [[File:check.gif]] || &nbsp;|| &nbsp; || vcard (deprecated)<br />
|-<br />
|}<br />
<br><br />
<br><br />
<br />
== Additional Flexible Functions ==<br />
<br />
The following functions can be added flexible to each permission level.<br />
<br />
{|<br />
|-<br />
! Additional Functions !! Default !! Requirements / Description !! &nbsp; !! API Parameter<br />
|-<br />
| rowspan="2" | '''Minimum Webmail'''<br />
|Collect Emailaddresses || Email addresses typed into sent/reveived emails can be saved automatically in a dedicated folder || &nbsp; || collectemailaddresses<br />
|-<br />
|Edit Password || If a plugin to change the own password is installed on the system, it will be displayed in the settings area || &nbsp; || editpassword<br />
|-<br />
| &nbsp; || &nbsp; || &nbsp; || &nbsp; || &nbsp;<br />
|-<br />
| rowspan="3" | '''Minimum PIM'''<br />
|Multiple Mailaccounts || The user can use external IMAP/POP3 Mailaccounts within the OX WebGUI. Starting with 6.20 this can be configured per email service || &nbsp; || multiplemailaccounts<br />
|-<br />
|Subscriptions || The user can subscribe to external/social datasources, like LinkedIN, XING, Facebook, Gmail, .... Starting with 6.20 this can be configured per subscription service || &nbsp; || subscriptions<br />
|-<br />
|Publications || The user can publish his own data (contacts/documents) for other users in the internet || &nbsp; || publication<br />
|-<br />
| &nbsp; || &nbsp; || &nbsp; || &nbsp; || &nbsp;<br />
|-<br />
| '''Minimum PIM + InfoStore'''<br />
|WebDAV || Allows WebDAV access to InfoStore documents; Requires InfoStore || &nbsp; || webdav<br />
|-<br />
| &nbsp; || &nbsp; || &nbsp; || &nbsp; || &nbsp;<br />
|-<br />
| rowspan="2" | '''Minimum GW Standard'''<br />
|Manage Resources || The user is allowed to create and manage resources for the whole company || &nbsp; || editresource<br />
|-<br />
|Manage Groups || The user is allowed to create and manage groups for the whole company || &nbsp; || editgroup<br />
|-<br />
| &nbsp; || &nbsp; || &nbsp; || &nbsp; || &nbsp;<br />
|-<br />
| rowspan="2" | '''Minimum GW Premium'''<br />
|vCard || The user can download all his contacts via the vCard interface || &nbsp; || vcard (deprecated)<br />
|-<br />
|iCal || The user can download all his contacts via the iCal interface || &nbsp; || ical (deprecated)<br />
|-<br />
|}</div>Sgablerhttps://oxpedia.org/wiki/index.php?title=OX_Permission_Level&diff=15880OX Permission Level2013-10-08T12:04:45Z<p>Sgabler: /* Additional Flexible Functions */</p>
<hr />
<div>= OX Permission Level Matrix=<br />
<br />
OX HE/SE/App Suite allows to provide different permission levels to the users. <br />
<br />
The levels start with pure webmail-only functionality and end with the full featured groupware product including all connectors and are described in the first table.<br />
<br />
* '''Webmail''' contains pure webmail functionality including a private addressbook<br />
* '''PIM''' (Private Information Management) adds private calendar and private tasks, no group or sharing capabilities are available<br />
* '''PIM + Mobility''' adds mobile synchronisation to the PIM level<br />
* '''PIM + InfoStore''' adds private InfoStore functionality to the PIM level<br />
* '''Groupware Standard''' includes all group and sharing capabilities as well as the InfoStore<br />
* '''Groupware Premium''' adds all external connectors and mobile synchronisation to Groupware Standard<br />
<br />
In addition to this levels, OX HE/SE/App Suite contains several functions, which can flexible be used with every level. This functions are described in the second table.<br />
<br />
<br />
== How to read the Matrix ==<br />
<br />
{|<br />
|-<br />
! !! Definition<br />
|-<br />
| '''Mandatory''' || This column defines the options, which must not be changed for this level. '''This is a technical requirement and necessary for the correct functioning of OX HE/SE/App Suite'''<br />
|-<br />
| '''Default''' || This column lists the options, which are activated per default for this level<br />
|-<br />
| '''API Parameter''' || Related parameter in the RMI, SOAP and CLT API - described in the [http://software.open-xchange.com/OX6/doc/OX6-Provisioning.pdf Provisioning Documentation]<br />
|-<br />
|&nbsp; || &nbsp;<br />
|-<br />
| '''and/or''' || Minimum one of this options need to be activated in this level<br />
|-<br />
|style="background-color:#C0C0C0" | &nbsp;|| Fields in this color define the most important differentiator to the next lower level<br />
|}<br />
<br />
== Matrix - Permission Levels ==<br />
<br />
This table describes the mandatory parameters for the different permission levels.<br />
<br />
{|<br />
|-<br />
! OX Base Levels !! Functionality !! Mandatory (technical requirement) !! Default !! Requirements / Description !! &nbsp; !! API Parameter<br />
|-<br />
| rowspan="2" | '''Webmail'''<br />
Webmail only <br />
|style="background-color:#F0F0F0" | Email ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || &nbsp;|| &nbsp;|| webmail<br />
|-<br />
|style="background-color:#F0F0F0" | Contacts ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || &nbsp;|| &nbsp; || contacts<br />
|-<br />
| &nbsp; || &nbsp; || &nbsp; || &nbsp; || &nbsp; || &nbsp; || &nbsp;<br />
|-<br />
| rowspan="5" | '''PIM'''<br>Private use only<br>No sharing, no group functions. <br />
|style="background-color:#F0F0F0" | Email ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || rowspan="3" | The absence of other features defines this level || &nbsp; || webmail<br />
|-<br />
|style="background-color:#F0F0F0" | Contacts ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || &nbsp; || contacts<br />
|-<br />
|style="background-color:#F0F0F0" | Calendar ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || &nbsp; || calendar<br />
|-<br />
|Global Addressbook || &nbsp; || [[File:Cross_gray.gif]] || &nbsp;|| &nbsp; || globaladdressbookdisabled<br />
|-<br />
|Tasks || &nbsp; || [[File:check.gif]] || &nbsp;|| &nbsp; || tasks<br />
|-<br />
| &nbsp; || &nbsp; || &nbsp; || &nbsp; || &nbsp; || &nbsp; ||&nbsp;<br />
|-<br />
| rowspan="9" | '''PIM + Mobility'''<br>Private use only<br>No sharing, no group functions<br>Enabled for mobile synchronization <br />
|style="background-color:#F0F0F0" | Email ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || &nbsp; || &nbsp; || webmail<br />
|-<br />
|style="background-color:#F0F0F0" | Contacts ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || &nbsp;|| &nbsp; || contacts<br />
|-<br />
|style="background-color:#F0F0F0" | Calendar ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || &nbsp;|| &nbsp; || calendar<br />
|-<br />
|style="background-color:#F0F0F0" | USM ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || &nbsp; || &nbsp; || usm<br />
|-<br />
|style="background-color:#C0C0C0" | Active Sync ||style="background-color:#C0C0C0" | and/or ||style="background-color:#C0C0C0" | [[File:check.gif]] || rowspan="2" | This defines the level<br>At least one of these needs to be set<br>Typically "Active Sync"|| &nbsp; || activesync<br />
|-<br />
|style="background-color:#C0C0C0" | SyncML ||style="background-color:#C0C0C0" | and/or ||style="background-color:#C0C0C0" | [[File:check.gif]] || &nbsp; || syncml (deprecated)<br />
|-<br />
|Global Addressbook || &nbsp;|| [[File:Cross_gray.gif]] || &nbsp;|| &nbsp; || globaladdressbookdisabled<br />
|-<br />
|Tasks || &nbsp; || [[File:check.gif]] || &nbsp;|| &nbsp; || tasks<br />
|-<br />
| &nbsp; || &nbsp; || &nbsp; || &nbsp; || &nbsp; || &nbsp;<br />
|-<br />
| rowspan="6" | '''PIM + InfoStore''' <br>Private use only<br>No sharing, no group functions<br>Enabled for document storage. <br />
|style="background-color:#F0F0F0" | Email ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || &nbsp;|| &nbsp; || webmail<br />
|-<br />
|style="background-color:#F0F0F0" | Contacts ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || &nbsp;|| &nbsp; || contacts<br />
|-<br />
|style="background-color:#F0F0F0" | Calendar ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || &nbsp;|| &nbsp; || calendar<br />
|-<br />
|style="background-color:#C0C0C0" | InfoStore ||style="background-color:#C0C0C0" | [[File:check.gif]] ||style="background-color:#C0C0C0" | [[File:check.gif]] || This combined with the absence of other switches defines the level <br> || &nbsp; || infostore<br />
|-<br />
|Global Addressbook || &nbsp; || [[File:Cross_gray.gif]] || &nbsp;|| &nbsp; || globaladdressbookdisabled<br />
|-<br />
|Tasks || &nbsp; || [[File:check.gif]] || &nbsp;|| &nbsp; || tasks<br />
|-<br />
| &nbsp; || &nbsp; || &nbsp; || &nbsp; || &nbsp; || &nbsp; || &nbsp;<br />
|-<br />
| rowspan="9" | '''Groupware Standard'''<br>Full Groupware functionality<br>Access restricted to Web GUI <br />
|style="background-color:#F0F0F0" | Email ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || &nbsp; || &nbsp; || webmail<br />
|-<br />
|style="background-color:#F0F0F0" | Contacts ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || &nbsp;|| &nbsp; || contacts<br />
|-<br />
|style="background-color:#F0F0F0" | Calendar ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || &nbsp;|| &nbsp; || calendar<br />
|-<br />
|style="background-color:#F0F0F0" | Tasks ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || &nbsp;|| &nbsp; || tasks<br />
|-<br />
|style="background-color:#C0C0C0" | Shared Folders ||style="background-color:#C0C0C0" | [[File:check.gif]] ||style="background-color:#C0C0C0" | [[File:check.gif]] || rowspan="3" | This defines the level<br>All need to be set together || &nbsp; || readcreatesharedfolders<br />
|-<br />
|style="background-color:#C0C0C0" | Public Folders ||style="background-color:#C0C0C0" | [[File:check.gif]] ||style="background-color:#C0C0C0" | [[File:check.gif]] || &nbsp; || editpublicfolders<br />
|-<br />
|style="background-color:#C0C0C0" | Task Delegation ||style="background-color:#C0C0C0" | [[File:check.gif]] ||style="background-color:#C0C0C0" | [[File:check.gif]] || &nbsp; || delegatetask<br />
|-<br />
|style="background-color:#F0F0F0" | Global Addressbook ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || &nbsp; || &nbsp; || globaladdressbookdisabled<br />
|-<br />
|InfoStore || &nbsp; || [[File:check.gif]] || &nbsp;|| &nbsp; || infostore<br />
|-<br />
| &nbsp; || &nbsp; || &nbsp; || &nbsp; || &nbsp; || &nbsp; || &nbsp;<br />
|-<br />
| rowspan="16" | '''Groupware Premium'''<br>Full Groupware functionality<br>All external clients enabled (Mobility, Outlook, Mac)<br />
|style="background-color:#F0F0F0" | Email ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || &nbsp; || &nbsp; || webmail<br />
|-<br />
|style="background-color:#F0F0F0" | Contacts ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || &nbsp;|| &nbsp; || contacts<br />
|-<br />
|style="background-color:#F0F0F0" | Calendar ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || &nbsp;|| &nbsp; || calendar<br />
|-<br />
|style="background-color:#F0F0F0" | Tasks ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || &nbsp;|| &nbsp; || tasks<br />
|-<br />
|style="background-color:#F0F0F0" | Shared Folders ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || &nbsp; || &nbsp; || readcreatesharedfolders<br />
|-<br />
|style="background-color:#F0F0F0" | Public Folders ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || &nbsp; || &nbsp; || editpublicfolders<br />
|-<br />
|style="background-color:#F0F0F0" | Task Delegation ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || &nbsp; || &nbsp; || delegatetask<br />
|-<br />
|style="background-color:#F0F0F0" | Global Addressbook ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || &nbsp; || &nbsp; || globaladdressbookdisabled<br />
|-<br />
|style="background-color:#F0F0F0" | USM ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || &nbsp; || &nbsp; || usm<br />
|-<br />
|style="background-color:#C0C0C0" | OLOX2 ||style="background-color:#C0C0C0" | and/or ||style="background-color:#C0C0C0" | [[File:check.gif]] || rowspan="4" | This defines the level<br>At least one of these needs to be set.<br>Typically OLOX2 and Active Sync || &nbsp; || olox20<br />
|-<br />
|style="background-color:#C0C0C0" | OLOX (Legacy) ||style="background-color:#C0C0C0" | and/or ||style="background-color:#C0C0C0" | [[File:check.gif]] || &nbsp; || webdavxml<br />
|-<br />
|style="background-color:#C0C0C0" | Active Sync ||style="background-color:#C0C0C0" | and/or ||style="background-color:#C0C0C0" | [[File:check.gif]] || &nbsp; || activesync<br />
|-<br />
|style="background-color:#C0C0C0" | SyncML ||style="background-color:#C0C0C0" | and/or ||style="background-color:#C0C0C0" | [[File:check.gif]] || &nbsp; || syncml (deprecated)<br />
|-<br />
|InfoStore || &nbsp; || [[File:check.gif]] || &nbsp;|| &nbsp; || infostore<br />
|-<br />
|iCal Access || &nbsp; || [[File:check.gif]] || &nbsp;|| &nbsp; || ical (deprecated)<br />
|-<br />
|vCard Access || &nbsp; || [[File:check.gif]] || &nbsp;|| &nbsp; || vcard (deprecated)<br />
|-<br />
|}<br />
<br><br />
<br><br />
<br />
== Additional Flexible Functions ==<br />
<br />
The following functions can be added flexible to each permission level.<br />
<br />
{|<br />
|-<br />
! Additional Functions !! Default !! Requirements / Description !! &nbsp; !! API Parameter<br />
|-<br />
| rowspan="2" | '''Minimum Webmail'''<br />
|Collect Emailaddresses || Email addresses typed into sent/reveived emails can be saved automatically in a dedicated folder || &nbsp; || collectemailaddresses<br />
|-<br />
|Edit Password || If a plugin to change the own password is installed on the system, it will be displayed in the settings area || &nbsp; || editpassword<br />
|-<br />
| &nbsp; || &nbsp; || &nbsp; || &nbsp; || &nbsp;<br />
|-<br />
| rowspan="3" | '''Minimum PIM'''<br />
|Multiple Mailaccounts || The user can use external IMAP/POP3 Mailaccounts within the OX WebGUI. Starting with 6.20 this can be configured per email service || &nbsp; || multiplemailaccounts<br />
|-<br />
|Subscriptions || The user can subscribe to external/social datasources, like LinkedIN, XING, Facebook, Gmail, .... Starting with 6.20 this can be configured per subscription service || &nbsp; || subscriptions<br />
|-<br />
|Publications || The user can publish his own data (contacts/documents) for other users in the internet || &nbsp; || publication<br />
|-<br />
| &nbsp; || &nbsp; || &nbsp; || &nbsp; || &nbsp;<br />
|-<br />
| '''Minimum PIM + InfoStore'''<br />
|WebDAV || Allows WebDAV access to InfoStore documents; Requires InfoStore || &nbsp; || webdav<br />
|-<br />
| &nbsp; || &nbsp; || &nbsp; || &nbsp; || &nbsp;<br />
|-<br />
| rowspan="2" | '''Minimum GW Standard'''<br />
|Manage Resources || The user is allowed to create and manage resources for the whole company || &nbsp; || editresource<br />
|-<br />
|Manage Groups || The user is allowed to create and manage groups for the whole company || &nbsp; || editgroup<br />
|-<br />
| &nbsp; || &nbsp; || &nbsp; || &nbsp; || &nbsp;<br />
|-<br />
| rowspan="2" | '''Minimum GW Premium'''<br />
|vCard || The user can download all his contacts via the vCard interface || &nbsp; || vcard (deprecated)<br />
|-<br />
|iCal || The user can download all his contacts via the iCal interface || &nbsp; || ical (deprecated)<br />
|-<br />
|}</div>Sgablerhttps://oxpedia.org/wiki/index.php?title=OX_Permission_Level&diff=15879OX Permission Level2013-10-08T12:04:04Z<p>Sgabler: /* Matrix - Permission Levels */</p>
<hr />
<div>= OX Permission Level Matrix=<br />
<br />
OX HE/SE/App Suite allows to provide different permission levels to the users. <br />
<br />
The levels start with pure webmail-only functionality and end with the full featured groupware product including all connectors and are described in the first table.<br />
<br />
* '''Webmail''' contains pure webmail functionality including a private addressbook<br />
* '''PIM''' (Private Information Management) adds private calendar and private tasks, no group or sharing capabilities are available<br />
* '''PIM + Mobility''' adds mobile synchronisation to the PIM level<br />
* '''PIM + InfoStore''' adds private InfoStore functionality to the PIM level<br />
* '''Groupware Standard''' includes all group and sharing capabilities as well as the InfoStore<br />
* '''Groupware Premium''' adds all external connectors and mobile synchronisation to Groupware Standard<br />
<br />
In addition to this levels, OX HE/SE/App Suite contains several functions, which can flexible be used with every level. This functions are described in the second table.<br />
<br />
<br />
== How to read the Matrix ==<br />
<br />
{|<br />
|-<br />
! !! Definition<br />
|-<br />
| '''Mandatory''' || This column defines the options, which must not be changed for this level. '''This is a technical requirement and necessary for the correct functioning of OX HE/SE/App Suite'''<br />
|-<br />
| '''Default''' || This column lists the options, which are activated per default for this level<br />
|-<br />
| '''API Parameter''' || Related parameter in the RMI, SOAP and CLT API - described in the [http://software.open-xchange.com/OX6/doc/OX6-Provisioning.pdf Provisioning Documentation]<br />
|-<br />
|&nbsp; || &nbsp;<br />
|-<br />
| '''and/or''' || Minimum one of this options need to be activated in this level<br />
|-<br />
|style="background-color:#C0C0C0" | &nbsp;|| Fields in this color define the most important differentiator to the next lower level<br />
|}<br />
<br />
== Matrix - Permission Levels ==<br />
<br />
This table describes the mandatory parameters for the different permission levels.<br />
<br />
{|<br />
|-<br />
! OX Base Levels !! Functionality !! Mandatory (technical requirement) !! Default !! Requirements / Description !! &nbsp; !! API Parameter<br />
|-<br />
| rowspan="2" | '''Webmail'''<br />
Webmail only <br />
|style="background-color:#F0F0F0" | Email ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || &nbsp;|| &nbsp;|| webmail<br />
|-<br />
|style="background-color:#F0F0F0" | Contacts ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || &nbsp;|| &nbsp; || contacts<br />
|-<br />
| &nbsp; || &nbsp; || &nbsp; || &nbsp; || &nbsp; || &nbsp; || &nbsp;<br />
|-<br />
| rowspan="5" | '''PIM'''<br>Private use only<br>No sharing, no group functions. <br />
|style="background-color:#F0F0F0" | Email ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || rowspan="3" | The absence of other features defines this level || &nbsp; || webmail<br />
|-<br />
|style="background-color:#F0F0F0" | Contacts ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || &nbsp; || contacts<br />
|-<br />
|style="background-color:#F0F0F0" | Calendar ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || &nbsp; || calendar<br />
|-<br />
|Global Addressbook || &nbsp; || [[File:Cross_gray.gif]] || &nbsp;|| &nbsp; || globaladdressbookdisabled<br />
|-<br />
|Tasks || &nbsp; || [[File:check.gif]] || &nbsp;|| &nbsp; || tasks<br />
|-<br />
| &nbsp; || &nbsp; || &nbsp; || &nbsp; || &nbsp; || &nbsp; ||&nbsp;<br />
|-<br />
| rowspan="9" | '''PIM + Mobility'''<br>Private use only<br>No sharing, no group functions<br>Enabled for mobile synchronization <br />
|style="background-color:#F0F0F0" | Email ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || &nbsp; || &nbsp; || webmail<br />
|-<br />
|style="background-color:#F0F0F0" | Contacts ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || &nbsp;|| &nbsp; || contacts<br />
|-<br />
|style="background-color:#F0F0F0" | Calendar ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || &nbsp;|| &nbsp; || calendar<br />
|-<br />
|style="background-color:#F0F0F0" | USM ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || &nbsp; || &nbsp; || usm<br />
|-<br />
|style="background-color:#C0C0C0" | Active Sync ||style="background-color:#C0C0C0" | and/or ||style="background-color:#C0C0C0" | [[File:check.gif]] || rowspan="2" | This defines the level<br>At least one of these needs to be set<br>Typically "Active Sync"|| &nbsp; || activesync<br />
|-<br />
|style="background-color:#C0C0C0" | SyncML ||style="background-color:#C0C0C0" | and/or ||style="background-color:#C0C0C0" | [[File:check.gif]] || &nbsp; || syncml (deprecated)<br />
|-<br />
|Global Addressbook || &nbsp;|| [[File:Cross_gray.gif]] || &nbsp;|| &nbsp; || globaladdressbookdisabled<br />
|-<br />
|Tasks || &nbsp; || [[File:check.gif]] || &nbsp;|| &nbsp; || tasks<br />
|-<br />
| &nbsp; || &nbsp; || &nbsp; || &nbsp; || &nbsp; || &nbsp;<br />
|-<br />
| rowspan="6" | '''PIM + InfoStore''' <br>Private use only<br>No sharing, no group functions<br>Enabled for document storage. <br />
|style="background-color:#F0F0F0" | Email ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || &nbsp;|| &nbsp; || webmail<br />
|-<br />
|style="background-color:#F0F0F0" | Contacts ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || &nbsp;|| &nbsp; || contacts<br />
|-<br />
|style="background-color:#F0F0F0" | Calendar ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || &nbsp;|| &nbsp; || calendar<br />
|-<br />
|style="background-color:#C0C0C0" | InfoStore ||style="background-color:#C0C0C0" | [[File:check.gif]] ||style="background-color:#C0C0C0" | [[File:check.gif]] || This combined with the absence of other switches defines the level <br> || &nbsp; || infostore<br />
|-<br />
|Global Addressbook || &nbsp; || [[File:Cross_gray.gif]] || &nbsp;|| &nbsp; || globaladdressbookdisabled<br />
|-<br />
|Tasks || &nbsp; || [[File:check.gif]] || &nbsp;|| &nbsp; || tasks<br />
|-<br />
| &nbsp; || &nbsp; || &nbsp; || &nbsp; || &nbsp; || &nbsp; || &nbsp;<br />
|-<br />
| rowspan="9" | '''Groupware Standard'''<br>Full Groupware functionality<br>Access restricted to Web GUI <br />
|style="background-color:#F0F0F0" | Email ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || &nbsp; || &nbsp; || webmail<br />
|-<br />
|style="background-color:#F0F0F0" | Contacts ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || &nbsp;|| &nbsp; || contacts<br />
|-<br />
|style="background-color:#F0F0F0" | Calendar ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || &nbsp;|| &nbsp; || calendar<br />
|-<br />
|style="background-color:#F0F0F0" | Tasks ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || &nbsp;|| &nbsp; || tasks<br />
|-<br />
|style="background-color:#C0C0C0" | Shared Folders ||style="background-color:#C0C0C0" | [[File:check.gif]] ||style="background-color:#C0C0C0" | [[File:check.gif]] || rowspan="3" | This defines the level<br>All need to be set together || &nbsp; || readcreatesharedfolders<br />
|-<br />
|style="background-color:#C0C0C0" | Public Folders ||style="background-color:#C0C0C0" | [[File:check.gif]] ||style="background-color:#C0C0C0" | [[File:check.gif]] || &nbsp; || editpublicfolders<br />
|-<br />
|style="background-color:#C0C0C0" | Task Delegation ||style="background-color:#C0C0C0" | [[File:check.gif]] ||style="background-color:#C0C0C0" | [[File:check.gif]] || &nbsp; || delegatetask<br />
|-<br />
|style="background-color:#F0F0F0" | Global Addressbook ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || &nbsp; || &nbsp; || globaladdressbookdisabled<br />
|-<br />
|InfoStore || &nbsp; || [[File:check.gif]] || &nbsp;|| &nbsp; || infostore<br />
|-<br />
| &nbsp; || &nbsp; || &nbsp; || &nbsp; || &nbsp; || &nbsp; || &nbsp;<br />
|-<br />
| rowspan="16" | '''Groupware Premium'''<br>Full Groupware functionality<br>All external clients enabled (Mobility, Outlook, Mac)<br />
|style="background-color:#F0F0F0" | Email ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || &nbsp; || &nbsp; || webmail<br />
|-<br />
|style="background-color:#F0F0F0" | Contacts ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || &nbsp;|| &nbsp; || contacts<br />
|-<br />
|style="background-color:#F0F0F0" | Calendar ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || &nbsp;|| &nbsp; || calendar<br />
|-<br />
|style="background-color:#F0F0F0" | Tasks ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || &nbsp;|| &nbsp; || tasks<br />
|-<br />
|style="background-color:#F0F0F0" | Shared Folders ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || &nbsp; || &nbsp; || readcreatesharedfolders<br />
|-<br />
|style="background-color:#F0F0F0" | Public Folders ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || &nbsp; || &nbsp; || editpublicfolders<br />
|-<br />
|style="background-color:#F0F0F0" | Task Delegation ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || &nbsp; || &nbsp; || delegatetask<br />
|-<br />
|style="background-color:#F0F0F0" | Global Addressbook ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || &nbsp; || &nbsp; || globaladdressbookdisabled<br />
|-<br />
|style="background-color:#F0F0F0" | USM ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || &nbsp; || &nbsp; || usm<br />
|-<br />
|style="background-color:#C0C0C0" | OLOX2 ||style="background-color:#C0C0C0" | and/or ||style="background-color:#C0C0C0" | [[File:check.gif]] || rowspan="4" | This defines the level<br>At least one of these needs to be set.<br>Typically OLOX2 and Active Sync || &nbsp; || olox20<br />
|-<br />
|style="background-color:#C0C0C0" | OLOX (Legacy) ||style="background-color:#C0C0C0" | and/or ||style="background-color:#C0C0C0" | [[File:check.gif]] || &nbsp; || webdavxml<br />
|-<br />
|style="background-color:#C0C0C0" | Active Sync ||style="background-color:#C0C0C0" | and/or ||style="background-color:#C0C0C0" | [[File:check.gif]] || &nbsp; || activesync<br />
|-<br />
|style="background-color:#C0C0C0" | SyncML ||style="background-color:#C0C0C0" | and/or ||style="background-color:#C0C0C0" | [[File:check.gif]] || &nbsp; || syncml (deprecated)<br />
|-<br />
|InfoStore || &nbsp; || [[File:check.gif]] || &nbsp;|| &nbsp; || infostore<br />
|-<br />
|iCal Access || &nbsp; || [[File:check.gif]] || &nbsp;|| &nbsp; || ical (deprecated)<br />
|-<br />
|vCard Access || &nbsp; || [[File:check.gif]] || &nbsp;|| &nbsp; || vcard (deprecated)<br />
|-<br />
|}<br />
<br><br />
<br><br />
<br />
== Additional Flexible Functions ==<br />
<br />
The following functions can be added flexible to each permission level.<br />
<br />
{|<br />
|-<br />
! Additional Functions !! Default !! Requirements / Description !! &nbsp; !! API Parameter<br />
|-<br />
| rowspan="2" | '''Minimum Webmail'''<br />
|Collect Emailaddresses || Email addresses typed into sent/reveived emails can be saved automatically in a dedicated folder || &nbsp; || collectemailaddresses<br />
|-<br />
|Edit Password || If a plugin to change the own password is installed on the system, it will be displayed in the settings area || &nbsp; || editpassword<br />
|-<br />
| &nbsp; || &nbsp; || &nbsp; || &nbsp; || &nbsp;<br />
|-<br />
| rowspan="3" | '''Minimum PIM'''<br />
|Multiple Mailaccounts || The user can use external IMAP/POP3 Mailaccounts within the OX WebGUI. Starting with 6.20 this can be configured per email service || &nbsp; || multiplemailaccounts<br />
|-<br />
|Subscriptions || The user can subscribe to external/social datasources, like LinkedIN, XING, Facebook, Gmail, .... Starting with 6.20 this can be configured per subscription service || &nbsp; || subscriptions<br />
|-<br />
|Publications || The user can publish his own data (contacts/documents) for other users in the internet || &nbsp; || publication<br />
|-<br />
| &nbsp; || &nbsp; || &nbsp; || &nbsp; || &nbsp;<br />
|-<br />
| '''Minimum PIM + InfoStore'''<br />
|WebDAV || Allows WebDAV access to InfoStore documents; Requires InfoStore || &nbsp; || webdav<br />
|-<br />
| &nbsp; || &nbsp; || &nbsp; || &nbsp; || &nbsp;<br />
|-<br />
| rowspan="2" | '''Minimum GW Standard'''<br />
|Manage Resources || The user is allowed to create and manage resources for the whole company || &nbsp; || editresource<br />
|-<br />
|Manage Groups || The user is allowed to create and manage groups for the whole company || &nbsp; || editgroup<br />
|-<br />
| &nbsp; || &nbsp; || &nbsp; || &nbsp; || &nbsp;<br />
|-<br />
| rowspan="2" | '''Minimum GW Premium'''<br />
|vCard || The user can download all his contacts via the vCard interface || &nbsp; || vcard<br />
|-<br />
|iCal || The user can download all his contacts via the iCal interface || &nbsp; || ical<br />
|-<br />
|}</div>Sgablerhttps://oxpedia.org/wiki/index.php?title=OX_Permission_Level&diff=15878OX Permission Level2013-10-08T11:55:55Z<p>Sgabler: /* Additional Flexible Functions */</p>
<hr />
<div>= OX Permission Level Matrix=<br />
<br />
OX HE/SE/App Suite allows to provide different permission levels to the users. <br />
<br />
The levels start with pure webmail-only functionality and end with the full featured groupware product including all connectors and are described in the first table.<br />
<br />
* '''Webmail''' contains pure webmail functionality including a private addressbook<br />
* '''PIM''' (Private Information Management) adds private calendar and private tasks, no group or sharing capabilities are available<br />
* '''PIM + Mobility''' adds mobile synchronisation to the PIM level<br />
* '''PIM + InfoStore''' adds private InfoStore functionality to the PIM level<br />
* '''Groupware Standard''' includes all group and sharing capabilities as well as the InfoStore<br />
* '''Groupware Premium''' adds all external connectors and mobile synchronisation to Groupware Standard<br />
<br />
In addition to this levels, OX HE/SE/App Suite contains several functions, which can flexible be used with every level. This functions are described in the second table.<br />
<br />
<br />
== How to read the Matrix ==<br />
<br />
{|<br />
|-<br />
! !! Definition<br />
|-<br />
| '''Mandatory''' || This column defines the options, which must not be changed for this level. '''This is a technical requirement and necessary for the correct functioning of OX HE/SE/App Suite'''<br />
|-<br />
| '''Default''' || This column lists the options, which are activated per default for this level<br />
|-<br />
| '''API Parameter''' || Related parameter in the RMI, SOAP and CLT API - described in the [http://software.open-xchange.com/OX6/doc/OX6-Provisioning.pdf Provisioning Documentation]<br />
|-<br />
|&nbsp; || &nbsp;<br />
|-<br />
| '''and/or''' || Minimum one of this options need to be activated in this level<br />
|-<br />
|style="background-color:#C0C0C0" | &nbsp;|| Fields in this color define the most important differentiator to the next lower level<br />
|}<br />
<br />
== Matrix - Permission Levels ==<br />
<br />
This table describes the mandatory parameters for the different permission levels.<br />
<br />
{|<br />
|-<br />
! OX Base Levels !! Functionality !! Mandatory (technical requirement) !! Default !! Requirements / Description !! &nbsp; !! API Parameter<br />
|-<br />
| rowspan="2" | '''Webmail'''<br />
Webmail only <br />
|style="background-color:#F0F0F0" | Email ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || &nbsp;|| &nbsp;|| webmail<br />
|-<br />
|style="background-color:#F0F0F0" | Contacts ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || &nbsp;|| &nbsp; || contacts<br />
|-<br />
| &nbsp; || &nbsp; || &nbsp; || &nbsp; || &nbsp; || &nbsp; || &nbsp;<br />
|-<br />
| rowspan="5" | '''PIM'''<br>Private use only<br>No sharing, no group functions. <br />
|style="background-color:#F0F0F0" | Email ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || rowspan="3" | The absence of other features defines this level || &nbsp; || webmail<br />
|-<br />
|style="background-color:#F0F0F0" | Contacts ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || &nbsp; || contacts<br />
|-<br />
|style="background-color:#F0F0F0" | Calendar ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || &nbsp; || calendar<br />
|-<br />
|Global Addressbook || &nbsp; || [[File:Cross_gray.gif]] || &nbsp;|| &nbsp; || globaladdressbookdisabled<br />
|-<br />
|Tasks || &nbsp; || [[File:check.gif]] || &nbsp;|| &nbsp; || tasks<br />
|-<br />
| &nbsp; || &nbsp; || &nbsp; || &nbsp; || &nbsp; || &nbsp; ||&nbsp;<br />
|-<br />
| rowspan="9" | '''PIM + Mobility'''<br>Private use only<br>No sharing, no group functions<br>Enabled for mobile synchronization <br />
|style="background-color:#F0F0F0" | Email ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || &nbsp; || &nbsp; || webmail<br />
|-<br />
|style="background-color:#F0F0F0" | Contacts ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || &nbsp;|| &nbsp; || contacts<br />
|-<br />
|style="background-color:#F0F0F0" | Calendar ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || &nbsp;|| &nbsp; || calendar<br />
|-<br />
|style="background-color:#F0F0F0" | USM ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || &nbsp; || &nbsp; || usm<br />
|-<br />
|style="background-color:#C0C0C0" | Active Sync ||style="background-color:#C0C0C0" | and/or ||style="background-color:#C0C0C0" | [[File:check.gif]] || rowspan="2" | This defines the level<br>At least one of these needs to be set<br>Typically "Active Sync"|| &nbsp; || activesync<br />
|-<br />
|style="background-color:#C0C0C0" | SyncML ||style="background-color:#C0C0C0" | and/or ||style="background-color:#C0C0C0" | [[File:check.gif]] || &nbsp; || syncml<br />
|-<br />
|Global Addressbook || &nbsp;|| [[File:Cross_gray.gif]] || &nbsp;|| &nbsp; || globaladdressbookdisabled<br />
|-<br />
|Tasks || &nbsp; || [[File:check.gif]] || &nbsp;|| &nbsp; || tasks<br />
|-<br />
| &nbsp; || &nbsp; || &nbsp; || &nbsp; || &nbsp; || &nbsp;<br />
|-<br />
| rowspan="6" | '''PIM + InfoStore''' <br>Private use only<br>No sharing, no group functions<br>Enabled for document storage. <br />
|style="background-color:#F0F0F0" | Email ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || &nbsp;|| &nbsp; || webmail<br />
|-<br />
|style="background-color:#F0F0F0" | Contacts ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || &nbsp;|| &nbsp; || contacts<br />
|-<br />
|style="background-color:#F0F0F0" | Calendar ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || &nbsp;|| &nbsp; || calendar<br />
|-<br />
|style="background-color:#C0C0C0" | InfoStore ||style="background-color:#C0C0C0" | [[File:check.gif]] ||style="background-color:#C0C0C0" | [[File:check.gif]] || This combined with the absence of other switches defines the level <br> || &nbsp; || infostore<br />
|-<br />
|Global Addressbook || &nbsp; || [[File:Cross_gray.gif]] || &nbsp;|| &nbsp; || globaladdressbookdisabled<br />
|-<br />
|Tasks || &nbsp; || [[File:check.gif]] || &nbsp;|| &nbsp; || tasks<br />
|-<br />
| &nbsp; || &nbsp; || &nbsp; || &nbsp; || &nbsp; || &nbsp; || &nbsp;<br />
|-<br />
| rowspan="9" | '''Groupware Standard'''<br>Full Groupware functionality<br>Access restricted to Web GUI <br />
|style="background-color:#F0F0F0" | Email ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || &nbsp; || &nbsp; || webmail<br />
|-<br />
|style="background-color:#F0F0F0" | Contacts ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || &nbsp;|| &nbsp; || contacts<br />
|-<br />
|style="background-color:#F0F0F0" | Calendar ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || &nbsp;|| &nbsp; || calendar<br />
|-<br />
|style="background-color:#F0F0F0" | Tasks ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || &nbsp;|| &nbsp; || tasks<br />
|-<br />
|style="background-color:#C0C0C0" | Shared Folders ||style="background-color:#C0C0C0" | [[File:check.gif]] ||style="background-color:#C0C0C0" | [[File:check.gif]] || rowspan="3" | This defines the level<br>All need to be set together || &nbsp; || readcreatesharedfolders<br />
|-<br />
|style="background-color:#C0C0C0" | Public Folders ||style="background-color:#C0C0C0" | [[File:check.gif]] ||style="background-color:#C0C0C0" | [[File:check.gif]] || &nbsp; || editpublicfolders<br />
|-<br />
|style="background-color:#C0C0C0" | Task Delegation ||style="background-color:#C0C0C0" | [[File:check.gif]] ||style="background-color:#C0C0C0" | [[File:check.gif]] || &nbsp; || delegatetask<br />
|-<br />
|style="background-color:#F0F0F0" | Global Addressbook ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || &nbsp; || &nbsp; || globaladdressbookdisabled<br />
|-<br />
|InfoStore || &nbsp; || [[File:check.gif]] || &nbsp;|| &nbsp; || infostore<br />
|-<br />
| &nbsp; || &nbsp; || &nbsp; || &nbsp; || &nbsp; || &nbsp; || &nbsp;<br />
|-<br />
| rowspan="16" | '''Groupware Premium'''<br>Full Groupware functionality<br>All external clients enabled (Mobility, Outlook, Mac)<br />
|style="background-color:#F0F0F0" | Email ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || &nbsp; || &nbsp; || webmail<br />
|-<br />
|style="background-color:#F0F0F0" | Contacts ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || &nbsp;|| &nbsp; || contacts<br />
|-<br />
|style="background-color:#F0F0F0" | Calendar ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || &nbsp;|| &nbsp; || calendar<br />
|-<br />
|style="background-color:#F0F0F0" | Tasks ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || &nbsp;|| &nbsp; || tasks<br />
|-<br />
|style="background-color:#F0F0F0" | Shared Folders ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || &nbsp; || &nbsp; || readcreatesharedfolders<br />
|-<br />
|style="background-color:#F0F0F0" | Public Folders ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || &nbsp; || &nbsp; || editpublicfolders<br />
|-<br />
|style="background-color:#F0F0F0" | Task Delegation ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || &nbsp; || &nbsp; || delegatetask<br />
|-<br />
|style="background-color:#F0F0F0" | Global Addressbook ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || &nbsp; || &nbsp; || globaladdressbookdisabled<br />
|-<br />
|style="background-color:#F0F0F0" | USM ||style="background-color:#F0F0F0" | [[File:check.gif]] ||style="background-color:#F0F0F0" | [[File:check.gif]] || &nbsp; || &nbsp; || usm<br />
|-<br />
|style="background-color:#C0C0C0" | OLOX2 ||style="background-color:#C0C0C0" | and/or ||style="background-color:#C0C0C0" | [[File:check.gif]] || rowspan="4" | This defines the level<br>At least one of these needs to be set.<br>Typically OLOX2 and Active Sync || &nbsp; || olox20<br />
|-<br />
|style="background-color:#C0C0C0" | OLOX (Legacy) ||style="background-color:#C0C0C0" | and/or ||style="background-color:#C0C0C0" | [[File:check.gif]] || &nbsp; || webdavxml<br />
|-<br />
|style="background-color:#C0C0C0" | Active Sync ||style="background-color:#C0C0C0" | and/or ||style="background-color:#C0C0C0" | [[File:check.gif]] || &nbsp; || activesync<br />
|-<br />
|style="background-color:#C0C0C0" | SyncML ||style="background-color:#C0C0C0" | and/or ||style="background-color:#C0C0C0" | [[File:check.gif]] || &nbsp; || syncml<br />
|-<br />
|InfoStore || &nbsp; || [[File:check.gif]] || &nbsp;|| &nbsp; || infostore<br />
|-<br />
|iCal Access || &nbsp; || [[File:check.gif]] || &nbsp;|| &nbsp; || ical<br />
|-<br />
|vCard Access || &nbsp; || [[File:check.gif]] || &nbsp;|| &nbsp; || vcard<br />
|-<br />
|}<br />
<br><br />
<br><br />
<br />
== Additional Flexible Functions ==<br />
<br />
The following functions can be added flexible to each permission level.<br />
<br />
{|<br />
|-<br />
! Additional Functions !! Default !! Requirements / Description !! &nbsp; !! API Parameter<br />
|-<br />
| rowspan="2" | '''Minimum Webmail'''<br />
|Collect Emailaddresses || Email addresses typed into sent/reveived emails can be saved automatically in a dedicated folder || &nbsp; || collectemailaddresses<br />
|-<br />
|Edit Password || If a plugin to change the own password is installed on the system, it will be displayed in the settings area || &nbsp; || editpassword<br />
|-<br />
| &nbsp; || &nbsp; || &nbsp; || &nbsp; || &nbsp;<br />
|-<br />
| rowspan="3" | '''Minimum PIM'''<br />
|Multiple Mailaccounts || The user can use external IMAP/POP3 Mailaccounts within the OX WebGUI. Starting with 6.20 this can be configured per email service || &nbsp; || multiplemailaccounts<br />
|-<br />
|Subscriptions || The user can subscribe to external/social datasources, like LinkedIN, XING, Facebook, Gmail, .... Starting with 6.20 this can be configured per subscription service || &nbsp; || subscriptions<br />
|-<br />
|Publications || The user can publish his own data (contacts/documents) for other users in the internet || &nbsp; || publication<br />
|-<br />
| &nbsp; || &nbsp; || &nbsp; || &nbsp; || &nbsp;<br />
|-<br />
| '''Minimum PIM + InfoStore'''<br />
|WebDAV || Allows WebDAV access to InfoStore documents; Requires InfoStore || &nbsp; || webdav<br />
|-<br />
| &nbsp; || &nbsp; || &nbsp; || &nbsp; || &nbsp;<br />
|-<br />
| rowspan="2" | '''Minimum GW Standard'''<br />
|Manage Resources || The user is allowed to create and manage resources for the whole company || &nbsp; || editresource<br />
|-<br />
|Manage Groups || The user is allowed to create and manage groups for the whole company || &nbsp; || editgroup<br />
|-<br />
| &nbsp; || &nbsp; || &nbsp; || &nbsp; || &nbsp;<br />
|-<br />
| rowspan="2" | '''Minimum GW Premium'''<br />
|vCard || The user can download all his contacts via the vCard interface || &nbsp; || vcard<br />
|-<br />
|iCal || The user can download all his contacts via the iCal interface || &nbsp; || ical<br />
|-<br />
|}</div>Sgablerhttps://oxpedia.org/wiki/index.php?title=OX6:Open-Xchange_Installation_Guide_for_CentOS_6_622&diff=12587OX6:Open-Xchange Installation Guide for CentOS 6 6222013-01-23T19:19:11Z<p>Sgabler: </p>
<hr />
<div>= Open-Xchange Server 6 (v6.22) on CentOS6 Linux =<br />
<br />
{{QuickInstIntro|release=6}}<br />
<br />
<br />
'''Important: This installation guide will only work for v6.22. If you want to install v6.20 please use the [http://oxpedia.org/wiki/index.php?title=Open-Xchange_Installation_Guide_for_CentOS_6 installation guide for earlier versions].'''<br />
<br />
= Requirements =<br />
<br />
* Plain installed CentOS6 with latest updates<br />
* A configured internet connection<br />
* httpd - Apache web server<br />
<br />
{{AddReposRHEL|rhelname=RHEL6|release=6.22}}<br />
<br />
= Updating repositories and installing packages =<br />
<br />
Reload the package index. This will download the package descriptions available at the software repositories:<br />
<br />
$ yum update<br />
<br />
The following command starts the download and installation process of all required package for Open-Xchange deployment:<br />
<br />
{{OXPackageInstallation|installer=yum|mysql=mysql-server|javavendor=sun|release=6.22}}<br />
<br />
<br />
{{OXConfiguration|mysqlstart=/etc/init.d/mysqld start}}<br />
<br />
{{oxinstaller}}<br />
<br />
After initializing the configuration, start the Open-Xchange service by executing:<br />
<br />
$ /etc/init.d/open-xchange start<br />
<br />
{{OXRegister}}<br />
<br />
<br />
= Configure services =<br />
Now as the Open-Xchange Server has been set up and the database is running, we have to configure the Apache webserver and the mod_proxy_ajp module to access the groupware frontend. To gain better GUI performance, the usage of ''mod_expires'' and ''mod_deflate'' is strongly recommended. Those modules will limit the amount of client requests and compress the delivered content. The default installation of the Apache webserver on CentOS provides a welcome screen which is not necessary for server operation, it can be removed by deleting the corresponding configuration file:<br />
<br />
$ rm /etc/httpd/conf.d/welcome.conf<br />
<br />
{{Template:ApacheOXConf|ajpconf=/etc/httpd/conf.d/proxy_ajp.conf|apacheconf= /etc/httpd/conf.d/ox.conf|docroot=/var/www/html|release=6.22|loadmodule=LoadModule proxy_ajp_module modules/mod_proxy_ajp.so}}<br />
<br />
After the configuration is done, restart the Apache webserver<br />
<br />
$ /etc/init.d/httpd restart<br />
<br />
= Adding services to runlevels =<br />
<br />
The new services are now installed and configured, but to make them start up on a server boot, they need to be added to some runlevels:<br />
<br />
$ chkconfig --level 345 mysqld on<br />
$ chkconfig --level 345 httpd on<br />
$ chkconfig --level 345 open-xchange on<br />
<br />
= Creating contexts and users =<br />
Now as the whole setup is complete and you already should get a login screen when accessing the server with a webbrowser, we have to setup a context and a default user as the last step of this tutorial.<br />
<br />
The mapping ''defaultcontext'' will allow you to set this context as the default one of the entire system so that users which will be created within this context can login into Open-Xchange Server without specifying their domain at the login screen. Only one context can be specified as ''defaultcontext''. The ''oxadmin'' user that will be created by this command is the default admin of the created context. This account will gather additional functions that are also described in the administration manual. The ''context id'' parameter must to be unique and numeric, otherwise the server will complain when you try to create a context. New contexts must be created by the ''oxadminmaster'' user, user accounts inside a context are created with the credentials of the contexts ''oxadmin'' account. The ''access-combination-name'' property defines the set of available modules and functions for users of the context.<br />
<br />
$ /opt/open-xchange/sbin/createcontext -A oxadminmaster -P admin_master_password -c 1 \<br />
-u oxadmin -d "Context Admin" -g Admin -s User -p secret -L defaultcontext \<br />
-e oxadmin@example.com -q 1024 --access-combination-name=all<br />
<br />
Create a user for testing purposes:<br />
<br />
$ /opt/open-xchange/sbin/createuser -c 1 -A oxadmin -P secret -u testuser \<br />
-d "Test User" -g Test -s User -p secret -e testuser@example.com \<br />
--imaplogin testuser --imapserver 127.0.0.1 --smtpserver 127.0.0.1<br />
<br />
Now connect to the server with a webbrowser and login using the credentials testuser / secret.<br />
<br />
<br />
= Log files and issue tracking =<br />
<br />
Whenever unexpected or erroneous behavior takes place, it will be logged depending on the configured loglevel. All logfiles are stored at the operating systems default location. Events triggered by the Open-Xchange Groupware services are logged to a rotating file ''open-xchange.log'', events triggered by the Open-Xchange Administration service are logged to ''open-xchange-admin.log''. Those files are the very first place to monitor.<br />
<br />
$ tail -f -n200 /var/log/open-xchange/open-xchange.log.0<br />
<br />
= Performance & Tuning Tips =<br />
Depending on your setup and the user accounts, it´s often helpful to know, how to get a better performance from the complete system. This section will try to assist you, how to tune the components within an OX setup, before you need to install a second server, add more RAM, add new CPU to existing servers. <br />
<br />
== MySQL ==<br />
Since OX itself used very specific features from MySQL like InnoDB instead of MyISAM as DB Engine, it´s often needed, how to increase performance of the OX databases. In general, you should always monitor your MySQL system via tools like "munin", to see when your system reaches it´s limits. Once, you recognized, the system responds more and more slowly, you start to read and research on the internet how to change your mysql configuration, specially, the my.cnf file. But due to the fact, that nearly every system is different in regards of hardware etc. you cannot just copy&paste existing configurations. At this point, a tool called "mysqltuner.pl" can help you. MySQLTuner is a script written in Perl that will assist you with your MySQL configuration and make recommendations for increased performance and stability. Within seconds, it will display statistics about your MySQL installation and the areas where it can be improved. To work with this tool, you need unrestricted read access to the MySQL server (OS root access is recommended). Just download and execute as shown below, and modify your existing my.cnf configuration file. <br />
<br />
IMPORTANT INFO: The MySQL system must run for several days, to gather statistics and informations about queries etc. from OX. After these days, you should execute mysqltuner.pl script. It does not work if you run it directly after installing an OX/MySQL setup. You can force traffic to OX while writing automatic testcases or jmeter plans. <br />
<br />
As already said, this is just ONE way to analyze MySQL systems. You can also check MYSQL.com for a consultant service or similar.<br />
<br />
$ wget http://mysqltuner.pl/mysqltuner.pl<br />
<br />
Make the PERL script executable:<br />
<br />
<pre><br />
$ chmod +x mysqltuner.pl<br />
</pre><br />
<br />
Execute the PERL script:<br />
<br />
<pre><br />
$ ./mysqltuner.pl<br />
</pre><br />
<br />
If prompted, enter your MySQL credentials and read carefully through the complete output of the script. Now you have very good informations, how to change your mysql system.<br />
<br />
<br />
<br />
[[Category: OX6]]</div>Sgablerhttps://oxpedia.org/wiki/index.php?title=Template:ContextUserAndLogs&diff=12586Template:ContextUserAndLogs2013-01-23T19:14:01Z<p>Sgabler: /* Default logging mechanism */</p>
<hr />
<div>= Creating contexts and users =<br />
<br />
Now as the whole setup is complete and you already should get a login screen when accessing the server with a webbrowser, we have to setup a context and a default user as the last step of this tutorial.<br />
<br />
The mapping ''defaultcontext'' will allow you to set this context as the default one of the entire system so that users which will be created within this context can login into Open-Xchange Server without specifying their domain at the login screen. Only one context can be specified as ''defaultcontext''. The ''oxadmin'' user that will be created by this command is the default admin of the created context. This account will gather additional functions that are also described in the administration manual. The ''context id'' parameter must to be unique and numeric, otherwise the server will complain when you try to create a context. New contexts must be created by the ''oxadminmaster'' user, user accounts inside a context are created with the credentials of the contexts ''oxadmin'' account. The ''access-combination-name'' property defines the set of available modules and functions for users of the context.<br />
<br />
$ /opt/open-xchange/sbin/createcontext -A oxadminmaster -P admin_master_password -c 1 \<br />
-u oxadmin -d "Context Admin" -g Admin -s User -p admin_password -L defaultcontext \<br />
-e oxadmin@example.com -q 1024 --access-combination-name=all<br />
<br />
Create a user for testing purposes (Make sure the password you use here for the user is the same password as your email account or you will not be able to use the email module until it is set right):<br />
<br />
$ /opt/open-xchange/sbin/createuser -c 1 -A oxadmin -P admin_password -u testuser \<br />
-d "Test User" -g Test -s User -p secret -e testuser@example.com \<br />
--imaplogin testuser --imapserver 127.0.0.1 --smtpserver 127.0.0.1<br />
<br />
Now connect to the server with a webbrowser and login using the credentials testuser / secret.<br />
<br />
<br />
If you need to migrate a batch of users and contexts at once, check the CSV Batch Import documentation [[Csv_import|page]].<br />
<br />
<br />
= Log files and issue tracking =<br />
== Default logging mechanism ==<br />
Whenever unexpected or erroneous behavior takes place, it will be logged depending on the configured loglevel. All logfiles are stored at the operating systems default location. Events triggered by the Open-Xchange Groupware services are logged to a rotating file ''open-xchange.log'', events triggered by the Open-Xchange Administration service are logged to ''open-xchange-admin.log''. Those files are the very first place to monitor.<br />
<br />
$ tail -f -n200 /var/log/open-xchange/open-xchange.log.0<br />
<br />
== Alternative logging mechanism using Syslog ==<br />
Apart from the default file logging mechanism, Open-Xchange supports logging via syslog in using Apache log4j which is a standard framework for application message and error logging. Using log4j makes it possible to directly log to a local or remote syslog daemon or other services. Log4j is highly customizable, please see the Apache log4j [http://logging.apache.org/log4j/] project websites for more information. Note, the default logging locations at /var/log/open-xchange will not be used anymore when installing the log4j bundles, please make sure to check out the [[Syslog_Configuration|configuration guide]].<br />
<br />
<br />
= Performance & Tuning Tips =<br />
Depending on your setup and the user accounts, it´s often helpful to know, how to get a better performance from the complete system. This section will try to assist you, how to tune the components within an OX setup, before you need to install a second server, add more RAM, add new CPU to existing servers. <br />
<br />
== MySQL ==<br />
Since OX itself used very specific features from MySQL like InnoDB instead of MyISAM as DB Engine, it´s often needed, how to increase performance of the OX databases. In general, you should always monitor your MySQL system via tools like "munin", to see when your system reaches it´s limits. Once, you recognized, the system responds more and more slowly, you start to read and research on the internet how to change your mysql configuration, specially, the my.cnf file. But due to the fact, that nearly every system is different in regards of hardware etc. you cannot just copy&paste existing configurations. At this point, a tool called "mysqltuner.pl" can help you. MySQLTuner is a script written in Perl that will assist you with your MySQL configuration and make recommendations for increased performance and stability. Within seconds, it will display statistics about your MySQL installation and the areas where it can be improved. To work with this tool, you need unrestricted read access to the MySQL server (OS root access is recommended). Just download and execute as shown below, and modify your existing my.cnf configuration file. <br />
<br />
IMPORTANT INFO: The MySQL system must run for several days, to gather statistics and informations about queries etc. from OX. After these days, you should execute mysqltuner.pl script. It does not work if you run it directly after installing an OX/MySQL setup. You can force traffic to OX while writing automatic testcases or jmeter plans. <br />
<br />
As already said, this is just ONE way to analyze MySQL systems. You can also check MYSQL.com for a consultant service or similar.<br />
<br />
$ wget http://mysqltuner.pl/mysqltuner.pl<br />
<br />
Make the PERL script executable:<br />
<br />
<pre><br />
$ chmod +x mysqltuner.pl<br />
</pre><br />
<br />
Execute the PERL script:<br />
<br />
<pre><br />
$ ./mysqltuner.pl<br />
</pre><br />
<br />
If prompted, enter your MySQL credentials and read carefully through the complete output of the script. Now you have very good informations, how to change your mysql system.</div>Sgablerhttps://oxpedia.org/wiki/index.php?title=OX6:Open-Xchange_Installation_Guide_for_CentOS_6_622&diff=12585OX6:Open-Xchange Installation Guide for CentOS 6 6222013-01-23T19:12:58Z<p>Sgabler: /* Log files and issue tracking */</p>
<hr />
<div>= Open-Xchange Server 6 (v6.22) on CentOS6 Linux =<br />
<br />
{{QuickInstIntro|release=6}}<br />
<br />
<br />
'''Important: This installation guide will only work for v6.22. If you want to install v6.20 please use the [http://oxpedia.org/wiki/index.php?title=Open-Xchange_Installation_Guide_for_CentOS_6 installation guide for earlier versions].'''<br />
<br />
= Requirements =<br />
<br />
* Plain installed CentOS6 with latest updates<br />
* A configured internet connection<br />
* httpd - Apache web server<br />
<br />
{{AddReposRHEL|rhelname=RHEL6|release=6.22}}<br />
<br />
= Updating repositories and installing packages =<br />
<br />
Reload the package index. This will download the package descriptions available at the software repositories:<br />
<br />
$ yum update<br />
<br />
The following command starts the download and installation process of all required package for Open-Xchange deployment:<br />
<br />
{{OXPackageInstallation|installer=yum|mysql=mysql-server|javavendor=sun|release=6.22}}<br />
<br />
<br />
{{OXConfiguration|mysqlstart=/etc/init.d/mysqld start}}<br />
<br />
{{oxinstaller}}<br />
<br />
After initializing the configuration, start the Open-Xchange service by executing:<br />
<br />
$ /etc/init.d/open-xchange start<br />
<br />
{{OXRegister}}<br />
<br />
<br />
= Configure services =<br />
Now as the Open-Xchange Server has been set up and the database is running, we have to configure the Apache webserver and the mod_proxy_ajp module to access the groupware frontend. To gain better GUI performance, the usage of ''mod_expires'' and ''mod_deflate'' is strongly recommended. Those modules will limit the amount of client requests and compress the delivered content. The default installation of the Apache webserver on CentOS provides a welcome screen which is not necessary for server operation, it can be removed by deleting the corresponding configuration file:<br />
<br />
$ rm /etc/httpd/conf.d/welcome.conf<br />
<br />
{{Template:ApacheOXConf|ajpconf=/etc/httpd/conf.d/proxy_ajp.conf|apacheconf= /etc/httpd/conf.d/ox.conf|docroot=/var/www/html|release=6.22|loadmodule=LoadModule proxy_ajp_module modules/mod_proxy_ajp.so}}<br />
<br />
After the configuration is done, restart the Apache webserver<br />
<br />
$ /etc/init.d/httpd restart<br />
<br />
= Adding services to runlevels =<br />
<br />
The new services are now installed and configured, but to make them start up on a server boot, they need to be added to some runlevels:<br />
<br />
$ chkconfig --level 345 mysqld on<br />
$ chkconfig --level 345 httpd on<br />
$ chkconfig --level 345 open-xchange on<br />
<br />
= Creating contexts and users =<br />
Now as the whole setup is complete and you already should get a login screen when accessing the server with a webbrowser, we have to setup a context and a default user as the last step of this tutorial.<br />
<br />
The mapping ''defaultcontext'' will allow you to set this context as the default one of the entire system so that users which will be created within this context can login into Open-Xchange Server without specifying their domain at the login screen. Only one context can be specified as ''defaultcontext''. The ''oxadmin'' user that will be created by this command is the default admin of the created context. This account will gather additional functions that are also described in the administration manual. The ''context id'' parameter must to be unique and numeric, otherwise the server will complain when you try to create a context. New contexts must be created by the ''oxadminmaster'' user, user accounts inside a context are created with the credentials of the contexts ''oxadmin'' account. The ''access-combination-name'' property defines the set of available modules and functions for users of the context.<br />
<br />
$ /opt/open-xchange/sbin/createcontext -A oxadminmaster -P admin_master_password -c 1 \<br />
-u oxadmin -d "Context Admin" -g Admin -s User -p secret -L defaultcontext \<br />
-e oxadmin@example.com -q 1024 --access-combination-name=all<br />
<br />
Create a user for testing purposes:<br />
<br />
$ /opt/open-xchange/sbin/createuser -c 1 -A oxadmin -P secret -u testuser \<br />
-d "Test User" -g Test -s User -p secret -e testuser@example.com \<br />
--imaplogin testuser --imapserver 127.0.0.1 --smtpserver 127.0.0.1<br />
<br />
Now connect to the server with a webbrowser and login using the credentials testuser / secret.<br />
<br />
<br />
= Log files and issue tracking =<br />
<br />
Whenever unexpected or erroneous behavior takes place, it will be logged depending on the configured loglevel. All logfiles are stored at the operating systems default location. Events triggered by the Open-Xchange Groupware services are logged to a rotating file ''open-xchange.log'', events triggered by the Open-Xchange Administration service are logged to ''open-xchange-admin.log''. Those files are the very first place to monitor.<br />
<br />
$ tail -f -n200 /var/log/open-xchange/open-xchange.log.0<br />
<br />
<br />
[[Category: OX6]]</div>Sgablerhttps://oxpedia.org/wiki/index.php?title=Caldav_carddav_Bundles&diff=11951Caldav carddav Bundles2012-11-09T16:39:53Z<p>Sgabler: /* com.openexchange.caldav.enabled */</p>
<hr />
<div>= Installation and Configuration of the CalDAV- and CardDAV-bundles =<br />
<br />
The Open-Xchange server can be accessed via it's CalDAV- and CardDAV-interfaces to allow the synchronization of Calendar- and Contact-data with external applications like the Mac OS X iCal and Address Book clients. The synchronization protocols are available and supported for all customers with a valid Open-Xchange license of Open-Xchange Server Edition and Open-Xchange Hosting Edition starting with Version 6.20.1 Rev5.<br />
<br />
CalDAV and CardDAV are standard protocols for the exchange of calendar data and address data respectively. The CalDAV interface publishes all the user's calendar folders via CalDAV so the user can subscribe to them in a client application. Similarly, the CardDAV interface publishes the user's contact folders. Depending on the used client, the user can either subscribe one or more folders, or access all available data in an aggregated way. <br />
<br />
== User Guide and Client Configuration ==<br />
Please find further information regarding the client configuration at [[CalDAVClients]] and [[CardDAVClients]].<br />
<br />
== Webserver Configuration ==<br />
In order to redirect DAV requests to the appropiate servlets, the webserver's configuration may need to be adjusted using one of the following alternatives.<br />
<br />
=== Alternative 1: Apache vhost (recommended) ===<br />
Please edit your file /etc/apache2/ox6.conf so that ''' the existing OX configuration as well as the CalDAV/CardDav configuration are placed inside their own virtual hosts sections.'''.<br />
<br />
This is an <b>example</b> where MYSERVER.TLD is the domain-name of the ox-server:<br />
<br />
$ vi /etc/apache2/ox6.conf <br />
<br />
NameVirtualHost *:80<br />
<VirtualHost *:80><br />
ServerName dav.MYSERVER.TLD<br />
ErrorLog /tmp/dav.err.log<br />
TransferLog /tmp/dav.access.log<br />
<Proxy /><br />
Order allow,deny<br />
Allow from all<br />
</Proxy><br />
ProxyPass / ajp://localhost:8009/servlet/dav/ smax=0 ttl=60 retry=5 # for ajp http service<br />
#ProxyPass / http://localhost:8080/servlet/dav/ smax=0 ttl=60 retry=5 # for grizzly http service<br />
</VirtualHost><br />
<br />
<VirtualHost *:80><br />
ServerName MYSERVER.TLD<br />
ServerAdmin webmaster@localhost<br />
DocumentRoot /var/www/<br />
<br />
<Directory /var/www/><br />
AllowOverride None<br />
Order allow,deny<br />
allow from all<br />
RedirectMatch ^/$ /ox6/<br />
Options +FollowSymLinks +SymLinksIfOwnerMatch<br />
</Directory><br />
# deflate<br />
AddOutputFilterByType DEFLATE text/html text/plain text/javascript application/javascript text/css text/xml application/xml text/x-js application/x-javascript<br />
<br />
# pre-compressed files<br />
AddType text/javascript .jsz<br />
AddType text/css .cssz<br />
AddType text/xml .xmlz<br />
AddType text/plain .po<br />
<br />
AddEncoding gzip .jsz .cssz .xmlz<br />
SetEnvIf Request_URI "\.(jsz|cssz|xmlz)$" no-gzip<br />
<br />
ExpiresActive On<br />
<br />
<Location /ox6><br />
# Expires (via ExpiresByType to override global settings)<br />
ExpiresByType image/gif "access plus 6 months"<br />
ExpiresByType image/png "access plus 6 months"<br />
ExpiresByType image/jpg "access plus 6 months"<br />
ExpiresByType image/jpeg "access plus 6 months"<br />
ExpiresByType text/css "access plus 6 months"<br />
ExpiresByType text/html "access plus 6 months"<br />
ExpiresByType text/xml "access plus 6 months"<br />
ExpiresByType text/javascript "access plus 6 months"<br />
ExpiresByType text/x-js "access plus 6 months"<br />
ExpiresByType application/x-javascript "access plus 6 months"<br />
ExpiresDefault "access plus 6 months"<br />
Header append Cache-Control "private"<br />
Header unset Last-Modified<br />
Header unset Vary<br />
# Strip version<br />
RewriteEngine On<br />
RewriteRule v=\w+/(.+) $1 [L]<br />
# Turn off ETag<br />
Header unset ETag<br />
FileETag None<br />
</Location><br />
<br />
<Location /ox6/ox.html><br />
ExpiresByType text/html "now"<br />
ExpiresDefault "now"<br />
Header unset Last-Modified<br />
Header set Cache-Control "no-store, no-cache, must-revalidate, post-check=0, pre-check=0"<br />
# Turn off ETag<br />
Header unset ETag<br />
FileETag None<br />
</Location><br />
<br />
<Location /ox6/index.html><br />
ExpiresByType text/html "now"<br />
ExpiresDefault "now"<br />
Header unset Last-Modified<br />
Header set Cache-Control "no-store, no-cache, must-revalidate, post-check=0, pre-check=0"<br />
# Turn off ETag<br />
Header unset ETag<br />
FileETag None<br />
</Location><br />
</VirtualHost><br />
<br />
If you use this method, you have to make sure that dav.MYSERVER.TLD is reachable, your dns configuration need an entry for this name. Take care of the the dav.* logfiles, the example writes them without logrotation to /tmp.<br />
<br />
=== Alternative 2: Apache useragent detection ===<br />
For environments where it is inconvenient to setup a vhost there is the possibility to redirect to relevant servlets another way: Via useragent detection. This is not recommended for the following reason: Per definition this is a whitelist-approach and any client sending a useragent-string not explicitly listed in the configuration will not be able to connect . Useragent-strings may also change between different versions of an application or may even be actively changed into something non-standard.<br />
<br />
$ vi /etc/apache2/ox6.conf<br />
<br />
RewriteEngine On<br />
RewriteCond %{HTTP_USER_AGENT} Calendar [OR]<br />
RewriteCond %{HTTP_USER_AGENT} DataAccess [OR]<br />
RewriteCond %{HTTP_USER_AGENT} DAVKit [OR]<br />
RewriteCond %{HTTP_USER_AGENT} Lightning [OR]<br />
RewriteCond %{HTTP_USER_AGENT} Adresboek [OR]<br />
RewriteCond %{HTTP_USER_AGENT} dataaccessd [OR]<br />
RewriteCond %{HTTP_USER_AGENT} Preferences [OR]<br />
RewriteCond %{HTTP_USER_AGENT} Adressbuch [OR]<br />
RewriteCond %{HTTP_USER_AGENT} AddressBook [OR]<br />
RewriteCond %{HTTP_USER_AGENT} Address%20Book [OR]<br />
RewriteCond %{HTTP_USER_AGENT} CalendarStore [OR]<br />
RewriteCond %{HTTP_USER_AGENT} CoreDAV<br />
RewriteRule (.*) ajp://localhost:8009/servlet/dav$1 [P] # for ajp http service<br />
#RewriteRule (.*) http://localhost:8080/servlet/dav$1 [P] # for grizzly http service<br />
<br />
'''Note:''' The address book app on OSX 10.6 uses a localized user-agent string. If you're expecting clients with non-english language settings, you need to add the translated user-agent string to these rewrite rules. For example: "Adressbuch" for german OSX clients.<br />
<br />
<br />
== Which packages do I need? ==<br />
To get CalDAV and CardDAV up and running you need the following packages:<br />
<br />
In v6.20 and earlier:<br />
* open-xchange-webdav-directory - Assembles the *DAV interfaces into a common tree. This is needed for publishing certain properties so clients accept the OX is a WebDAV Server.<br />
* open-xchange-webdav-acl - The WebDAV equivalent of the /ajax/user interface. Allows clients to discover the current and other users and their addressbooks and calendars.<br />
* open-xchange-carddav - The CardDAV interface exposing the users addressbook via carddav<br />
* open-xchange-caldav - The CalDAV inteface exposing the users calendars via caldav<br />
<br />
<br />
With v6.22 we have significantly reduced the number of packages necessary to install Open-Xchange Server.<br />
In v6.22 and later only one package is needed:<br />
* open-xchange-dav <br />
<br />
<br />
<br />
{{InstallPlugin|pluginname=open-xchange-caldav open-xchange-carddav open-xchange-webdav-acl open-xchange-webdav-directory |sopath=updates}}<br />
<br />
== Installation on Open-Xchange v6.22 == <br />
<br />
=== Debian GNU/Linux 6.0 === <br />
<br />
Add the following entry to /etc/apt/sources.list if not already present:<br />
<br />
deb http://software.open-xchange.com/OX6/6.22/6.22.0/backend/DebianSqueeze/all/<br />
<br />
and run<br />
<br />
$ apt-get update<br />
$ apt-get install open-xchange-dav<br />
<br />
=== SUSE Linux Enterprise Server 11 ===<br />
<br />
Add the package repository using zypper if not already present:<br />
<br />
$ zypper ar http://software.open-xchange.com/OX6/6.22/6.22.0/backend/SLES11 ox<br />
<br />
and run<br />
<br />
$ zypper ref<br />
$ zypper in open-xchange-dav<br />
<br />
=== RedHat Enterprise Linux 6 ===<br />
<br />
Start a console and create a software repository file if not already present:<br />
<br />
$ vim /etc/yum.repos.d/ox.repo<br />
<br />
[ox]<br />
name=Open-Xchange<br />
baseurl=http://software.open-xchange.com/OX6/6.22/6.22.0/backend/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
and run<br />
<br />
$ yum update<br />
$ yum install open-xchange-dav<br />
<br />
=== RedHat Enterprise Linux 5 ===<br />
<br />
Start a console and create a software repository file if not already present:<br />
<br />
$ vim /etc/yum.repos.d/ox.repo<br />
<br />
[ox]<br />
name=Open-Xchange<br />
baseurl=http://software.open-xchange.com/OX6/6.22/6.22.0/backend/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
and run<br />
<br />
$ yum update<br />
$ yum install open-xchange-dav<br />
<br />
=== CentOS 5 ===<br />
<br />
Start a console and create a software repository file if not already present:<br />
<br />
$ vim /etc/yum.repos.d/ox.repo<br />
<br />
[ox]<br />
name=Open-Xchange<br />
baseurl=http://software.open-xchange.com/OX6/6.22/6.22.0/backend/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
and run<br />
<br />
$ yum update<br />
$ yum install open-xchange-dav<br />
<br />
=== CentOS 6 ===<br />
<br />
Start a console and create a software repository file if not already present:<br />
<br />
$ vim /etc/yum.repos.d/ox.repo<br />
<br />
[ox]<br />
name=Open-Xchange<br />
baseurl=http://software.open-xchange.com/OX6/6.22/6.22.0/backend/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
and run<br />
<br />
$ yum update<br />
$ yum install open-xchange-dav<br />
<br />
== CalDAV Configuration ==<br />
<br />
The following configuration options are available in the configuration files caldav.properties and caldav.yml:<br />
<br />
===com.openexchange.caldav.enabled===<br />
The property '''com.openexchange.caldav.enabled''' governs whether a user has access to the CalDAV interface. This can be configured along the config cascade, in the default setting, everyone that has access to the infostore also has access to caldav. This is achieved in the following way:<br />
<br />
In v6.20 and earlier:<br />
<br />
/opt/open-xchange/etc/groupware/caldav.properties:<br />
com.openexchange.caldav.enabled=false<br />
<br />
/opt/open-xchange/etc/groupware/contextSets/caldav.yml<br />
premium:<br />
com.openexchange.caldav.enabled: true<br />
withTags: ucInfostore<br />
<br />
With v6.22 and up:<br />
<br />
/opt/open-xchange/etc/caldav.properties:<br />
com.openexchange.caldav.enabled=false<br />
<br />
/opt/open-xchange/etc/contextSets/caldav.yml<br />
premium:<br />
com.openexchange.caldav.enabled: true<br />
withTags: ucInfostore<br />
<br />
<br />
This means: In general CalDAV is turned off, but using the contextSets feature of the config cascade it is turned on for everyone that has infostore access.<br />
<br />
===com.openexchange.caldav.tree===<br />
Configures the ID of the folder tree used by the CalDAV interface. Currently, this should be set to the default value of '0'.<br />
<br />
===com.openexchange.caldav.interval.start===<br />
Defines the minimum end time of appointments to be synchronized via the CalDAV interface, relative to the current date. Possible values are "one_month" (default), "one_year" and "six_months". <br />
<br />
===com.openexchange.caldav.interval.end===<br />
Defines the maximum start time of appointments to be synchronized via the CalDAV interface, relative to the current date. Possible values are "one_year" (default) and "two_years". <br />
<br />
===com.openexchange.caldav.url===<br />
Tells users where to find a caldav folder. This can be displayed in frontends. You can use the variables [hostname] and [folderId]. If you chose to deploy caldav as a virtual host (say 'dav.open-xchange.com') use https://dav.open-xchange.com/caldav/[folderId] as the value. If you are using user-agent sniffing use https://[hostname]/caldav/[folderId].<br />
<br />
<br />
== CardDAV Configuration ==<br />
<br />
The following configuration options are available in the configuration files carddav.properties and carddav.yml:<br />
<br />
===com.openexchange.carddav.enabled===<br />
Similarly to CalDAV, the property '''com.openexchange.carddav.enabled''' governs whether CardDAV is available for a certain user. This is configured exactly like CalDAV with the config cascade only enabling this for users that have access to the infostore:<br />
<br />
/opt/open-xchange/etc/groupware/carddav.properties:<br />
com.openexchange.carddav.enabled=false<br />
<br />
/opt/open-xchange/etc/groupware/contextSets/carddav.yml<br />
premium:<br />
com.openexchange.carddav.enabled: true<br />
withTags: ucInfostore<br />
<br />
===com.openexchange.carddav.ignoreFolders===<br />
A comma-separated list of folder IDs to exclude from the synchronization. Use this to disable syncing of very large folders (e.g. the global address list in large contexts, which always has ID 6). By default, no folders are excluded.<br />
<br />
===com.openexchange.carddav.tree===<br />
Configures the ID of the folder tree used by the CardDAV interface. Currently, this should be set to the default value of '0'.<br />
<br />
===com.openexchange.carddav.exposedCollections===<br />
Controls which collections are exposed via the CardDAV interface. Possible values are '0', '1' and '2'. A value of '1' makes each visible folder available as a resource collection, while '2' only exposes an aggregated collection containing all contact resources from all visible folders. The default value '0' exposes either an aggregated collection or individual collections for each folder, depending on the client's user-agent that is matched against the pattern in 'userAgentForAggregatedCollection'. <br />
<br />
===com.openexchange.carddav.userAgentForAggregatedCollection===<br />
Regular expression to match against the client's user-agent to decide whether the aggregated collection is exposed or not. The default pattern matches all known varieties of the Mac OS Addressbook client, that doesn't support multiple collections. Only used if 'exposedCollections' is set to '0'. The pattern is used case insensitive. <br />
<br />
===com.openexchange.carddav.reducedAggregatedCollection===<br />
Specifies if all visible folders are used to create the aggregated collection, or if a reduced set of folders only containing the global addressbook and the personal contacts folders should be used. This setting only influences the aggregated collection that is used for clients that don't support multiple collections. Possible values are 'true' and 'false.</div>Sgablerhttps://oxpedia.org/wiki/index.php?title=Caldav_carddav_Bundles&diff=11950Caldav carddav Bundles2012-11-09T16:36:35Z<p>Sgabler: /* Which packages do I need? */</p>
<hr />
<div>= Installation and Configuration of the CalDAV- and CardDAV-bundles =<br />
<br />
The Open-Xchange server can be accessed via it's CalDAV- and CardDAV-interfaces to allow the synchronization of Calendar- and Contact-data with external applications like the Mac OS X iCal and Address Book clients. The synchronization protocols are available and supported for all customers with a valid Open-Xchange license of Open-Xchange Server Edition and Open-Xchange Hosting Edition starting with Version 6.20.1 Rev5.<br />
<br />
CalDAV and CardDAV are standard protocols for the exchange of calendar data and address data respectively. The CalDAV interface publishes all the user's calendar folders via CalDAV so the user can subscribe to them in a client application. Similarly, the CardDAV interface publishes the user's contact folders. Depending on the used client, the user can either subscribe one or more folders, or access all available data in an aggregated way. <br />
<br />
== User Guide and Client Configuration ==<br />
Please find further information regarding the client configuration at [[CalDAVClients]] and [[CardDAVClients]].<br />
<br />
== Webserver Configuration ==<br />
In order to redirect DAV requests to the appropiate servlets, the webserver's configuration may need to be adjusted using one of the following alternatives.<br />
<br />
=== Alternative 1: Apache vhost (recommended) ===<br />
Please edit your file /etc/apache2/ox6.conf so that ''' the existing OX configuration as well as the CalDAV/CardDav configuration are placed inside their own virtual hosts sections.'''.<br />
<br />
This is an <b>example</b> where MYSERVER.TLD is the domain-name of the ox-server:<br />
<br />
$ vi /etc/apache2/ox6.conf <br />
<br />
NameVirtualHost *:80<br />
<VirtualHost *:80><br />
ServerName dav.MYSERVER.TLD<br />
ErrorLog /tmp/dav.err.log<br />
TransferLog /tmp/dav.access.log<br />
<Proxy /><br />
Order allow,deny<br />
Allow from all<br />
</Proxy><br />
ProxyPass / ajp://localhost:8009/servlet/dav/ smax=0 ttl=60 retry=5 # for ajp http service<br />
#ProxyPass / http://localhost:8080/servlet/dav/ smax=0 ttl=60 retry=5 # for grizzly http service<br />
</VirtualHost><br />
<br />
<VirtualHost *:80><br />
ServerName MYSERVER.TLD<br />
ServerAdmin webmaster@localhost<br />
DocumentRoot /var/www/<br />
<br />
<Directory /var/www/><br />
AllowOverride None<br />
Order allow,deny<br />
allow from all<br />
RedirectMatch ^/$ /ox6/<br />
Options +FollowSymLinks +SymLinksIfOwnerMatch<br />
</Directory><br />
# deflate<br />
AddOutputFilterByType DEFLATE text/html text/plain text/javascript application/javascript text/css text/xml application/xml text/x-js application/x-javascript<br />
<br />
# pre-compressed files<br />
AddType text/javascript .jsz<br />
AddType text/css .cssz<br />
AddType text/xml .xmlz<br />
AddType text/plain .po<br />
<br />
AddEncoding gzip .jsz .cssz .xmlz<br />
SetEnvIf Request_URI "\.(jsz|cssz|xmlz)$" no-gzip<br />
<br />
ExpiresActive On<br />
<br />
<Location /ox6><br />
# Expires (via ExpiresByType to override global settings)<br />
ExpiresByType image/gif "access plus 6 months"<br />
ExpiresByType image/png "access plus 6 months"<br />
ExpiresByType image/jpg "access plus 6 months"<br />
ExpiresByType image/jpeg "access plus 6 months"<br />
ExpiresByType text/css "access plus 6 months"<br />
ExpiresByType text/html "access plus 6 months"<br />
ExpiresByType text/xml "access plus 6 months"<br />
ExpiresByType text/javascript "access plus 6 months"<br />
ExpiresByType text/x-js "access plus 6 months"<br />
ExpiresByType application/x-javascript "access plus 6 months"<br />
ExpiresDefault "access plus 6 months"<br />
Header append Cache-Control "private"<br />
Header unset Last-Modified<br />
Header unset Vary<br />
# Strip version<br />
RewriteEngine On<br />
RewriteRule v=\w+/(.+) $1 [L]<br />
# Turn off ETag<br />
Header unset ETag<br />
FileETag None<br />
</Location><br />
<br />
<Location /ox6/ox.html><br />
ExpiresByType text/html "now"<br />
ExpiresDefault "now"<br />
Header unset Last-Modified<br />
Header set Cache-Control "no-store, no-cache, must-revalidate, post-check=0, pre-check=0"<br />
# Turn off ETag<br />
Header unset ETag<br />
FileETag None<br />
</Location><br />
<br />
<Location /ox6/index.html><br />
ExpiresByType text/html "now"<br />
ExpiresDefault "now"<br />
Header unset Last-Modified<br />
Header set Cache-Control "no-store, no-cache, must-revalidate, post-check=0, pre-check=0"<br />
# Turn off ETag<br />
Header unset ETag<br />
FileETag None<br />
</Location><br />
</VirtualHost><br />
<br />
If you use this method, you have to make sure that dav.MYSERVER.TLD is reachable, your dns configuration need an entry for this name. Take care of the the dav.* logfiles, the example writes them without logrotation to /tmp.<br />
<br />
=== Alternative 2: Apache useragent detection ===<br />
For environments where it is inconvenient to setup a vhost there is the possibility to redirect to relevant servlets another way: Via useragent detection. This is not recommended for the following reason: Per definition this is a whitelist-approach and any client sending a useragent-string not explicitly listed in the configuration will not be able to connect . Useragent-strings may also change between different versions of an application or may even be actively changed into something non-standard.<br />
<br />
$ vi /etc/apache2/ox6.conf<br />
<br />
RewriteEngine On<br />
RewriteCond %{HTTP_USER_AGENT} Calendar [OR]<br />
RewriteCond %{HTTP_USER_AGENT} DataAccess [OR]<br />
RewriteCond %{HTTP_USER_AGENT} DAVKit [OR]<br />
RewriteCond %{HTTP_USER_AGENT} Lightning [OR]<br />
RewriteCond %{HTTP_USER_AGENT} Adresboek [OR]<br />
RewriteCond %{HTTP_USER_AGENT} dataaccessd [OR]<br />
RewriteCond %{HTTP_USER_AGENT} Preferences [OR]<br />
RewriteCond %{HTTP_USER_AGENT} Adressbuch [OR]<br />
RewriteCond %{HTTP_USER_AGENT} AddressBook [OR]<br />
RewriteCond %{HTTP_USER_AGENT} Address%20Book [OR]<br />
RewriteCond %{HTTP_USER_AGENT} CalendarStore [OR]<br />
RewriteCond %{HTTP_USER_AGENT} CoreDAV<br />
RewriteRule (.*) ajp://localhost:8009/servlet/dav$1 [P] # for ajp http service<br />
#RewriteRule (.*) http://localhost:8080/servlet/dav$1 [P] # for grizzly http service<br />
<br />
'''Note:''' The address book app on OSX 10.6 uses a localized user-agent string. If you're expecting clients with non-english language settings, you need to add the translated user-agent string to these rewrite rules. For example: "Adressbuch" for german OSX clients.<br />
<br />
<br />
== Which packages do I need? ==<br />
To get CalDAV and CardDAV up and running you need the following packages:<br />
<br />
In v6.20 and earlier:<br />
* open-xchange-webdav-directory - Assembles the *DAV interfaces into a common tree. This is needed for publishing certain properties so clients accept the OX is a WebDAV Server.<br />
* open-xchange-webdav-acl - The WebDAV equivalent of the /ajax/user interface. Allows clients to discover the current and other users and their addressbooks and calendars.<br />
* open-xchange-carddav - The CardDAV interface exposing the users addressbook via carddav<br />
* open-xchange-caldav - The CalDAV inteface exposing the users calendars via caldav<br />
<br />
<br />
With v6.22 we have significantly reduced the number of packages necessary to install Open-Xchange Server.<br />
In v6.22 and later only one package is needed:<br />
* open-xchange-dav <br />
<br />
<br />
<br />
{{InstallPlugin|pluginname=open-xchange-caldav open-xchange-carddav open-xchange-webdav-acl open-xchange-webdav-directory |sopath=updates}}<br />
<br />
== Installation on Open-Xchange v6.22 == <br />
<br />
=== Debian GNU/Linux 6.0 === <br />
<br />
Add the following entry to /etc/apt/sources.list if not already present:<br />
<br />
deb http://software.open-xchange.com/OX6/6.22/6.22.0/backend/DebianSqueeze/all/<br />
<br />
and run<br />
<br />
$ apt-get update<br />
$ apt-get install open-xchange-dav<br />
<br />
=== SUSE Linux Enterprise Server 11 ===<br />
<br />
Add the package repository using zypper if not already present:<br />
<br />
$ zypper ar http://software.open-xchange.com/OX6/6.22/6.22.0/backend/SLES11 ox<br />
<br />
and run<br />
<br />
$ zypper ref<br />
$ zypper in open-xchange-dav<br />
<br />
=== RedHat Enterprise Linux 6 ===<br />
<br />
Start a console and create a software repository file if not already present:<br />
<br />
$ vim /etc/yum.repos.d/ox.repo<br />
<br />
[ox]<br />
name=Open-Xchange<br />
baseurl=http://software.open-xchange.com/OX6/6.22/6.22.0/backend/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
and run<br />
<br />
$ yum update<br />
$ yum install open-xchange-dav<br />
<br />
=== RedHat Enterprise Linux 5 ===<br />
<br />
Start a console and create a software repository file if not already present:<br />
<br />
$ vim /etc/yum.repos.d/ox.repo<br />
<br />
[ox]<br />
name=Open-Xchange<br />
baseurl=http://software.open-xchange.com/OX6/6.22/6.22.0/backend/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
and run<br />
<br />
$ yum update<br />
$ yum install open-xchange-dav<br />
<br />
=== CentOS 5 ===<br />
<br />
Start a console and create a software repository file if not already present:<br />
<br />
$ vim /etc/yum.repos.d/ox.repo<br />
<br />
[ox]<br />
name=Open-Xchange<br />
baseurl=http://software.open-xchange.com/OX6/6.22/6.22.0/backend/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
and run<br />
<br />
$ yum update<br />
$ yum install open-xchange-dav<br />
<br />
=== CentOS 6 ===<br />
<br />
Start a console and create a software repository file if not already present:<br />
<br />
$ vim /etc/yum.repos.d/ox.repo<br />
<br />
[ox]<br />
name=Open-Xchange<br />
baseurl=http://software.open-xchange.com/OX6/6.22/6.22.0/backend/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
and run<br />
<br />
$ yum update<br />
$ yum install open-xchange-dav<br />
<br />
== CalDAV Configuration ==<br />
<br />
The following configuration options are available in the configuration files caldav.properties and caldav.yml:<br />
<br />
===com.openexchange.caldav.enabled===<br />
The property '''com.openexchange.caldav.enabled''' governs whether a user has access to the CalDAV interface. This can be configured along the config cascade, in the default setting, everyone that has access to the infostore also has access to caldav. This is achieved in the following way:<br />
<br />
/opt/open-xchange/etc/groupware/caldav.properties:<br />
com.openexchange.caldav.enabled=false<br />
<br />
/opt/open-xchange/etc/groupware/contextSets/caldav.yml<br />
premium:<br />
com.openexchange.caldav.enabled: true<br />
withTags: ucInfostore<br />
<br />
This means: In general CalDAV is turned off, but using the contextSets feature of the config cascade it is turned on for everyone that has infostore access.<br />
<br />
===com.openexchange.caldav.tree===<br />
Configures the ID of the folder tree used by the CalDAV interface. Currently, this should be set to the default value of '0'.<br />
<br />
===com.openexchange.caldav.interval.start===<br />
Defines the minimum end time of appointments to be synchronized via the CalDAV interface, relative to the current date. Possible values are "one_month" (default), "one_year" and "six_months". <br />
<br />
===com.openexchange.caldav.interval.end===<br />
Defines the maximum start time of appointments to be synchronized via the CalDAV interface, relative to the current date. Possible values are "one_year" (default) and "two_years". <br />
<br />
===com.openexchange.caldav.url===<br />
Tells users where to find a caldav folder. This can be displayed in frontends. You can use the variables [hostname] and [folderId]. If you chose to deploy caldav as a virtual host (say 'dav.open-xchange.com') use https://dav.open-xchange.com/caldav/[folderId] as the value. If you are using user-agent sniffing use https://[hostname]/caldav/[folderId].<br />
<br />
<br />
== CardDAV Configuration ==<br />
<br />
The following configuration options are available in the configuration files carddav.properties and carddav.yml:<br />
<br />
===com.openexchange.carddav.enabled===<br />
Similarly to CalDAV, the property '''com.openexchange.carddav.enabled''' governs whether CardDAV is available for a certain user. This is configured exactly like CalDAV with the config cascade only enabling this for users that have access to the infostore:<br />
<br />
/opt/open-xchange/etc/groupware/carddav.properties:<br />
com.openexchange.carddav.enabled=false<br />
<br />
/opt/open-xchange/etc/groupware/contextSets/carddav.yml<br />
premium:<br />
com.openexchange.carddav.enabled: true<br />
withTags: ucInfostore<br />
<br />
===com.openexchange.carddav.ignoreFolders===<br />
A comma-separated list of folder IDs to exclude from the synchronization. Use this to disable syncing of very large folders (e.g. the global address list in large contexts, which always has ID 6). By default, no folders are excluded.<br />
<br />
===com.openexchange.carddav.tree===<br />
Configures the ID of the folder tree used by the CardDAV interface. Currently, this should be set to the default value of '0'.<br />
<br />
===com.openexchange.carddav.exposedCollections===<br />
Controls which collections are exposed via the CardDAV interface. Possible values are '0', '1' and '2'. A value of '1' makes each visible folder available as a resource collection, while '2' only exposes an aggregated collection containing all contact resources from all visible folders. The default value '0' exposes either an aggregated collection or individual collections for each folder, depending on the client's user-agent that is matched against the pattern in 'userAgentForAggregatedCollection'. <br />
<br />
===com.openexchange.carddav.userAgentForAggregatedCollection===<br />
Regular expression to match against the client's user-agent to decide whether the aggregated collection is exposed or not. The default pattern matches all known varieties of the Mac OS Addressbook client, that doesn't support multiple collections. Only used if 'exposedCollections' is set to '0'. The pattern is used case insensitive. <br />
<br />
===com.openexchange.carddav.reducedAggregatedCollection===<br />
Specifies if all visible folders are used to create the aggregated collection, or if a reduced set of folders only containing the global addressbook and the personal contacts folders should be used. This setting only influences the aggregated collection that is used for clients that don't support multiple collections. Possible values are 'true' and 'false.</div>Sgablerhttps://oxpedia.org/wiki/index.php?title=Caldav_carddav_Bundles&diff=11949Caldav carddav Bundles2012-11-09T16:35:32Z<p>Sgabler: /* CentOS 6 */</p>
<hr />
<div>= Installation and Configuration of the CalDAV- and CardDAV-bundles =<br />
<br />
The Open-Xchange server can be accessed via it's CalDAV- and CardDAV-interfaces to allow the synchronization of Calendar- and Contact-data with external applications like the Mac OS X iCal and Address Book clients. The synchronization protocols are available and supported for all customers with a valid Open-Xchange license of Open-Xchange Server Edition and Open-Xchange Hosting Edition starting with Version 6.20.1 Rev5.<br />
<br />
CalDAV and CardDAV are standard protocols for the exchange of calendar data and address data respectively. The CalDAV interface publishes all the user's calendar folders via CalDAV so the user can subscribe to them in a client application. Similarly, the CardDAV interface publishes the user's contact folders. Depending on the used client, the user can either subscribe one or more folders, or access all available data in an aggregated way. <br />
<br />
== User Guide and Client Configuration ==<br />
Please find further information regarding the client configuration at [[CalDAVClients]] and [[CardDAVClients]].<br />
<br />
== Webserver Configuration ==<br />
In order to redirect DAV requests to the appropiate servlets, the webserver's configuration may need to be adjusted using one of the following alternatives.<br />
<br />
=== Alternative 1: Apache vhost (recommended) ===<br />
Please edit your file /etc/apache2/ox6.conf so that ''' the existing OX configuration as well as the CalDAV/CardDav configuration are placed inside their own virtual hosts sections.'''.<br />
<br />
This is an <b>example</b> where MYSERVER.TLD is the domain-name of the ox-server:<br />
<br />
$ vi /etc/apache2/ox6.conf <br />
<br />
NameVirtualHost *:80<br />
<VirtualHost *:80><br />
ServerName dav.MYSERVER.TLD<br />
ErrorLog /tmp/dav.err.log<br />
TransferLog /tmp/dav.access.log<br />
<Proxy /><br />
Order allow,deny<br />
Allow from all<br />
</Proxy><br />
ProxyPass / ajp://localhost:8009/servlet/dav/ smax=0 ttl=60 retry=5 # for ajp http service<br />
#ProxyPass / http://localhost:8080/servlet/dav/ smax=0 ttl=60 retry=5 # for grizzly http service<br />
</VirtualHost><br />
<br />
<VirtualHost *:80><br />
ServerName MYSERVER.TLD<br />
ServerAdmin webmaster@localhost<br />
DocumentRoot /var/www/<br />
<br />
<Directory /var/www/><br />
AllowOverride None<br />
Order allow,deny<br />
allow from all<br />
RedirectMatch ^/$ /ox6/<br />
Options +FollowSymLinks +SymLinksIfOwnerMatch<br />
</Directory><br />
# deflate<br />
AddOutputFilterByType DEFLATE text/html text/plain text/javascript application/javascript text/css text/xml application/xml text/x-js application/x-javascript<br />
<br />
# pre-compressed files<br />
AddType text/javascript .jsz<br />
AddType text/css .cssz<br />
AddType text/xml .xmlz<br />
AddType text/plain .po<br />
<br />
AddEncoding gzip .jsz .cssz .xmlz<br />
SetEnvIf Request_URI "\.(jsz|cssz|xmlz)$" no-gzip<br />
<br />
ExpiresActive On<br />
<br />
<Location /ox6><br />
# Expires (via ExpiresByType to override global settings)<br />
ExpiresByType image/gif "access plus 6 months"<br />
ExpiresByType image/png "access plus 6 months"<br />
ExpiresByType image/jpg "access plus 6 months"<br />
ExpiresByType image/jpeg "access plus 6 months"<br />
ExpiresByType text/css "access plus 6 months"<br />
ExpiresByType text/html "access plus 6 months"<br />
ExpiresByType text/xml "access plus 6 months"<br />
ExpiresByType text/javascript "access plus 6 months"<br />
ExpiresByType text/x-js "access plus 6 months"<br />
ExpiresByType application/x-javascript "access plus 6 months"<br />
ExpiresDefault "access plus 6 months"<br />
Header append Cache-Control "private"<br />
Header unset Last-Modified<br />
Header unset Vary<br />
# Strip version<br />
RewriteEngine On<br />
RewriteRule v=\w+/(.+) $1 [L]<br />
# Turn off ETag<br />
Header unset ETag<br />
FileETag None<br />
</Location><br />
<br />
<Location /ox6/ox.html><br />
ExpiresByType text/html "now"<br />
ExpiresDefault "now"<br />
Header unset Last-Modified<br />
Header set Cache-Control "no-store, no-cache, must-revalidate, post-check=0, pre-check=0"<br />
# Turn off ETag<br />
Header unset ETag<br />
FileETag None<br />
</Location><br />
<br />
<Location /ox6/index.html><br />
ExpiresByType text/html "now"<br />
ExpiresDefault "now"<br />
Header unset Last-Modified<br />
Header set Cache-Control "no-store, no-cache, must-revalidate, post-check=0, pre-check=0"<br />
# Turn off ETag<br />
Header unset ETag<br />
FileETag None<br />
</Location><br />
</VirtualHost><br />
<br />
If you use this method, you have to make sure that dav.MYSERVER.TLD is reachable, your dns configuration need an entry for this name. Take care of the the dav.* logfiles, the example writes them without logrotation to /tmp.<br />
<br />
=== Alternative 2: Apache useragent detection ===<br />
For environments where it is inconvenient to setup a vhost there is the possibility to redirect to relevant servlets another way: Via useragent detection. This is not recommended for the following reason: Per definition this is a whitelist-approach and any client sending a useragent-string not explicitly listed in the configuration will not be able to connect . Useragent-strings may also change between different versions of an application or may even be actively changed into something non-standard.<br />
<br />
$ vi /etc/apache2/ox6.conf<br />
<br />
RewriteEngine On<br />
RewriteCond %{HTTP_USER_AGENT} Calendar [OR]<br />
RewriteCond %{HTTP_USER_AGENT} DataAccess [OR]<br />
RewriteCond %{HTTP_USER_AGENT} DAVKit [OR]<br />
RewriteCond %{HTTP_USER_AGENT} Lightning [OR]<br />
RewriteCond %{HTTP_USER_AGENT} Adresboek [OR]<br />
RewriteCond %{HTTP_USER_AGENT} dataaccessd [OR]<br />
RewriteCond %{HTTP_USER_AGENT} Preferences [OR]<br />
RewriteCond %{HTTP_USER_AGENT} Adressbuch [OR]<br />
RewriteCond %{HTTP_USER_AGENT} AddressBook [OR]<br />
RewriteCond %{HTTP_USER_AGENT} Address%20Book [OR]<br />
RewriteCond %{HTTP_USER_AGENT} CalendarStore [OR]<br />
RewriteCond %{HTTP_USER_AGENT} CoreDAV<br />
RewriteRule (.*) ajp://localhost:8009/servlet/dav$1 [P] # for ajp http service<br />
#RewriteRule (.*) http://localhost:8080/servlet/dav$1 [P] # for grizzly http service<br />
<br />
'''Note:''' The address book app on OSX 10.6 uses a localized user-agent string. If you're expecting clients with non-english language settings, you need to add the translated user-agent string to these rewrite rules. For example: "Adressbuch" for german OSX clients.<br />
<br />
<br />
== Which packages do I need? ==<br />
To get CalDAV and CardDAV up and running you need the following packages:<br />
<br />
In v6.20 and earlier:<br />
* open-xchange-webdav-directory - Assembles the *DAV interfaces into a common tree. This is needed for publishing certain properties so clients accept the OX is a WebDAV Server.<br />
* open-xchange-webdav-acl - The WebDAV equivalent of the /ajax/user interface. Allows clients to discover the current and other users and their addressbooks and calendars.<br />
* open-xchange-carddav - The CardDAV interface exposing the users addressbook via carddav<br />
* open-xchange-caldav - The CalDAV inteface exposing the users calendars via caldav<br />
<br />
<br />
With v6.22 we have significantly reduced the number of packages necessary to install Open-Xchange Server.<br />
In v6.22 and later only one package is needed:<br />
* open-xchange-dav <br />
<br />
{{InstallPlugin|pluginname=open-xchange-caldav open-xchange-carddav open-xchange-webdav-acl open-xchange-webdav-directory |sopath=updates}}<br />
<br />
== Installation on Open-Xchange v6.22 == <br />
<br />
=== Debian GNU/Linux 6.0 === <br />
<br />
Add the following entry to /etc/apt/sources.list if not already present:<br />
<br />
deb http://software.open-xchange.com/OX6/6.22/6.22.0/backend/DebianSqueeze/all/<br />
<br />
and run<br />
<br />
$ apt-get update<br />
$ apt-get install open-xchange-dav<br />
<br />
=== SUSE Linux Enterprise Server 11 ===<br />
<br />
Add the package repository using zypper if not already present:<br />
<br />
$ zypper ar http://software.open-xchange.com/OX6/6.22/6.22.0/backend/SLES11 ox<br />
<br />
and run<br />
<br />
$ zypper ref<br />
$ zypper in open-xchange-dav<br />
<br />
=== RedHat Enterprise Linux 6 ===<br />
<br />
Start a console and create a software repository file if not already present:<br />
<br />
$ vim /etc/yum.repos.d/ox.repo<br />
<br />
[ox]<br />
name=Open-Xchange<br />
baseurl=http://software.open-xchange.com/OX6/6.22/6.22.0/backend/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
and run<br />
<br />
$ yum update<br />
$ yum install open-xchange-dav<br />
<br />
=== RedHat Enterprise Linux 5 ===<br />
<br />
Start a console and create a software repository file if not already present:<br />
<br />
$ vim /etc/yum.repos.d/ox.repo<br />
<br />
[ox]<br />
name=Open-Xchange<br />
baseurl=http://software.open-xchange.com/OX6/6.22/6.22.0/backend/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
and run<br />
<br />
$ yum update<br />
$ yum install open-xchange-dav<br />
<br />
=== CentOS 5 ===<br />
<br />
Start a console and create a software repository file if not already present:<br />
<br />
$ vim /etc/yum.repos.d/ox.repo<br />
<br />
[ox]<br />
name=Open-Xchange<br />
baseurl=http://software.open-xchange.com/OX6/6.22/6.22.0/backend/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
and run<br />
<br />
$ yum update<br />
$ yum install open-xchange-dav<br />
<br />
=== CentOS 6 ===<br />
<br />
Start a console and create a software repository file if not already present:<br />
<br />
$ vim /etc/yum.repos.d/ox.repo<br />
<br />
[ox]<br />
name=Open-Xchange<br />
baseurl=http://software.open-xchange.com/OX6/6.22/6.22.0/backend/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
and run<br />
<br />
$ yum update<br />
$ yum install open-xchange-dav<br />
<br />
== CalDAV Configuration ==<br />
<br />
The following configuration options are available in the configuration files caldav.properties and caldav.yml:<br />
<br />
===com.openexchange.caldav.enabled===<br />
The property '''com.openexchange.caldav.enabled''' governs whether a user has access to the CalDAV interface. This can be configured along the config cascade, in the default setting, everyone that has access to the infostore also has access to caldav. This is achieved in the following way:<br />
<br />
/opt/open-xchange/etc/groupware/caldav.properties:<br />
com.openexchange.caldav.enabled=false<br />
<br />
/opt/open-xchange/etc/groupware/contextSets/caldav.yml<br />
premium:<br />
com.openexchange.caldav.enabled: true<br />
withTags: ucInfostore<br />
<br />
This means: In general CalDAV is turned off, but using the contextSets feature of the config cascade it is turned on for everyone that has infostore access.<br />
<br />
===com.openexchange.caldav.tree===<br />
Configures the ID of the folder tree used by the CalDAV interface. Currently, this should be set to the default value of '0'.<br />
<br />
===com.openexchange.caldav.interval.start===<br />
Defines the minimum end time of appointments to be synchronized via the CalDAV interface, relative to the current date. Possible values are "one_month" (default), "one_year" and "six_months". <br />
<br />
===com.openexchange.caldav.interval.end===<br />
Defines the maximum start time of appointments to be synchronized via the CalDAV interface, relative to the current date. Possible values are "one_year" (default) and "two_years". <br />
<br />
===com.openexchange.caldav.url===<br />
Tells users where to find a caldav folder. This can be displayed in frontends. You can use the variables [hostname] and [folderId]. If you chose to deploy caldav as a virtual host (say 'dav.open-xchange.com') use https://dav.open-xchange.com/caldav/[folderId] as the value. If you are using user-agent sniffing use https://[hostname]/caldav/[folderId].<br />
<br />
<br />
== CardDAV Configuration ==<br />
<br />
The following configuration options are available in the configuration files carddav.properties and carddav.yml:<br />
<br />
===com.openexchange.carddav.enabled===<br />
Similarly to CalDAV, the property '''com.openexchange.carddav.enabled''' governs whether CardDAV is available for a certain user. This is configured exactly like CalDAV with the config cascade only enabling this for users that have access to the infostore:<br />
<br />
/opt/open-xchange/etc/groupware/carddav.properties:<br />
com.openexchange.carddav.enabled=false<br />
<br />
/opt/open-xchange/etc/groupware/contextSets/carddav.yml<br />
premium:<br />
com.openexchange.carddav.enabled: true<br />
withTags: ucInfostore<br />
<br />
===com.openexchange.carddav.ignoreFolders===<br />
A comma-separated list of folder IDs to exclude from the synchronization. Use this to disable syncing of very large folders (e.g. the global address list in large contexts, which always has ID 6). By default, no folders are excluded.<br />
<br />
===com.openexchange.carddav.tree===<br />
Configures the ID of the folder tree used by the CardDAV interface. Currently, this should be set to the default value of '0'.<br />
<br />
===com.openexchange.carddav.exposedCollections===<br />
Controls which collections are exposed via the CardDAV interface. Possible values are '0', '1' and '2'. A value of '1' makes each visible folder available as a resource collection, while '2' only exposes an aggregated collection containing all contact resources from all visible folders. The default value '0' exposes either an aggregated collection or individual collections for each folder, depending on the client's user-agent that is matched against the pattern in 'userAgentForAggregatedCollection'. <br />
<br />
===com.openexchange.carddav.userAgentForAggregatedCollection===<br />
Regular expression to match against the client's user-agent to decide whether the aggregated collection is exposed or not. The default pattern matches all known varieties of the Mac OS Addressbook client, that doesn't support multiple collections. Only used if 'exposedCollections' is set to '0'. The pattern is used case insensitive. <br />
<br />
===com.openexchange.carddav.reducedAggregatedCollection===<br />
Specifies if all visible folders are used to create the aggregated collection, or if a reduced set of folders only containing the global addressbook and the personal contacts folders should be used. This setting only influences the aggregated collection that is used for clients that don't support multiple collections. Possible values are 'true' and 'false.</div>Sgablerhttps://oxpedia.org/wiki/index.php?title=Caldav_carddav_Bundles&diff=11948Caldav carddav Bundles2012-11-09T16:35:11Z<p>Sgabler: /* CentOS 5 */</p>
<hr />
<div>= Installation and Configuration of the CalDAV- and CardDAV-bundles =<br />
<br />
The Open-Xchange server can be accessed via it's CalDAV- and CardDAV-interfaces to allow the synchronization of Calendar- and Contact-data with external applications like the Mac OS X iCal and Address Book clients. The synchronization protocols are available and supported for all customers with a valid Open-Xchange license of Open-Xchange Server Edition and Open-Xchange Hosting Edition starting with Version 6.20.1 Rev5.<br />
<br />
CalDAV and CardDAV are standard protocols for the exchange of calendar data and address data respectively. The CalDAV interface publishes all the user's calendar folders via CalDAV so the user can subscribe to them in a client application. Similarly, the CardDAV interface publishes the user's contact folders. Depending on the used client, the user can either subscribe one or more folders, or access all available data in an aggregated way. <br />
<br />
== User Guide and Client Configuration ==<br />
Please find further information regarding the client configuration at [[CalDAVClients]] and [[CardDAVClients]].<br />
<br />
== Webserver Configuration ==<br />
In order to redirect DAV requests to the appropiate servlets, the webserver's configuration may need to be adjusted using one of the following alternatives.<br />
<br />
=== Alternative 1: Apache vhost (recommended) ===<br />
Please edit your file /etc/apache2/ox6.conf so that ''' the existing OX configuration as well as the CalDAV/CardDav configuration are placed inside their own virtual hosts sections.'''.<br />
<br />
This is an <b>example</b> where MYSERVER.TLD is the domain-name of the ox-server:<br />
<br />
$ vi /etc/apache2/ox6.conf <br />
<br />
NameVirtualHost *:80<br />
<VirtualHost *:80><br />
ServerName dav.MYSERVER.TLD<br />
ErrorLog /tmp/dav.err.log<br />
TransferLog /tmp/dav.access.log<br />
<Proxy /><br />
Order allow,deny<br />
Allow from all<br />
</Proxy><br />
ProxyPass / ajp://localhost:8009/servlet/dav/ smax=0 ttl=60 retry=5 # for ajp http service<br />
#ProxyPass / http://localhost:8080/servlet/dav/ smax=0 ttl=60 retry=5 # for grizzly http service<br />
</VirtualHost><br />
<br />
<VirtualHost *:80><br />
ServerName MYSERVER.TLD<br />
ServerAdmin webmaster@localhost<br />
DocumentRoot /var/www/<br />
<br />
<Directory /var/www/><br />
AllowOverride None<br />
Order allow,deny<br />
allow from all<br />
RedirectMatch ^/$ /ox6/<br />
Options +FollowSymLinks +SymLinksIfOwnerMatch<br />
</Directory><br />
# deflate<br />
AddOutputFilterByType DEFLATE text/html text/plain text/javascript application/javascript text/css text/xml application/xml text/x-js application/x-javascript<br />
<br />
# pre-compressed files<br />
AddType text/javascript .jsz<br />
AddType text/css .cssz<br />
AddType text/xml .xmlz<br />
AddType text/plain .po<br />
<br />
AddEncoding gzip .jsz .cssz .xmlz<br />
SetEnvIf Request_URI "\.(jsz|cssz|xmlz)$" no-gzip<br />
<br />
ExpiresActive On<br />
<br />
<Location /ox6><br />
# Expires (via ExpiresByType to override global settings)<br />
ExpiresByType image/gif "access plus 6 months"<br />
ExpiresByType image/png "access plus 6 months"<br />
ExpiresByType image/jpg "access plus 6 months"<br />
ExpiresByType image/jpeg "access plus 6 months"<br />
ExpiresByType text/css "access plus 6 months"<br />
ExpiresByType text/html "access plus 6 months"<br />
ExpiresByType text/xml "access plus 6 months"<br />
ExpiresByType text/javascript "access plus 6 months"<br />
ExpiresByType text/x-js "access plus 6 months"<br />
ExpiresByType application/x-javascript "access plus 6 months"<br />
ExpiresDefault "access plus 6 months"<br />
Header append Cache-Control "private"<br />
Header unset Last-Modified<br />
Header unset Vary<br />
# Strip version<br />
RewriteEngine On<br />
RewriteRule v=\w+/(.+) $1 [L]<br />
# Turn off ETag<br />
Header unset ETag<br />
FileETag None<br />
</Location><br />
<br />
<Location /ox6/ox.html><br />
ExpiresByType text/html "now"<br />
ExpiresDefault "now"<br />
Header unset Last-Modified<br />
Header set Cache-Control "no-store, no-cache, must-revalidate, post-check=0, pre-check=0"<br />
# Turn off ETag<br />
Header unset ETag<br />
FileETag None<br />
</Location><br />
<br />
<Location /ox6/index.html><br />
ExpiresByType text/html "now"<br />
ExpiresDefault "now"<br />
Header unset Last-Modified<br />
Header set Cache-Control "no-store, no-cache, must-revalidate, post-check=0, pre-check=0"<br />
# Turn off ETag<br />
Header unset ETag<br />
FileETag None<br />
</Location><br />
</VirtualHost><br />
<br />
If you use this method, you have to make sure that dav.MYSERVER.TLD is reachable, your dns configuration need an entry for this name. Take care of the the dav.* logfiles, the example writes them without logrotation to /tmp.<br />
<br />
=== Alternative 2: Apache useragent detection ===<br />
For environments where it is inconvenient to setup a vhost there is the possibility to redirect to relevant servlets another way: Via useragent detection. This is not recommended for the following reason: Per definition this is a whitelist-approach and any client sending a useragent-string not explicitly listed in the configuration will not be able to connect . Useragent-strings may also change between different versions of an application or may even be actively changed into something non-standard.<br />
<br />
$ vi /etc/apache2/ox6.conf<br />
<br />
RewriteEngine On<br />
RewriteCond %{HTTP_USER_AGENT} Calendar [OR]<br />
RewriteCond %{HTTP_USER_AGENT} DataAccess [OR]<br />
RewriteCond %{HTTP_USER_AGENT} DAVKit [OR]<br />
RewriteCond %{HTTP_USER_AGENT} Lightning [OR]<br />
RewriteCond %{HTTP_USER_AGENT} Adresboek [OR]<br />
RewriteCond %{HTTP_USER_AGENT} dataaccessd [OR]<br />
RewriteCond %{HTTP_USER_AGENT} Preferences [OR]<br />
RewriteCond %{HTTP_USER_AGENT} Adressbuch [OR]<br />
RewriteCond %{HTTP_USER_AGENT} AddressBook [OR]<br />
RewriteCond %{HTTP_USER_AGENT} Address%20Book [OR]<br />
RewriteCond %{HTTP_USER_AGENT} CalendarStore [OR]<br />
RewriteCond %{HTTP_USER_AGENT} CoreDAV<br />
RewriteRule (.*) ajp://localhost:8009/servlet/dav$1 [P] # for ajp http service<br />
#RewriteRule (.*) http://localhost:8080/servlet/dav$1 [P] # for grizzly http service<br />
<br />
'''Note:''' The address book app on OSX 10.6 uses a localized user-agent string. If you're expecting clients with non-english language settings, you need to add the translated user-agent string to these rewrite rules. For example: "Adressbuch" for german OSX clients.<br />
<br />
<br />
== Which packages do I need? ==<br />
To get CalDAV and CardDAV up and running you need the following packages:<br />
<br />
In v6.20 and earlier:<br />
* open-xchange-webdav-directory - Assembles the *DAV interfaces into a common tree. This is needed for publishing certain properties so clients accept the OX is a WebDAV Server.<br />
* open-xchange-webdav-acl - The WebDAV equivalent of the /ajax/user interface. Allows clients to discover the current and other users and their addressbooks and calendars.<br />
* open-xchange-carddav - The CardDAV interface exposing the users addressbook via carddav<br />
* open-xchange-caldav - The CalDAV inteface exposing the users calendars via caldav<br />
<br />
<br />
With v6.22 we have significantly reduced the number of packages necessary to install Open-Xchange Server.<br />
In v6.22 and later only one package is needed:<br />
* open-xchange-dav <br />
<br />
{{InstallPlugin|pluginname=open-xchange-caldav open-xchange-carddav open-xchange-webdav-acl open-xchange-webdav-directory |sopath=updates}}<br />
<br />
== Installation on Open-Xchange v6.22 == <br />
<br />
=== Debian GNU/Linux 6.0 === <br />
<br />
Add the following entry to /etc/apt/sources.list if not already present:<br />
<br />
deb http://software.open-xchange.com/OX6/6.22/6.22.0/backend/DebianSqueeze/all/<br />
<br />
and run<br />
<br />
$ apt-get update<br />
$ apt-get install open-xchange-dav<br />
<br />
=== SUSE Linux Enterprise Server 11 ===<br />
<br />
Add the package repository using zypper if not already present:<br />
<br />
$ zypper ar http://software.open-xchange.com/OX6/6.22/6.22.0/backend/SLES11 ox<br />
<br />
and run<br />
<br />
$ zypper ref<br />
$ zypper in open-xchange-dav<br />
<br />
=== RedHat Enterprise Linux 6 ===<br />
<br />
Start a console and create a software repository file if not already present:<br />
<br />
$ vim /etc/yum.repos.d/ox.repo<br />
<br />
[ox]<br />
name=Open-Xchange<br />
baseurl=http://software.open-xchange.com/OX6/6.22/6.22.0/backend/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
and run<br />
<br />
$ yum update<br />
$ yum install open-xchange-dav<br />
<br />
=== RedHat Enterprise Linux 5 ===<br />
<br />
Start a console and create a software repository file if not already present:<br />
<br />
$ vim /etc/yum.repos.d/ox.repo<br />
<br />
[ox]<br />
name=Open-Xchange<br />
baseurl=http://software.open-xchange.com/OX6/6.22/6.22.0/backend/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
and run<br />
<br />
$ yum update<br />
$ yum install open-xchange-dav<br />
<br />
=== CentOS 5 ===<br />
<br />
Start a console and create a software repository file if not already present:<br />
<br />
$ vim /etc/yum.repos.d/ox.repo<br />
<br />
[ox]<br />
name=Open-Xchange<br />
baseurl=http://software.open-xchange.com/OX6/6.22/6.22.0/backend/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
and run<br />
<br />
$ yum update<br />
$ yum install open-xchange-dav<br />
<br />
=== CentOS 6 ===<br />
<br />
Start a console and create a software repository file if not already present:<br />
<br />
$ vim /etc/yum.repos.d/ox.repo<br />
<br />
[ox]<br />
name=Open-Xchange<br />
baseurl=http://software.open-xchange.com/OX6/6.22/6.22.0/backend/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
and run<br />
<br />
$ yum update<br />
$ yum install open-xchange-caldav open-xchange-carddav open-xchange-webdav-acl open-xchange-webdav-directory<br />
<br />
== CalDAV Configuration ==<br />
<br />
The following configuration options are available in the configuration files caldav.properties and caldav.yml:<br />
<br />
===com.openexchange.caldav.enabled===<br />
The property '''com.openexchange.caldav.enabled''' governs whether a user has access to the CalDAV interface. This can be configured along the config cascade, in the default setting, everyone that has access to the infostore also has access to caldav. This is achieved in the following way:<br />
<br />
/opt/open-xchange/etc/groupware/caldav.properties:<br />
com.openexchange.caldav.enabled=false<br />
<br />
/opt/open-xchange/etc/groupware/contextSets/caldav.yml<br />
premium:<br />
com.openexchange.caldav.enabled: true<br />
withTags: ucInfostore<br />
<br />
This means: In general CalDAV is turned off, but using the contextSets feature of the config cascade it is turned on for everyone that has infostore access.<br />
<br />
===com.openexchange.caldav.tree===<br />
Configures the ID of the folder tree used by the CalDAV interface. Currently, this should be set to the default value of '0'.<br />
<br />
===com.openexchange.caldav.interval.start===<br />
Defines the minimum end time of appointments to be synchronized via the CalDAV interface, relative to the current date. Possible values are "one_month" (default), "one_year" and "six_months". <br />
<br />
===com.openexchange.caldav.interval.end===<br />
Defines the maximum start time of appointments to be synchronized via the CalDAV interface, relative to the current date. Possible values are "one_year" (default) and "two_years". <br />
<br />
===com.openexchange.caldav.url===<br />
Tells users where to find a caldav folder. This can be displayed in frontends. You can use the variables [hostname] and [folderId]. If you chose to deploy caldav as a virtual host (say 'dav.open-xchange.com') use https://dav.open-xchange.com/caldav/[folderId] as the value. If you are using user-agent sniffing use https://[hostname]/caldav/[folderId].<br />
<br />
<br />
== CardDAV Configuration ==<br />
<br />
The following configuration options are available in the configuration files carddav.properties and carddav.yml:<br />
<br />
===com.openexchange.carddav.enabled===<br />
Similarly to CalDAV, the property '''com.openexchange.carddav.enabled''' governs whether CardDAV is available for a certain user. This is configured exactly like CalDAV with the config cascade only enabling this for users that have access to the infostore:<br />
<br />
/opt/open-xchange/etc/groupware/carddav.properties:<br />
com.openexchange.carddav.enabled=false<br />
<br />
/opt/open-xchange/etc/groupware/contextSets/carddav.yml<br />
premium:<br />
com.openexchange.carddav.enabled: true<br />
withTags: ucInfostore<br />
<br />
===com.openexchange.carddav.ignoreFolders===<br />
A comma-separated list of folder IDs to exclude from the synchronization. Use this to disable syncing of very large folders (e.g. the global address list in large contexts, which always has ID 6). By default, no folders are excluded.<br />
<br />
===com.openexchange.carddav.tree===<br />
Configures the ID of the folder tree used by the CardDAV interface. Currently, this should be set to the default value of '0'.<br />
<br />
===com.openexchange.carddav.exposedCollections===<br />
Controls which collections are exposed via the CardDAV interface. Possible values are '0', '1' and '2'. A value of '1' makes each visible folder available as a resource collection, while '2' only exposes an aggregated collection containing all contact resources from all visible folders. The default value '0' exposes either an aggregated collection or individual collections for each folder, depending on the client's user-agent that is matched against the pattern in 'userAgentForAggregatedCollection'. <br />
<br />
===com.openexchange.carddav.userAgentForAggregatedCollection===<br />
Regular expression to match against the client's user-agent to decide whether the aggregated collection is exposed or not. The default pattern matches all known varieties of the Mac OS Addressbook client, that doesn't support multiple collections. Only used if 'exposedCollections' is set to '0'. The pattern is used case insensitive. <br />
<br />
===com.openexchange.carddav.reducedAggregatedCollection===<br />
Specifies if all visible folders are used to create the aggregated collection, or if a reduced set of folders only containing the global addressbook and the personal contacts folders should be used. This setting only influences the aggregated collection that is used for clients that don't support multiple collections. Possible values are 'true' and 'false.</div>Sgablerhttps://oxpedia.org/wiki/index.php?title=Caldav_carddav_Bundles&diff=11947Caldav carddav Bundles2012-11-09T16:34:40Z<p>Sgabler: /* RedHat Enterprise Linux 5 */</p>
<hr />
<div>= Installation and Configuration of the CalDAV- and CardDAV-bundles =<br />
<br />
The Open-Xchange server can be accessed via it's CalDAV- and CardDAV-interfaces to allow the synchronization of Calendar- and Contact-data with external applications like the Mac OS X iCal and Address Book clients. The synchronization protocols are available and supported for all customers with a valid Open-Xchange license of Open-Xchange Server Edition and Open-Xchange Hosting Edition starting with Version 6.20.1 Rev5.<br />
<br />
CalDAV and CardDAV are standard protocols for the exchange of calendar data and address data respectively. The CalDAV interface publishes all the user's calendar folders via CalDAV so the user can subscribe to them in a client application. Similarly, the CardDAV interface publishes the user's contact folders. Depending on the used client, the user can either subscribe one or more folders, or access all available data in an aggregated way. <br />
<br />
== User Guide and Client Configuration ==<br />
Please find further information regarding the client configuration at [[CalDAVClients]] and [[CardDAVClients]].<br />
<br />
== Webserver Configuration ==<br />
In order to redirect DAV requests to the appropiate servlets, the webserver's configuration may need to be adjusted using one of the following alternatives.<br />
<br />
=== Alternative 1: Apache vhost (recommended) ===<br />
Please edit your file /etc/apache2/ox6.conf so that ''' the existing OX configuration as well as the CalDAV/CardDav configuration are placed inside their own virtual hosts sections.'''.<br />
<br />
This is an <b>example</b> where MYSERVER.TLD is the domain-name of the ox-server:<br />
<br />
$ vi /etc/apache2/ox6.conf <br />
<br />
NameVirtualHost *:80<br />
<VirtualHost *:80><br />
ServerName dav.MYSERVER.TLD<br />
ErrorLog /tmp/dav.err.log<br />
TransferLog /tmp/dav.access.log<br />
<Proxy /><br />
Order allow,deny<br />
Allow from all<br />
</Proxy><br />
ProxyPass / ajp://localhost:8009/servlet/dav/ smax=0 ttl=60 retry=5 # for ajp http service<br />
#ProxyPass / http://localhost:8080/servlet/dav/ smax=0 ttl=60 retry=5 # for grizzly http service<br />
</VirtualHost><br />
<br />
<VirtualHost *:80><br />
ServerName MYSERVER.TLD<br />
ServerAdmin webmaster@localhost<br />
DocumentRoot /var/www/<br />
<br />
<Directory /var/www/><br />
AllowOverride None<br />
Order allow,deny<br />
allow from all<br />
RedirectMatch ^/$ /ox6/<br />
Options +FollowSymLinks +SymLinksIfOwnerMatch<br />
</Directory><br />
# deflate<br />
AddOutputFilterByType DEFLATE text/html text/plain text/javascript application/javascript text/css text/xml application/xml text/x-js application/x-javascript<br />
<br />
# pre-compressed files<br />
AddType text/javascript .jsz<br />
AddType text/css .cssz<br />
AddType text/xml .xmlz<br />
AddType text/plain .po<br />
<br />
AddEncoding gzip .jsz .cssz .xmlz<br />
SetEnvIf Request_URI "\.(jsz|cssz|xmlz)$" no-gzip<br />
<br />
ExpiresActive On<br />
<br />
<Location /ox6><br />
# Expires (via ExpiresByType to override global settings)<br />
ExpiresByType image/gif "access plus 6 months"<br />
ExpiresByType image/png "access plus 6 months"<br />
ExpiresByType image/jpg "access plus 6 months"<br />
ExpiresByType image/jpeg "access plus 6 months"<br />
ExpiresByType text/css "access plus 6 months"<br />
ExpiresByType text/html "access plus 6 months"<br />
ExpiresByType text/xml "access plus 6 months"<br />
ExpiresByType text/javascript "access plus 6 months"<br />
ExpiresByType text/x-js "access plus 6 months"<br />
ExpiresByType application/x-javascript "access plus 6 months"<br />
ExpiresDefault "access plus 6 months"<br />
Header append Cache-Control "private"<br />
Header unset Last-Modified<br />
Header unset Vary<br />
# Strip version<br />
RewriteEngine On<br />
RewriteRule v=\w+/(.+) $1 [L]<br />
# Turn off ETag<br />
Header unset ETag<br />
FileETag None<br />
</Location><br />
<br />
<Location /ox6/ox.html><br />
ExpiresByType text/html "now"<br />
ExpiresDefault "now"<br />
Header unset Last-Modified<br />
Header set Cache-Control "no-store, no-cache, must-revalidate, post-check=0, pre-check=0"<br />
# Turn off ETag<br />
Header unset ETag<br />
FileETag None<br />
</Location><br />
<br />
<Location /ox6/index.html><br />
ExpiresByType text/html "now"<br />
ExpiresDefault "now"<br />
Header unset Last-Modified<br />
Header set Cache-Control "no-store, no-cache, must-revalidate, post-check=0, pre-check=0"<br />
# Turn off ETag<br />
Header unset ETag<br />
FileETag None<br />
</Location><br />
</VirtualHost><br />
<br />
If you use this method, you have to make sure that dav.MYSERVER.TLD is reachable, your dns configuration need an entry for this name. Take care of the the dav.* logfiles, the example writes them without logrotation to /tmp.<br />
<br />
=== Alternative 2: Apache useragent detection ===<br />
For environments where it is inconvenient to setup a vhost there is the possibility to redirect to relevant servlets another way: Via useragent detection. This is not recommended for the following reason: Per definition this is a whitelist-approach and any client sending a useragent-string not explicitly listed in the configuration will not be able to connect . Useragent-strings may also change between different versions of an application or may even be actively changed into something non-standard.<br />
<br />
$ vi /etc/apache2/ox6.conf<br />
<br />
RewriteEngine On<br />
RewriteCond %{HTTP_USER_AGENT} Calendar [OR]<br />
RewriteCond %{HTTP_USER_AGENT} DataAccess [OR]<br />
RewriteCond %{HTTP_USER_AGENT} DAVKit [OR]<br />
RewriteCond %{HTTP_USER_AGENT} Lightning [OR]<br />
RewriteCond %{HTTP_USER_AGENT} Adresboek [OR]<br />
RewriteCond %{HTTP_USER_AGENT} dataaccessd [OR]<br />
RewriteCond %{HTTP_USER_AGENT} Preferences [OR]<br />
RewriteCond %{HTTP_USER_AGENT} Adressbuch [OR]<br />
RewriteCond %{HTTP_USER_AGENT} AddressBook [OR]<br />
RewriteCond %{HTTP_USER_AGENT} Address%20Book [OR]<br />
RewriteCond %{HTTP_USER_AGENT} CalendarStore [OR]<br />
RewriteCond %{HTTP_USER_AGENT} CoreDAV<br />
RewriteRule (.*) ajp://localhost:8009/servlet/dav$1 [P] # for ajp http service<br />
#RewriteRule (.*) http://localhost:8080/servlet/dav$1 [P] # for grizzly http service<br />
<br />
'''Note:''' The address book app on OSX 10.6 uses a localized user-agent string. If you're expecting clients with non-english language settings, you need to add the translated user-agent string to these rewrite rules. For example: "Adressbuch" for german OSX clients.<br />
<br />
<br />
== Which packages do I need? ==<br />
To get CalDAV and CardDAV up and running you need the following packages:<br />
<br />
In v6.20 and earlier:<br />
* open-xchange-webdav-directory - Assembles the *DAV interfaces into a common tree. This is needed for publishing certain properties so clients accept the OX is a WebDAV Server.<br />
* open-xchange-webdav-acl - The WebDAV equivalent of the /ajax/user interface. Allows clients to discover the current and other users and their addressbooks and calendars.<br />
* open-xchange-carddav - The CardDAV interface exposing the users addressbook via carddav<br />
* open-xchange-caldav - The CalDAV inteface exposing the users calendars via caldav<br />
<br />
<br />
With v6.22 we have significantly reduced the number of packages necessary to install Open-Xchange Server.<br />
In v6.22 and later only one package is needed:<br />
* open-xchange-dav <br />
<br />
{{InstallPlugin|pluginname=open-xchange-caldav open-xchange-carddav open-xchange-webdav-acl open-xchange-webdav-directory |sopath=updates}}<br />
<br />
== Installation on Open-Xchange v6.22 == <br />
<br />
=== Debian GNU/Linux 6.0 === <br />
<br />
Add the following entry to /etc/apt/sources.list if not already present:<br />
<br />
deb http://software.open-xchange.com/OX6/6.22/6.22.0/backend/DebianSqueeze/all/<br />
<br />
and run<br />
<br />
$ apt-get update<br />
$ apt-get install open-xchange-dav<br />
<br />
=== SUSE Linux Enterprise Server 11 ===<br />
<br />
Add the package repository using zypper if not already present:<br />
<br />
$ zypper ar http://software.open-xchange.com/OX6/6.22/6.22.0/backend/SLES11 ox<br />
<br />
and run<br />
<br />
$ zypper ref<br />
$ zypper in open-xchange-dav<br />
<br />
=== RedHat Enterprise Linux 6 ===<br />
<br />
Start a console and create a software repository file if not already present:<br />
<br />
$ vim /etc/yum.repos.d/ox.repo<br />
<br />
[ox]<br />
name=Open-Xchange<br />
baseurl=http://software.open-xchange.com/OX6/6.22/6.22.0/backend/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
and run<br />
<br />
$ yum update<br />
$ yum install open-xchange-dav<br />
<br />
=== RedHat Enterprise Linux 5 ===<br />
<br />
Start a console and create a software repository file if not already present:<br />
<br />
$ vim /etc/yum.repos.d/ox.repo<br />
<br />
[ox]<br />
name=Open-Xchange<br />
baseurl=http://software.open-xchange.com/OX6/6.22/6.22.0/backend/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
and run<br />
<br />
$ yum update<br />
$ yum install open-xchange-dav<br />
<br />
=== CentOS 5 ===<br />
<br />
Start a console and create a software repository file if not already present:<br />
<br />
$ vim /etc/yum.repos.d/ox.repo<br />
<br />
[ox]<br />
name=Open-Xchange<br />
baseurl=http://software.open-xchange.com/OX6/6.22/6.22.0/backend/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
and run<br />
<br />
$ yum update<br />
$ yum install open-xchange-caldav open-xchange-carddav open-xchange-webdav-acl open-xchange-webdav-directory<br />
<br />
=== CentOS 6 ===<br />
<br />
Start a console and create a software repository file if not already present:<br />
<br />
$ vim /etc/yum.repos.d/ox.repo<br />
<br />
[ox]<br />
name=Open-Xchange<br />
baseurl=http://software.open-xchange.com/OX6/6.22/6.22.0/backend/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
and run<br />
<br />
$ yum update<br />
$ yum install open-xchange-caldav open-xchange-carddav open-xchange-webdav-acl open-xchange-webdav-directory<br />
<br />
== CalDAV Configuration ==<br />
<br />
The following configuration options are available in the configuration files caldav.properties and caldav.yml:<br />
<br />
===com.openexchange.caldav.enabled===<br />
The property '''com.openexchange.caldav.enabled''' governs whether a user has access to the CalDAV interface. This can be configured along the config cascade, in the default setting, everyone that has access to the infostore also has access to caldav. This is achieved in the following way:<br />
<br />
/opt/open-xchange/etc/groupware/caldav.properties:<br />
com.openexchange.caldav.enabled=false<br />
<br />
/opt/open-xchange/etc/groupware/contextSets/caldav.yml<br />
premium:<br />
com.openexchange.caldav.enabled: true<br />
withTags: ucInfostore<br />
<br />
This means: In general CalDAV is turned off, but using the contextSets feature of the config cascade it is turned on for everyone that has infostore access.<br />
<br />
===com.openexchange.caldav.tree===<br />
Configures the ID of the folder tree used by the CalDAV interface. Currently, this should be set to the default value of '0'.<br />
<br />
===com.openexchange.caldav.interval.start===<br />
Defines the minimum end time of appointments to be synchronized via the CalDAV interface, relative to the current date. Possible values are "one_month" (default), "one_year" and "six_months". <br />
<br />
===com.openexchange.caldav.interval.end===<br />
Defines the maximum start time of appointments to be synchronized via the CalDAV interface, relative to the current date. Possible values are "one_year" (default) and "two_years". <br />
<br />
===com.openexchange.caldav.url===<br />
Tells users where to find a caldav folder. This can be displayed in frontends. You can use the variables [hostname] and [folderId]. If you chose to deploy caldav as a virtual host (say 'dav.open-xchange.com') use https://dav.open-xchange.com/caldav/[folderId] as the value. If you are using user-agent sniffing use https://[hostname]/caldav/[folderId].<br />
<br />
<br />
== CardDAV Configuration ==<br />
<br />
The following configuration options are available in the configuration files carddav.properties and carddav.yml:<br />
<br />
===com.openexchange.carddav.enabled===<br />
Similarly to CalDAV, the property '''com.openexchange.carddav.enabled''' governs whether CardDAV is available for a certain user. This is configured exactly like CalDAV with the config cascade only enabling this for users that have access to the infostore:<br />
<br />
/opt/open-xchange/etc/groupware/carddav.properties:<br />
com.openexchange.carddav.enabled=false<br />
<br />
/opt/open-xchange/etc/groupware/contextSets/carddav.yml<br />
premium:<br />
com.openexchange.carddav.enabled: true<br />
withTags: ucInfostore<br />
<br />
===com.openexchange.carddav.ignoreFolders===<br />
A comma-separated list of folder IDs to exclude from the synchronization. Use this to disable syncing of very large folders (e.g. the global address list in large contexts, which always has ID 6). By default, no folders are excluded.<br />
<br />
===com.openexchange.carddav.tree===<br />
Configures the ID of the folder tree used by the CardDAV interface. Currently, this should be set to the default value of '0'.<br />
<br />
===com.openexchange.carddav.exposedCollections===<br />
Controls which collections are exposed via the CardDAV interface. Possible values are '0', '1' and '2'. A value of '1' makes each visible folder available as a resource collection, while '2' only exposes an aggregated collection containing all contact resources from all visible folders. The default value '0' exposes either an aggregated collection or individual collections for each folder, depending on the client's user-agent that is matched against the pattern in 'userAgentForAggregatedCollection'. <br />
<br />
===com.openexchange.carddav.userAgentForAggregatedCollection===<br />
Regular expression to match against the client's user-agent to decide whether the aggregated collection is exposed or not. The default pattern matches all known varieties of the Mac OS Addressbook client, that doesn't support multiple collections. Only used if 'exposedCollections' is set to '0'. The pattern is used case insensitive. <br />
<br />
===com.openexchange.carddav.reducedAggregatedCollection===<br />
Specifies if all visible folders are used to create the aggregated collection, or if a reduced set of folders only containing the global addressbook and the personal contacts folders should be used. This setting only influences the aggregated collection that is used for clients that don't support multiple collections. Possible values are 'true' and 'false.</div>Sgablerhttps://oxpedia.org/wiki/index.php?title=Caldav_carddav_Bundles&diff=11946Caldav carddav Bundles2012-11-09T16:33:52Z<p>Sgabler: /* RedHat Enterprise Linux 6 */</p>
<hr />
<div>= Installation and Configuration of the CalDAV- and CardDAV-bundles =<br />
<br />
The Open-Xchange server can be accessed via it's CalDAV- and CardDAV-interfaces to allow the synchronization of Calendar- and Contact-data with external applications like the Mac OS X iCal and Address Book clients. The synchronization protocols are available and supported for all customers with a valid Open-Xchange license of Open-Xchange Server Edition and Open-Xchange Hosting Edition starting with Version 6.20.1 Rev5.<br />
<br />
CalDAV and CardDAV are standard protocols for the exchange of calendar data and address data respectively. The CalDAV interface publishes all the user's calendar folders via CalDAV so the user can subscribe to them in a client application. Similarly, the CardDAV interface publishes the user's contact folders. Depending on the used client, the user can either subscribe one or more folders, or access all available data in an aggregated way. <br />
<br />
== User Guide and Client Configuration ==<br />
Please find further information regarding the client configuration at [[CalDAVClients]] and [[CardDAVClients]].<br />
<br />
== Webserver Configuration ==<br />
In order to redirect DAV requests to the appropiate servlets, the webserver's configuration may need to be adjusted using one of the following alternatives.<br />
<br />
=== Alternative 1: Apache vhost (recommended) ===<br />
Please edit your file /etc/apache2/ox6.conf so that ''' the existing OX configuration as well as the CalDAV/CardDav configuration are placed inside their own virtual hosts sections.'''.<br />
<br />
This is an <b>example</b> where MYSERVER.TLD is the domain-name of the ox-server:<br />
<br />
$ vi /etc/apache2/ox6.conf <br />
<br />
NameVirtualHost *:80<br />
<VirtualHost *:80><br />
ServerName dav.MYSERVER.TLD<br />
ErrorLog /tmp/dav.err.log<br />
TransferLog /tmp/dav.access.log<br />
<Proxy /><br />
Order allow,deny<br />
Allow from all<br />
</Proxy><br />
ProxyPass / ajp://localhost:8009/servlet/dav/ smax=0 ttl=60 retry=5 # for ajp http service<br />
#ProxyPass / http://localhost:8080/servlet/dav/ smax=0 ttl=60 retry=5 # for grizzly http service<br />
</VirtualHost><br />
<br />
<VirtualHost *:80><br />
ServerName MYSERVER.TLD<br />
ServerAdmin webmaster@localhost<br />
DocumentRoot /var/www/<br />
<br />
<Directory /var/www/><br />
AllowOverride None<br />
Order allow,deny<br />
allow from all<br />
RedirectMatch ^/$ /ox6/<br />
Options +FollowSymLinks +SymLinksIfOwnerMatch<br />
</Directory><br />
# deflate<br />
AddOutputFilterByType DEFLATE text/html text/plain text/javascript application/javascript text/css text/xml application/xml text/x-js application/x-javascript<br />
<br />
# pre-compressed files<br />
AddType text/javascript .jsz<br />
AddType text/css .cssz<br />
AddType text/xml .xmlz<br />
AddType text/plain .po<br />
<br />
AddEncoding gzip .jsz .cssz .xmlz<br />
SetEnvIf Request_URI "\.(jsz|cssz|xmlz)$" no-gzip<br />
<br />
ExpiresActive On<br />
<br />
<Location /ox6><br />
# Expires (via ExpiresByType to override global settings)<br />
ExpiresByType image/gif "access plus 6 months"<br />
ExpiresByType image/png "access plus 6 months"<br />
ExpiresByType image/jpg "access plus 6 months"<br />
ExpiresByType image/jpeg "access plus 6 months"<br />
ExpiresByType text/css "access plus 6 months"<br />
ExpiresByType text/html "access plus 6 months"<br />
ExpiresByType text/xml "access plus 6 months"<br />
ExpiresByType text/javascript "access plus 6 months"<br />
ExpiresByType text/x-js "access plus 6 months"<br />
ExpiresByType application/x-javascript "access plus 6 months"<br />
ExpiresDefault "access plus 6 months"<br />
Header append Cache-Control "private"<br />
Header unset Last-Modified<br />
Header unset Vary<br />
# Strip version<br />
RewriteEngine On<br />
RewriteRule v=\w+/(.+) $1 [L]<br />
# Turn off ETag<br />
Header unset ETag<br />
FileETag None<br />
</Location><br />
<br />
<Location /ox6/ox.html><br />
ExpiresByType text/html "now"<br />
ExpiresDefault "now"<br />
Header unset Last-Modified<br />
Header set Cache-Control "no-store, no-cache, must-revalidate, post-check=0, pre-check=0"<br />
# Turn off ETag<br />
Header unset ETag<br />
FileETag None<br />
</Location><br />
<br />
<Location /ox6/index.html><br />
ExpiresByType text/html "now"<br />
ExpiresDefault "now"<br />
Header unset Last-Modified<br />
Header set Cache-Control "no-store, no-cache, must-revalidate, post-check=0, pre-check=0"<br />
# Turn off ETag<br />
Header unset ETag<br />
FileETag None<br />
</Location><br />
</VirtualHost><br />
<br />
If you use this method, you have to make sure that dav.MYSERVER.TLD is reachable, your dns configuration need an entry for this name. Take care of the the dav.* logfiles, the example writes them without logrotation to /tmp.<br />
<br />
=== Alternative 2: Apache useragent detection ===<br />
For environments where it is inconvenient to setup a vhost there is the possibility to redirect to relevant servlets another way: Via useragent detection. This is not recommended for the following reason: Per definition this is a whitelist-approach and any client sending a useragent-string not explicitly listed in the configuration will not be able to connect . Useragent-strings may also change between different versions of an application or may even be actively changed into something non-standard.<br />
<br />
$ vi /etc/apache2/ox6.conf<br />
<br />
RewriteEngine On<br />
RewriteCond %{HTTP_USER_AGENT} Calendar [OR]<br />
RewriteCond %{HTTP_USER_AGENT} DataAccess [OR]<br />
RewriteCond %{HTTP_USER_AGENT} DAVKit [OR]<br />
RewriteCond %{HTTP_USER_AGENT} Lightning [OR]<br />
RewriteCond %{HTTP_USER_AGENT} Adresboek [OR]<br />
RewriteCond %{HTTP_USER_AGENT} dataaccessd [OR]<br />
RewriteCond %{HTTP_USER_AGENT} Preferences [OR]<br />
RewriteCond %{HTTP_USER_AGENT} Adressbuch [OR]<br />
RewriteCond %{HTTP_USER_AGENT} AddressBook [OR]<br />
RewriteCond %{HTTP_USER_AGENT} Address%20Book [OR]<br />
RewriteCond %{HTTP_USER_AGENT} CalendarStore [OR]<br />
RewriteCond %{HTTP_USER_AGENT} CoreDAV<br />
RewriteRule (.*) ajp://localhost:8009/servlet/dav$1 [P] # for ajp http service<br />
#RewriteRule (.*) http://localhost:8080/servlet/dav$1 [P] # for grizzly http service<br />
<br />
'''Note:''' The address book app on OSX 10.6 uses a localized user-agent string. If you're expecting clients with non-english language settings, you need to add the translated user-agent string to these rewrite rules. For example: "Adressbuch" for german OSX clients.<br />
<br />
<br />
== Which packages do I need? ==<br />
To get CalDAV and CardDAV up and running you need the following packages:<br />
<br />
In v6.20 and earlier:<br />
* open-xchange-webdav-directory - Assembles the *DAV interfaces into a common tree. This is needed for publishing certain properties so clients accept the OX is a WebDAV Server.<br />
* open-xchange-webdav-acl - The WebDAV equivalent of the /ajax/user interface. Allows clients to discover the current and other users and their addressbooks and calendars.<br />
* open-xchange-carddav - The CardDAV interface exposing the users addressbook via carddav<br />
* open-xchange-caldav - The CalDAV inteface exposing the users calendars via caldav<br />
<br />
<br />
With v6.22 we have significantly reduced the number of packages necessary to install Open-Xchange Server.<br />
In v6.22 and later only one package is needed:<br />
* open-xchange-dav <br />
<br />
{{InstallPlugin|pluginname=open-xchange-caldav open-xchange-carddav open-xchange-webdav-acl open-xchange-webdav-directory |sopath=updates}}<br />
<br />
== Installation on Open-Xchange v6.22 == <br />
<br />
=== Debian GNU/Linux 6.0 === <br />
<br />
Add the following entry to /etc/apt/sources.list if not already present:<br />
<br />
deb http://software.open-xchange.com/OX6/6.22/6.22.0/backend/DebianSqueeze/all/<br />
<br />
and run<br />
<br />
$ apt-get update<br />
$ apt-get install open-xchange-dav<br />
<br />
=== SUSE Linux Enterprise Server 11 ===<br />
<br />
Add the package repository using zypper if not already present:<br />
<br />
$ zypper ar http://software.open-xchange.com/OX6/6.22/6.22.0/backend/SLES11 ox<br />
<br />
and run<br />
<br />
$ zypper ref<br />
$ zypper in open-xchange-dav<br />
<br />
=== RedHat Enterprise Linux 6 ===<br />
<br />
Start a console and create a software repository file if not already present:<br />
<br />
$ vim /etc/yum.repos.d/ox.repo<br />
<br />
[ox]<br />
name=Open-Xchange<br />
baseurl=http://software.open-xchange.com/OX6/6.22/6.22.0/backend/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
and run<br />
<br />
$ yum update<br />
$ yum install open-xchange-dav<br />
<br />
=== RedHat Enterprise Linux 5 ===<br />
<br />
Start a console and create a software repository file if not already present:<br />
<br />
$ vim /etc/yum.repos.d/ox.repo<br />
<br />
[ox]<br />
name=Open-Xchange<br />
baseurl=http://software.open-xchange.com/OX6/6.22/6.22.0/backend/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
and run<br />
<br />
$ yum update<br />
$ yum install open-xchange-caldav open-xchange-carddav open-xchange-webdav-acl open-xchange-webdav-directory<br />
<br />
=== CentOS 5 ===<br />
<br />
Start a console and create a software repository file if not already present:<br />
<br />
$ vim /etc/yum.repos.d/ox.repo<br />
<br />
[ox]<br />
name=Open-Xchange<br />
baseurl=http://software.open-xchange.com/OX6/6.22/6.22.0/backend/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
and run<br />
<br />
$ yum update<br />
$ yum install open-xchange-caldav open-xchange-carddav open-xchange-webdav-acl open-xchange-webdav-directory<br />
<br />
=== CentOS 6 ===<br />
<br />
Start a console and create a software repository file if not already present:<br />
<br />
$ vim /etc/yum.repos.d/ox.repo<br />
<br />
[ox]<br />
name=Open-Xchange<br />
baseurl=http://software.open-xchange.com/OX6/6.22/6.22.0/backend/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
and run<br />
<br />
$ yum update<br />
$ yum install open-xchange-caldav open-xchange-carddav open-xchange-webdav-acl open-xchange-webdav-directory<br />
<br />
== CalDAV Configuration ==<br />
<br />
The following configuration options are available in the configuration files caldav.properties and caldav.yml:<br />
<br />
===com.openexchange.caldav.enabled===<br />
The property '''com.openexchange.caldav.enabled''' governs whether a user has access to the CalDAV interface. This can be configured along the config cascade, in the default setting, everyone that has access to the infostore also has access to caldav. This is achieved in the following way:<br />
<br />
/opt/open-xchange/etc/groupware/caldav.properties:<br />
com.openexchange.caldav.enabled=false<br />
<br />
/opt/open-xchange/etc/groupware/contextSets/caldav.yml<br />
premium:<br />
com.openexchange.caldav.enabled: true<br />
withTags: ucInfostore<br />
<br />
This means: In general CalDAV is turned off, but using the contextSets feature of the config cascade it is turned on for everyone that has infostore access.<br />
<br />
===com.openexchange.caldav.tree===<br />
Configures the ID of the folder tree used by the CalDAV interface. Currently, this should be set to the default value of '0'.<br />
<br />
===com.openexchange.caldav.interval.start===<br />
Defines the minimum end time of appointments to be synchronized via the CalDAV interface, relative to the current date. Possible values are "one_month" (default), "one_year" and "six_months". <br />
<br />
===com.openexchange.caldav.interval.end===<br />
Defines the maximum start time of appointments to be synchronized via the CalDAV interface, relative to the current date. Possible values are "one_year" (default) and "two_years". <br />
<br />
===com.openexchange.caldav.url===<br />
Tells users where to find a caldav folder. This can be displayed in frontends. You can use the variables [hostname] and [folderId]. If you chose to deploy caldav as a virtual host (say 'dav.open-xchange.com') use https://dav.open-xchange.com/caldav/[folderId] as the value. If you are using user-agent sniffing use https://[hostname]/caldav/[folderId].<br />
<br />
<br />
== CardDAV Configuration ==<br />
<br />
The following configuration options are available in the configuration files carddav.properties and carddav.yml:<br />
<br />
===com.openexchange.carddav.enabled===<br />
Similarly to CalDAV, the property '''com.openexchange.carddav.enabled''' governs whether CardDAV is available for a certain user. This is configured exactly like CalDAV with the config cascade only enabling this for users that have access to the infostore:<br />
<br />
/opt/open-xchange/etc/groupware/carddav.properties:<br />
com.openexchange.carddav.enabled=false<br />
<br />
/opt/open-xchange/etc/groupware/contextSets/carddav.yml<br />
premium:<br />
com.openexchange.carddav.enabled: true<br />
withTags: ucInfostore<br />
<br />
===com.openexchange.carddav.ignoreFolders===<br />
A comma-separated list of folder IDs to exclude from the synchronization. Use this to disable syncing of very large folders (e.g. the global address list in large contexts, which always has ID 6). By default, no folders are excluded.<br />
<br />
===com.openexchange.carddav.tree===<br />
Configures the ID of the folder tree used by the CardDAV interface. Currently, this should be set to the default value of '0'.<br />
<br />
===com.openexchange.carddav.exposedCollections===<br />
Controls which collections are exposed via the CardDAV interface. Possible values are '0', '1' and '2'. A value of '1' makes each visible folder available as a resource collection, while '2' only exposes an aggregated collection containing all contact resources from all visible folders. The default value '0' exposes either an aggregated collection or individual collections for each folder, depending on the client's user-agent that is matched against the pattern in 'userAgentForAggregatedCollection'. <br />
<br />
===com.openexchange.carddav.userAgentForAggregatedCollection===<br />
Regular expression to match against the client's user-agent to decide whether the aggregated collection is exposed or not. The default pattern matches all known varieties of the Mac OS Addressbook client, that doesn't support multiple collections. Only used if 'exposedCollections' is set to '0'. The pattern is used case insensitive. <br />
<br />
===com.openexchange.carddav.reducedAggregatedCollection===<br />
Specifies if all visible folders are used to create the aggregated collection, or if a reduced set of folders only containing the global addressbook and the personal contacts folders should be used. This setting only influences the aggregated collection that is used for clients that don't support multiple collections. Possible values are 'true' and 'false.</div>Sgablerhttps://oxpedia.org/wiki/index.php?title=Caldav_carddav_Bundles&diff=11945Caldav carddav Bundles2012-11-09T16:33:19Z<p>Sgabler: /* SUSE Linux Enterprise Server 11 */</p>
<hr />
<div>= Installation and Configuration of the CalDAV- and CardDAV-bundles =<br />
<br />
The Open-Xchange server can be accessed via it's CalDAV- and CardDAV-interfaces to allow the synchronization of Calendar- and Contact-data with external applications like the Mac OS X iCal and Address Book clients. The synchronization protocols are available and supported for all customers with a valid Open-Xchange license of Open-Xchange Server Edition and Open-Xchange Hosting Edition starting with Version 6.20.1 Rev5.<br />
<br />
CalDAV and CardDAV are standard protocols for the exchange of calendar data and address data respectively. The CalDAV interface publishes all the user's calendar folders via CalDAV so the user can subscribe to them in a client application. Similarly, the CardDAV interface publishes the user's contact folders. Depending on the used client, the user can either subscribe one or more folders, or access all available data in an aggregated way. <br />
<br />
== User Guide and Client Configuration ==<br />
Please find further information regarding the client configuration at [[CalDAVClients]] and [[CardDAVClients]].<br />
<br />
== Webserver Configuration ==<br />
In order to redirect DAV requests to the appropiate servlets, the webserver's configuration may need to be adjusted using one of the following alternatives.<br />
<br />
=== Alternative 1: Apache vhost (recommended) ===<br />
Please edit your file /etc/apache2/ox6.conf so that ''' the existing OX configuration as well as the CalDAV/CardDav configuration are placed inside their own virtual hosts sections.'''.<br />
<br />
This is an <b>example</b> where MYSERVER.TLD is the domain-name of the ox-server:<br />
<br />
$ vi /etc/apache2/ox6.conf <br />
<br />
NameVirtualHost *:80<br />
<VirtualHost *:80><br />
ServerName dav.MYSERVER.TLD<br />
ErrorLog /tmp/dav.err.log<br />
TransferLog /tmp/dav.access.log<br />
<Proxy /><br />
Order allow,deny<br />
Allow from all<br />
</Proxy><br />
ProxyPass / ajp://localhost:8009/servlet/dav/ smax=0 ttl=60 retry=5 # for ajp http service<br />
#ProxyPass / http://localhost:8080/servlet/dav/ smax=0 ttl=60 retry=5 # for grizzly http service<br />
</VirtualHost><br />
<br />
<VirtualHost *:80><br />
ServerName MYSERVER.TLD<br />
ServerAdmin webmaster@localhost<br />
DocumentRoot /var/www/<br />
<br />
<Directory /var/www/><br />
AllowOverride None<br />
Order allow,deny<br />
allow from all<br />
RedirectMatch ^/$ /ox6/<br />
Options +FollowSymLinks +SymLinksIfOwnerMatch<br />
</Directory><br />
# deflate<br />
AddOutputFilterByType DEFLATE text/html text/plain text/javascript application/javascript text/css text/xml application/xml text/x-js application/x-javascript<br />
<br />
# pre-compressed files<br />
AddType text/javascript .jsz<br />
AddType text/css .cssz<br />
AddType text/xml .xmlz<br />
AddType text/plain .po<br />
<br />
AddEncoding gzip .jsz .cssz .xmlz<br />
SetEnvIf Request_URI "\.(jsz|cssz|xmlz)$" no-gzip<br />
<br />
ExpiresActive On<br />
<br />
<Location /ox6><br />
# Expires (via ExpiresByType to override global settings)<br />
ExpiresByType image/gif "access plus 6 months"<br />
ExpiresByType image/png "access plus 6 months"<br />
ExpiresByType image/jpg "access plus 6 months"<br />
ExpiresByType image/jpeg "access plus 6 months"<br />
ExpiresByType text/css "access plus 6 months"<br />
ExpiresByType text/html "access plus 6 months"<br />
ExpiresByType text/xml "access plus 6 months"<br />
ExpiresByType text/javascript "access plus 6 months"<br />
ExpiresByType text/x-js "access plus 6 months"<br />
ExpiresByType application/x-javascript "access plus 6 months"<br />
ExpiresDefault "access plus 6 months"<br />
Header append Cache-Control "private"<br />
Header unset Last-Modified<br />
Header unset Vary<br />
# Strip version<br />
RewriteEngine On<br />
RewriteRule v=\w+/(.+) $1 [L]<br />
# Turn off ETag<br />
Header unset ETag<br />
FileETag None<br />
</Location><br />
<br />
<Location /ox6/ox.html><br />
ExpiresByType text/html "now"<br />
ExpiresDefault "now"<br />
Header unset Last-Modified<br />
Header set Cache-Control "no-store, no-cache, must-revalidate, post-check=0, pre-check=0"<br />
# Turn off ETag<br />
Header unset ETag<br />
FileETag None<br />
</Location><br />
<br />
<Location /ox6/index.html><br />
ExpiresByType text/html "now"<br />
ExpiresDefault "now"<br />
Header unset Last-Modified<br />
Header set Cache-Control "no-store, no-cache, must-revalidate, post-check=0, pre-check=0"<br />
# Turn off ETag<br />
Header unset ETag<br />
FileETag None<br />
</Location><br />
</VirtualHost><br />
<br />
If you use this method, you have to make sure that dav.MYSERVER.TLD is reachable, your dns configuration need an entry for this name. Take care of the the dav.* logfiles, the example writes them without logrotation to /tmp.<br />
<br />
=== Alternative 2: Apache useragent detection ===<br />
For environments where it is inconvenient to setup a vhost there is the possibility to redirect to relevant servlets another way: Via useragent detection. This is not recommended for the following reason: Per definition this is a whitelist-approach and any client sending a useragent-string not explicitly listed in the configuration will not be able to connect . Useragent-strings may also change between different versions of an application or may even be actively changed into something non-standard.<br />
<br />
$ vi /etc/apache2/ox6.conf<br />
<br />
RewriteEngine On<br />
RewriteCond %{HTTP_USER_AGENT} Calendar [OR]<br />
RewriteCond %{HTTP_USER_AGENT} DataAccess [OR]<br />
RewriteCond %{HTTP_USER_AGENT} DAVKit [OR]<br />
RewriteCond %{HTTP_USER_AGENT} Lightning [OR]<br />
RewriteCond %{HTTP_USER_AGENT} Adresboek [OR]<br />
RewriteCond %{HTTP_USER_AGENT} dataaccessd [OR]<br />
RewriteCond %{HTTP_USER_AGENT} Preferences [OR]<br />
RewriteCond %{HTTP_USER_AGENT} Adressbuch [OR]<br />
RewriteCond %{HTTP_USER_AGENT} AddressBook [OR]<br />
RewriteCond %{HTTP_USER_AGENT} Address%20Book [OR]<br />
RewriteCond %{HTTP_USER_AGENT} CalendarStore [OR]<br />
RewriteCond %{HTTP_USER_AGENT} CoreDAV<br />
RewriteRule (.*) ajp://localhost:8009/servlet/dav$1 [P] # for ajp http service<br />
#RewriteRule (.*) http://localhost:8080/servlet/dav$1 [P] # for grizzly http service<br />
<br />
'''Note:''' The address book app on OSX 10.6 uses a localized user-agent string. If you're expecting clients with non-english language settings, you need to add the translated user-agent string to these rewrite rules. For example: "Adressbuch" for german OSX clients.<br />
<br />
<br />
== Which packages do I need? ==<br />
To get CalDAV and CardDAV up and running you need the following packages:<br />
<br />
In v6.20 and earlier:<br />
* open-xchange-webdav-directory - Assembles the *DAV interfaces into a common tree. This is needed for publishing certain properties so clients accept the OX is a WebDAV Server.<br />
* open-xchange-webdav-acl - The WebDAV equivalent of the /ajax/user interface. Allows clients to discover the current and other users and their addressbooks and calendars.<br />
* open-xchange-carddav - The CardDAV interface exposing the users addressbook via carddav<br />
* open-xchange-caldav - The CalDAV inteface exposing the users calendars via caldav<br />
<br />
<br />
With v6.22 we have significantly reduced the number of packages necessary to install Open-Xchange Server.<br />
In v6.22 and later only one package is needed:<br />
* open-xchange-dav <br />
<br />
{{InstallPlugin|pluginname=open-xchange-caldav open-xchange-carddav open-xchange-webdav-acl open-xchange-webdav-directory |sopath=updates}}<br />
<br />
== Installation on Open-Xchange v6.22 == <br />
<br />
=== Debian GNU/Linux 6.0 === <br />
<br />
Add the following entry to /etc/apt/sources.list if not already present:<br />
<br />
deb http://software.open-xchange.com/OX6/6.22/6.22.0/backend/DebianSqueeze/all/<br />
<br />
and run<br />
<br />
$ apt-get update<br />
$ apt-get install open-xchange-dav<br />
<br />
=== SUSE Linux Enterprise Server 11 ===<br />
<br />
Add the package repository using zypper if not already present:<br />
<br />
$ zypper ar http://software.open-xchange.com/OX6/6.22/6.22.0/backend/SLES11 ox<br />
<br />
and run<br />
<br />
$ zypper ref<br />
$ zypper in open-xchange-dav<br />
<br />
=== RedHat Enterprise Linux 6 ===<br />
<br />
Start a console and create a software repository file if not already present:<br />
<br />
$ vim /etc/yum.repos.d/ox.repo<br />
<br />
[ox]<br />
name=Open-Xchange<br />
baseurl=http://software.open-xchange.com/OX6/6.22/6.22.0/backend/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
and run<br />
<br />
$ yum update<br />
$ yum install open-xchange-caldav open-xchange-carddav open-xchange-webdav-acl open-xchange-webdav-directory<br />
<br />
=== RedHat Enterprise Linux 5 ===<br />
<br />
Start a console and create a software repository file if not already present:<br />
<br />
$ vim /etc/yum.repos.d/ox.repo<br />
<br />
[ox]<br />
name=Open-Xchange<br />
baseurl=http://software.open-xchange.com/OX6/6.22/6.22.0/backend/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
and run<br />
<br />
$ yum update<br />
$ yum install open-xchange-caldav open-xchange-carddav open-xchange-webdav-acl open-xchange-webdav-directory<br />
<br />
=== CentOS 5 ===<br />
<br />
Start a console and create a software repository file if not already present:<br />
<br />
$ vim /etc/yum.repos.d/ox.repo<br />
<br />
[ox]<br />
name=Open-Xchange<br />
baseurl=http://software.open-xchange.com/OX6/6.22/6.22.0/backend/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
and run<br />
<br />
$ yum update<br />
$ yum install open-xchange-caldav open-xchange-carddav open-xchange-webdav-acl open-xchange-webdav-directory<br />
<br />
=== CentOS 6 ===<br />
<br />
Start a console and create a software repository file if not already present:<br />
<br />
$ vim /etc/yum.repos.d/ox.repo<br />
<br />
[ox]<br />
name=Open-Xchange<br />
baseurl=http://software.open-xchange.com/OX6/6.22/6.22.0/backend/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
and run<br />
<br />
$ yum update<br />
$ yum install open-xchange-caldav open-xchange-carddav open-xchange-webdav-acl open-xchange-webdav-directory<br />
<br />
== CalDAV Configuration ==<br />
<br />
The following configuration options are available in the configuration files caldav.properties and caldav.yml:<br />
<br />
===com.openexchange.caldav.enabled===<br />
The property '''com.openexchange.caldav.enabled''' governs whether a user has access to the CalDAV interface. This can be configured along the config cascade, in the default setting, everyone that has access to the infostore also has access to caldav. This is achieved in the following way:<br />
<br />
/opt/open-xchange/etc/groupware/caldav.properties:<br />
com.openexchange.caldav.enabled=false<br />
<br />
/opt/open-xchange/etc/groupware/contextSets/caldav.yml<br />
premium:<br />
com.openexchange.caldav.enabled: true<br />
withTags: ucInfostore<br />
<br />
This means: In general CalDAV is turned off, but using the contextSets feature of the config cascade it is turned on for everyone that has infostore access.<br />
<br />
===com.openexchange.caldav.tree===<br />
Configures the ID of the folder tree used by the CalDAV interface. Currently, this should be set to the default value of '0'.<br />
<br />
===com.openexchange.caldav.interval.start===<br />
Defines the minimum end time of appointments to be synchronized via the CalDAV interface, relative to the current date. Possible values are "one_month" (default), "one_year" and "six_months". <br />
<br />
===com.openexchange.caldav.interval.end===<br />
Defines the maximum start time of appointments to be synchronized via the CalDAV interface, relative to the current date. Possible values are "one_year" (default) and "two_years". <br />
<br />
===com.openexchange.caldav.url===<br />
Tells users where to find a caldav folder. This can be displayed in frontends. You can use the variables [hostname] and [folderId]. If you chose to deploy caldav as a virtual host (say 'dav.open-xchange.com') use https://dav.open-xchange.com/caldav/[folderId] as the value. If you are using user-agent sniffing use https://[hostname]/caldav/[folderId].<br />
<br />
<br />
== CardDAV Configuration ==<br />
<br />
The following configuration options are available in the configuration files carddav.properties and carddav.yml:<br />
<br />
===com.openexchange.carddav.enabled===<br />
Similarly to CalDAV, the property '''com.openexchange.carddav.enabled''' governs whether CardDAV is available for a certain user. This is configured exactly like CalDAV with the config cascade only enabling this for users that have access to the infostore:<br />
<br />
/opt/open-xchange/etc/groupware/carddav.properties:<br />
com.openexchange.carddav.enabled=false<br />
<br />
/opt/open-xchange/etc/groupware/contextSets/carddav.yml<br />
premium:<br />
com.openexchange.carddav.enabled: true<br />
withTags: ucInfostore<br />
<br />
===com.openexchange.carddav.ignoreFolders===<br />
A comma-separated list of folder IDs to exclude from the synchronization. Use this to disable syncing of very large folders (e.g. the global address list in large contexts, which always has ID 6). By default, no folders are excluded.<br />
<br />
===com.openexchange.carddav.tree===<br />
Configures the ID of the folder tree used by the CardDAV interface. Currently, this should be set to the default value of '0'.<br />
<br />
===com.openexchange.carddav.exposedCollections===<br />
Controls which collections are exposed via the CardDAV interface. Possible values are '0', '1' and '2'. A value of '1' makes each visible folder available as a resource collection, while '2' only exposes an aggregated collection containing all contact resources from all visible folders. The default value '0' exposes either an aggregated collection or individual collections for each folder, depending on the client's user-agent that is matched against the pattern in 'userAgentForAggregatedCollection'. <br />
<br />
===com.openexchange.carddav.userAgentForAggregatedCollection===<br />
Regular expression to match against the client's user-agent to decide whether the aggregated collection is exposed or not. The default pattern matches all known varieties of the Mac OS Addressbook client, that doesn't support multiple collections. Only used if 'exposedCollections' is set to '0'. The pattern is used case insensitive. <br />
<br />
===com.openexchange.carddav.reducedAggregatedCollection===<br />
Specifies if all visible folders are used to create the aggregated collection, or if a reduced set of folders only containing the global addressbook and the personal contacts folders should be used. This setting only influences the aggregated collection that is used for clients that don't support multiple collections. Possible values are 'true' and 'false.</div>Sgablerhttps://oxpedia.org/wiki/index.php?title=Caldav_carddav_Bundles&diff=11944Caldav carddav Bundles2012-11-09T16:32:48Z<p>Sgabler: /* Debian GNU/Linux 6.0 */</p>
<hr />
<div>= Installation and Configuration of the CalDAV- and CardDAV-bundles =<br />
<br />
The Open-Xchange server can be accessed via it's CalDAV- and CardDAV-interfaces to allow the synchronization of Calendar- and Contact-data with external applications like the Mac OS X iCal and Address Book clients. The synchronization protocols are available and supported for all customers with a valid Open-Xchange license of Open-Xchange Server Edition and Open-Xchange Hosting Edition starting with Version 6.20.1 Rev5.<br />
<br />
CalDAV and CardDAV are standard protocols for the exchange of calendar data and address data respectively. The CalDAV interface publishes all the user's calendar folders via CalDAV so the user can subscribe to them in a client application. Similarly, the CardDAV interface publishes the user's contact folders. Depending on the used client, the user can either subscribe one or more folders, or access all available data in an aggregated way. <br />
<br />
== User Guide and Client Configuration ==<br />
Please find further information regarding the client configuration at [[CalDAVClients]] and [[CardDAVClients]].<br />
<br />
== Webserver Configuration ==<br />
In order to redirect DAV requests to the appropiate servlets, the webserver's configuration may need to be adjusted using one of the following alternatives.<br />
<br />
=== Alternative 1: Apache vhost (recommended) ===<br />
Please edit your file /etc/apache2/ox6.conf so that ''' the existing OX configuration as well as the CalDAV/CardDav configuration are placed inside their own virtual hosts sections.'''.<br />
<br />
This is an <b>example</b> where MYSERVER.TLD is the domain-name of the ox-server:<br />
<br />
$ vi /etc/apache2/ox6.conf <br />
<br />
NameVirtualHost *:80<br />
<VirtualHost *:80><br />
ServerName dav.MYSERVER.TLD<br />
ErrorLog /tmp/dav.err.log<br />
TransferLog /tmp/dav.access.log<br />
<Proxy /><br />
Order allow,deny<br />
Allow from all<br />
</Proxy><br />
ProxyPass / ajp://localhost:8009/servlet/dav/ smax=0 ttl=60 retry=5 # for ajp http service<br />
#ProxyPass / http://localhost:8080/servlet/dav/ smax=0 ttl=60 retry=5 # for grizzly http service<br />
</VirtualHost><br />
<br />
<VirtualHost *:80><br />
ServerName MYSERVER.TLD<br />
ServerAdmin webmaster@localhost<br />
DocumentRoot /var/www/<br />
<br />
<Directory /var/www/><br />
AllowOverride None<br />
Order allow,deny<br />
allow from all<br />
RedirectMatch ^/$ /ox6/<br />
Options +FollowSymLinks +SymLinksIfOwnerMatch<br />
</Directory><br />
# deflate<br />
AddOutputFilterByType DEFLATE text/html text/plain text/javascript application/javascript text/css text/xml application/xml text/x-js application/x-javascript<br />
<br />
# pre-compressed files<br />
AddType text/javascript .jsz<br />
AddType text/css .cssz<br />
AddType text/xml .xmlz<br />
AddType text/plain .po<br />
<br />
AddEncoding gzip .jsz .cssz .xmlz<br />
SetEnvIf Request_URI "\.(jsz|cssz|xmlz)$" no-gzip<br />
<br />
ExpiresActive On<br />
<br />
<Location /ox6><br />
# Expires (via ExpiresByType to override global settings)<br />
ExpiresByType image/gif "access plus 6 months"<br />
ExpiresByType image/png "access plus 6 months"<br />
ExpiresByType image/jpg "access plus 6 months"<br />
ExpiresByType image/jpeg "access plus 6 months"<br />
ExpiresByType text/css "access plus 6 months"<br />
ExpiresByType text/html "access plus 6 months"<br />
ExpiresByType text/xml "access plus 6 months"<br />
ExpiresByType text/javascript "access plus 6 months"<br />
ExpiresByType text/x-js "access plus 6 months"<br />
ExpiresByType application/x-javascript "access plus 6 months"<br />
ExpiresDefault "access plus 6 months"<br />
Header append Cache-Control "private"<br />
Header unset Last-Modified<br />
Header unset Vary<br />
# Strip version<br />
RewriteEngine On<br />
RewriteRule v=\w+/(.+) $1 [L]<br />
# Turn off ETag<br />
Header unset ETag<br />
FileETag None<br />
</Location><br />
<br />
<Location /ox6/ox.html><br />
ExpiresByType text/html "now"<br />
ExpiresDefault "now"<br />
Header unset Last-Modified<br />
Header set Cache-Control "no-store, no-cache, must-revalidate, post-check=0, pre-check=0"<br />
# Turn off ETag<br />
Header unset ETag<br />
FileETag None<br />
</Location><br />
<br />
<Location /ox6/index.html><br />
ExpiresByType text/html "now"<br />
ExpiresDefault "now"<br />
Header unset Last-Modified<br />
Header set Cache-Control "no-store, no-cache, must-revalidate, post-check=0, pre-check=0"<br />
# Turn off ETag<br />
Header unset ETag<br />
FileETag None<br />
</Location><br />
</VirtualHost><br />
<br />
If you use this method, you have to make sure that dav.MYSERVER.TLD is reachable, your dns configuration need an entry for this name. Take care of the the dav.* logfiles, the example writes them without logrotation to /tmp.<br />
<br />
=== Alternative 2: Apache useragent detection ===<br />
For environments where it is inconvenient to setup a vhost there is the possibility to redirect to relevant servlets another way: Via useragent detection. This is not recommended for the following reason: Per definition this is a whitelist-approach and any client sending a useragent-string not explicitly listed in the configuration will not be able to connect . Useragent-strings may also change between different versions of an application or may even be actively changed into something non-standard.<br />
<br />
$ vi /etc/apache2/ox6.conf<br />
<br />
RewriteEngine On<br />
RewriteCond %{HTTP_USER_AGENT} Calendar [OR]<br />
RewriteCond %{HTTP_USER_AGENT} DataAccess [OR]<br />
RewriteCond %{HTTP_USER_AGENT} DAVKit [OR]<br />
RewriteCond %{HTTP_USER_AGENT} Lightning [OR]<br />
RewriteCond %{HTTP_USER_AGENT} Adresboek [OR]<br />
RewriteCond %{HTTP_USER_AGENT} dataaccessd [OR]<br />
RewriteCond %{HTTP_USER_AGENT} Preferences [OR]<br />
RewriteCond %{HTTP_USER_AGENT} Adressbuch [OR]<br />
RewriteCond %{HTTP_USER_AGENT} AddressBook [OR]<br />
RewriteCond %{HTTP_USER_AGENT} Address%20Book [OR]<br />
RewriteCond %{HTTP_USER_AGENT} CalendarStore [OR]<br />
RewriteCond %{HTTP_USER_AGENT} CoreDAV<br />
RewriteRule (.*) ajp://localhost:8009/servlet/dav$1 [P] # for ajp http service<br />
#RewriteRule (.*) http://localhost:8080/servlet/dav$1 [P] # for grizzly http service<br />
<br />
'''Note:''' The address book app on OSX 10.6 uses a localized user-agent string. If you're expecting clients with non-english language settings, you need to add the translated user-agent string to these rewrite rules. For example: "Adressbuch" for german OSX clients.<br />
<br />
<br />
== Which packages do I need? ==<br />
To get CalDAV and CardDAV up and running you need the following packages:<br />
<br />
In v6.20 and earlier:<br />
* open-xchange-webdav-directory - Assembles the *DAV interfaces into a common tree. This is needed for publishing certain properties so clients accept the OX is a WebDAV Server.<br />
* open-xchange-webdav-acl - The WebDAV equivalent of the /ajax/user interface. Allows clients to discover the current and other users and their addressbooks and calendars.<br />
* open-xchange-carddav - The CardDAV interface exposing the users addressbook via carddav<br />
* open-xchange-caldav - The CalDAV inteface exposing the users calendars via caldav<br />
<br />
<br />
With v6.22 we have significantly reduced the number of packages necessary to install Open-Xchange Server.<br />
In v6.22 and later only one package is needed:<br />
* open-xchange-dav <br />
<br />
{{InstallPlugin|pluginname=open-xchange-caldav open-xchange-carddav open-xchange-webdav-acl open-xchange-webdav-directory |sopath=updates}}<br />
<br />
== Installation on Open-Xchange v6.22 == <br />
<br />
=== Debian GNU/Linux 6.0 === <br />
<br />
Add the following entry to /etc/apt/sources.list if not already present:<br />
<br />
deb http://software.open-xchange.com/OX6/6.22/6.22.0/backend/DebianSqueeze/all/<br />
<br />
and run<br />
<br />
$ apt-get update<br />
$ apt-get install open-xchange-dav<br />
<br />
=== SUSE Linux Enterprise Server 11 ===<br />
<br />
Add the package repository using zypper if not already present:<br />
<br />
$ zypper ar http://software.open-xchange.com/OX6/6.22/6.22.0/backend/SLES11 ox<br />
<br />
and run<br />
<br />
$ zypper ref<br />
$ zypper in open-xchange-caldav open-xchange-carddav open-xchange-webdav-acl open-xchange-webdav-directory<br />
<br />
=== RedHat Enterprise Linux 6 ===<br />
<br />
Start a console and create a software repository file if not already present:<br />
<br />
$ vim /etc/yum.repos.d/ox.repo<br />
<br />
[ox]<br />
name=Open-Xchange<br />
baseurl=http://software.open-xchange.com/OX6/6.22/6.22.0/backend/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
and run<br />
<br />
$ yum update<br />
$ yum install open-xchange-caldav open-xchange-carddav open-xchange-webdav-acl open-xchange-webdav-directory<br />
<br />
=== RedHat Enterprise Linux 5 ===<br />
<br />
Start a console and create a software repository file if not already present:<br />
<br />
$ vim /etc/yum.repos.d/ox.repo<br />
<br />
[ox]<br />
name=Open-Xchange<br />
baseurl=http://software.open-xchange.com/OX6/6.22/6.22.0/backend/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
and run<br />
<br />
$ yum update<br />
$ yum install open-xchange-caldav open-xchange-carddav open-xchange-webdav-acl open-xchange-webdav-directory<br />
<br />
=== CentOS 5 ===<br />
<br />
Start a console and create a software repository file if not already present:<br />
<br />
$ vim /etc/yum.repos.d/ox.repo<br />
<br />
[ox]<br />
name=Open-Xchange<br />
baseurl=http://software.open-xchange.com/OX6/6.22/6.22.0/backend/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
and run<br />
<br />
$ yum update<br />
$ yum install open-xchange-caldav open-xchange-carddav open-xchange-webdav-acl open-xchange-webdav-directory<br />
<br />
=== CentOS 6 ===<br />
<br />
Start a console and create a software repository file if not already present:<br />
<br />
$ vim /etc/yum.repos.d/ox.repo<br />
<br />
[ox]<br />
name=Open-Xchange<br />
baseurl=http://software.open-xchange.com/OX6/6.22/6.22.0/backend/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
and run<br />
<br />
$ yum update<br />
$ yum install open-xchange-caldav open-xchange-carddav open-xchange-webdav-acl open-xchange-webdav-directory<br />
<br />
== CalDAV Configuration ==<br />
<br />
The following configuration options are available in the configuration files caldav.properties and caldav.yml:<br />
<br />
===com.openexchange.caldav.enabled===<br />
The property '''com.openexchange.caldav.enabled''' governs whether a user has access to the CalDAV interface. This can be configured along the config cascade, in the default setting, everyone that has access to the infostore also has access to caldav. This is achieved in the following way:<br />
<br />
/opt/open-xchange/etc/groupware/caldav.properties:<br />
com.openexchange.caldav.enabled=false<br />
<br />
/opt/open-xchange/etc/groupware/contextSets/caldav.yml<br />
premium:<br />
com.openexchange.caldav.enabled: true<br />
withTags: ucInfostore<br />
<br />
This means: In general CalDAV is turned off, but using the contextSets feature of the config cascade it is turned on for everyone that has infostore access.<br />
<br />
===com.openexchange.caldav.tree===<br />
Configures the ID of the folder tree used by the CalDAV interface. Currently, this should be set to the default value of '0'.<br />
<br />
===com.openexchange.caldav.interval.start===<br />
Defines the minimum end time of appointments to be synchronized via the CalDAV interface, relative to the current date. Possible values are "one_month" (default), "one_year" and "six_months". <br />
<br />
===com.openexchange.caldav.interval.end===<br />
Defines the maximum start time of appointments to be synchronized via the CalDAV interface, relative to the current date. Possible values are "one_year" (default) and "two_years". <br />
<br />
===com.openexchange.caldav.url===<br />
Tells users where to find a caldav folder. This can be displayed in frontends. You can use the variables [hostname] and [folderId]. If you chose to deploy caldav as a virtual host (say 'dav.open-xchange.com') use https://dav.open-xchange.com/caldav/[folderId] as the value. If you are using user-agent sniffing use https://[hostname]/caldav/[folderId].<br />
<br />
<br />
== CardDAV Configuration ==<br />
<br />
The following configuration options are available in the configuration files carddav.properties and carddav.yml:<br />
<br />
===com.openexchange.carddav.enabled===<br />
Similarly to CalDAV, the property '''com.openexchange.carddav.enabled''' governs whether CardDAV is available for a certain user. This is configured exactly like CalDAV with the config cascade only enabling this for users that have access to the infostore:<br />
<br />
/opt/open-xchange/etc/groupware/carddav.properties:<br />
com.openexchange.carddav.enabled=false<br />
<br />
/opt/open-xchange/etc/groupware/contextSets/carddav.yml<br />
premium:<br />
com.openexchange.carddav.enabled: true<br />
withTags: ucInfostore<br />
<br />
===com.openexchange.carddav.ignoreFolders===<br />
A comma-separated list of folder IDs to exclude from the synchronization. Use this to disable syncing of very large folders (e.g. the global address list in large contexts, which always has ID 6). By default, no folders are excluded.<br />
<br />
===com.openexchange.carddav.tree===<br />
Configures the ID of the folder tree used by the CardDAV interface. Currently, this should be set to the default value of '0'.<br />
<br />
===com.openexchange.carddav.exposedCollections===<br />
Controls which collections are exposed via the CardDAV interface. Possible values are '0', '1' and '2'. A value of '1' makes each visible folder available as a resource collection, while '2' only exposes an aggregated collection containing all contact resources from all visible folders. The default value '0' exposes either an aggregated collection or individual collections for each folder, depending on the client's user-agent that is matched against the pattern in 'userAgentForAggregatedCollection'. <br />
<br />
===com.openexchange.carddav.userAgentForAggregatedCollection===<br />
Regular expression to match against the client's user-agent to decide whether the aggregated collection is exposed or not. The default pattern matches all known varieties of the Mac OS Addressbook client, that doesn't support multiple collections. Only used if 'exposedCollections' is set to '0'. The pattern is used case insensitive. <br />
<br />
===com.openexchange.carddav.reducedAggregatedCollection===<br />
Specifies if all visible folders are used to create the aggregated collection, or if a reduced set of folders only containing the global addressbook and the personal contacts folders should be used. This setting only influences the aggregated collection that is used for clients that don't support multiple collections. Possible values are 'true' and 'false.</div>Sgablerhttps://oxpedia.org/wiki/index.php?title=Caldav_carddav_Bundles&diff=11943Caldav carddav Bundles2012-11-09T15:46:00Z<p>Sgabler: /* Which packages do I need? */</p>
<hr />
<div>= Installation and Configuration of the CalDAV- and CardDAV-bundles =<br />
<br />
The Open-Xchange server can be accessed via it's CalDAV- and CardDAV-interfaces to allow the synchronization of Calendar- and Contact-data with external applications like the Mac OS X iCal and Address Book clients. The synchronization protocols are available and supported for all customers with a valid Open-Xchange license of Open-Xchange Server Edition and Open-Xchange Hosting Edition starting with Version 6.20.1 Rev5.<br />
<br />
CalDAV and CardDAV are standard protocols for the exchange of calendar data and address data respectively. The CalDAV interface publishes all the user's calendar folders via CalDAV so the user can subscribe to them in a client application. Similarly, the CardDAV interface publishes the user's contact folders. Depending on the used client, the user can either subscribe one or more folders, or access all available data in an aggregated way. <br />
<br />
== User Guide and Client Configuration ==<br />
Please find further information regarding the client configuration at [[CalDAVClients]] and [[CardDAVClients]].<br />
<br />
== Webserver Configuration ==<br />
In order to redirect DAV requests to the appropiate servlets, the webserver's configuration may need to be adjusted using one of the following alternatives.<br />
<br />
=== Alternative 1: Apache vhost (recommended) ===<br />
Please edit your file /etc/apache2/ox6.conf so that ''' the existing OX configuration as well as the CalDAV/CardDav configuration are placed inside their own virtual hosts sections.'''.<br />
<br />
This is an <b>example</b> where MYSERVER.TLD is the domain-name of the ox-server:<br />
<br />
$ vi /etc/apache2/ox6.conf <br />
<br />
NameVirtualHost *:80<br />
<VirtualHost *:80><br />
ServerName dav.MYSERVER.TLD<br />
ErrorLog /tmp/dav.err.log<br />
TransferLog /tmp/dav.access.log<br />
<Proxy /><br />
Order allow,deny<br />
Allow from all<br />
</Proxy><br />
ProxyPass / ajp://localhost:8009/servlet/dav/ smax=0 ttl=60 retry=5 # for ajp http service<br />
#ProxyPass / http://localhost:8080/servlet/dav/ smax=0 ttl=60 retry=5 # for grizzly http service<br />
</VirtualHost><br />
<br />
<VirtualHost *:80><br />
ServerName MYSERVER.TLD<br />
ServerAdmin webmaster@localhost<br />
DocumentRoot /var/www/<br />
<br />
<Directory /var/www/><br />
AllowOverride None<br />
Order allow,deny<br />
allow from all<br />
RedirectMatch ^/$ /ox6/<br />
Options +FollowSymLinks +SymLinksIfOwnerMatch<br />
</Directory><br />
# deflate<br />
AddOutputFilterByType DEFLATE text/html text/plain text/javascript application/javascript text/css text/xml application/xml text/x-js application/x-javascript<br />
<br />
# pre-compressed files<br />
AddType text/javascript .jsz<br />
AddType text/css .cssz<br />
AddType text/xml .xmlz<br />
AddType text/plain .po<br />
<br />
AddEncoding gzip .jsz .cssz .xmlz<br />
SetEnvIf Request_URI "\.(jsz|cssz|xmlz)$" no-gzip<br />
<br />
ExpiresActive On<br />
<br />
<Location /ox6><br />
# Expires (via ExpiresByType to override global settings)<br />
ExpiresByType image/gif "access plus 6 months"<br />
ExpiresByType image/png "access plus 6 months"<br />
ExpiresByType image/jpg "access plus 6 months"<br />
ExpiresByType image/jpeg "access plus 6 months"<br />
ExpiresByType text/css "access plus 6 months"<br />
ExpiresByType text/html "access plus 6 months"<br />
ExpiresByType text/xml "access plus 6 months"<br />
ExpiresByType text/javascript "access plus 6 months"<br />
ExpiresByType text/x-js "access plus 6 months"<br />
ExpiresByType application/x-javascript "access plus 6 months"<br />
ExpiresDefault "access plus 6 months"<br />
Header append Cache-Control "private"<br />
Header unset Last-Modified<br />
Header unset Vary<br />
# Strip version<br />
RewriteEngine On<br />
RewriteRule v=\w+/(.+) $1 [L]<br />
# Turn off ETag<br />
Header unset ETag<br />
FileETag None<br />
</Location><br />
<br />
<Location /ox6/ox.html><br />
ExpiresByType text/html "now"<br />
ExpiresDefault "now"<br />
Header unset Last-Modified<br />
Header set Cache-Control "no-store, no-cache, must-revalidate, post-check=0, pre-check=0"<br />
# Turn off ETag<br />
Header unset ETag<br />
FileETag None<br />
</Location><br />
<br />
<Location /ox6/index.html><br />
ExpiresByType text/html "now"<br />
ExpiresDefault "now"<br />
Header unset Last-Modified<br />
Header set Cache-Control "no-store, no-cache, must-revalidate, post-check=0, pre-check=0"<br />
# Turn off ETag<br />
Header unset ETag<br />
FileETag None<br />
</Location><br />
</VirtualHost><br />
<br />
If you use this method, you have to make sure that dav.MYSERVER.TLD is reachable, your dns configuration need an entry for this name. Take care of the the dav.* logfiles, the example writes them without logrotation to /tmp.<br />
<br />
=== Alternative 2: Apache useragent detection ===<br />
For environments where it is inconvenient to setup a vhost there is the possibility to redirect to relevant servlets another way: Via useragent detection. This is not recommended for the following reason: Per definition this is a whitelist-approach and any client sending a useragent-string not explicitly listed in the configuration will not be able to connect . Useragent-strings may also change between different versions of an application or may even be actively changed into something non-standard.<br />
<br />
$ vi /etc/apache2/ox6.conf<br />
<br />
RewriteEngine On<br />
RewriteCond %{HTTP_USER_AGENT} Calendar [OR]<br />
RewriteCond %{HTTP_USER_AGENT} DataAccess [OR]<br />
RewriteCond %{HTTP_USER_AGENT} DAVKit [OR]<br />
RewriteCond %{HTTP_USER_AGENT} Lightning [OR]<br />
RewriteCond %{HTTP_USER_AGENT} Adresboek [OR]<br />
RewriteCond %{HTTP_USER_AGENT} dataaccessd [OR]<br />
RewriteCond %{HTTP_USER_AGENT} Preferences [OR]<br />
RewriteCond %{HTTP_USER_AGENT} Adressbuch [OR]<br />
RewriteCond %{HTTP_USER_AGENT} AddressBook [OR]<br />
RewriteCond %{HTTP_USER_AGENT} Address%20Book [OR]<br />
RewriteCond %{HTTP_USER_AGENT} CalendarStore [OR]<br />
RewriteCond %{HTTP_USER_AGENT} CoreDAV<br />
RewriteRule (.*) ajp://localhost:8009/servlet/dav$1 [P] # for ajp http service<br />
#RewriteRule (.*) http://localhost:8080/servlet/dav$1 [P] # for grizzly http service<br />
<br />
'''Note:''' The address book app on OSX 10.6 uses a localized user-agent string. If you're expecting clients with non-english language settings, you need to add the translated user-agent string to these rewrite rules. For example: "Adressbuch" for german OSX clients.<br />
<br />
<br />
== Which packages do I need? ==<br />
To get CalDAV and CardDAV up and running you need the following packages:<br />
<br />
In v6.20 and earlier:<br />
* open-xchange-webdav-directory - Assembles the *DAV interfaces into a common tree. This is needed for publishing certain properties so clients accept the OX is a WebDAV Server.<br />
* open-xchange-webdav-acl - The WebDAV equivalent of the /ajax/user interface. Allows clients to discover the current and other users and their addressbooks and calendars.<br />
* open-xchange-carddav - The CardDAV interface exposing the users addressbook via carddav<br />
* open-xchange-caldav - The CalDAV inteface exposing the users calendars via caldav<br />
<br />
<br />
With v6.22 we have significantly reduced the number of packages necessary to install Open-Xchange Server.<br />
In v6.22 and later only one package is needed:<br />
* open-xchange-dav <br />
<br />
{{InstallPlugin|pluginname=open-xchange-caldav open-xchange-carddav open-xchange-webdav-acl open-xchange-webdav-directory |sopath=updates}}<br />
<br />
== Installation on Open-Xchange v6.22 == <br />
<br />
=== Debian GNU/Linux 6.0 === <br />
<br />
Add the following entry to /etc/apt/sources.list if not already present:<br />
<br />
deb http://software.open-xchange.com/OX6/6.22/6.22.0/backend/DebianSqueeze/all/<br />
<br />
and run<br />
<br />
$ apt-get update<br />
$ apt-get install open-xchange-caldav open-xchange-carddav open-xchange-webdav-acl open-xchange-webdav-directory<br />
<br />
=== SUSE Linux Enterprise Server 11 ===<br />
<br />
Add the package repository using zypper if not already present:<br />
<br />
$ zypper ar http://software.open-xchange.com/OX6/6.22/6.22.0/backend/SLES11 ox<br />
<br />
and run<br />
<br />
$ zypper ref<br />
$ zypper in open-xchange-caldav open-xchange-carddav open-xchange-webdav-acl open-xchange-webdav-directory<br />
<br />
=== RedHat Enterprise Linux 6 ===<br />
<br />
Start a console and create a software repository file if not already present:<br />
<br />
$ vim /etc/yum.repos.d/ox.repo<br />
<br />
[ox]<br />
name=Open-Xchange<br />
baseurl=http://software.open-xchange.com/OX6/6.22/6.22.0/backend/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
and run<br />
<br />
$ yum update<br />
$ yum install open-xchange-caldav open-xchange-carddav open-xchange-webdav-acl open-xchange-webdav-directory<br />
<br />
=== RedHat Enterprise Linux 5 ===<br />
<br />
Start a console and create a software repository file if not already present:<br />
<br />
$ vim /etc/yum.repos.d/ox.repo<br />
<br />
[ox]<br />
name=Open-Xchange<br />
baseurl=http://software.open-xchange.com/OX6/6.22/6.22.0/backend/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
and run<br />
<br />
$ yum update<br />
$ yum install open-xchange-caldav open-xchange-carddav open-xchange-webdav-acl open-xchange-webdav-directory<br />
<br />
=== CentOS 5 ===<br />
<br />
Start a console and create a software repository file if not already present:<br />
<br />
$ vim /etc/yum.repos.d/ox.repo<br />
<br />
[ox]<br />
name=Open-Xchange<br />
baseurl=http://software.open-xchange.com/OX6/6.22/6.22.0/backend/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
and run<br />
<br />
$ yum update<br />
$ yum install open-xchange-caldav open-xchange-carddav open-xchange-webdav-acl open-xchange-webdav-directory<br />
<br />
=== CentOS 6 ===<br />
<br />
Start a console and create a software repository file if not already present:<br />
<br />
$ vim /etc/yum.repos.d/ox.repo<br />
<br />
[ox]<br />
name=Open-Xchange<br />
baseurl=http://software.open-xchange.com/OX6/6.22/6.22.0/backend/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
and run<br />
<br />
$ yum update<br />
$ yum install open-xchange-caldav open-xchange-carddav open-xchange-webdav-acl open-xchange-webdav-directory<br />
<br />
== CalDAV Configuration ==<br />
<br />
The following configuration options are available in the configuration files caldav.properties and caldav.yml:<br />
<br />
===com.openexchange.caldav.enabled===<br />
The property '''com.openexchange.caldav.enabled''' governs whether a user has access to the CalDAV interface. This can be configured along the config cascade, in the default setting, everyone that has access to the infostore also has access to caldav. This is achieved in the following way:<br />
<br />
/opt/open-xchange/etc/groupware/caldav.properties:<br />
com.openexchange.caldav.enabled=false<br />
<br />
/opt/open-xchange/etc/groupware/contextSets/caldav.yml<br />
premium:<br />
com.openexchange.caldav.enabled: true<br />
withTags: ucInfostore<br />
<br />
This means: In general CalDAV is turned off, but using the contextSets feature of the config cascade it is turned on for everyone that has infostore access.<br />
<br />
===com.openexchange.caldav.tree===<br />
Configures the ID of the folder tree used by the CalDAV interface. Currently, this should be set to the default value of '0'.<br />
<br />
===com.openexchange.caldav.interval.start===<br />
Defines the minimum end time of appointments to be synchronized via the CalDAV interface, relative to the current date. Possible values are "one_month" (default), "one_year" and "six_months". <br />
<br />
===com.openexchange.caldav.interval.end===<br />
Defines the maximum start time of appointments to be synchronized via the CalDAV interface, relative to the current date. Possible values are "one_year" (default) and "two_years". <br />
<br />
===com.openexchange.caldav.url===<br />
Tells users where to find a caldav folder. This can be displayed in frontends. You can use the variables [hostname] and [folderId]. If you chose to deploy caldav as a virtual host (say 'dav.open-xchange.com') use https://dav.open-xchange.com/caldav/[folderId] as the value. If you are using user-agent sniffing use https://[hostname]/caldav/[folderId].<br />
<br />
<br />
== CardDAV Configuration ==<br />
<br />
The following configuration options are available in the configuration files carddav.properties and carddav.yml:<br />
<br />
===com.openexchange.carddav.enabled===<br />
Similarly to CalDAV, the property '''com.openexchange.carddav.enabled''' governs whether CardDAV is available for a certain user. This is configured exactly like CalDAV with the config cascade only enabling this for users that have access to the infostore:<br />
<br />
/opt/open-xchange/etc/groupware/carddav.properties:<br />
com.openexchange.carddav.enabled=false<br />
<br />
/opt/open-xchange/etc/groupware/contextSets/carddav.yml<br />
premium:<br />
com.openexchange.carddav.enabled: true<br />
withTags: ucInfostore<br />
<br />
===com.openexchange.carddav.ignoreFolders===<br />
A comma-separated list of folder IDs to exclude from the synchronization. Use this to disable syncing of very large folders (e.g. the global address list in large contexts, which always has ID 6). By default, no folders are excluded.<br />
<br />
===com.openexchange.carddav.tree===<br />
Configures the ID of the folder tree used by the CardDAV interface. Currently, this should be set to the default value of '0'.<br />
<br />
===com.openexchange.carddav.exposedCollections===<br />
Controls which collections are exposed via the CardDAV interface. Possible values are '0', '1' and '2'. A value of '1' makes each visible folder available as a resource collection, while '2' only exposes an aggregated collection containing all contact resources from all visible folders. The default value '0' exposes either an aggregated collection or individual collections for each folder, depending on the client's user-agent that is matched against the pattern in 'userAgentForAggregatedCollection'. <br />
<br />
===com.openexchange.carddav.userAgentForAggregatedCollection===<br />
Regular expression to match against the client's user-agent to decide whether the aggregated collection is exposed or not. The default pattern matches all known varieties of the Mac OS Addressbook client, that doesn't support multiple collections. Only used if 'exposedCollections' is set to '0'. The pattern is used case insensitive. <br />
<br />
===com.openexchange.carddav.reducedAggregatedCollection===<br />
Specifies if all visible folders are used to create the aggregated collection, or if a reduced set of folders only containing the global addressbook and the personal contacts folders should be used. This setting only influences the aggregated collection that is used for clients that don't support multiple collections. Possible values are 'true' and 'false.</div>Sgablerhttps://oxpedia.org/wiki/index.php?title=Caldav_carddav_Bundles&diff=11942Caldav carddav Bundles2012-11-09T15:06:26Z<p>Sgabler: /* Which packages do I need? */</p>
<hr />
<div>= Installation and Configuration of the CalDAV- and CardDAV-bundles =<br />
<br />
The Open-Xchange server can be accessed via it's CalDAV- and CardDAV-interfaces to allow the synchronization of Calendar- and Contact-data with external applications like the Mac OS X iCal and Address Book clients. The synchronization protocols are available and supported for all customers with a valid Open-Xchange license of Open-Xchange Server Edition and Open-Xchange Hosting Edition starting with Version 6.20.1 Rev5.<br />
<br />
CalDAV and CardDAV are standard protocols for the exchange of calendar data and address data respectively. The CalDAV interface publishes all the user's calendar folders via CalDAV so the user can subscribe to them in a client application. Similarly, the CardDAV interface publishes the user's contact folders. Depending on the used client, the user can either subscribe one or more folders, or access all available data in an aggregated way. <br />
<br />
== User Guide and Client Configuration ==<br />
Please find further information regarding the client configuration at [[CalDAVClients]] and [[CardDAVClients]].<br />
<br />
== Webserver Configuration ==<br />
In order to redirect DAV requests to the appropiate servlets, the webserver's configuration may need to be adjusted using one of the following alternatives.<br />
<br />
=== Alternative 1: Apache vhost (recommended) ===<br />
Please edit your file /etc/apache2/ox6.conf so that ''' the existing OX configuration as well as the CalDAV/CardDav configuration are placed inside their own virtual hosts sections.'''.<br />
<br />
This is an <b>example</b> where MYSERVER.TLD is the domain-name of the ox-server:<br />
<br />
$ vi /etc/apache2/ox6.conf <br />
<br />
NameVirtualHost *:80<br />
<VirtualHost *:80><br />
ServerName dav.MYSERVER.TLD<br />
ErrorLog /tmp/dav.err.log<br />
TransferLog /tmp/dav.access.log<br />
<Proxy /><br />
Order allow,deny<br />
Allow from all<br />
</Proxy><br />
ProxyPass / ajp://localhost:8009/servlet/dav/ smax=0 ttl=60 retry=5 # for ajp http service<br />
#ProxyPass / http://localhost:8080/servlet/dav/ smax=0 ttl=60 retry=5 # for grizzly http service<br />
</VirtualHost><br />
<br />
<VirtualHost *:80><br />
ServerName MYSERVER.TLD<br />
ServerAdmin webmaster@localhost<br />
DocumentRoot /var/www/<br />
<br />
<Directory /var/www/><br />
AllowOverride None<br />
Order allow,deny<br />
allow from all<br />
RedirectMatch ^/$ /ox6/<br />
Options +FollowSymLinks +SymLinksIfOwnerMatch<br />
</Directory><br />
# deflate<br />
AddOutputFilterByType DEFLATE text/html text/plain text/javascript application/javascript text/css text/xml application/xml text/x-js application/x-javascript<br />
<br />
# pre-compressed files<br />
AddType text/javascript .jsz<br />
AddType text/css .cssz<br />
AddType text/xml .xmlz<br />
AddType text/plain .po<br />
<br />
AddEncoding gzip .jsz .cssz .xmlz<br />
SetEnvIf Request_URI "\.(jsz|cssz|xmlz)$" no-gzip<br />
<br />
ExpiresActive On<br />
<br />
<Location /ox6><br />
# Expires (via ExpiresByType to override global settings)<br />
ExpiresByType image/gif "access plus 6 months"<br />
ExpiresByType image/png "access plus 6 months"<br />
ExpiresByType image/jpg "access plus 6 months"<br />
ExpiresByType image/jpeg "access plus 6 months"<br />
ExpiresByType text/css "access plus 6 months"<br />
ExpiresByType text/html "access plus 6 months"<br />
ExpiresByType text/xml "access plus 6 months"<br />
ExpiresByType text/javascript "access plus 6 months"<br />
ExpiresByType text/x-js "access plus 6 months"<br />
ExpiresByType application/x-javascript "access plus 6 months"<br />
ExpiresDefault "access plus 6 months"<br />
Header append Cache-Control "private"<br />
Header unset Last-Modified<br />
Header unset Vary<br />
# Strip version<br />
RewriteEngine On<br />
RewriteRule v=\w+/(.+) $1 [L]<br />
# Turn off ETag<br />
Header unset ETag<br />
FileETag None<br />
</Location><br />
<br />
<Location /ox6/ox.html><br />
ExpiresByType text/html "now"<br />
ExpiresDefault "now"<br />
Header unset Last-Modified<br />
Header set Cache-Control "no-store, no-cache, must-revalidate, post-check=0, pre-check=0"<br />
# Turn off ETag<br />
Header unset ETag<br />
FileETag None<br />
</Location><br />
<br />
<Location /ox6/index.html><br />
ExpiresByType text/html "now"<br />
ExpiresDefault "now"<br />
Header unset Last-Modified<br />
Header set Cache-Control "no-store, no-cache, must-revalidate, post-check=0, pre-check=0"<br />
# Turn off ETag<br />
Header unset ETag<br />
FileETag None<br />
</Location><br />
</VirtualHost><br />
<br />
If you use this method, you have to make sure that dav.MYSERVER.TLD is reachable, your dns configuration need an entry for this name. Take care of the the dav.* logfiles, the example writes them without logrotation to /tmp.<br />
<br />
=== Alternative 2: Apache useragent detection ===<br />
For environments where it is inconvenient to setup a vhost there is the possibility to redirect to relevant servlets another way: Via useragent detection. This is not recommended for the following reason: Per definition this is a whitelist-approach and any client sending a useragent-string not explicitly listed in the configuration will not be able to connect . Useragent-strings may also change between different versions of an application or may even be actively changed into something non-standard.<br />
<br />
$ vi /etc/apache2/ox6.conf<br />
<br />
RewriteEngine On<br />
RewriteCond %{HTTP_USER_AGENT} Calendar [OR]<br />
RewriteCond %{HTTP_USER_AGENT} DataAccess [OR]<br />
RewriteCond %{HTTP_USER_AGENT} DAVKit [OR]<br />
RewriteCond %{HTTP_USER_AGENT} Lightning [OR]<br />
RewriteCond %{HTTP_USER_AGENT} Adresboek [OR]<br />
RewriteCond %{HTTP_USER_AGENT} dataaccessd [OR]<br />
RewriteCond %{HTTP_USER_AGENT} Preferences [OR]<br />
RewriteCond %{HTTP_USER_AGENT} Adressbuch [OR]<br />
RewriteCond %{HTTP_USER_AGENT} AddressBook [OR]<br />
RewriteCond %{HTTP_USER_AGENT} Address%20Book [OR]<br />
RewriteCond %{HTTP_USER_AGENT} CalendarStore [OR]<br />
RewriteCond %{HTTP_USER_AGENT} CoreDAV<br />
RewriteRule (.*) ajp://localhost:8009/servlet/dav$1 [P] # for ajp http service<br />
#RewriteRule (.*) http://localhost:8080/servlet/dav$1 [P] # for grizzly http service<br />
<br />
'''Note:''' The address book app on OSX 10.6 uses a localized user-agent string. If you're expecting clients with non-english language settings, you need to add the translated user-agent string to these rewrite rules. For example: "Adressbuch" for german OSX clients.<br />
<br />
<br />
== Which packages do I need? ==<br />
To get CalDAV and CardDAV up and running you need the following packages:<br />
<br />
In v6.20 and earlier:<br />
* open-xchange-webdav-directory - Assembles the *DAV interfaces into a common tree. This is needed for publishing certain properties so clients accept the OX is a WebDAV Server.<br />
* open-xchange-webdav-acl - The WebDAV equivalent of the /ajax/user interface. Allows clients to discover the current and other users and their addressbooks and calendars.<br />
* open-xchange-carddav - The CardDAV interface exposing the users addressbook via carddav<br />
* open-xchange-caldav - The CalDAV inteface exposing the users calendars via caldav<br />
<br />
With v6.22 we have significantly reduced the number of packages necessary to install Open-Xchange Server.<br />
In v6.22 and later only one package is needed:<br />
* open-xchange-dav <br />
<br />
{{InstallPlugin|pluginname=open-xchange-caldav open-xchange-carddav open-xchange-webdav-acl open-xchange-webdav-directory |sopath=updates}}<br />
<br />
== Installation on Open-Xchange v6.22 == <br />
<br />
=== Debian GNU/Linux 6.0 === <br />
<br />
Add the following entry to /etc/apt/sources.list if not already present:<br />
<br />
deb http://software.open-xchange.com/OX6/6.22/6.22.0/backend/DebianSqueeze/all/<br />
<br />
and run<br />
<br />
$ apt-get update<br />
$ apt-get install open-xchange-caldav open-xchange-carddav open-xchange-webdav-acl open-xchange-webdav-directory<br />
<br />
=== SUSE Linux Enterprise Server 11 ===<br />
<br />
Add the package repository using zypper if not already present:<br />
<br />
$ zypper ar http://software.open-xchange.com/OX6/6.22/6.22.0/backend/SLES11 ox<br />
<br />
and run<br />
<br />
$ zypper ref<br />
$ zypper in open-xchange-caldav open-xchange-carddav open-xchange-webdav-acl open-xchange-webdav-directory<br />
<br />
=== RedHat Enterprise Linux 6 ===<br />
<br />
Start a console and create a software repository file if not already present:<br />
<br />
$ vim /etc/yum.repos.d/ox.repo<br />
<br />
[ox]<br />
name=Open-Xchange<br />
baseurl=http://software.open-xchange.com/OX6/6.22/6.22.0/backend/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
and run<br />
<br />
$ yum update<br />
$ yum install open-xchange-caldav open-xchange-carddav open-xchange-webdav-acl open-xchange-webdav-directory<br />
<br />
=== RedHat Enterprise Linux 5 ===<br />
<br />
Start a console and create a software repository file if not already present:<br />
<br />
$ vim /etc/yum.repos.d/ox.repo<br />
<br />
[ox]<br />
name=Open-Xchange<br />
baseurl=http://software.open-xchange.com/OX6/6.22/6.22.0/backend/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
and run<br />
<br />
$ yum update<br />
$ yum install open-xchange-caldav open-xchange-carddav open-xchange-webdav-acl open-xchange-webdav-directory<br />
<br />
=== CentOS 5 ===<br />
<br />
Start a console and create a software repository file if not already present:<br />
<br />
$ vim /etc/yum.repos.d/ox.repo<br />
<br />
[ox]<br />
name=Open-Xchange<br />
baseurl=http://software.open-xchange.com/OX6/6.22/6.22.0/backend/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
and run<br />
<br />
$ yum update<br />
$ yum install open-xchange-caldav open-xchange-carddav open-xchange-webdav-acl open-xchange-webdav-directory<br />
<br />
=== CentOS 6 ===<br />
<br />
Start a console and create a software repository file if not already present:<br />
<br />
$ vim /etc/yum.repos.d/ox.repo<br />
<br />
[ox]<br />
name=Open-Xchange<br />
baseurl=http://software.open-xchange.com/OX6/6.22/6.22.0/backend/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
and run<br />
<br />
$ yum update<br />
$ yum install open-xchange-caldav open-xchange-carddav open-xchange-webdav-acl open-xchange-webdav-directory<br />
<br />
== CalDAV Configuration ==<br />
<br />
The following configuration options are available in the configuration files caldav.properties and caldav.yml:<br />
<br />
===com.openexchange.caldav.enabled===<br />
The property '''com.openexchange.caldav.enabled''' governs whether a user has access to the CalDAV interface. This can be configured along the config cascade, in the default setting, everyone that has access to the infostore also has access to caldav. This is achieved in the following way:<br />
<br />
/opt/open-xchange/etc/groupware/caldav.properties:<br />
com.openexchange.caldav.enabled=false<br />
<br />
/opt/open-xchange/etc/groupware/contextSets/caldav.yml<br />
premium:<br />
com.openexchange.caldav.enabled: true<br />
withTags: ucInfostore<br />
<br />
This means: In general CalDAV is turned off, but using the contextSets feature of the config cascade it is turned on for everyone that has infostore access.<br />
<br />
===com.openexchange.caldav.tree===<br />
Configures the ID of the folder tree used by the CalDAV interface. Currently, this should be set to the default value of '0'.<br />
<br />
===com.openexchange.caldav.interval.start===<br />
Defines the minimum end time of appointments to be synchronized via the CalDAV interface, relative to the current date. Possible values are "one_month" (default), "one_year" and "six_months". <br />
<br />
===com.openexchange.caldav.interval.end===<br />
Defines the maximum start time of appointments to be synchronized via the CalDAV interface, relative to the current date. Possible values are "one_year" (default) and "two_years". <br />
<br />
===com.openexchange.caldav.url===<br />
Tells users where to find a caldav folder. This can be displayed in frontends. You can use the variables [hostname] and [folderId]. If you chose to deploy caldav as a virtual host (say 'dav.open-xchange.com') use https://dav.open-xchange.com/caldav/[folderId] as the value. If you are using user-agent sniffing use https://[hostname]/caldav/[folderId].<br />
<br />
<br />
== CardDAV Configuration ==<br />
<br />
The following configuration options are available in the configuration files carddav.properties and carddav.yml:<br />
<br />
===com.openexchange.carddav.enabled===<br />
Similarly to CalDAV, the property '''com.openexchange.carddav.enabled''' governs whether CardDAV is available for a certain user. This is configured exactly like CalDAV with the config cascade only enabling this for users that have access to the infostore:<br />
<br />
/opt/open-xchange/etc/groupware/carddav.properties:<br />
com.openexchange.carddav.enabled=false<br />
<br />
/opt/open-xchange/etc/groupware/contextSets/carddav.yml<br />
premium:<br />
com.openexchange.carddav.enabled: true<br />
withTags: ucInfostore<br />
<br />
===com.openexchange.carddav.ignoreFolders===<br />
A comma-separated list of folder IDs to exclude from the synchronization. Use this to disable syncing of very large folders (e.g. the global address list in large contexts, which always has ID 6). By default, no folders are excluded.<br />
<br />
===com.openexchange.carddav.tree===<br />
Configures the ID of the folder tree used by the CardDAV interface. Currently, this should be set to the default value of '0'.<br />
<br />
===com.openexchange.carddav.exposedCollections===<br />
Controls which collections are exposed via the CardDAV interface. Possible values are '0', '1' and '2'. A value of '1' makes each visible folder available as a resource collection, while '2' only exposes an aggregated collection containing all contact resources from all visible folders. The default value '0' exposes either an aggregated collection or individual collections for each folder, depending on the client's user-agent that is matched against the pattern in 'userAgentForAggregatedCollection'. <br />
<br />
===com.openexchange.carddav.userAgentForAggregatedCollection===<br />
Regular expression to match against the client's user-agent to decide whether the aggregated collection is exposed or not. The default pattern matches all known varieties of the Mac OS Addressbook client, that doesn't support multiple collections. Only used if 'exposedCollections' is set to '0'. The pattern is used case insensitive. <br />
<br />
===com.openexchange.carddav.reducedAggregatedCollection===<br />
Specifies if all visible folders are used to create the aggregated collection, or if a reduced set of folders only containing the global addressbook and the personal contacts folders should be used. This setting only influences the aggregated collection that is used for clients that don't support multiple collections. Possible values are 'true' and 'false.</div>Sgablerhttps://oxpedia.org/wiki/index.php?title=OX6:Open-Xchange_620_622_Update_Guide_for_CentOS6&diff=11725OX6:Open-Xchange 620 622 Update Guide for CentOS62012-10-10T17:17:32Z<p>Sgabler: /* Leftover configuration files and runtime data */</p>
<hr />
<div>= Update of Open-Xchange Server v6.20 to v6.22 on CentOS 6 =<br />
<br />
This article will guide you through the update of an existing Open-Xchange Server 6 installation to the newest major release, v6.22.<br />
<br />
<br />
= Supported update path =<br />
<br />
Please note that the update to v6.22 is only supported from an installed version 6.20.7 or later. If you have an earlier version of Open-Xchange Server 6 installed, please update to the latest release of v6.20 before attempting an update to v6.22.<br />
<br />
The latest v6.20 release will remain accessible on our servers. If you need to access the repository after the release of v6.22, please use the following lines in your <code>yum</code> repository configuration to access v6.20 packages:<br />
<br />
Start a console and change the software repository file for Open-Xchange:<br />
<code>$ vim /etc/yum.repos.d/ox.repo</code><br />
[ox]<br />
name=Open-Xchange<br />
baseurl=http://software.open-xchange.com/OX6/6.20/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
# if you have a valid maintenance subscription, please uncomment the <br />
# following and add the ldb account data to the url so that the most recent<br />
# packages get installed<br />
<br />
[ox-updates]<br />
name=Open-Xchange Updates<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.20/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
<br />
= Requirements =<br />
* An Open-Xchange Server installation v6.20.7 or later. This update guide is valid for a system installed through our [[Open-Xchange_Installation_Guide_for_CentOS_6|Download and Installation Guide for CentOS 6]]<br />
* If you have custom packages done by Open-Xchange, please discuss with your Open-Xchange contact when these packages are available for 6.22. Do not attempt the update earlier<br />
* If you have built custom packages yourself which install config files in the OX config tree, please check the page [[6.22_Packaging_Changes|v6.22 Packaging Changes]]<br />
* If you have custom plugins written by yourself which depend on Open-Xchange Server OSGI bundles, check the pages [[6.22_Packaging_Changes|v6.22 Packaging Changes]] and [[6.22_Necessary_Code_Changes|v6.22 Necessary Code Changes]] for changes you might need to do.<br />
* Custom packages built for 6.20.7 or earlier might not work with 6.22.<br />
* As for every update we strongly recommend that you make a backup of your system(s) before you proceed.<br />
<br />
<br />
= Update Open-Xchange Repositories =<br />
<br />
Add the following repositories to your <code>apt</code> configuration to access the v6.22 packages:<br />
<br />
<code>$ vim /etc/yum.repos.d/ox.repo</code><br />
[ox-frontend]<br />
name=Open-Xchange-frontend<br />
baseurl=http://software.open-xchange.com/OX6/6.22/frontend/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-backend]<br />
name=Open-Xchange-backend<br />
baseurl=http://software.open-xchange.com/OX6/6.22/backend/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-usm]<br />
name=Open-Xchange-USM<br />
baseurl=http://software.open-xchange.com/OX6/6.22/usm/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
# if you have a valid maintenance subscription, please uncomment the <br />
# following and add the ldb account data to the url so that the most recent<br />
# packages get installed<br />
<br />
[ox-updates-frontend]<br />
name=Open-Xchange Updates-frontend<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.22/updates/frontend/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-updates-backend]<br />
name=Open-Xchange Updates-backend<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.22/updates/backend/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-updates-usm]<br />
name=Open-Xchange Updates-USM<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.22/updates/usm/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
In case there are issues with an username and password containing URL unsafe characters, e.g. an @, they have to be entered URL encoded. Details can be found at http://www.w3schools.com/tags/ref_urlencode.asp<br />
<br />
Please note that frontend and backend packages are now provided from two different repositories. Depending on your setup and the packages installed on the specific system you're updating it is possible that you only need one of these repositories. All packages providing <code>open-xchange-admin</code> functionality are included in the <code>backend</code> repository.<br />
<br />
<br />
= Updating repositories and update packages =<br />
<br />
Reload the package index and update all installed packages:<br />
<br />
$ yum update<br />
$ yum upgrade<br />
<br />
<br />
= Install additional language packages if necessary =<br />
<br />
Starting with v6.22 the localization files for German, French and British English are no longer part of the core packages. This change was necessary to allow customers to uninstall these languages when they are not needed. If you want to offer German, French and/or British English to your customers as language option, you need to install the corresponding packages after the update.<br />
<br />
For German:<br />
<br />
$ yum install open-xchange-l10n-de-de open-xchange-gui-l10n-de-de<br />
<br />
For French:<br />
<br />
$ yum install open-xchange-l10n-fr-fr open-xchange-gui-l10n-fr-fr<br />
<br />
For British English:<br />
<br />
$ yum install open-xchange-gui-l10n-en-gb<br />
<br />
<br />
= Adjusting runlevel configuration =<br />
<br />
Starting with v6.22 there are no longer two separate process, but only one, <code>open-xchange</code>. Therefore, the runlevel configuration needs to be adjusted:<br />
<br />
$ chkconfig --level 345 open-xchange on<br />
<br />
NOTE: Admin functionality is only available if the package <code>open-xchange-admin</code> is installed. If you are updating a system without admin packages installed it still won't have admin functionality after the update.<br />
<br />
<br />
= Restart Open-Xchange =<br />
<br />
To restart Open-Xchange Server after the update, run<br />
<br />
$ /etc/init.d/open-xchange restart<br />
<br />
This script will check on startup if the old processes for <code>open-xchange-groupware</code> and <code>open-xchange-admin</code> are running, and stops them if they are. You might still want to check with<br />
<br />
$ ps aux | grep open-xchange<br />
<br />
that there is now only one process running Open-Xchange Server.<br />
<br />
<br />
= Leftover configuration files and runtime data =<br />
<br />
After the update you may see leftover configuration files and runtime data below <code>/opt/open-xchange/etc</code>.<br />
<br />
Some of these files belong to packages which have been uninstalled during the update.<br />
<br />
Other orphaned files may be runtime data or temporary files which do not belong to any package and therefore couldn't be removed during the package update.<br />
<br />
Finally, there may be backup files created by the package manager during earlier updates.<br />
<br />
It is safe to remove:<br />
<br />
* All files and subdirectories below:<br />
<br />
/opt/open-xchange/etc/admindaemon<br />
/opt/open-xchange/etc/common<br />
/opt/open-xchange/etc/groupware<br />
<br />
unless you have built your own packages which install files into these directories.<br />
<br />
* All files ending in <code>.rpmsave</code> or <code>.rpmnew</code> once you are confident that your configuration is working after the update.</div>Sgablerhttps://oxpedia.org/wiki/index.php?title=OX6:Open-Xchange_620_622_Update_Guide_for_RHEL6&diff=11724OX6:Open-Xchange 620 622 Update Guide for RHEL62012-10-10T17:15:47Z<p>Sgabler: /* Leftover configuration files and runtime data */</p>
<hr />
<div>= Update of Open-Xchange Server v6.20 to v6.22 on RHEL 6 =<br />
<br />
This article will guide you through the update of an existing Open-Xchange Server 6 installation to the newest major release, v6.22.<br />
<br />
<br />
= Supported update path =<br />
<br />
Please note that the update to v6.22 is only supported from an installed version 6.20.7. If you have an earlier version of Open-Xchange Server 6 installed, please update to the latest release of v6.20.7 before attempting an update to v6.22.<br />
<br />
The latest v6.20 release will remain accessible on our servers. If you need to access the repository after the release of v6.22, please use the following lines in your <code>yum</code> repository configuration to access v6.20 packages:<br />
<br />
Start a console and change the software repository file for Open-Xchange:<br />
<code>$ vim /etc/yum.repos.d/ox.repo</code><br />
[ox]<br />
name=Open-Xchange<br />
baseurl=http://software.open-xchange.com/OX6/6.20/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
# if you have a valid maintenance subscription, please uncomment the <br />
# following and add the ldb account data to the url so that the most recent<br />
# packages get installed<br />
<br />
[ox-updates]<br />
name=Open-Xchange Updates<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.20/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
<br />
= Requirements =<br />
* An Open-Xchange Server installation v6.20.7. This update guide is valid for a system installed through our [[Open-Xchange_Installation_Guide_for_RHEL6|Download and Installation Guide for RHEL 6]]<br />
* If you have custom packages done by Open-Xchange, please discuss with your Open-Xchange contact when these packages are available for 6.22. Do not attempt the update earlier<br />
* If you have built custom packages yourself which install config files in the OX config tree, please check the page [[6.22_Packaging_Changes|v6.22 Packaging Changes]]<br />
* If you have custom plugins written by yourself which depend on Open-Xchange Server OSGI bundles, check the pages [[6.22_Packaging_Changes|v6.22 Packaging Changes]] and [[6.22_Necessary_Code_Changes|v6.22 Necessary Code Changes]] for changes you might need to do.<br />
* Custom packages built for 6.20.7 or earlier might not work with 6.22.<br />
* As for every update we strongly recommend that you make a backup of your system(s) before you proceed.<br />
<br />
<br />
= Update Open-Xchange Repositories =<br />
<br />
Add the following repositories to your <code>apt</code> configuration to access the v6.22 packages:<br />
<br />
<code>$ vim /etc/yum.repos.d/ox.repo</code><br />
[ox-frontend]<br />
name=Open-Xchange-frontend<br />
baseurl=http://software.open-xchange.com/OX6/6.22/frontend/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-backend]<br />
name=Open-Xchange-backend<br />
baseurl=http://software.open-xchange.com/OX6/6.22/backend/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-usm]<br />
name=Open-Xchange-USM<br />
baseurl=http://software.open-xchange.com/OX6/6.22/usm/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
# if you have a valid maintenance subscription, please uncomment the <br />
# following and add the ldb account data to the url so that the most recent<br />
# packages get installed<br />
<br />
[ox-updates-frontend]<br />
name=Open-Xchange Updates-frontend<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.22/updates/frontend/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-updates-backend]<br />
name=Open-Xchange Updates-backend<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.22/updates/backend/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-updates-usm]<br />
name=Open-Xchange Updates-USM<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.22/updates/usm/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
In case there are issues with an username and password containing URL unsafe characters, e.g. an @, they have to be entered URL encoded. Details can be found at http://www.w3schools.com/tags/ref_urlencode.asp<br />
<br />
Please note that frontend and backend packages are now provided from two different repositories. Depending on your setup and the packages installed on the specific system you're updating it is possible that you only need one of these repositories. All packages providing <code>open-xchange-admin</code> functionality are included in the <code>backend</code> repository.<br />
<br />
<br />
= Updating repositories and update packages =<br />
<br />
Reload the package index and update all installed packages:<br />
<br />
$ yum update<br />
$ yum upgrade<br />
<br />
<br />
= Install additional language packages if necessary =<br />
<br />
Starting with v6.22 the localization files for German, French and British English are no longer part of the core packages. This change was necessary to allow customers to uninstall these languages when they are not needed. If you want to offer German, French and/or British English to your customers as language option, you need to install the corresponding packages after the update.<br />
<br />
For German:<br />
<br />
$ yum install open-xchange-l10n-de-de open-xchange-gui-l10n-de-de<br />
<br />
For French:<br />
<br />
$ yum install open-xchange-l10n-fr-fr open-xchange-gui-l10n-fr-fr<br />
<br />
For British English:<br />
<br />
$ yum install open-xchange-gui-l10n-en-gb<br />
<br />
<br />
= Adjusting runlevel configuration =<br />
<br />
Starting with v6.22 there are no longer two separate process, but only one, <code>open-xchange</code>. Therefore, the runlevel configuration needs to be adjusted:<br />
<br />
$ chkconfig --level 345 open-xchange on<br />
<br />
NOTE: Admin functionality is only available if the package <code>open-xchange-admin</code> is installed. If you are updating a system without admin packages installed it still won't have admin functionality after the update.<br />
<br />
<br />
= Restart Open-Xchange =<br />
<br />
To restart Open-Xchange Server after the update, run<br />
<br />
$ /etc/init.d/open-xchange restart<br />
<br />
This script will check on startup if the old processes for <code>open-xchange-groupware</code> and <code>open-xchange-admin</code> are running, and stops them if they are. You might still want to check with<br />
<br />
$ ps aux | grep open-xchange<br />
<br />
that there is now only one process running Open-Xchange Server.<br />
<br />
<br />
= Leftover configuration files and runtime data =<br />
<br />
After the update you may see leftover configuration files and runtime data below <code>/opt/open-xchange/etc</code>.<br />
<br />
Some of these files belong to packages which have been uninstalled during the update.<br />
<br />
Other orphaned files may be runtime data or temporary files which do not belong to any package and therefore couldn't be removed during the package update.<br />
<br />
Finally, there may be backup files created by the package manager during earlier updates.<br />
<br />
It is safe to remove:<br />
<br />
* All files and subdirectories below:<br />
<br />
/opt/open-xchange/etc/admindaemon<br />
/opt/open-xchange/etc/common<br />
/opt/open-xchange/etc/groupware<br />
<br />
unless you have built your own packages which install files into these directories.<br />
<br />
* All files ending in <code>.rpmsave</code> or <code>.rpmnew</code> once you are confident that your configuration is working after the update.</div>Sgablerhttps://oxpedia.org/wiki/index.php?title=OX6:Open-Xchange_620_622_Update_Guide_for_RHEL5&diff=11723OX6:Open-Xchange 620 622 Update Guide for RHEL52012-10-10T17:15:21Z<p>Sgabler: /* Leftover configuration files and runtime data */</p>
<hr />
<div>= Update of Open-Xchange Server v6.20 to v6.22 on RHEL 5 =<br />
<br />
This article will guide you through the update of an existing Open-Xchange Server 6 installation to the newest major release, v6.22.<br />
<br />
<br />
= Supported update path =<br />
<br />
Please note that the update to v6.22 is only supported from an installed version 6.20.7. If you have an earlier version of Open-Xchange Server 6 installed, please update to the latest release of v6.20.7 before attempting an update to v6.22.<br />
<br />
The latest v6.20 release will remain accessible on our servers. If you need to access the repository after the release of v6.22, please use the following lines in your <code>yum</code> repository configuration to access v6.20 packages:<br />
<br />
Start a console and change the software repository file for Open-Xchange:<br />
<code>$ vim /etc/yum.repos.d/ox.repo</code><br />
[ox]<br />
name=Open-Xchange<br />
baseurl=http://software.open-xchange.com/OX6/6.20/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
# if you have a valid maintenance subscription, please uncomment the <br />
# following and add the ldb account data to the url so that the most recent<br />
# packages get installed<br />
<br />
[ox-updates]<br />
name=Open-Xchange Updates<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.20/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
<br />
= Requirements =<br />
* An Open-Xchange Server installation v6.20.7. This update guide is valid for a system installed through our [[Open-Xchange_Installation_Guide_for_RHEL5|Download and Installation Guide for RHEL 5]]<br />
* If you have custom packages done by Open-Xchange, please discuss with your Open-Xchange contact when these packages are available for 6.22. Do not attempt the update earlier<br />
* If you have built custom packages yourself which install config files in the OX config tree, please check the page [[6.22_Packaging_Changes|v6.22 Packaging Changes]]<br />
* If you have custom plugins written by yourself which depend on Open-Xchange Server OSGI bundles, check the pages [[6.22_Packaging_Changes|v6.22 Packaging Changes]] and [[6.22_Necessary_Code_Changes|v6.22 Necessary Code Changes]] for changes you might need to do.<br />
* Custom packages built for 6.20.7 or earlier might not work with 6.22.<br />
* As for every update we strongly recommend that you make a backup of your system(s) before you proceed.<br />
<br />
<br />
= Update Open-Xchange Repositories =<br />
<br />
Add the following repositories to your <code>apt</code> configuration to access the v6.22 packages:<br />
<br />
<code>$ vim /etc/yum.repos.d/ox.repo</code><br />
[ox-frontend]<br />
name=Open-Xchange-frontend<br />
baseurl=http://software.open-xchange.com/OX6/6.22/frontend/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-backend]<br />
name=Open-Xchange-backend<br />
baseurl=http://software.open-xchange.com/OX6/6.22/backend/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-usm]<br />
name=Open-Xchange-USM<br />
baseurl=http://software.open-xchange.com/OX6/6.22/usm/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
# if you have a valid maintenance subscription, please uncomment the <br />
# following and add the ldb account data to the url so that the most recent<br />
# packages get installed<br />
<br />
[ox-updates-frontend]<br />
name=Open-Xchange Updates-frontend<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.22/updates/frontend/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-updates-backend]<br />
name=Open-Xchange Updates-backend<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.22/updates/backend/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-updates-usm]<br />
name=Open-Xchange Updates-USM<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.22/updates/usm/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
In case there are issues with an username and password containing URL unsafe characters, e.g. an @, they have to be entered URL encoded. Details can be found at http://www.w3schools.com/tags/ref_urlencode.asp<br />
<br />
Please note that frontend and backend packages are now provided from two different repositories. Depending on your setup and the packages installed on the specific system you're updating it is possible that you only need one of these repositories. All packages providing <code>open-xchange-admin</code> functionality are included in the <code>backend</code> repository.<br />
<br />
<br />
= Updating repositories and update packages =<br />
<br />
Reload the package index and update all installed packages:<br />
<br />
$ yum update<br />
$ yum upgrade<br />
<br />
<br />
= Install additional language packages if necessary =<br />
<br />
Starting with v6.22 the localization files for German, French and British English are no longer part of the core packages. This change was necessary to allow customers to uninstall these languages when they are not needed. If you want to offer German, French and/or British English to your customers as language option, you need to install the corresponding packages after the update.<br />
<br />
For German:<br />
<br />
$ yum install open-xchange-l10n-de-de open-xchange-gui-l10n-de-de<br />
<br />
For French:<br />
<br />
$ yum install open-xchange-l10n-fr-fr open-xchange-gui-l10n-fr-fr<br />
<br />
For British English:<br />
<br />
$ yum install open-xchange-gui-l10n-en-gb<br />
<br />
<br />
= Adjusting runlevel configuration =<br />
<br />
Starting with v6.22 there are no longer two separate process, but only one, <code>open-xchange</code>. Therefore, the runlevel configuration needs to be adjusted:<br />
<br />
$ chkconfig --level 345 open-xchange on<br />
<br />
NOTE: Admin functionality is only available if the package <code>open-xchange-admin</code> is installed. If you are updating a system without admin packages installed it still won't have admin functionality after the update.<br />
<br />
<br />
= Restart Open-Xchange =<br />
<br />
To restart Open-Xchange Server after the update, run<br />
<br />
$ /etc/init.d/open-xchange restart<br />
<br />
This script will check on startup if the old processes for <code>open-xchange-groupware</code> and <code>open-xchange-admin</code> are running, and stops them if they are. You might still want to check with<br />
<br />
$ ps aux | grep open-xchange<br />
<br />
that there is now only one process running Open-Xchange Server.<br />
<br />
<br />
= Leftover configuration files and runtime data =<br />
<br />
After the update you may see leftover configuration files and runtime data below <code>/opt/open-xchange/etc</code>.<br />
<br />
Some of these files belong to packages which have been uninstalled during the update.<br />
<br />
Other orphaned files may be runtime data or temporary files which do not belong to any package and therefore couldn't be removed during the package update.<br />
<br />
Finally, there may be backup files created by the package manager during earlier updates.<br />
<br />
It is safe to remove:<br />
<br />
* All files and subdirectories below:<br />
<br />
/opt/open-xchange/etc/admindaemon<br />
/opt/open-xchange/etc/common<br />
/opt/open-xchange/etc/groupware<br />
<br />
unless you have built your own packages which install files into these directories.<br />
<br />
* All files ending in <code>.rpmsave</code> or <code>.rpmnew</code> once you are confident that your configuration is working after the update.</div>Sgablerhttps://oxpedia.org/wiki/index.php?title=OX6:Open-Xchange_620_622_Update_Guide_for_CentOS6&diff=11722OX6:Open-Xchange 620 622 Update Guide for CentOS62012-10-10T17:14:50Z<p>Sgabler: /* Leftover configuration files and runtime data */</p>
<hr />
<div>= Update of Open-Xchange Server v6.20 to v6.22 on CentOS 6 =<br />
<br />
This article will guide you through the update of an existing Open-Xchange Server 6 installation to the newest major release, v6.22.<br />
<br />
<br />
= Supported update path =<br />
<br />
Please note that the update to v6.22 is only supported from an installed version 6.20.7 or later. If you have an earlier version of Open-Xchange Server 6 installed, please update to the latest release of v6.20 before attempting an update to v6.22.<br />
<br />
The latest v6.20 release will remain accessible on our servers. If you need to access the repository after the release of v6.22, please use the following lines in your <code>yum</code> repository configuration to access v6.20 packages:<br />
<br />
Start a console and change the software repository file for Open-Xchange:<br />
<code>$ vim /etc/yum.repos.d/ox.repo</code><br />
[ox]<br />
name=Open-Xchange<br />
baseurl=http://software.open-xchange.com/OX6/6.20/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
# if you have a valid maintenance subscription, please uncomment the <br />
# following and add the ldb account data to the url so that the most recent<br />
# packages get installed<br />
<br />
[ox-updates]<br />
name=Open-Xchange Updates<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.20/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
<br />
= Requirements =<br />
* An Open-Xchange Server installation v6.20.7 or later. This update guide is valid for a system installed through our [[Open-Xchange_Installation_Guide_for_CentOS_6|Download and Installation Guide for CentOS 6]]<br />
* If you have custom packages done by Open-Xchange, please discuss with your Open-Xchange contact when these packages are available for 6.22. Do not attempt the update earlier<br />
* If you have built custom packages yourself which install config files in the OX config tree, please check the page [[6.22_Packaging_Changes|v6.22 Packaging Changes]]<br />
* If you have custom plugins written by yourself which depend on Open-Xchange Server OSGI bundles, check the pages [[6.22_Packaging_Changes|v6.22 Packaging Changes]] and [[6.22_Necessary_Code_Changes|v6.22 Necessary Code Changes]] for changes you might need to do.<br />
* Custom packages built for 6.20.7 or earlier might not work with 6.22.<br />
* As for every update we strongly recommend that you make a backup of your system(s) before you proceed.<br />
<br />
<br />
= Update Open-Xchange Repositories =<br />
<br />
Add the following repositories to your <code>apt</code> configuration to access the v6.22 packages:<br />
<br />
<code>$ vim /etc/yum.repos.d/ox.repo</code><br />
[ox-frontend]<br />
name=Open-Xchange-frontend<br />
baseurl=http://software.open-xchange.com/OX6/6.22/frontend/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-backend]<br />
name=Open-Xchange-backend<br />
baseurl=http://software.open-xchange.com/OX6/6.22/backend/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-usm]<br />
name=Open-Xchange-USM<br />
baseurl=http://software.open-xchange.com/OX6/6.22/usm/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
# if you have a valid maintenance subscription, please uncomment the <br />
# following and add the ldb account data to the url so that the most recent<br />
# packages get installed<br />
<br />
[ox-updates-frontend]<br />
name=Open-Xchange Updates-frontend<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.22/updates/frontend/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-updates-backend]<br />
name=Open-Xchange Updates-backend<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.22/updates/backend/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-updates-usm]<br />
name=Open-Xchange Updates-USM<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.22/updates/usm/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
In case there are issues with an username and password containing URL unsafe characters, e.g. an @, they have to be entered URL encoded. Details can be found at http://www.w3schools.com/tags/ref_urlencode.asp<br />
<br />
Please note that frontend and backend packages are now provided from two different repositories. Depending on your setup and the packages installed on the specific system you're updating it is possible that you only need one of these repositories. All packages providing <code>open-xchange-admin</code> functionality are included in the <code>backend</code> repository.<br />
<br />
<br />
= Updating repositories and update packages =<br />
<br />
Reload the package index and update all installed packages:<br />
<br />
$ yum update<br />
$ yum upgrade<br />
<br />
<br />
= Install additional language packages if necessary =<br />
<br />
Starting with v6.22 the localization files for German, French and British English are no longer part of the core packages. This change was necessary to allow customers to uninstall these languages when they are not needed. If you want to offer German, French and/or British English to your customers as language option, you need to install the corresponding packages after the update.<br />
<br />
For German:<br />
<br />
$ yum install open-xchange-l10n-de-de open-xchange-gui-l10n-de-de<br />
<br />
For French:<br />
<br />
$ yum install open-xchange-l10n-fr-fr open-xchange-gui-l10n-fr-fr<br />
<br />
For British English:<br />
<br />
$ yum install open-xchange-gui-l10n-en-gb<br />
<br />
<br />
= Adjusting runlevel configuration =<br />
<br />
Starting with v6.22 there are no longer two separate process, but only one, <code>open-xchange</code>. Therefore, the runlevel configuration needs to be adjusted:<br />
<br />
$ chkconfig --level 345 open-xchange on<br />
<br />
NOTE: Admin functionality is only available if the package <code>open-xchange-admin</code> is installed. If you are updating a system without admin packages installed it still won't have admin functionality after the update.<br />
<br />
<br />
= Restart Open-Xchange =<br />
<br />
To restart Open-Xchange Server after the update, run<br />
<br />
$ /etc/init.d/open-xchange restart<br />
<br />
This script will check on startup if the old processes for <code>open-xchange-groupware</code> and <code>open-xchange-admin</code> are running, and stops them if they are. You might still want to check with<br />
<br />
$ ps aux | grep open-xchange<br />
<br />
that there is now only one process running Open-Xchange Server.<br />
<br />
<br />
= Leftover configuration files and runtime data =<br />
<br />
After the update you may see leftover configuration files and runtime data below <code>/opt/open-xchange/etc</code>.<br />
<br />
Some of these files belong to packages which have been uninstalled during the update.<br />
<br />
Other orphaned files may be runtime data or temporary files which do not belong to any package and therefore couldn't be removed during the package update.<br />
<br />
<br />
Finally, there may be backup files created by the package manager during earlier updates.<br />
<br />
It is safe to remove:<br />
<br />
* All files and subdirectories below:<br />
<br />
/opt/open-xchange/etc/admindaemon<br />
/opt/open-xchange/etc/common<br />
/opt/open-xchange/etc/groupware<br />
<br />
unless you have built your own packages which install files into these directories.<br />
<br />
* All files ending in <code>.rpmsave</code> or <code>.rpmnew</code> once you are confident that your configuration is working after the update.</div>Sgablerhttps://oxpedia.org/wiki/index.php?title=OX6:Open-Xchange_620_622_Update_Guide_for_CentOS5&diff=11721OX6:Open-Xchange 620 622 Update Guide for CentOS52012-10-10T17:14:16Z<p>Sgabler: /* Leftover configuration files and runtime data */</p>
<hr />
<div>= Update of Open-Xchange Server v6.20 to v6.22 on CentOS 5 =<br />
<br />
This article will guide you through the update of an existing Open-Xchange Server 6 installation to the newest major release, v6.22.<br />
<br />
<br />
= Supported update path =<br />
<br />
Please note that the update to v6.22 is only supported from an installed version 6.20.7. If you have an earlier version of Open-Xchange Server 6 installed, please update to the latest release of v6.20.7 before attempting an update to v6.22.<br />
<br />
The latest v6.20.7 release will remain accessible on our servers. If you need to access the repository after the release of v6.22, please use the following lines in your <code>yum</code> repository configuration to access v6.20 packages:<br />
<br />
Start a console and change the software repository file for Open-Xchange:<br />
<code>$ vim /etc/yum.repos.d/ox.repo</code><br />
[ox]<br />
name=Open-Xchange<br />
baseurl=http://software.open-xchange.com/OX6/6.20/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
# if you have a valid maintenance subscription, please uncomment the <br />
# following and add the ldb account data to the url so that the most recent<br />
# packages get installed<br />
<br />
[ox-updates]<br />
name=Open-Xchange Updates<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.20/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
<br />
= Requirements =<br />
* An Open-Xchange Server installation v6.20.7. This update guide is valid for a system installed through our [[Open-Xchange_Installation_Guide_for_CentOS_5|Download and Installation Guide for CentOS 5]]<br />
* If you have custom packages done by Open-Xchange, please discuss with your Open-Xchange contact when these packages are available for 6.22. Do not attempt the update earlier<br />
* If you have built custom packages yourself which install config files in the OX config tree, please check the page [[6.22_Packaging_Changes|v6.22 Packaging Changes]]<br />
* If you have custom plugins written by yourself which depend on Open-Xchange Server OSGI bundles, check the pages [[6.22_Packaging_Changes|v6.22 Packaging Changes]] and [[6.22_Necessary_Code_Changes|v6.22 Necessary Code Changes]] for changes you might need to do.<br />
* Custom packages built for 6.20.7 or earlier might not work with 6.22.<br />
* As for every update we strongly recommend that you make a backup of your system(s) before you proceed.<br />
<br />
<br />
= Update Open-Xchange Repositories =<br />
<br />
Add the following repositories to your <code>apt</code> configuration to access the v6.22 packages:<br />
<br />
<code>$ vim /etc/yum.repos.d/ox.repo</code><br />
[ox-frontend]<br />
name=Open-Xchange-frontend<br />
baseurl=http://software.open-xchange.com/OX6/6.22/frontend/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-backend]<br />
name=Open-Xchange-backend<br />
baseurl=http://software.open-xchange.com/OX6/6.22/backend/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-usm]<br />
name=Open-Xchange-USM<br />
baseurl=http://software.open-xchange.com/OX6/6.22/usm/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
# if you have a valid maintenance subscription, please uncomment the <br />
# following and add the ldb account data to the url so that the most recent<br />
# packages get installed<br />
<br />
[ox-updates-frontend]<br />
name=Open-Xchange Updates-frontend<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.22/updates/frontend/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-updates-backend]<br />
name=Open-Xchange Updates-backend<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.22/updates/backend/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-updates-usm]<br />
name=Open-Xchange Updates-USM<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.22/updates/usm/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
In case there are issues with an username and password containing URL unsafe characters, e.g. an @, they have to be entered URL encoded. Details can be found at http://www.w3schools.com/tags/ref_urlencode.asp<br />
<br />
Please note that frontend and backend packages are now provided from two different repositories. Depending on your setup and the packages installed on the specific system you're updating it is possible that you only need one of these repositories. All packages providing <code>open-xchange-admin</code> functionality are included in the <code>backend</code> repository.<br />
<br />
<br />
= Updating repositories and update packages =<br />
<br />
Reload the package index and update all installed packages:<br />
<br />
$ yum update<br />
$ yum upgrade<br />
<br />
= Install additional language packages if necessary =<br />
<br />
Starting with v6.22 the localization files for German, French and British English are no longer part of the core packages. This change was necessary to allow customers to uninstall these languages when they are not needed. If you want to offer German, French and/or British English to your customers as language option, you need to install the corresponding packages after the update.<br />
<br />
For German:<br />
<br />
$ yum install open-xchange-l10n-de-de open-xchange-gui-l10n-de-de<br />
<br />
For French:<br />
<br />
$ yum install open-xchange-l10n-fr-fr open-xchange-gui-l10n-fr-fr<br />
<br />
For British English:<br />
<br />
$ yum install open-xchange-gui-l10n-en-gb<br />
<br />
<br />
= Adjusting runlevel configuration =<br />
<br />
Starting with v6.22 there are no longer two separate process, but only one, <code>open-xchange</code>. Therefore, the runlevel configuration needs to be adjusted:<br />
<br />
$ chkconfig --level 345 open-xchange on<br />
<br />
NOTE: Admin functionality is only available if the package <code>open-xchange-admin</code> is installed. If you are updating a system without admin packages installed it still won't have admin functionality after the update.<br />
<br />
<br />
= Restart Open-Xchange =<br />
<br />
To restart Open-Xchange Server after the update, run<br />
<br />
$ /etc/init.d/open-xchange restart<br />
<br />
This script will check on startup if the old processes for <code>open-xchange-groupware</code> and <code>open-xchange-admin</code> are running, and stops them if they are. You might still want to check with<br />
<br />
$ ps aux | grep open-xchange<br />
<br />
that there is now only one process running Open-Xchange Server.<br />
<br />
= Leftover configuration files and runtime data =<br />
<br />
After the update you may see leftover configuration files and runtime data below <code>/opt/open-xchange/etc</code>.<br />
<br />
Some of these files belong to packages which have been uninstalled during the update.<br />
<br />
Other orphaned files may be runtime data or temporary files which do not belong to any package and therefore couldn't be removed during the package update.<br />
<br />
Finally, there may be backup files created by the package manager during earlier updates.<br />
<br />
It is safe to remove:<br />
<br />
* All files and subdirectories below:<br />
<br />
/opt/open-xchange/etc/admindaemon<br />
/opt/open-xchange/etc/common<br />
/opt/open-xchange/etc/groupware<br />
<br />
unless you have built your own packages which install files into these directories.<br />
<br />
* All files ending in <code>.rpmsave</code> or <code>.rpmnew</code> once you are confident that your configuration is working after the update.</div>Sgablerhttps://oxpedia.org/wiki/index.php?title=OX6:Open-Xchange_620_622_Update_Guide_for_SLES11&diff=11632OX6:Open-Xchange 620 622 Update Guide for SLES112012-10-05T20:07:06Z<p>Sgabler: /* Requirements */</p>
<hr />
<div>= Update of Open-Xchange Server v6.20 to v6.22 on SLES11=<br />
<br />
This article will guide you through the update of an existing Open-Xchange Server 6 installation to the newest major release, v6.22.<br />
<br />
= Supported update path =<br />
<br />
Please note that the update to v6.22 is only supported from an installed version 6.20.7 or later. If you have an earlier version of Open-Xchange Server 6 installed, please update to the latest release of v6.20 before attempting an update to v6.22.<br />
<br />
The latest v6.20 release will remain accessible on our servers. If you need to access the repository after the release of v6.22, please use the following commands to configure the repository containing 6.20 packages.<br />
<br />
First, list your configured repositories:<br />
<br />
<code><br />
$ zypper lr<br />
</code><br />
<br />
Next, disable your existing Open-Xchange package repository. Assuming it is called <code>ox</code>, the command would be:<br />
<br />
<code><br />
$ zypper mr -d ox<br />
</code><br />
<br />
Finally, add the repository for 6.20.7 packages:<br />
<br />
<code><br />
$ zypper ar http://software.open-xchange.com/OX6/6.20/SLES11/ ox-6.20<br />
</code><br />
<br />
After updating your system, disable the repository again:<br />
<br />
<code><br />
$ zypper mr -d ox-6/20<br />
</code><br />
<br />
Instead of disabling the repositories you can also remove them with the command <code>zypper rr</code>.<br />
<br />
= Requirements =<br />
* An Open-Xchange Server installation v6.20.7 or later. This update guide is valid for a system installed through our [[Open-Xchange_Installation_Guide_for_SLES11|Download and Installation Guide for SLES 11]]<br />
* If you have custom packages done by Open-Xchange, please discuss with your Open-Xchange contact when these packages are available for 6.22. Do not attempt the update earlier<br />
* If you have built custom packages yourself which install config files in the OX config tree, please check the page [[6.22_Packaging_Changes|v6.22 Packaging Changes]]<br />
* If you have custom plugins written by yourself which depend on Open-Xchange Server OSGI bundles, check the pages [[6.22_Packaging_Changes|v6.22 Packaging Changes]] and [[6.22_Necessary_Code_Changes|v6.22 Necessary Code Changes]] for changes you might need to do.<br />
* Custom packages built for 6.20.7 or earlier might not work with 6.22.<br />
* As for every update we strongly recommend that you make a backup of your system(s) before you proceed.<br />
<br />
= Update Open-Xchange Repositories =<br />
<br />
First, you need to add the current repositories to your zypper configuration to access the v6.22 packages.<br />
<br />
To do so, start with listing your existing repositories.<br />
<br />
<code><br />
$ zypper lr<br />
</code><br />
<br />
Then, disable your configured Open-Xchange repositories. Assuming they are called <code>ox</code> and <code>ox-updates</code>, the commands would be:<br />
<br />
<code><br />
$ zypper mr -d ox<br />
$ zypper mr -d ox-updates<br />
</code><br />
<br />
Instead of disabling the repositories, you can also remove them with <code>zypper rr</code>.<br />
<br />
Finally, add the new Open-Xchange repositories for SLES11:<br />
<br />
$ zypper ar http://software.open-xchange.com/OX6/6.22/frontend/SLES11/ ox-frontend <br />
$ zypper ar http://software.open-xchange.com/OX6/6.22/backend/SLES11/ ox-backend<br />
$ zypper ar http://software.open-xchange.com/OX6/6.22/usm/SLES11/ ox-usm<br />
<br />
If you have a valid maintenance subscription, please run the following command so that the most recent packages get installed:<br />
<br />
$ zypper ar http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.22/updates/frontend/SLES11/ ox-updates-frontend<br />
$ zypper ar http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.22/updates/backend/SLES11/ ox-updates-backend<br />
$ zypper ar http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.22/updates/usm/SLES11/ ox-updates-usm<br />
<br />
A warning will be shown because the Open-Xchange packages are not yet signed by a cryptographic key. To accept and continue the installation, press Y. <br />
<br />
Please note that frontend and backend packages are now provided from two different repositories. Depending on your setup and the packages installed on the specific system you're updating it is possible that you only need one of these repositories. All packages providing <code>open-xchange-admin</code> functionality are included in the <code>backend</code> repository. The repository <code>usm</code> is also only needed on backend servers.<br />
<br />
= Updating repositories and update packages =<br />
<br />
Reload the package index:<br />
<br />
$ zypper ref<br />
<br />
A warning will be shown because the Open-Xchange packages are not yet signed by a cryptographic key. To accept and continue the installation, press Y. <br />
<br />
Download and update all installed Open-Xchange packages: <br />
<br />
$ zypper dup -r ox-backend -r ox-frontend -r ox-usm<br />
<br />
= Install additional language packages if necessary =<br />
<br />
Starting with v6.22 the localization files for German, French and British English are no longer part of the core packages. This change was necessary to allow customers to uninstall these languages when they are not needed. If you want to offer German, French and/or British English to your customers as language option, you need to install the corresponding packages after the update.<br />
<br />
For German:<br />
<br />
$ zypper in open-xchange-l10n-de-de open-xchange-gui-l10n-de-de<br />
<br />
For French:<br />
<br />
$ zypper in open-xchange-l10n-fr-fr open-xchange-gui-l10n-fr-fr<br />
<br />
For British English:<br />
<br />
$zypper in open-xchange-gui-l10n-en-gb<br />
<br />
= Adjusting runlevel configuration =<br />
<br />
Starting with v6.22 there are no longer two separate process, but only one, <code>open-xchange</code>. Therefore, the runlevel configuration needs to be adjusted:<br />
<br />
$ insserv /sbin/rcopen-xchange<br />
<br />
NOTE: Admin functionality is only available if the package <code>open-xchange-admin</code> is installed. If you are updating a system without admin packages installed it still won't have admin functionality after the update.<br />
<br />
= Restart Open-Xchange =<br />
<br />
To restart Open-Xchange Server after the update, run<br />
<br />
$ rcopen-xchange restart<br />
<br />
This script will check on startup if the old processes for <code>open-xchange-groupware</code> and <code>open-xchange-admin</code> are running, and stops them if they are. You might still want to check with<br />
<br />
$ ps aux | grep open-xchange<br />
<br />
that there is now only one process running Open-Xchange Server. <br />
<br />
= Leftover configuration files and runtime data =<br />
<br />
<br />
After the update you may see leftover configuration files and runtime data below <code>/opt/open-xchange/etc</code>.<br />
<br />
Some of these files belong to packages which have been uninstalled during the update.<br />
<br />
Other orphaned files may be runtime data or temporary files which do not belong to any package and therefore couldn't be removed during the package update.<br />
<br />
Finally, there may be backup files created by the package manager during earlier updates.<br />
<br />
It is safe to remove:<br />
<br />
* All files and subdirectories below:<br />
<br />
/opt/open-xchange/etc/admindaemon<br />
/opt/open-xchange/etc/common<br />
/opt/open-xchange/etc/groupware<br />
<br />
unless you have built your own packages which install files into these directories.<br />
<br />
* All files ending in <code>.rpmsave</code> or <code>.rpmnew</code> once you are confident that your configuration is working after the update.</div>Sgablerhttps://oxpedia.org/wiki/index.php?title=OX6:Open-Xchange_620_622_Update_Guide_for_RHEL5&diff=11631OX6:Open-Xchange 620 622 Update Guide for RHEL52012-10-05T20:03:36Z<p>Sgabler: /* Requirements */</p>
<hr />
<div>= Update of Open-Xchange Server v6.20 to v6.22 on RHEL 5 =<br />
<br />
This article will guide you through the update of an existing Open-Xchange Server 6 installation to the newest major release, v6.22.<br />
<br />
= Supported update path =<br />
<br />
Please note that the update to v6.22 is only supported from an installed version 6.20.7. If you have an earlier version of Open-Xchange Server 6 installed, please update to the latest release of v6.20.7 before attempting an update to v6.22.<br />
<br />
The latest v6.20 release will remain accessible on our servers. If you need to access the repository after the release of v6.22, please use the following lines in your <code>yum</code> repository configuration to access v6.20 packages:<br />
<br />
Start a console and change the software repository file for Open-Xchange:<br />
<code>$ vim /etc/yum.repos.d/ox.repo</code><br />
[ox]<br />
name=Open-Xchange<br />
baseurl=http://software.open-xchange.com/OX6/6.20/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
# if you have a valid maintenance subscription, please uncomment the <br />
# following and add the ldb account data to the url so that the most recent<br />
# packages get installed<br />
<br />
[ox-updates]<br />
name=Open-Xchange Updates<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.20/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
= Requirements =<br />
* An Open-Xchange Server installation v6.20.7. This update guide is valid for a system installed through our [[Open-Xchange_Installation_Guide_for_RHEL5|Download and Installation Guide for RHEL 5]]<br />
* If you have custom packages done by Open-Xchange, please discuss with your Open-Xchange contact when these packages are available for 6.22. Do not attempt the update earlier<br />
* If you have built custom packages yourself which install config files in the OX config tree, please check the page [[6.22_Packaging_Changes|v6.22 Packaging Changes]]<br />
* If you have custom plugins written by yourself which depend on Open-Xchange Server OSGI bundles, check the pages [[6.22_Packaging_Changes|v6.22 Packaging Changes]] and [[6.22_Necessary_Code_Changes|v6.22 Necessary Code Changes]] for changes you might need to do.<br />
* Custom packages built for 6.20.7 or earlier might not work with 6.22.<br />
* As for every update we strongly recommend that you make a backup of your system(s) before you proceed.<br />
<br />
= Update Open-Xchange Repositories =<br />
<br />
Add the following repositories to your <code>apt</code> configuration to access the v6.22 packages:<br />
<br />
<code>$ vim /etc/yum.repos.d/ox.repo</code><br />
[ox-frontend]<br />
name=Open-Xchange-frontend<br />
baseurl=http://software.open-xchange.com/OX6/6.22/frontend/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-backend]<br />
name=Open-Xchange-backend<br />
baseurl=http://software.open-xchange.com/OX6/6.22/backend/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-usm]<br />
name=Open-Xchange-USM<br />
baseurl=http://software.open-xchange.com/OX6/6.22/usm/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
# if you have a valid maintenance subscription, please uncomment the <br />
# following and add the ldb account data to the url so that the most recent<br />
# packages get installed<br />
<br />
[ox-updates-frontend]<br />
name=Open-Xchange Updates-frontend<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.22/updates/frontend/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-updates-backend]<br />
name=Open-Xchange Updates-backend<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.22/updates/backend/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-updates-usm]<br />
name=Open-Xchange Updates-USM<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.22/updates/usm/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
In case there are issues with an username and password containing URL unsafe characters, e.g. an @, they have to be entered URL encoded. Details can be found at http://www.w3schools.com/tags/ref_urlencode.asp<br />
<br />
Please note that frontend and backend packages are now provided from two different repositories. Depending on your setup and the packages installed on the specific system you're updating it is possible that you only need one of these repositories. All packages providing <code>open-xchange-admin</code> functionality are included in the <code>backend</code> repository.<br />
<br />
= Updating repositories and update packages =<br />
<br />
Reload the package index and update all installed packages:<br />
<br />
$ yum update<br />
$ yum upgrade<br />
<br />
= Install additional language packages if necessary =<br />
<br />
Starting with v6.22 the localization files for German, French and British English are no longer part of the core packages. This change was necessary to allow customers to uninstall these languages when they are not needed. If you want to offer German, French and/or British English to your customers as language option, you need to install the corresponding packages after the update.<br />
<br />
For German:<br />
<br />
$ yum install open-xchange-l10n-de-de open-xchange-gui-l10n-de-de<br />
<br />
For French:<br />
<br />
$ yum install open-xchange-l10n-fr-fr open-xchange-gui-l10n-fr-fr<br />
<br />
For British English:<br />
<br />
$ yum install open-xchange-gui-l10n-en-gb<br />
<br />
= Restart Open-Xchange =<br />
<br />
To restart Open-Xchange Server after the update, run<br />
<br />
$ /etc/init.d/open-xchange restart<br />
<br />
This script will check on startup if the old processes for <code>open-xchange-groupware</code> and <code>open-xchange-admin</code> are running, and stops them if they are. You might still want to check with<br />
<br />
$ ps aux | grep open-xchange<br />
<br />
that there is now only one process running Open-Xchange Server.<br />
<br />
= Leftover configuration files and runtime data =<br />
<br />
After the update you may see leftover configuration files and runtime data below <code>/opt/open-xchange/etc</code>.<br />
<br />
Some of these files belong to packages which have been uninstalled during the update.<br />
Other orphaned files may be runtime data or temporary files which do not belong to any package and therefore couldn't be removed during the package update.<br />
<br />
<code>package-cleanup --orphans | grep open-x*</code><br />
<br />
Finally, there may be backup files created by the package manager during earlier updates.<br />
<br />
It is safe to remove:<br />
<br />
* All files and subdirectories below:<br />
<br />
/opt/open-xchange/etc/admindaemon<br />
/opt/open-xchange/etc/common<br />
/opt/open-xchange/etc/groupware<br />
<br />
unless you have built your own packages which install files into these directories.<br />
<br />
* All files ending in <code>.rpmsave</code> or <code>.rpmnew</code> once you are confident that your configuration is working after the update.</div>Sgablerhttps://oxpedia.org/wiki/index.php?title=OX6:Open-Xchange_620_622_Update_Guide_for_RHEL5&diff=11630OX6:Open-Xchange 620 622 Update Guide for RHEL52012-10-05T20:03:08Z<p>Sgabler: /* Supported update path */</p>
<hr />
<div>= Update of Open-Xchange Server v6.20 to v6.22 on RHEL 5 =<br />
<br />
This article will guide you through the update of an existing Open-Xchange Server 6 installation to the newest major release, v6.22.<br />
<br />
= Supported update path =<br />
<br />
Please note that the update to v6.22 is only supported from an installed version 6.20.7. If you have an earlier version of Open-Xchange Server 6 installed, please update to the latest release of v6.20.7 before attempting an update to v6.22.<br />
<br />
The latest v6.20 release will remain accessible on our servers. If you need to access the repository after the release of v6.22, please use the following lines in your <code>yum</code> repository configuration to access v6.20 packages:<br />
<br />
Start a console and change the software repository file for Open-Xchange:<br />
<code>$ vim /etc/yum.repos.d/ox.repo</code><br />
[ox]<br />
name=Open-Xchange<br />
baseurl=http://software.open-xchange.com/OX6/6.20/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
# if you have a valid maintenance subscription, please uncomment the <br />
# following and add the ldb account data to the url so that the most recent<br />
# packages get installed<br />
<br />
[ox-updates]<br />
name=Open-Xchange Updates<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.20/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
= Requirements =<br />
* An Open-Xchange Server installation v6.20.7 or later. This update guide is valid for a system installed through our [[Open-Xchange_Installation_Guide_for_RHEL5|Download and Installation Guide for RHEL 5]]<br />
* If you have custom packages done by Open-Xchange, please discuss with your Open-Xchange contact when these packages are available for 6.22. Do not attempt the update earlier<br />
* If you have built custom packages yourself which install config files in the OX config tree, please check the page [[6.22_Packaging_Changes|v6.22 Packaging Changes]]<br />
* If you have custom plugins written by yourself which depend on Open-Xchange Server OSGI bundles, check the pages [[6.22_Packaging_Changes|v6.22 Packaging Changes]] and [[6.22_Necessary_Code_Changes|v6.22 Necessary Code Changes]] for changes you might need to do.<br />
* Custom packages built for 6.20.7 or earlier might not work with 6.22.<br />
* As for every update we strongly recommend that you make a backup of your system(s) before you proceed.<br />
<br />
= Update Open-Xchange Repositories =<br />
<br />
Add the following repositories to your <code>apt</code> configuration to access the v6.22 packages:<br />
<br />
<code>$ vim /etc/yum.repos.d/ox.repo</code><br />
[ox-frontend]<br />
name=Open-Xchange-frontend<br />
baseurl=http://software.open-xchange.com/OX6/6.22/frontend/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-backend]<br />
name=Open-Xchange-backend<br />
baseurl=http://software.open-xchange.com/OX6/6.22/backend/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-usm]<br />
name=Open-Xchange-USM<br />
baseurl=http://software.open-xchange.com/OX6/6.22/usm/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
# if you have a valid maintenance subscription, please uncomment the <br />
# following and add the ldb account data to the url so that the most recent<br />
# packages get installed<br />
<br />
[ox-updates-frontend]<br />
name=Open-Xchange Updates-frontend<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.22/updates/frontend/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-updates-backend]<br />
name=Open-Xchange Updates-backend<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.22/updates/backend/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-updates-usm]<br />
name=Open-Xchange Updates-USM<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.22/updates/usm/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
In case there are issues with an username and password containing URL unsafe characters, e.g. an @, they have to be entered URL encoded. Details can be found at http://www.w3schools.com/tags/ref_urlencode.asp<br />
<br />
Please note that frontend and backend packages are now provided from two different repositories. Depending on your setup and the packages installed on the specific system you're updating it is possible that you only need one of these repositories. All packages providing <code>open-xchange-admin</code> functionality are included in the <code>backend</code> repository.<br />
<br />
= Updating repositories and update packages =<br />
<br />
Reload the package index and update all installed packages:<br />
<br />
$ yum update<br />
$ yum upgrade<br />
<br />
= Install additional language packages if necessary =<br />
<br />
Starting with v6.22 the localization files for German, French and British English are no longer part of the core packages. This change was necessary to allow customers to uninstall these languages when they are not needed. If you want to offer German, French and/or British English to your customers as language option, you need to install the corresponding packages after the update.<br />
<br />
For German:<br />
<br />
$ yum install open-xchange-l10n-de-de open-xchange-gui-l10n-de-de<br />
<br />
For French:<br />
<br />
$ yum install open-xchange-l10n-fr-fr open-xchange-gui-l10n-fr-fr<br />
<br />
For British English:<br />
<br />
$ yum install open-xchange-gui-l10n-en-gb<br />
<br />
= Restart Open-Xchange =<br />
<br />
To restart Open-Xchange Server after the update, run<br />
<br />
$ /etc/init.d/open-xchange restart<br />
<br />
This script will check on startup if the old processes for <code>open-xchange-groupware</code> and <code>open-xchange-admin</code> are running, and stops them if they are. You might still want to check with<br />
<br />
$ ps aux | grep open-xchange<br />
<br />
that there is now only one process running Open-Xchange Server.<br />
<br />
= Leftover configuration files and runtime data =<br />
<br />
After the update you may see leftover configuration files and runtime data below <code>/opt/open-xchange/etc</code>.<br />
<br />
Some of these files belong to packages which have been uninstalled during the update.<br />
Other orphaned files may be runtime data or temporary files which do not belong to any package and therefore couldn't be removed during the package update.<br />
<br />
<code>package-cleanup --orphans | grep open-x*</code><br />
<br />
Finally, there may be backup files created by the package manager during earlier updates.<br />
<br />
It is safe to remove:<br />
<br />
* All files and subdirectories below:<br />
<br />
/opt/open-xchange/etc/admindaemon<br />
/opt/open-xchange/etc/common<br />
/opt/open-xchange/etc/groupware<br />
<br />
unless you have built your own packages which install files into these directories.<br />
<br />
* All files ending in <code>.rpmsave</code> or <code>.rpmnew</code> once you are confident that your configuration is working after the update.</div>Sgablerhttps://oxpedia.org/wiki/index.php?title=OX6:Open-Xchange_620_622_Update_Guide_for_RHEL6&diff=11629OX6:Open-Xchange 620 622 Update Guide for RHEL62012-10-05T20:02:09Z<p>Sgabler: /* Requirements */</p>
<hr />
<div>= Update of Open-Xchange Server v6.20 to v6.22 on RHEL 6 =<br />
<br />
This article will guide you through the update of an existing Open-Xchange Server 6 installation to the newest major release, v6.22.<br />
<br />
= Supported update path =<br />
<br />
Please note that the update to v6.22 is only supported from an installed version 6.20.7. If you have an earlier version of Open-Xchange Server 6 installed, please update to the latest release of v6.20.7 before attempting an update to v6.22.<br />
<br />
The latest v6.20 release will remain accessible on our servers. If you need to access the repository after the release of v6.22, please use the following lines in your <code>yum</code> repository configuration to access v6.20 packages:<br />
<br />
Start a console and change the software repository file for Open-Xchange:<br />
<code>$ vim /etc/yum.repos.d/ox.repo</code><br />
[ox]<br />
name=Open-Xchange<br />
baseurl=http://software.open-xchange.com/OX6/6.20/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
# if you have a valid maintenance subscription, please uncomment the <br />
# following and add the ldb account data to the url so that the most recent<br />
# packages get installed<br />
<br />
[ox-updates]<br />
name=Open-Xchange Updates<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.20/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
= Requirements =<br />
* An Open-Xchange Server installation v6.20.7. This update guide is valid for a system installed through our [[Open-Xchange_Installation_Guide_for_RHEL6|Download and Installation Guide for RHEL 6]]<br />
* If you have custom packages done by Open-Xchange, please discuss with your Open-Xchange contact when these packages are available for 6.22. Do not attempt the update earlier<br />
* If you have built custom packages yourself which install config files in the OX config tree, please check the page [[6.22_Packaging_Changes|v6.22 Packaging Changes]]<br />
* If you have custom plugins written by yourself which depend on Open-Xchange Server OSGI bundles, check the pages [[6.22_Packaging_Changes|v6.22 Packaging Changes]] and [[6.22_Necessary_Code_Changes|v6.22 Necessary Code Changes]] for changes you might need to do.<br />
* Custom packages built for 6.20.7 or earlier might not work with 6.22.<br />
* As for every update we strongly recommend that you make a backup of your system(s) before you proceed.<br />
<br />
= Update Open-Xchange Repositories =<br />
<br />
Add the following repositories to your <code>apt</code> configuration to access the v6.22 packages:<br />
<br />
<code>$ vim /etc/yum.repos.d/ox.repo</code><br />
[ox-frontend]<br />
name=Open-Xchange-frontend<br />
baseurl=http://software.open-xchange.com/OX6/6.22/frontend/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-backend]<br />
name=Open-Xchange-backend<br />
baseurl=http://software.open-xchange.com/OX6/6.22/backend/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-usm]<br />
name=Open-Xchange-USM<br />
baseurl=http://software.open-xchange.com/OX6/6.22/usm/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
# if you have a valid maintenance subscription, please uncomment the <br />
# following and add the ldb account data to the url so that the most recent<br />
# packages get installed<br />
<br />
[ox-updates-frontend]<br />
name=Open-Xchange Updates-frontend<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.22/updates/frontend/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-updates-backend]<br />
name=Open-Xchange Updates-backend<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.22/updates/backend/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-updates-usm]<br />
name=Open-Xchange Updates-USM<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.22/updates/usm/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
In case there are issues with an username and password containing URL unsafe characters, e.g. an @, they have to be entered URL encoded. Details can be found at http://www.w3schools.com/tags/ref_urlencode.asp<br />
<br />
Please note that frontend and backend packages are now provided from two different repositories. Depending on your setup and the packages installed on the specific system you're updating it is possible that you only need one of these repositories. All packages providing <code>open-xchange-admin</code> functionality are included in the <code>backend</code> repository.<br />
<br />
= Updating repositories and update packages =<br />
<br />
Reload the package index and update all installed packages:<br />
<br />
$ yum update<br />
$ yum upgrade<br />
<br />
= Install additional language packages if necessary =<br />
<br />
Starting with v6.22 the localization files for German, French and British English are no longer part of the core packages. This change was necessary to allow customers to uninstall these languages when they are not needed. If you want to offer German, French and/or British English to your customers as language option, you need to install the corresponding packages after the update.<br />
<br />
For German:<br />
<br />
$ yum install open-xchange-l10n-de-de open-xchange-gui-l10n-de-de<br />
<br />
For French:<br />
<br />
$ yum install open-xchange-l10n-fr-fr open-xchange-gui-l10n-fr-fr<br />
<br />
For British English:<br />
<br />
$ yum install open-xchange-gui-l10n-en-gb<br />
<br />
= Restart Open-Xchange =<br />
<br />
To restart Open-Xchange Server after the update, run<br />
<br />
$ /etc/init.d/open-xchange restart<br />
<br />
This script will check on startup if the old processes for <code>open-xchange-groupware</code> and <code>open-xchange-admin</code> are running, and stops them if they are. You might still want to check with<br />
<br />
$ ps aux | grep open-xchange<br />
<br />
that there is now only one process running Open-Xchange Server.<br />
<br />
= Leftover configuration files and runtime data =<br />
<br />
After the update you may see leftover configuration files and runtime data below <code>/opt/open-xchange/etc</code>.<br />
<br />
Some of these files belong to packages which have been uninstalled during the update.<br />
Other orphaned files may be runtime data or temporary files which do not belong to any package and therefore couldn't be removed during the package update.<br />
<br />
<code>package-cleanup --orphans | grep open-x*</code><br />
<br />
Finally, there may be backup files created by the package manager during earlier updates.<br />
<br />
It is safe to remove:<br />
<br />
* All files and subdirectories below:<br />
<br />
/opt/open-xchange/etc/admindaemon<br />
/opt/open-xchange/etc/common<br />
/opt/open-xchange/etc/groupware<br />
<br />
unless you have built your own packages which install files into these directories.<br />
<br />
* All files ending in <code>.rpmsave</code> or <code>.rpmnew</code> once you are confident that your configuration is working after the update.</div>Sgablerhttps://oxpedia.org/wiki/index.php?title=OX6:Open-Xchange_620_622_Update_Guide_for_RHEL6&diff=11628OX6:Open-Xchange 620 622 Update Guide for RHEL62012-10-05T20:01:47Z<p>Sgabler: /* Supported update path */</p>
<hr />
<div>= Update of Open-Xchange Server v6.20 to v6.22 on RHEL 6 =<br />
<br />
This article will guide you through the update of an existing Open-Xchange Server 6 installation to the newest major release, v6.22.<br />
<br />
= Supported update path =<br />
<br />
Please note that the update to v6.22 is only supported from an installed version 6.20.7. If you have an earlier version of Open-Xchange Server 6 installed, please update to the latest release of v6.20.7 before attempting an update to v6.22.<br />
<br />
The latest v6.20 release will remain accessible on our servers. If you need to access the repository after the release of v6.22, please use the following lines in your <code>yum</code> repository configuration to access v6.20 packages:<br />
<br />
Start a console and change the software repository file for Open-Xchange:<br />
<code>$ vim /etc/yum.repos.d/ox.repo</code><br />
[ox]<br />
name=Open-Xchange<br />
baseurl=http://software.open-xchange.com/OX6/6.20/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
# if you have a valid maintenance subscription, please uncomment the <br />
# following and add the ldb account data to the url so that the most recent<br />
# packages get installed<br />
<br />
[ox-updates]<br />
name=Open-Xchange Updates<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.20/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
= Requirements =<br />
* An Open-Xchange Server installation v6.20.7 or later. This update guide is valid for a system installed through our [[Open-Xchange_Installation_Guide_for_RHEL6|Download and Installation Guide for RHEL 6]]<br />
* If you have custom packages done by Open-Xchange, please discuss with your Open-Xchange contact when these packages are available for 6.22. Do not attempt the update earlier<br />
* If you have built custom packages yourself which install config files in the OX config tree, please check the page [[6.22_Packaging_Changes|v6.22 Packaging Changes]]<br />
* If you have custom plugins written by yourself which depend on Open-Xchange Server OSGI bundles, check the pages [[6.22_Packaging_Changes|v6.22 Packaging Changes]] and [[6.22_Necessary_Code_Changes|v6.22 Necessary Code Changes]] for changes you might need to do.<br />
* Custom packages built for 6.20.7 or earlier might not work with 6.22.<br />
* As for every update we strongly recommend that you make a backup of your system(s) before you proceed.<br />
<br />
= Update Open-Xchange Repositories =<br />
<br />
Add the following repositories to your <code>apt</code> configuration to access the v6.22 packages:<br />
<br />
<code>$ vim /etc/yum.repos.d/ox.repo</code><br />
[ox-frontend]<br />
name=Open-Xchange-frontend<br />
baseurl=http://software.open-xchange.com/OX6/6.22/frontend/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-backend]<br />
name=Open-Xchange-backend<br />
baseurl=http://software.open-xchange.com/OX6/6.22/backend/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-usm]<br />
name=Open-Xchange-USM<br />
baseurl=http://software.open-xchange.com/OX6/6.22/usm/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
# if you have a valid maintenance subscription, please uncomment the <br />
# following and add the ldb account data to the url so that the most recent<br />
# packages get installed<br />
<br />
[ox-updates-frontend]<br />
name=Open-Xchange Updates-frontend<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.22/updates/frontend/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-updates-backend]<br />
name=Open-Xchange Updates-backend<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.22/updates/backend/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-updates-usm]<br />
name=Open-Xchange Updates-USM<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.22/updates/usm/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
In case there are issues with an username and password containing URL unsafe characters, e.g. an @, they have to be entered URL encoded. Details can be found at http://www.w3schools.com/tags/ref_urlencode.asp<br />
<br />
Please note that frontend and backend packages are now provided from two different repositories. Depending on your setup and the packages installed on the specific system you're updating it is possible that you only need one of these repositories. All packages providing <code>open-xchange-admin</code> functionality are included in the <code>backend</code> repository.<br />
<br />
= Updating repositories and update packages =<br />
<br />
Reload the package index and update all installed packages:<br />
<br />
$ yum update<br />
$ yum upgrade<br />
<br />
= Install additional language packages if necessary =<br />
<br />
Starting with v6.22 the localization files for German, French and British English are no longer part of the core packages. This change was necessary to allow customers to uninstall these languages when they are not needed. If you want to offer German, French and/or British English to your customers as language option, you need to install the corresponding packages after the update.<br />
<br />
For German:<br />
<br />
$ yum install open-xchange-l10n-de-de open-xchange-gui-l10n-de-de<br />
<br />
For French:<br />
<br />
$ yum install open-xchange-l10n-fr-fr open-xchange-gui-l10n-fr-fr<br />
<br />
For British English:<br />
<br />
$ yum install open-xchange-gui-l10n-en-gb<br />
<br />
= Restart Open-Xchange =<br />
<br />
To restart Open-Xchange Server after the update, run<br />
<br />
$ /etc/init.d/open-xchange restart<br />
<br />
This script will check on startup if the old processes for <code>open-xchange-groupware</code> and <code>open-xchange-admin</code> are running, and stops them if they are. You might still want to check with<br />
<br />
$ ps aux | grep open-xchange<br />
<br />
that there is now only one process running Open-Xchange Server.<br />
<br />
= Leftover configuration files and runtime data =<br />
<br />
After the update you may see leftover configuration files and runtime data below <code>/opt/open-xchange/etc</code>.<br />
<br />
Some of these files belong to packages which have been uninstalled during the update.<br />
Other orphaned files may be runtime data or temporary files which do not belong to any package and therefore couldn't be removed during the package update.<br />
<br />
<code>package-cleanup --orphans | grep open-x*</code><br />
<br />
Finally, there may be backup files created by the package manager during earlier updates.<br />
<br />
It is safe to remove:<br />
<br />
* All files and subdirectories below:<br />
<br />
/opt/open-xchange/etc/admindaemon<br />
/opt/open-xchange/etc/common<br />
/opt/open-xchange/etc/groupware<br />
<br />
unless you have built your own packages which install files into these directories.<br />
<br />
* All files ending in <code>.rpmsave</code> or <code>.rpmnew</code> once you are confident that your configuration is working after the update.</div>Sgablerhttps://oxpedia.org/wiki/index.php?title=OX6:Open-Xchange_620_622_Update_Guide_for_CentOS5&diff=11627OX6:Open-Xchange 620 622 Update Guide for CentOS52012-10-05T20:00:03Z<p>Sgabler: /* Requirements */</p>
<hr />
<div>= Update of Open-Xchange Server v6.20 to v6.22 on CentOS 5 =<br />
<br />
This article will guide you through the update of an existing Open-Xchange Server 6 installation to the newest major release, v6.22.<br />
<br />
= Supported update path =<br />
<br />
Please note that the update to v6.22 is only supported from an installed version 6.20.7. If you have an earlier version of Open-Xchange Server 6 installed, please update to the latest release of v6.20.7 before attempting an update to v6.22.<br />
<br />
The latest v6.20.7 release will remain accessible on our servers. If you need to access the repository after the release of v6.22, please use the following lines in your <code>yum</code> repository configuration to access v6.20 packages:<br />
<br />
Start a console and change the software repository file for Open-Xchange:<br />
<code>$ vim /etc/yum.repos.d/ox.repo</code><br />
[ox]<br />
name=Open-Xchange<br />
baseurl=http://software.open-xchange.com/OX6/6.20/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
# if you have a valid maintenance subscription, please uncomment the <br />
# following and add the ldb account data to the url so that the most recent<br />
# packages get installed<br />
<br />
[ox-updates]<br />
name=Open-Xchange Updates<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.20/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
= Requirements =<br />
* An Open-Xchange Server installation v6.20.7. This update guide is valid for a system installed through our [[Open-Xchange_Installation_Guide_for_CentOS_5|Download and Installation Guide for CentOS 5]]<br />
* If you have custom packages done by Open-Xchange, please discuss with your Open-Xchange contact when these packages are available for 6.22. Do not attempt the update earlier<br />
* If you have built custom packages yourself which install config files in the OX config tree, please check the page [[6.22_Packaging_Changes|v6.22 Packaging Changes]]<br />
* If you have custom plugins written by yourself which depend on Open-Xchange Server OSGI bundles, check the pages [[6.22_Packaging_Changes|v6.22 Packaging Changes]] and [[6.22_Necessary_Code_Changes|v6.22 Necessary Code Changes]] for changes you might need to do.<br />
* Custom packages built for 6.20.7 or earlier might not work with 6.22.<br />
* As for every update we strongly recommend that you make a backup of your system(s) before you proceed.<br />
<br />
= Update Open-Xchange Repositories =<br />
<br />
Add the following repositories to your <code>apt</code> configuration to access the v6.22 packages:<br />
<br />
<code>$ vim /etc/yum.repos.d/ox.repo</code><br />
[ox-frontend]<br />
name=Open-Xchange-frontend<br />
baseurl=http://software.open-xchange.com/OX6/6.22/frontend/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-backend]<br />
name=Open-Xchange-backend<br />
baseurl=http://software.open-xchange.com/OX6/6.22/backend/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-usm]<br />
name=Open-Xchange-USM<br />
baseurl=http://software.open-xchange.com/OX6/6.22/usm/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
# if you have a valid maintenance subscription, please uncomment the <br />
# following and add the ldb account data to the url so that the most recent<br />
# packages get installed<br />
<br />
[ox-updates-frontend]<br />
name=Open-Xchange Updates-frontend<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.22/updates/frontend/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-updates-backend]<br />
name=Open-Xchange Updates-backend<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.22/updates/backend/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-updates-usm]<br />
name=Open-Xchange Updates-USM<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.22/updates/usm/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
In case there are issues with an username and password containing URL unsafe characters, e.g. an @, they have to be entered URL encoded. Details can be found at http://www.w3schools.com/tags/ref_urlencode.asp<br />
<br />
Please note that frontend and backend packages are now provided from two different repositories. Depending on your setup and the packages installed on the specific system you're updating it is possible that you only need one of these repositories. All packages providing <code>open-xchange-admin</code> functionality are included in the <code>backend</code> repository.<br />
<br />
= Updating repositories and update packages =<br />
<br />
Reload the package index and update all installed packages:<br />
<br />
$ yum update<br />
$ yum upgrade<br />
<br />
= Install additional language packages if necessary =<br />
<br />
Starting with v6.22 the localization files for German, French and British English are no longer part of the core packages. This change was necessary to allow customers to uninstall these languages when they are not needed. If you want to offer German, French and/or British English to your customers as language option, you need to install the corresponding packages after the update.<br />
<br />
For German:<br />
<br />
$ yum install open-xchange-l10n-de-de open-xchange-gui-l10n-de-de<br />
<br />
For French:<br />
<br />
$ yum install open-xchange-l10n-fr-fr open-xchange-gui-l10n-fr-fr<br />
<br />
For British English:<br />
<br />
$ yum install open-xchange-gui-l10n-en-gb<br />
<br />
= Restart Open-Xchange =<br />
<br />
To restart Open-Xchange Server after the update, run<br />
<br />
$ /etc/init.d/open-xchange restart<br />
<br />
This script will check on startup if the old processes for <code>open-xchange-groupware</code> and <code>open-xchange-admin</code> are running, and stops them if they are. You might still want to check with<br />
<br />
$ ps aux | grep open-xchange<br />
<br />
that there is now only one process running Open-Xchange Server.<br />
<br />
= Leftover configuration files and runtime data =<br />
<br />
After the update you may see leftover configuration files and runtime data below <code>/opt/open-xchange/etc</code>.<br />
<br />
Some of these files belong to packages which have been uninstalled during the update.<br />
Other orphaned files may be runtime data or temporary files which do not belong to any package and therefore couldn't be removed during the package update.<br />
<br />
<code>package-cleanup --orphans | grep open-x*</code><br />
<br />
Finally, there may be backup files created by the package manager during earlier updates.<br />
<br />
It is safe to remove:<br />
<br />
* All files and subdirectories below:<br />
<br />
/opt/open-xchange/etc/admindaemon<br />
/opt/open-xchange/etc/common<br />
/opt/open-xchange/etc/groupware<br />
<br />
unless you have built your own packages which install files into these directories.<br />
<br />
* All files ending in <code>.rpmsave</code> or <code>.rpmnew</code> once you are confident that your configuration is working after the update.</div>Sgablerhttps://oxpedia.org/wiki/index.php?title=OX6:Open-Xchange_620_622_Update_Guide_for_CentOS5&diff=11626OX6:Open-Xchange 620 622 Update Guide for CentOS52012-10-05T19:59:28Z<p>Sgabler: /* Supported update path */</p>
<hr />
<div>= Update of Open-Xchange Server v6.20 to v6.22 on CentOS 5 =<br />
<br />
This article will guide you through the update of an existing Open-Xchange Server 6 installation to the newest major release, v6.22.<br />
<br />
= Supported update path =<br />
<br />
Please note that the update to v6.22 is only supported from an installed version 6.20.7. If you have an earlier version of Open-Xchange Server 6 installed, please update to the latest release of v6.20.7 before attempting an update to v6.22.<br />
<br />
The latest v6.20.7 release will remain accessible on our servers. If you need to access the repository after the release of v6.22, please use the following lines in your <code>yum</code> repository configuration to access v6.20 packages:<br />
<br />
Start a console and change the software repository file for Open-Xchange:<br />
<code>$ vim /etc/yum.repos.d/ox.repo</code><br />
[ox]<br />
name=Open-Xchange<br />
baseurl=http://software.open-xchange.com/OX6/6.20/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
# if you have a valid maintenance subscription, please uncomment the <br />
# following and add the ldb account data to the url so that the most recent<br />
# packages get installed<br />
<br />
[ox-updates]<br />
name=Open-Xchange Updates<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.20/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
= Requirements =<br />
* An Open-Xchange Server installation v6.20.7 or later. This update guide is valid for a system installed through our [[Open-Xchange_Installation_Guide_for_CentOS_5|Download and Installation Guide for CentOS 5]]<br />
* If you have custom packages done by Open-Xchange, please discuss with your Open-Xchange contact when these packages are available for 6.22. Do not attempt the update earlier<br />
* If you have built custom packages yourself which install config files in the OX config tree, please check the page [[6.22_Packaging_Changes|v6.22 Packaging Changes]]<br />
* If you have custom plugins written by yourself which depend on Open-Xchange Server OSGI bundles, check the pages [[6.22_Packaging_Changes|v6.22 Packaging Changes]] and [[6.22_Necessary_Code_Changes|v6.22 Necessary Code Changes]] for changes you might need to do.<br />
* Custom packages built for 6.20.7 or earlier might not work with 6.22.<br />
* As for every update we strongly recommend that you make a backup of your system(s) before you proceed.<br />
<br />
= Update Open-Xchange Repositories =<br />
<br />
Add the following repositories to your <code>apt</code> configuration to access the v6.22 packages:<br />
<br />
<code>$ vim /etc/yum.repos.d/ox.repo</code><br />
[ox-frontend]<br />
name=Open-Xchange-frontend<br />
baseurl=http://software.open-xchange.com/OX6/6.22/frontend/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-backend]<br />
name=Open-Xchange-backend<br />
baseurl=http://software.open-xchange.com/OX6/6.22/backend/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-usm]<br />
name=Open-Xchange-USM<br />
baseurl=http://software.open-xchange.com/OX6/6.22/usm/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
# if you have a valid maintenance subscription, please uncomment the <br />
# following and add the ldb account data to the url so that the most recent<br />
# packages get installed<br />
<br />
[ox-updates-frontend]<br />
name=Open-Xchange Updates-frontend<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.22/updates/frontend/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-updates-backend]<br />
name=Open-Xchange Updates-backend<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.22/updates/backend/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-updates-usm]<br />
name=Open-Xchange Updates-USM<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.22/updates/usm/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
In case there are issues with an username and password containing URL unsafe characters, e.g. an @, they have to be entered URL encoded. Details can be found at http://www.w3schools.com/tags/ref_urlencode.asp<br />
<br />
Please note that frontend and backend packages are now provided from two different repositories. Depending on your setup and the packages installed on the specific system you're updating it is possible that you only need one of these repositories. All packages providing <code>open-xchange-admin</code> functionality are included in the <code>backend</code> repository.<br />
<br />
= Updating repositories and update packages =<br />
<br />
Reload the package index and update all installed packages:<br />
<br />
$ yum update<br />
$ yum upgrade<br />
<br />
= Install additional language packages if necessary =<br />
<br />
Starting with v6.22 the localization files for German, French and British English are no longer part of the core packages. This change was necessary to allow customers to uninstall these languages when they are not needed. If you want to offer German, French and/or British English to your customers as language option, you need to install the corresponding packages after the update.<br />
<br />
For German:<br />
<br />
$ yum install open-xchange-l10n-de-de open-xchange-gui-l10n-de-de<br />
<br />
For French:<br />
<br />
$ yum install open-xchange-l10n-fr-fr open-xchange-gui-l10n-fr-fr<br />
<br />
For British English:<br />
<br />
$ yum install open-xchange-gui-l10n-en-gb<br />
<br />
= Restart Open-Xchange =<br />
<br />
To restart Open-Xchange Server after the update, run<br />
<br />
$ /etc/init.d/open-xchange restart<br />
<br />
This script will check on startup if the old processes for <code>open-xchange-groupware</code> and <code>open-xchange-admin</code> are running, and stops them if they are. You might still want to check with<br />
<br />
$ ps aux | grep open-xchange<br />
<br />
that there is now only one process running Open-Xchange Server.<br />
<br />
= Leftover configuration files and runtime data =<br />
<br />
After the update you may see leftover configuration files and runtime data below <code>/opt/open-xchange/etc</code>.<br />
<br />
Some of these files belong to packages which have been uninstalled during the update.<br />
Other orphaned files may be runtime data or temporary files which do not belong to any package and therefore couldn't be removed during the package update.<br />
<br />
<code>package-cleanup --orphans | grep open-x*</code><br />
<br />
Finally, there may be backup files created by the package manager during earlier updates.<br />
<br />
It is safe to remove:<br />
<br />
* All files and subdirectories below:<br />
<br />
/opt/open-xchange/etc/admindaemon<br />
/opt/open-xchange/etc/common<br />
/opt/open-xchange/etc/groupware<br />
<br />
unless you have built your own packages which install files into these directories.<br />
<br />
* All files ending in <code>.rpmsave</code> or <code>.rpmnew</code> once you are confident that your configuration is working after the update.</div>Sgablerhttps://oxpedia.org/wiki/index.php?title=OX6:Open-Xchange_620_622_Update_Guide_for_CentOS6&diff=11625OX6:Open-Xchange 620 622 Update Guide for CentOS62012-10-05T19:53:10Z<p>Sgabler: /* Update Open-Xchange Repositories */</p>
<hr />
<div>= Update of Open-Xchange Server v6.20 to v6.22 on CentOS 6 =<br />
<br />
This article will guide you through the update of an existing Open-Xchange Server 6 installation to the newest major release, v6.22.<br />
<br />
= Supported update path =<br />
<br />
Please note that the update to v6.22 is only supported from an installed version 6.20.7 or later. If you have an earlier version of Open-Xchange Server 6 installed, please update to the latest release of v6.20 before attempting an update to v6.22.<br />
<br />
The latest v6.20 release will remain accessible on our servers. If you need to access the repository after the release of v6.22, please use the following lines in your <code>yum</code> repository configuration to access v6.20 packages:<br />
<br />
Start a console and change the software repository file for Open-Xchange:<br />
<code>$ vim /etc/yum.repos.d/ox.repo</code><br />
[ox]<br />
name=Open-Xchange<br />
baseurl=http://software.open-xchange.com/OX6/6.20/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
# if you have a valid maintenance subscription, please uncomment the <br />
# following and add the ldb account data to the url so that the most recent<br />
# packages get installed<br />
<br />
[ox-updates]<br />
name=Open-Xchange Updates<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.20/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
= Requirements =<br />
* An Open-Xchange Server installation v6.20.7 or later. This update guide is valid for a system installed through our [[Open-Xchange_Installation_Guide_for_CentOS_6|Download and Installation Guide for CentOS 6]]<br />
* If you have custom packages done by Open-Xchange, please discuss with your Open-Xchange contact when these packages are available for 6.22. Do not attempt the update earlier<br />
* If you have built custom packages yourself which install config files in the OX config tree, please check the page [[6.22_Packaging_Changes|v6.22 Packaging Changes]]<br />
* If you have custom plugins written by yourself which depend on Open-Xchange Server OSGI bundles, check the pages [[6.22_Packaging_Changes|v6.22 Packaging Changes]] and [[6.22_Necessary_Code_Changes|v6.22 Necessary Code Changes]] for changes you might need to do.<br />
* Custom packages built for 6.20.7 or earlier might not work with 6.22.<br />
* As for every update we strongly recommend that you make a backup of your system(s) before you proceed.<br />
<br />
= Update Open-Xchange Repositories =<br />
<br />
Add the following repositories to your <code>apt</code> configuration to access the v6.22 packages:<br />
<br />
<code>$ vim /etc/yum.repos.d/ox.repo</code><br />
[ox-frontend]<br />
name=Open-Xchange-frontend<br />
baseurl=http://software.open-xchange.com/OX6/6.22/frontend/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-backend]<br />
name=Open-Xchange-backend<br />
baseurl=http://software.open-xchange.com/OX6/6.22/backend/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-usm]<br />
name=Open-Xchange-USM<br />
baseurl=http://software.open-xchange.com/OX6/6.22/usm/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
# if you have a valid maintenance subscription, please uncomment the <br />
# following and add the ldb account data to the url so that the most recent<br />
# packages get installed<br />
<br />
[ox-updates-frontend]<br />
name=Open-Xchange Updates-frontend<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.22/updates/frontend/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-updates-backend]<br />
name=Open-Xchange Updates-backend<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.22/updates/backend/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-updates-usm]<br />
name=Open-Xchange Updates-USM<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.22/updates/usm/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
In case there are issues with an username and password containing URL unsafe characters, e.g. an @, they have to be entered URL encoded. Details can be found at http://www.w3schools.com/tags/ref_urlencode.asp<br />
<br />
Please note that frontend and backend packages are now provided from two different repositories. Depending on your setup and the packages installed on the specific system you're updating it is possible that you only need one of these repositories. All packages providing <code>open-xchange-admin</code> functionality are included in the <code>backend</code> repository.<br />
<br />
= Updating repositories and update packages =<br />
<br />
Reload the package index and update all installed packages:<br />
<br />
$ yum update<br />
$ yum upgrade<br />
<br />
= Install additional language packages if necessary =<br />
<br />
Starting with v6.22 the localization files for German, French and British English are no longer part of the core packages. This change was necessary to allow customers to uninstall these languages when they are not needed. If you want to offer German, French and/or British English to your customers as language option, you need to install the corresponding packages after the update.<br />
<br />
For German:<br />
<br />
$ yum install open-xchange-l10n-de-de open-xchange-gui-l10n-de-de<br />
<br />
For French:<br />
<br />
$ yum install open-xchange-l10n-fr-fr open-xchange-gui-l10n-fr-fr<br />
<br />
For British English:<br />
<br />
$ yum install open-xchange-gui-l10n-en-gb<br />
<br />
= Restart Open-Xchange =<br />
<br />
To restart Open-Xchange Server after the update, run<br />
<br />
$ /etc/init.d/open-xchange restart<br />
<br />
This script will check on startup if the old processes for <code>open-xchange-groupware</code> and <code>open-xchange-admin</code> are running, and stops them if they are. You might still want to check with<br />
<br />
$ ps aux | grep open-xchange<br />
<br />
that there is now only one process running Open-Xchange Server.<br />
<br />
= Leftover configuration files and runtime data =<br />
<br />
After the update you may see leftover configuration files and runtime data below <code>/opt/open-xchange/etc</code>.<br />
<br />
Some of these files belong to packages which have been uninstalled during the update.<br />
Other orphaned files may be runtime data or temporary files which do not belong to any package and therefore couldn't be removed during the package update.<br />
<br />
<code>package-cleanup --orphans | grep open-x*</code><br />
<br />
Finally, there may be backup files created by the package manager during earlier updates.<br />
<br />
It is safe to remove:<br />
<br />
* All files and subdirectories below:<br />
<br />
/opt/open-xchange/etc/admindaemon<br />
/opt/open-xchange/etc/common<br />
/opt/open-xchange/etc/groupware<br />
<br />
unless you have built your own packages which install files into these directories.<br />
<br />
* All files ending in <code>.rpmsave</code> or <code>.rpmnew</code> once you are confident that your configuration is working after the update.</div>Sgablerhttps://oxpedia.org/wiki/index.php?title=OX6:Open-Xchange_620_622_Update_Guide_for_CentOS5&diff=11624OX6:Open-Xchange 620 622 Update Guide for CentOS52012-10-05T19:52:23Z<p>Sgabler: /* Update Open-Xchange Repositories */</p>
<hr />
<div>= Update of Open-Xchange Server v6.20 to v6.22 on CentOS 5 =<br />
<br />
This article will guide you through the update of an existing Open-Xchange Server 6 installation to the newest major release, v6.22.<br />
<br />
= Supported update path =<br />
<br />
Please note that the update to v6.22 is only supported from an installed version 6.20.7 or later. If you have an earlier version of Open-Xchange Server 6 installed, please update to the latest release of v6.20 before attempting an update to v6.22.<br />
<br />
The latest v6.20 release will remain accessible on our servers. If you need to access the repository after the release of v6.22, please use the following lines in your <code>yum</code> repository configuration to access v6.20 packages:<br />
<br />
Start a console and change the software repository file for Open-Xchange:<br />
<code>$ vim /etc/yum.repos.d/ox.repo</code><br />
[ox]<br />
name=Open-Xchange<br />
baseurl=http://software.open-xchange.com/OX6/6.20/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
# if you have a valid maintenance subscription, please uncomment the <br />
# following and add the ldb account data to the url so that the most recent<br />
# packages get installed<br />
<br />
[ox-updates]<br />
name=Open-Xchange Updates<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.20/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
= Requirements =<br />
* An Open-Xchange Server installation v6.20.7 or later. This update guide is valid for a system installed through our [[Open-Xchange_Installation_Guide_for_CentOS_5|Download and Installation Guide for CentOS 5]]<br />
* If you have custom packages done by Open-Xchange, please discuss with your Open-Xchange contact when these packages are available for 6.22. Do not attempt the update earlier<br />
* If you have built custom packages yourself which install config files in the OX config tree, please check the page [[6.22_Packaging_Changes|v6.22 Packaging Changes]]<br />
* If you have custom plugins written by yourself which depend on Open-Xchange Server OSGI bundles, check the pages [[6.22_Packaging_Changes|v6.22 Packaging Changes]] and [[6.22_Necessary_Code_Changes|v6.22 Necessary Code Changes]] for changes you might need to do.<br />
* Custom packages built for 6.20.7 or earlier might not work with 6.22.<br />
* As for every update we strongly recommend that you make a backup of your system(s) before you proceed.<br />
<br />
= Update Open-Xchange Repositories =<br />
<br />
Add the following repositories to your <code>apt</code> configuration to access the v6.22 packages:<br />
<br />
<code>$ vim /etc/yum.repos.d/ox.repo</code><br />
[ox-frontend]<br />
name=Open-Xchange-frontend<br />
baseurl=http://software.open-xchange.com/OX6/6.22/frontend/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-backend]<br />
name=Open-Xchange-backend<br />
baseurl=http://software.open-xchange.com/OX6/6.22/backend/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-usm]<br />
name=Open-Xchange-USM<br />
baseurl=http://software.open-xchange.com/OX6/6.22/usm/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
# if you have a valid maintenance subscription, please uncomment the <br />
# following and add the ldb account data to the url so that the most recent<br />
# packages get installed<br />
<br />
[ox-updates-frontend]<br />
name=Open-Xchange Updates-frontend<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.22/updates/frontend/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-updates-backend]<br />
name=Open-Xchange Updates-backend<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.22/updates/backend/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-updates-usm]<br />
name=Open-Xchange Updates-USM<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.22/updates/usm/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
In case there are issues with an username and password containing URL unsafe characters, e.g. an @, they have to be entered URL encoded. Details can be found at http://www.w3schools.com/tags/ref_urlencode.asp<br />
<br />
Please note that frontend and backend packages are now provided from two different repositories. Depending on your setup and the packages installed on the specific system you're updating it is possible that you only need one of these repositories. All packages providing <code>open-xchange-admin</code> functionality are included in the <code>backend</code> repository.<br />
<br />
= Updating repositories and update packages =<br />
<br />
Reload the package index and update all installed packages:<br />
<br />
$ yum update<br />
$ yum upgrade<br />
<br />
= Install additional language packages if necessary =<br />
<br />
Starting with v6.22 the localization files for German, French and British English are no longer part of the core packages. This change was necessary to allow customers to uninstall these languages when they are not needed. If you want to offer German, French and/or British English to your customers as language option, you need to install the corresponding packages after the update.<br />
<br />
For German:<br />
<br />
$ yum install open-xchange-l10n-de-de open-xchange-gui-l10n-de-de<br />
<br />
For French:<br />
<br />
$ yum install open-xchange-l10n-fr-fr open-xchange-gui-l10n-fr-fr<br />
<br />
For British English:<br />
<br />
$ yum install open-xchange-gui-l10n-en-gb<br />
<br />
= Restart Open-Xchange =<br />
<br />
To restart Open-Xchange Server after the update, run<br />
<br />
$ /etc/init.d/open-xchange restart<br />
<br />
This script will check on startup if the old processes for <code>open-xchange-groupware</code> and <code>open-xchange-admin</code> are running, and stops them if they are. You might still want to check with<br />
<br />
$ ps aux | grep open-xchange<br />
<br />
that there is now only one process running Open-Xchange Server.<br />
<br />
= Leftover configuration files and runtime data =<br />
<br />
After the update you may see leftover configuration files and runtime data below <code>/opt/open-xchange/etc</code>.<br />
<br />
Some of these files belong to packages which have been uninstalled during the update.<br />
Other orphaned files may be runtime data or temporary files which do not belong to any package and therefore couldn't be removed during the package update.<br />
<br />
<code>package-cleanup --orphans | grep open-x*</code><br />
<br />
Finally, there may be backup files created by the package manager during earlier updates.<br />
<br />
It is safe to remove:<br />
<br />
* All files and subdirectories below:<br />
<br />
/opt/open-xchange/etc/admindaemon<br />
/opt/open-xchange/etc/common<br />
/opt/open-xchange/etc/groupware<br />
<br />
unless you have built your own packages which install files into these directories.<br />
<br />
* All files ending in <code>.rpmsave</code> or <code>.rpmnew</code> once you are confident that your configuration is working after the update.</div>Sgablerhttps://oxpedia.org/wiki/index.php?title=OX6:Open-Xchange_620_622_Update_Guide_for_RHEL6&diff=11623OX6:Open-Xchange 620 622 Update Guide for RHEL62012-10-05T19:50:43Z<p>Sgabler: /* Update Open-Xchange Repositories */</p>
<hr />
<div>= Update of Open-Xchange Server v6.20 to v6.22 on RHEL 6 =<br />
<br />
This article will guide you through the update of an existing Open-Xchange Server 6 installation to the newest major release, v6.22.<br />
<br />
= Supported update path =<br />
<br />
Please note that the update to v6.22 is only supported from an installed version 6.20.7 or later. If you have an earlier version of Open-Xchange Server 6 installed, please update to the latest release of v6.20 before attempting an update to v6.22.<br />
<br />
The latest v6.20 release will remain accessible on our servers. If you need to access the repository after the release of v6.22, please use the following lines in your <code>yum</code> repository configuration to access v6.20 packages:<br />
<br />
Start a console and change the software repository file for Open-Xchange:<br />
<code>$ vim /etc/yum.repos.d/ox.repo</code><br />
[ox]<br />
name=Open-Xchange<br />
baseurl=http://software.open-xchange.com/OX6/6.20/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
# if you have a valid maintenance subscription, please uncomment the <br />
# following and add the ldb account data to the url so that the most recent<br />
# packages get installed<br />
<br />
[ox-updates]<br />
name=Open-Xchange Updates<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.20/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
= Requirements =<br />
* An Open-Xchange Server installation v6.20.7 or later. This update guide is valid for a system installed through our [[Open-Xchange_Installation_Guide_for_RHEL6|Download and Installation Guide for RHEL 6]]<br />
* If you have custom packages done by Open-Xchange, please discuss with your Open-Xchange contact when these packages are available for 6.22. Do not attempt the update earlier<br />
* If you have built custom packages yourself which install config files in the OX config tree, please check the page [[6.22_Packaging_Changes|v6.22 Packaging Changes]]<br />
* If you have custom plugins written by yourself which depend on Open-Xchange Server OSGI bundles, check the pages [[6.22_Packaging_Changes|v6.22 Packaging Changes]] and [[6.22_Necessary_Code_Changes|v6.22 Necessary Code Changes]] for changes you might need to do.<br />
* Custom packages built for 6.20.7 or earlier might not work with 6.22.<br />
* As for every update we strongly recommend that you make a backup of your system(s) before you proceed.<br />
<br />
= Update Open-Xchange Repositories =<br />
<br />
Add the following repositories to your <code>apt</code> configuration to access the v6.22 packages:<br />
<br />
<code>$ vim /etc/yum.repos.d/ox.repo</code><br />
[ox-frontend]<br />
name=Open-Xchange-frontend<br />
baseurl=http://software.open-xchange.com/OX6/6.22/frontend/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-backend]<br />
name=Open-Xchange-backend<br />
baseurl=http://software.open-xchange.com/OX6/6.22/backend/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-usm]<br />
name=Open-Xchange-USM<br />
baseurl=http://software.open-xchange.com/OX6/6.22/usm/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
# if you have a valid maintenance subscription, please uncomment the <br />
# following and add the ldb account data to the url so that the most recent<br />
# packages get installed<br />
<br />
[ox-updates-frontend]<br />
name=Open-Xchange Updates-frontend<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.22/updates/frontend/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-updates-backend]<br />
name=Open-Xchange Updates-backend<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.22/updates/backend/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-updates-usm]<br />
name=Open-Xchange Updates-USM<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.22/updates/usm/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
In case there are issues with an username and password containing URL unsafe characters, e.g. an @, they have to be entered URL encoded. Details can be found at http://www.w3schools.com/tags/ref_urlencode.asp<br />
<br />
Please note that frontend and backend packages are now provided from two different repositories. Depending on your setup and the packages installed on the specific system you're updating it is possible that you only need one of these repositories. All packages providing <code>open-xchange-admin</code> functionality are included in the <code>backend</code> repository.<br />
<br />
= Updating repositories and update packages =<br />
<br />
Reload the package index and update all installed packages:<br />
<br />
$ yum update<br />
$ yum upgrade<br />
<br />
= Install additional language packages if necessary =<br />
<br />
Starting with v6.22 the localization files for German, French and British English are no longer part of the core packages. This change was necessary to allow customers to uninstall these languages when they are not needed. If you want to offer German, French and/or British English to your customers as language option, you need to install the corresponding packages after the update.<br />
<br />
For German:<br />
<br />
$ yum install open-xchange-l10n-de-de open-xchange-gui-l10n-de-de<br />
<br />
For French:<br />
<br />
$ yum install open-xchange-l10n-fr-fr open-xchange-gui-l10n-fr-fr<br />
<br />
For British English:<br />
<br />
$ yum install open-xchange-gui-l10n-en-gb<br />
<br />
= Restart Open-Xchange =<br />
<br />
To restart Open-Xchange Server after the update, run<br />
<br />
$ /etc/init.d/open-xchange restart<br />
<br />
This script will check on startup if the old processes for <code>open-xchange-groupware</code> and <code>open-xchange-admin</code> are running, and stops them if they are. You might still want to check with<br />
<br />
$ ps aux | grep open-xchange<br />
<br />
that there is now only one process running Open-Xchange Server.<br />
<br />
= Leftover configuration files and runtime data =<br />
<br />
After the update you may see leftover configuration files and runtime data below <code>/opt/open-xchange/etc</code>.<br />
<br />
Some of these files belong to packages which have been uninstalled during the update.<br />
Other orphaned files may be runtime data or temporary files which do not belong to any package and therefore couldn't be removed during the package update.<br />
<br />
<code>package-cleanup --orphans | grep open-x*</code><br />
<br />
Finally, there may be backup files created by the package manager during earlier updates.<br />
<br />
It is safe to remove:<br />
<br />
* All files and subdirectories below:<br />
<br />
/opt/open-xchange/etc/admindaemon<br />
/opt/open-xchange/etc/common<br />
/opt/open-xchange/etc/groupware<br />
<br />
unless you have built your own packages which install files into these directories.<br />
<br />
* All files ending in <code>.rpmsave</code> or <code>.rpmnew</code> once you are confident that your configuration is working after the update.</div>Sgablerhttps://oxpedia.org/wiki/index.php?title=OX6:Open-Xchange_620_622_Update_Guide_for_RHEL5&diff=11622OX6:Open-Xchange 620 622 Update Guide for RHEL52012-10-05T19:46:11Z<p>Sgabler: /* Update Open-Xchange Repositories */</p>
<hr />
<div>= Update of Open-Xchange Server v6.20 to v6.22 on RHEL 5 =<br />
<br />
This article will guide you through the update of an existing Open-Xchange Server 6 installation to the newest major release, v6.22.<br />
<br />
= Supported update path =<br />
<br />
Please note that the update to v6.22 is only supported from an installed version 6.20.7 or later. If you have an earlier version of Open-Xchange Server 6 installed, please update to the latest release of v6.20 before attempting an update to v6.22.<br />
<br />
The latest v6.20 release will remain accessible on our servers. If you need to access the repository after the release of v6.22, please use the following lines in your <code>yum</code> repository configuration to access v6.20 packages:<br />
<br />
Start a console and change the software repository file for Open-Xchange:<br />
<code>$ vim /etc/yum.repos.d/ox.repo</code><br />
[ox]<br />
name=Open-Xchange<br />
baseurl=http://software.open-xchange.com/OX6/6.20/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
# if you have a valid maintenance subscription, please uncomment the <br />
# following and add the ldb account data to the url so that the most recent<br />
# packages get installed<br />
<br />
[ox-updates]<br />
name=Open-Xchange Updates<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.20/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
= Requirements =<br />
* An Open-Xchange Server installation v6.20.7 or later. This update guide is valid for a system installed through our [[Open-Xchange_Installation_Guide_for_RHEL5|Download and Installation Guide for RHEL 5]]<br />
* If you have custom packages done by Open-Xchange, please discuss with your Open-Xchange contact when these packages are available for 6.22. Do not attempt the update earlier<br />
* If you have built custom packages yourself which install config files in the OX config tree, please check the page [[6.22_Packaging_Changes|v6.22 Packaging Changes]]<br />
* If you have custom plugins written by yourself which depend on Open-Xchange Server OSGI bundles, check the pages [[6.22_Packaging_Changes|v6.22 Packaging Changes]] and [[6.22_Necessary_Code_Changes|v6.22 Necessary Code Changes]] for changes you might need to do.<br />
* Custom packages built for 6.20.7 or earlier might not work with 6.22.<br />
* As for every update we strongly recommend that you make a backup of your system(s) before you proceed.<br />
<br />
= Update Open-Xchange Repositories =<br />
<br />
Add the following repositories to your <code>apt</code> configuration to access the v6.22 packages:<br />
<br />
<code>$ vim /etc/yum.repos.d/ox.repo</code><br />
[ox-frontend]<br />
name=Open-Xchange-frontend<br />
baseurl=http://software.open-xchange.com/OX6/6.22/frontend/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-backend]<br />
name=Open-Xchange-backend<br />
baseurl=http://software.open-xchange.com/OX6/6.22/backend/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-usm]<br />
name=Open-Xchange-USM<br />
baseurl=http://software.open-xchange.com/OX6/6.22/usm/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
# if you have a valid maintenance subscription, please uncomment the <br />
# following and add the ldb account data to the url so that the most recent<br />
# packages get installed<br />
<br />
[ox-updates-frontend]<br />
name=Open-Xchange Updates-frontend<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.22/updates/frontend/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-updates-backend]<br />
name=Open-Xchange Updates-backend<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.22/updates/backend/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-updates-usm]<br />
name=Open-Xchange Updates-USM<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.22/updates/usm/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
In case there are issues with an username and password containing URL unsafe characters, e.g. an @, they have to be entered URL encoded. Details can be found at http://www.w3schools.com/tags/ref_urlencode.asp<br />
<br />
Please note that frontend and backend packages are now provided from two different repositories. Depending on your setup and the packages installed on the specific system you're updating it is possible that you only need one of these repositories. All packages providing <code>open-xchange-admin</code> functionality are included in the <code>backend</code> repository.<br />
<br />
= Updating repositories and update packages =<br />
<br />
Reload the package index and update all installed packages:<br />
<br />
$ yum update<br />
$ yum upgrade<br />
<br />
= Install additional language packages if necessary =<br />
<br />
Starting with v6.22 the localization files for German, French and British English are no longer part of the core packages. This change was necessary to allow customers to uninstall these languages when they are not needed. If you want to offer German, French and/or British English to your customers as language option, you need to install the corresponding packages after the update.<br />
<br />
For German:<br />
<br />
$ yum install open-xchange-l10n-de-de open-xchange-gui-l10n-de-de<br />
<br />
For French:<br />
<br />
$ yum install open-xchange-l10n-fr-fr open-xchange-gui-l10n-fr-fr<br />
<br />
For British English:<br />
<br />
$ yum install open-xchange-gui-l10n-en-gb<br />
<br />
= Restart Open-Xchange =<br />
<br />
To restart Open-Xchange Server after the update, run<br />
<br />
$ /etc/init.d/open-xchange restart<br />
<br />
This script will check on startup if the old processes for <code>open-xchange-groupware</code> and <code>open-xchange-admin</code> are running, and stops them if they are. You might still want to check with<br />
<br />
$ ps aux | grep open-xchange<br />
<br />
that there is now only one process running Open-Xchange Server.<br />
<br />
= Leftover configuration files and runtime data =<br />
<br />
After the update you may see leftover configuration files and runtime data below <code>/opt/open-xchange/etc</code>.<br />
<br />
Some of these files belong to packages which have been uninstalled during the update.<br />
Other orphaned files may be runtime data or temporary files which do not belong to any package and therefore couldn't be removed during the package update.<br />
<br />
<code>package-cleanup --orphans | grep open-x*</code><br />
<br />
Finally, there may be backup files created by the package manager during earlier updates.<br />
<br />
It is safe to remove:<br />
<br />
* All files and subdirectories below:<br />
<br />
/opt/open-xchange/etc/admindaemon<br />
/opt/open-xchange/etc/common<br />
/opt/open-xchange/etc/groupware<br />
<br />
unless you have built your own packages which install files into these directories.<br />
<br />
* All files ending in <code>.rpmsave</code> or <code>.rpmnew</code> once you are confident that your configuration is working after the update.</div>Sgablerhttps://oxpedia.org/wiki/index.php?title=OX6:Open-Xchange_620_622_Update_Guide_for_RHEL5&diff=11621OX6:Open-Xchange 620 622 Update Guide for RHEL52012-10-05T19:29:01Z<p>Sgabler: /* Requirements */</p>
<hr />
<div>= Update of Open-Xchange Server v6.20 to v6.22 on RHEL 5 =<br />
<br />
This article will guide you through the update of an existing Open-Xchange Server 6 installation to the newest major release, v6.22.<br />
<br />
= Supported update path =<br />
<br />
Please note that the update to v6.22 is only supported from an installed version 6.20.7 or later. If you have an earlier version of Open-Xchange Server 6 installed, please update to the latest release of v6.20 before attempting an update to v6.22.<br />
<br />
The latest v6.20 release will remain accessible on our servers. If you need to access the repository after the release of v6.22, please use the following lines in your <code>yum</code> repository configuration to access v6.20 packages:<br />
<br />
Start a console and change the software repository file for Open-Xchange:<br />
<code>$ vim /etc/yum.repos.d/ox.repo</code><br />
[ox]<br />
name=Open-Xchange<br />
baseurl=http://software.open-xchange.com/OX6/6.20/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
# if you have a valid maintenance subscription, please uncomment the <br />
# following and add the ldb account data to the url so that the most recent<br />
# packages get installed<br />
<br />
[ox-updates]<br />
name=Open-Xchange Updates<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.20/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
= Requirements =<br />
* An Open-Xchange Server installation v6.20.7 or later. This update guide is valid for a system installed through our [[Open-Xchange_Installation_Guide_for_RHEL5|Download and Installation Guide for RHEL 5]]<br />
* If you have custom packages done by Open-Xchange, please discuss with your Open-Xchange contact when these packages are available for 6.22. Do not attempt the update earlier<br />
* If you have built custom packages yourself which install config files in the OX config tree, please check the page [[6.22_Packaging_Changes|v6.22 Packaging Changes]]<br />
* If you have custom plugins written by yourself which depend on Open-Xchange Server OSGI bundles, check the pages [[6.22_Packaging_Changes|v6.22 Packaging Changes]] and [[6.22_Necessary_Code_Changes|v6.22 Necessary Code Changes]] for changes you might need to do.<br />
* Custom packages built for 6.20.7 or earlier might not work with 6.22.<br />
* As for every update we strongly recommend that you make a backup of your system(s) before you proceed.<br />
<br />
= Update Open-Xchange Repositories =<br />
<br />
Add the following repositories to your <code>apt</code> configuration to access the v6.22 packages:<br />
<br />
<code>$ vim /etc/yum.repos.d/ox.repo</code><br />
[ox-frontend]<br />
name=Open-Xchange-frontend<br />
baseurl=http://software.open-xchange.com/OX6/6.22/frontend/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-backend]<br />
name=Open-Xchange-backend<br />
baseurl=http://software.open-xchange.com/OX6/6.22/backend/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-usm]<br />
name=Open-Xchange-USM<br />
baseurl=http://software.open-xchange.com/OX6/6.22/usm/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
# if you have a valid maintenance subscription, please uncomment the <br />
# following and add the ldb account data to the url so that the most recent<br />
# packages get installed<br />
<br />
[ox-updates-frontend]<br />
name=Open-Xchange Updates-frontend<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.22/updates/frontend/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-updates-backend]<br />
name=Open-Xchange Updates-backend<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.22/updates/backend/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-updates-usm]<br />
name=Open-Xchange Updates-USM<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.22/updates/usm/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
In case there are issues with an username and password containing URL unsafe characters, e.g. an @, they have to be entered URL encoded. Details can be found at http://www.w3schools.com/tags/ref_urlencode.asp<br />
<br />
Please note that frontend and backend packages are now provided from two different repositories. Depending on your setup and the packages installed on the specific system you're updating it is possible that you only need one of these repositories. All packages providing <code>open-xchange-admin</code> functionality are included in the <code>backend</code> repository.<br />
<br />
= Updating repositories and update packages =<br />
<br />
Reload the package index and update all installed packages:<br />
<br />
$ yum update<br />
$ yum upgrade<br />
<br />
= Install additional language packages if necessary =<br />
<br />
Starting with v6.22 the localization files for German, French and British English are no longer part of the core packages. This change was necessary to allow customers to uninstall these languages when they are not needed. If you want to offer German, French and/or British English to your customers as language option, you need to install the corresponding packages after the update.<br />
<br />
For German:<br />
<br />
$ yum install open-xchange-l10n-de-de open-xchange-gui-l10n-de-de<br />
<br />
For French:<br />
<br />
$ yum install open-xchange-l10n-fr-fr open-xchange-gui-l10n-fr-fr<br />
<br />
For British English:<br />
<br />
$ yum install open-xchange-gui-l10n-en-gb<br />
<br />
= Restart Open-Xchange =<br />
<br />
To restart Open-Xchange Server after the update, run<br />
<br />
$ /etc/init.d/open-xchange restart<br />
<br />
This script will check on startup if the old processes for <code>open-xchange-groupware</code> and <code>open-xchange-admin</code> are running, and stops them if they are. You might still want to check with<br />
<br />
$ ps aux | grep open-xchange<br />
<br />
that there is now only one process running Open-Xchange Server.<br />
<br />
= Leftover configuration files and runtime data =<br />
<br />
After the update you may see leftover configuration files and runtime data below <code>/opt/open-xchange/etc</code>.<br />
<br />
Some of these files belong to packages which have been uninstalled during the update.<br />
Other orphaned files may be runtime data or temporary files which do not belong to any package and therefore couldn't be removed during the package update.<br />
<br />
<code>package-cleanup --orphans | grep open-x*</code><br />
<br />
Finally, there may be backup files created by the package manager during earlier updates.<br />
<br />
It is safe to remove:<br />
<br />
* All files and subdirectories below:<br />
<br />
/opt/open-xchange/etc/admindaemon<br />
/opt/open-xchange/etc/common<br />
/opt/open-xchange/etc/groupware<br />
<br />
unless you have built your own packages which install files into these directories.<br />
<br />
* All files ending in <code>.rpmsave</code> or <code>.rpmnew</code> once you are confident that your configuration is working after the update.</div>Sgablerhttps://oxpedia.org/wiki/index.php?title=Template:AddReposRHEL&diff=11601Template:AddReposRHEL2012-10-05T17:23:03Z<p>Sgabler: /* Add Open-Xchange Repository */</p>
<hr />
<div>= Add Open-Xchange Repository =<br />
<br />
Open-Xchange maintains public available software repositories for different platforms, such as RHEL. This repository should be added to the RHEL installation to enable simple installation and updates.<br />
<br />
Start a console and create a software repository file for Open-Xchange:<br />
{{#if:{{{release}}}|{{#ifeq:{{{release|}}}|6.20|<br />
<code>$ vim /etc/yum.repos.d/ox.repo</code><br />
[ox]<br />
name=Open-Xchange<br />
baseurl=http://software.open-xchange.com/OX6/stable/{{{rhelname}}}/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
# if you have a valid maintenance subscription, please uncomment the <br />
# following and add the ldb account data to the url so that the most recent<br />
# packages get installed<br />
<br />
[ox-updates]<br />
name=Open-Xchange Updates<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/updates/{{{rhelname}}}/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
|}}|}}<br />
<br />
{{#if:{{{release}}}|{{#ifeq:{{{release|}}}|6.22|<br />
<code>$ vim /etc/yum.repos.d/ox.repo</code><br />
[ox-frontend]<br />
name=Open-Xchange-frontend<br />
baseurl=http://software.open-xchange.com/OX6/6.22/frontend/{{{rhelname}}}/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-backend]<br />
name=Open-Xchange-backend<br />
baseurl=http://software.open-xchange.com/OX6/6.22/backend/{{{rhelname}}}/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-usm]<br />
name=Open-Xchange-USM<br />
baseurl=http://software.open-xchange.com/OX6/6.22/usm/{{{rhelname}}}/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
# if you have a valid maintenance subscription, please uncomment the <br />
# following and add the ldb account data to the url so that the most recent<br />
# packages get installed<br />
<br />
[ox-updates-frontend]<br />
name=Open-Xchange Updates-frontend<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.22/updates/frontend/{{{rhelname}}}/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-updates-backend]<br />
name=Open-Xchange Updates-backend<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.22/updates/backend/{{{rhelname}}}/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-updates-usm]<br />
name=Open-Xchange Updates-USM<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.22/updates/usm/{{{rhelname}}}/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
|}}|}}<br />
In case there are issues with an username and password containing URL unsafe characters, e.g. an @, they have to be entered URL encoded. Details can be found at http://www.w3schools.com/tags/ref_urlencode.asp</div>Sgablerhttps://oxpedia.org/wiki/index.php?title=Template:AddReposRHEL&diff=11600Template:AddReposRHEL2012-10-05T17:22:05Z<p>Sgabler: /* Add Open-Xchange Repository */</p>
<hr />
<div>= Add Open-Xchange Repository =<br />
<br />
Open-Xchange maintains public available software repositories for different platforms, such as RHEL. This repository should be added to the RHEL installation to enable simple installation and updates.<br />
<br />
Start a console and create a software repository file for Open-Xchange:<br />
{{#if:{{{release}}}|{{#ifeq:{{{release|}}}|6.20|<br />
<code>$ vim /etc/yum.repos.d/ox.repo</code><br />
[ox]<br />
name=Open-Xchange<br />
baseurl=http://software.open-xchange.com/OX6/stable/{{{rhelname}}}/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
# if you have a valid maintenance subscription, please uncomment the <br />
# following and add the ldb account data to the url so that the most recent<br />
# packages get installed<br />
<br />
[ox-updates]<br />
name=Open-Xchange Updates<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/updates/{{{rhelname}}}/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
|}}|}}<br />
<br />
{{#if:{{{release}}}|{{#ifeq:{{{release|}}}|6.22|<br />
<code>$ vim /etc/yum.repos.d/ox.repo</code><br />
[ox-frontend]<br />
name=Open-Xchange-frontend<br />
baseurl=http://software.open-xchange.com/OX6/6.22/frontend/{{{rhelname}}}/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-backend]<br />
name=Open-Xchange-backend<br />
baseurl=http://software.open-xchange.com/OX6/6.22/backend/{{{rhelname}}}/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-usm]<br />
name=Open-Xchange-USM<br />
baseurl=http://software.open-xchange.com/OX6/6.22/usm/{{{rhelname}}}/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
# if you have a valid maintenance subscription, please uncomment the <br />
# following and add the ldb account data to the url so that the most recent<br />
# packages get installed<br />
<br />
[ox-updates-frontend]<br />
name=Open-Xchange Updates-frontend<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.22/updates/frontend/{{{rhelname}}}/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-updates-backend]<br />
name=Open-Xchange Updates-backend<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.22/updates/backend/{{{rhelname}}}/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-updates-usm]<br />
name=Open-Xchange Updates-USM<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.22/updates/usm/{{{rhelname}}}/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
|}}|}}<br />
In case there are issues with an username and password containing URL unsafe characters, e.g. an @, they have to be entered URL encoded. Details can be found at http://www.w3schools.com/tags/ref_urlencode.asp</div>Sgablerhttps://oxpedia.org/wiki/index.php?title=OX6:Open-Xchange_620_622_Update_Guide_for_RHEL6&diff=11599OX6:Open-Xchange 620 622 Update Guide for RHEL62012-10-05T17:14:56Z<p>Sgabler: /* Update Open-Xchange Repositories */</p>
<hr />
<div>= Update of Open-Xchange Server v6.20 to v6.22 on RHEL 6 =<br />
<br />
This article will guide you through the update of an existing Open-Xchange Server 6 installation to the newest major release, v6.22.<br />
<br />
= Supported update path =<br />
<br />
Please note that the update to v6.22 is only supported from an installed version 6.20.7 or later. If you have an earlier version of Open-Xchange Server 6 installed, please update to the latest release of v6.20 before attempting an update to v6.22.<br />
<br />
The latest v6.20 release will remain accessible on our servers. If you need to access the repository after the release of v6.22, please use the following lines in your <code>yum</code> repository configuration to access v6.20 packages:<br />
<br />
Start a console and change the software repository file for Open-Xchange:<br />
<code>$ vim /etc/yum.repos.d/ox.repo</code><br />
[ox]<br />
name=Open-Xchange<br />
baseurl=http://software.open-xchange.com/OX6/6.20/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
# if you have a valid maintenance subscription, please uncomment the <br />
# following and add the ldb account data to the url so that the most recent<br />
# packages get installed<br />
<br />
[ox-updates]<br />
name=Open-Xchange Updates<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.20/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
= Requirements =<br />
* An Open-Xchange Server installation v6.20.7 or later. This update guide is valid for a system installed through our [[Open-Xchange_Installation_Guide_for_RHEL6|Download and Installation Guide for RHEL 6]]<br />
* If you have custom packages done by Open-Xchange, please discuss with your Open-Xchange contact when these packages are available for 6.22. Do not attempt the update earlier<br />
* If you have built custom packages yourself which install config files in the OX config tree, please check the page [[6.22_Packaging_Changes|v6.22 Packaging Changes]]<br />
* If you have custom plugins written by yourself which depend on Open-Xchange Server OSGI bundles, check the pages [[6.22_Packaging_Changes|v6.22 Packaging Changes]] and [[6.22_Necessary_Code_Changes|v6.22 Necessary Code Changes]] for changes you might need to do.<br />
* Custom packages built for 6.20.7 or earlier might not work with 6.22.<br />
* As for every update we strongly recommend that you make a backup of your system(s) before you proceed.<br />
<br />
= Update Open-Xchange Repositories =<br />
<br />
Add the following repositories to your <code>apt</code> configuration to access the v6.22 packages:<br />
<br />
<code>$ vim /etc/yum.repos.d/ox.repo</code><br />
[ox-frontend]<br />
name=Open-Xchange-frontend<br />
baseurl=http://software.open-xchange.com/OX6/6.22/frontend/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-backend]<br />
name=Open-Xchange-backend<br />
baseurl=http://software.open-xchange.com/OX6/6.22/backend/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-usm]<br />
name=Open-Xchange-USM<br />
baseurl=http://software.open-xchange.com/OX6/6.22/usm/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
# if you have a valid maintenance subscription, please uncomment the <br />
# following and add the ldb account data to the url so that the most recent<br />
# packages get installed<br />
<br />
[ox-updates-frontend]<br />
name=Open-Xchange Updates-frontend<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.22/updates/frontend/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-updates-backend]<br />
name=Open-Xchange Updates-backend<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.22/updates/backend/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-updates-usm]<br />
name=Open-Xchange Updates-USM<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.22/updates/usm/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
In case there are issues with an username and password containing URL unsafe characters, e.g. an @, they have to be entered URL encoded. Details can be found at http://www.w3schools.com/tags/ref_urlencode.asp<br />
<br />
Please note that frontend and backend packages are now provided from two different repositories. Depending on your setup and the packages installed on the specific system you're updating it is possible that you only need one of these repositories. All packages providing <code>open-xchange-admin</code> functionality are included in the <code>backend</code> repository.<br />
<br />
= Updating repositories and update packages =<br />
<br />
Reload the package index and update all installed packages:<br />
<br />
$ yum update<br />
$ yum upgrade<br />
<br />
= Install additional language packages if necessary =<br />
<br />
Starting with v6.22 the localization files for German, French and British English are no longer part of the core packages. This change was necessary to allow customers to uninstall these languages when they are not needed. If you want to offer German, French and/or British English to your customers as language option, you need to install the corresponding packages after the update.<br />
<br />
For German:<br />
<br />
$ yum install open-xchange-l10n-de-de open-xchange-gui-l10n-de-de<br />
<br />
For French:<br />
<br />
$ yum install open-xchange-l10n-fr-fr open-xchange-gui-l10n-fr-fr<br />
<br />
For British English:<br />
<br />
$ yum install open-xchange-gui-l10n-en-gb<br />
<br />
= Restart Open-Xchange =<br />
<br />
To restart Open-Xchange Server after the update, run<br />
<br />
$ /etc/init.d/open-xchange restart<br />
<br />
This script will check on startup if the old processes for <code>open-xchange-groupware</code> and <code>open-xchange-admin</code> are running, and stops them if they are. You might still want to check with<br />
<br />
$ ps aux | grep open-xchange<br />
<br />
that there is now only one process running Open-Xchange Server.<br />
<br />
= Leftover configuration files and runtime data =<br />
<br />
After the update you may see leftover configuration files and runtime data below <code>/opt/open-xchange/etc</code>.<br />
<br />
Some of these files belong to packages which have been uninstalled during the update.<br />
Other orphaned files may be runtime data or temporary files which do not belong to any package and therefore couldn't be removed during the package update.<br />
<br />
<code>package-cleanup --orphans | grep open-x*</code><br />
<br />
Finally, there may be backup files created by the package manager during earlier updates.<br />
<br />
It is safe to remove:<br />
<br />
* All files and subdirectories below:<br />
<br />
/opt/open-xchange/etc/admindaemon<br />
/opt/open-xchange/etc/common<br />
/opt/open-xchange/etc/groupware<br />
<br />
unless you have built your own packages which install files into these directories.<br />
<br />
* All files ending in <code>.rpmsave</code> or <code>.rpmnew</code> once you are confident that your configuration is working after the update.</div>Sgablerhttps://oxpedia.org/wiki/index.php?title=OX6:Open-Xchange_620_622_Update_Guide_for_RHEL5&diff=11598OX6:Open-Xchange 620 622 Update Guide for RHEL52012-10-05T17:14:29Z<p>Sgabler: /* Update Open-Xchange Repositories */</p>
<hr />
<div>= Update of Open-Xchange Server v6.20 to v6.22 on RHEL 5 =<br />
<br />
This article will guide you through the update of an existing Open-Xchange Server 6 installation to the newest major release, v6.22.<br />
<br />
= Supported update path =<br />
<br />
Please note that the update to v6.22 is only supported from an installed version 6.20.7 or later. If you have an earlier version of Open-Xchange Server 6 installed, please update to the latest release of v6.20 before attempting an update to v6.22.<br />
<br />
The latest v6.20 release will remain accessible on our servers. If you need to access the repository after the release of v6.22, please use the following lines in your <code>yum</code> repository configuration to access v6.20 packages:<br />
<br />
Start a console and change the software repository file for Open-Xchange:<br />
<code>$ vim /etc/yum.repos.d/ox.repo</code><br />
[ox]<br />
name=Open-Xchange<br />
baseurl=http://software.open-xchange.com/OX6/6.20/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
# if you have a valid maintenance subscription, please uncomment the <br />
# following and add the ldb account data to the url so that the most recent<br />
# packages get installed<br />
<br />
[ox-updates]<br />
name=Open-Xchange Updates<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.20/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
= Requirements =<br />
* An Open-Xchange Server installation v6.20.7 or later. This update guide is valid for a system installed through our [[Open-Xchange_Installation_Guide_for_RHEL_5|Download and Installation Guide for RHEL5]]<br />
* If you have custom packages done by Open-Xchange, please discuss with your Open-Xchange contact when these packages are available for 6.22. Do not attempt the update earlier<br />
* If you have built custom packages yourself which install config files in the OX config tree, please check the page [[6.22_Packaging_Changes|v6.22 Packaging Changes]]<br />
* If you have custom plugins written by yourself which depend on Open-Xchange Server OSGI bundles, check the pages [[6.22_Packaging_Changes|v6.22 Packaging Changes]] and [[6.22_Necessary_Code_Changes|v6.22 Necessary Code Changes]] for changes you might need to do.<br />
* Custom packages built for 6.20.7 or earlier might not work with 6.22.<br />
* As for every update we strongly recommend that you make a backup of your system(s) before you proceed.<br />
<br />
= Update Open-Xchange Repositories =<br />
<br />
Add the following repositories to your <code>apt</code> configuration to access the v6.22 packages:<br />
<br />
<code>$ vim /etc/yum.repos.d/ox.repo</code><br />
[ox-frontend]<br />
name=Open-Xchange-frontend<br />
baseurl=http://software.open-xchange.com/OX6/6.22/frontend/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-backend]<br />
name=Open-Xchange-backend<br />
baseurl=http://software.open-xchange.com/OX6/6.22/backend/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-usm]<br />
name=Open-Xchange-USM<br />
baseurl=http://software.open-xchange.com/OX6/6.22/usm/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
# if you have a valid maintenance subscription, please uncomment the <br />
# following and add the ldb account data to the url so that the most recent<br />
# packages get installed<br />
<br />
[ox-updates-frontend]<br />
name=Open-Xchange Updates-frontend<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.22/updates/frontend/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-updates-backend]<br />
name=Open-Xchange Updates-backend<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.22/updates/backend/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-updates-usm]<br />
name=Open-Xchange Updates-USM<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.22/updates/usm/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
In case there are issues with an username and password containing URL unsafe characters, e.g. an @, they have to be entered URL encoded. Details can be found at http://www.w3schools.com/tags/ref_urlencode.asp<br />
<br />
Please note that frontend and backend packages are now provided from two different repositories. Depending on your setup and the packages installed on the specific system you're updating it is possible that you only need one of these repositories. All packages providing <code>open-xchange-admin</code> functionality are included in the <code>backend</code> repository.<br />
<br />
= Updating repositories and update packages =<br />
<br />
Reload the package index and update all installed packages:<br />
<br />
$ yum update<br />
$ yum upgrade<br />
<br />
= Install additional language packages if necessary =<br />
<br />
Starting with v6.22 the localization files for German, French and British English are no longer part of the core packages. This change was necessary to allow customers to uninstall these languages when they are not needed. If you want to offer German, French and/or British English to your customers as language option, you need to install the corresponding packages after the update.<br />
<br />
For German:<br />
<br />
$ yum install open-xchange-l10n-de-de open-xchange-gui-l10n-de-de<br />
<br />
For French:<br />
<br />
$ yum install open-xchange-l10n-fr-fr open-xchange-gui-l10n-fr-fr<br />
<br />
For British English:<br />
<br />
$ yum install open-xchange-gui-l10n-en-gb<br />
<br />
= Restart Open-Xchange =<br />
<br />
To restart Open-Xchange Server after the update, run<br />
<br />
$ /etc/init.d/open-xchange restart<br />
<br />
This script will check on startup if the old processes for <code>open-xchange-groupware</code> and <code>open-xchange-admin</code> are running, and stops them if they are. You might still want to check with<br />
<br />
$ ps aux | grep open-xchange<br />
<br />
that there is now only one process running Open-Xchange Server.<br />
<br />
= Leftover configuration files and runtime data =<br />
<br />
After the update you may see leftover configuration files and runtime data below <code>/opt/open-xchange/etc</code>.<br />
<br />
Some of these files belong to packages which have been uninstalled during the update.<br />
Other orphaned files may be runtime data or temporary files which do not belong to any package and therefore couldn't be removed during the package update.<br />
<br />
<code>package-cleanup --orphans | grep open-x*</code><br />
<br />
Finally, there may be backup files created by the package manager during earlier updates.<br />
<br />
It is safe to remove:<br />
<br />
* All files and subdirectories below:<br />
<br />
/opt/open-xchange/etc/admindaemon<br />
/opt/open-xchange/etc/common<br />
/opt/open-xchange/etc/groupware<br />
<br />
unless you have built your own packages which install files into these directories.<br />
<br />
* All files ending in <code>.rpmsave</code> or <code>.rpmnew</code> once you are confident that your configuration is working after the update.</div>Sgablerhttps://oxpedia.org/wiki/index.php?title=OX6:Open-Xchange_620_622_Update_Guide_for_CentOS6&diff=11597OX6:Open-Xchange 620 622 Update Guide for CentOS62012-10-05T17:14:07Z<p>Sgabler: /* Update Open-Xchange Repositories */</p>
<hr />
<div>= Update of Open-Xchange Server v6.20 to v6.22 on CentOS 6 =<br />
<br />
This article will guide you through the update of an existing Open-Xchange Server 6 installation to the newest major release, v6.22.<br />
<br />
= Supported update path =<br />
<br />
Please note that the update to v6.22 is only supported from an installed version 6.20.7 or later. If you have an earlier version of Open-Xchange Server 6 installed, please update to the latest release of v6.20 before attempting an update to v6.22.<br />
<br />
The latest v6.20 release will remain accessible on our servers. If you need to access the repository after the release of v6.22, please use the following lines in your <code>yum</code> repository configuration to access v6.20 packages:<br />
<br />
Start a console and change the software repository file for Open-Xchange:<br />
<code>$ vim /etc/yum.repos.d/ox.repo</code><br />
[ox]<br />
name=Open-Xchange<br />
baseurl=http://software.open-xchange.com/OX6/6.20/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
# if you have a valid maintenance subscription, please uncomment the <br />
# following and add the ldb account data to the url so that the most recent<br />
# packages get installed<br />
<br />
[ox-updates]<br />
name=Open-Xchange Updates<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.20/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
= Requirements =<br />
* An Open-Xchange Server installation v6.20.7 or later. This update guide is valid for a system installed through our [[Open-Xchange_Installation_Guide_for_CentOS_6|Download and Installation Guide for CentOS 6]]<br />
* If you have custom packages done by Open-Xchange, please discuss with your Open-Xchange contact when these packages are available for 6.22. Do not attempt the update earlier<br />
* If you have built custom packages yourself which install config files in the OX config tree, please check the page [[6.22_Packaging_Changes|v6.22 Packaging Changes]]<br />
* If you have custom plugins written by yourself which depend on Open-Xchange Server OSGI bundles, check the pages [[6.22_Packaging_Changes|v6.22 Packaging Changes]] and [[6.22_Necessary_Code_Changes|v6.22 Necessary Code Changes]] for changes you might need to do.<br />
* Custom packages built for 6.20.7 or earlier might not work with 6.22.<br />
* As for every update we strongly recommend that you make a backup of your system(s) before you proceed.<br />
<br />
= Update Open-Xchange Repositories =<br />
<br />
Add the following repositories to your <code>apt</code> configuration to access the v6.22 packages:<br />
<br />
<code>$ vim /etc/yum.repos.d/ox.repo</code><br />
[ox-frontend]<br />
name=Open-Xchange-frontend<br />
baseurl=http://software.open-xchange.com/OX6/6.22/frontend/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-backend]<br />
name=Open-Xchange-backend<br />
baseurl=http://software.open-xchange.com/OX6/6.22/backend/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-usm]<br />
name=Open-Xchange-USM<br />
baseurl=http://software.open-xchange.com/OX6/6.22/usm/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
# if you have a valid maintenance subscription, please uncomment the <br />
# following and add the ldb account data to the url so that the most recent<br />
# packages get installed<br />
<br />
[ox-updates-frontend]<br />
name=Open-Xchange Updates-frontend<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.22/updates/frontend/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-updates-backend]<br />
name=Open-Xchange Updates-backend<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.22/updates/backend/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-updates-usm]<br />
name=Open-Xchange Updates-USM<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.22/updates/usm/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
In case there are issues with an username and password containing URL unsafe characters, e.g. an @, they have to be entered URL encoded. Details can be found at http://www.w3schools.com/tags/ref_urlencode.asp<br />
<br />
Please note that frontend and backend packages are now provided from two different repositories. Depending on your setup and the packages installed on the specific system you're updating it is possible that you only need one of these repositories. All packages providing <code>open-xchange-admin</code> functionality are included in the <code>backend</code> repository.<br />
<br />
= Updating repositories and update packages =<br />
<br />
Reload the package index and update all installed packages:<br />
<br />
$ yum update<br />
$ yum upgrade<br />
<br />
= Install additional language packages if necessary =<br />
<br />
Starting with v6.22 the localization files for German, French and British English are no longer part of the core packages. This change was necessary to allow customers to uninstall these languages when they are not needed. If you want to offer German, French and/or British English to your customers as language option, you need to install the corresponding packages after the update.<br />
<br />
For German:<br />
<br />
$ yum install open-xchange-l10n-de-de open-xchange-gui-l10n-de-de<br />
<br />
For French:<br />
<br />
$ yum install open-xchange-l10n-fr-fr open-xchange-gui-l10n-fr-fr<br />
<br />
For British English:<br />
<br />
$ yum install open-xchange-gui-l10n-en-gb<br />
<br />
= Restart Open-Xchange =<br />
<br />
To restart Open-Xchange Server after the update, run<br />
<br />
$ /etc/init.d/open-xchange restart<br />
<br />
This script will check on startup if the old processes for <code>open-xchange-groupware</code> and <code>open-xchange-admin</code> are running, and stops them if they are. You might still want to check with<br />
<br />
$ ps aux | grep open-xchange<br />
<br />
that there is now only one process running Open-Xchange Server.<br />
<br />
= Leftover configuration files and runtime data =<br />
<br />
After the update you may see leftover configuration files and runtime data below <code>/opt/open-xchange/etc</code>.<br />
<br />
Some of these files belong to packages which have been uninstalled during the update.<br />
Other orphaned files may be runtime data or temporary files which do not belong to any package and therefore couldn't be removed during the package update.<br />
<br />
<code>package-cleanup --orphans | grep open-x*</code><br />
<br />
Finally, there may be backup files created by the package manager during earlier updates.<br />
<br />
It is safe to remove:<br />
<br />
* All files and subdirectories below:<br />
<br />
/opt/open-xchange/etc/admindaemon<br />
/opt/open-xchange/etc/common<br />
/opt/open-xchange/etc/groupware<br />
<br />
unless you have built your own packages which install files into these directories.<br />
<br />
* All files ending in <code>.rpmsave</code> or <code>.rpmnew</code> once you are confident that your configuration is working after the update.</div>Sgablerhttps://oxpedia.org/wiki/index.php?title=OX6:Open-Xchange_620_622_Update_Guide_for_CentOS6&diff=11596OX6:Open-Xchange 620 622 Update Guide for CentOS62012-10-05T17:13:35Z<p>Sgabler: /* Update Open-Xchange Repositories */</p>
<hr />
<div>= Update of Open-Xchange Server v6.20 to v6.22 on CentOS 6 =<br />
<br />
This article will guide you through the update of an existing Open-Xchange Server 6 installation to the newest major release, v6.22.<br />
<br />
= Supported update path =<br />
<br />
Please note that the update to v6.22 is only supported from an installed version 6.20.7 or later. If you have an earlier version of Open-Xchange Server 6 installed, please update to the latest release of v6.20 before attempting an update to v6.22.<br />
<br />
The latest v6.20 release will remain accessible on our servers. If you need to access the repository after the release of v6.22, please use the following lines in your <code>yum</code> repository configuration to access v6.20 packages:<br />
<br />
Start a console and change the software repository file for Open-Xchange:<br />
<code>$ vim /etc/yum.repos.d/ox.repo</code><br />
[ox]<br />
name=Open-Xchange<br />
baseurl=http://software.open-xchange.com/OX6/6.20/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
# if you have a valid maintenance subscription, please uncomment the <br />
# following and add the ldb account data to the url so that the most recent<br />
# packages get installed<br />
<br />
[ox-updates]<br />
name=Open-Xchange Updates<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.20/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
= Requirements =<br />
* An Open-Xchange Server installation v6.20.7 or later. This update guide is valid for a system installed through our [[Open-Xchange_Installation_Guide_for_CentOS_6|Download and Installation Guide for CentOS 6]]<br />
* If you have custom packages done by Open-Xchange, please discuss with your Open-Xchange contact when these packages are available for 6.22. Do not attempt the update earlier<br />
* If you have built custom packages yourself which install config files in the OX config tree, please check the page [[6.22_Packaging_Changes|v6.22 Packaging Changes]]<br />
* If you have custom plugins written by yourself which depend on Open-Xchange Server OSGI bundles, check the pages [[6.22_Packaging_Changes|v6.22 Packaging Changes]] and [[6.22_Necessary_Code_Changes|v6.22 Necessary Code Changes]] for changes you might need to do.<br />
* Custom packages built for 6.20.7 or earlier might not work with 6.22.<br />
* As for every update we strongly recommend that you make a backup of your system(s) before you proceed.<br />
<br />
= Update Open-Xchange Repositories =<br />
<br />
Add the following repositories to your <code>apt</code> configuration to access the v6.22 packages:<br />
<br />
<code>$ vim /etc/yum.repos.d/ox.repo</code><br />
[ox-frontend]<br />
name=Open-Xchange-frontend<br />
baseurl=http://software.open-xchange.com/OX6/6.22/frontend/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-backend]<br />
name=Open-Xchange-backend<br />
baseurl=http://software.open-xchange.com/OX6/6.22/backend/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-usm]<br />
name=Open-Xchange-USM<br />
baseurl=http://software.open-xchange.com/OX6/6.22/usm/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
<br />
# if you have a valid maintenance subscription, please uncomment the <br />
# following and add the ldb account data to the url so that the most recent<br />
# packages get installed<br />
<br />
[ox-updates-frontend]<br />
name=Open-Xchange Updates-frontend<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.22/updates/frontend/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-updates-backend]<br />
name=Open-Xchange Updates-backend<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.22/updates/backend/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-updates-usm]<br />
name=Open-Xchange Updates-USM<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.22/updates/usm/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
In case there are issues with an username and password containing URL unsafe characters, e.g. an @, they have to be entered URL encoded. Details can be found at http://www.w3schools.com/tags/ref_urlencode.asp<br />
<br />
Please note that frontend and backend packages are now provided from two different repositories. Depending on your setup and the packages installed on the specific system you're updating it is possible that you only need one of these repositories. All packages providing <code>open-xchange-admin</code> functionality are included in the <code>backend</code> repository.<br />
<br />
= Updating repositories and update packages =<br />
<br />
Reload the package index and update all installed packages:<br />
<br />
$ yum update<br />
$ yum upgrade<br />
<br />
= Install additional language packages if necessary =<br />
<br />
Starting with v6.22 the localization files for German, French and British English are no longer part of the core packages. This change was necessary to allow customers to uninstall these languages when they are not needed. If you want to offer German, French and/or British English to your customers as language option, you need to install the corresponding packages after the update.<br />
<br />
For German:<br />
<br />
$ yum install open-xchange-l10n-de-de open-xchange-gui-l10n-de-de<br />
<br />
For French:<br />
<br />
$ yum install open-xchange-l10n-fr-fr open-xchange-gui-l10n-fr-fr<br />
<br />
For British English:<br />
<br />
$ yum install open-xchange-gui-l10n-en-gb<br />
<br />
= Restart Open-Xchange =<br />
<br />
To restart Open-Xchange Server after the update, run<br />
<br />
$ /etc/init.d/open-xchange restart<br />
<br />
This script will check on startup if the old processes for <code>open-xchange-groupware</code> and <code>open-xchange-admin</code> are running, and stops them if they are. You might still want to check with<br />
<br />
$ ps aux | grep open-xchange<br />
<br />
that there is now only one process running Open-Xchange Server.<br />
<br />
= Leftover configuration files and runtime data =<br />
<br />
After the update you may see leftover configuration files and runtime data below <code>/opt/open-xchange/etc</code>.<br />
<br />
Some of these files belong to packages which have been uninstalled during the update.<br />
Other orphaned files may be runtime data or temporary files which do not belong to any package and therefore couldn't be removed during the package update.<br />
<br />
<code>package-cleanup --orphans | grep open-x*</code><br />
<br />
Finally, there may be backup files created by the package manager during earlier updates.<br />
<br />
It is safe to remove:<br />
<br />
* All files and subdirectories below:<br />
<br />
/opt/open-xchange/etc/admindaemon<br />
/opt/open-xchange/etc/common<br />
/opt/open-xchange/etc/groupware<br />
<br />
unless you have built your own packages which install files into these directories.<br />
<br />
* All files ending in <code>.rpmsave</code> or <code>.rpmnew</code> once you are confident that your configuration is working after the update.</div>Sgablerhttps://oxpedia.org/wiki/index.php?title=OX6:Open-Xchange_620_622_Update_Guide_for_CentOS5&diff=11595OX6:Open-Xchange 620 622 Update Guide for CentOS52012-10-05T17:13:09Z<p>Sgabler: /* Update Open-Xchange Repositories */</p>
<hr />
<div>= Update of Open-Xchange Server v6.20 to v6.22 on CentOS 5 =<br />
<br />
This article will guide you through the update of an existing Open-Xchange Server 6 installation to the newest major release, v6.22.<br />
<br />
= Supported update path =<br />
<br />
Please note that the update to v6.22 is only supported from an installed version 6.20.7 or later. If you have an earlier version of Open-Xchange Server 6 installed, please update to the latest release of v6.20 before attempting an update to v6.22.<br />
<br />
The latest v6.20 release will remain accessible on our servers. If you need to access the repository after the release of v6.22, please use the following lines in your <code>yum</code> repository configuration to access v6.20 packages:<br />
<br />
Start a console and change the software repository file for Open-Xchange:<br />
<code>$ vim /etc/yum.repos.d/ox.repo</code><br />
[ox]<br />
name=Open-Xchange<br />
baseurl=http://software.open-xchange.com/OX6/6.20/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
# if you have a valid maintenance subscription, please uncomment the <br />
# following and add the ldb account data to the url so that the most recent<br />
# packages get installed<br />
<br />
[ox-updates]<br />
name=Open-Xchange Updates<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.20/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
= Requirements =<br />
* An Open-Xchange Server installation v6.20.7 or later. This update guide is valid for a system installed through our [[Open-Xchange_Installation_Guide_for_CentOS_5|Download and Installation Guide for CentOS 5]]<br />
* If you have custom packages done by Open-Xchange, please discuss with your Open-Xchange contact when these packages are available for 6.22. Do not attempt the update earlier<br />
* If you have built custom packages yourself which install config files in the OX config tree, please check the page [[6.22_Packaging_Changes|v6.22 Packaging Changes]]<br />
* If you have custom plugins written by yourself which depend on Open-Xchange Server OSGI bundles, check the pages [[6.22_Packaging_Changes|v6.22 Packaging Changes]] and [[6.22_Necessary_Code_Changes|v6.22 Necessary Code Changes]] for changes you might need to do.<br />
* Custom packages built for 6.20.7 or earlier might not work with 6.22.<br />
* As for every update we strongly recommend that you make a backup of your system(s) before you proceed.<br />
<br />
= Update Open-Xchange Repositories =<br />
<br />
Add the following repositories to your <code>apt</code> configuration to access the v6.22 packages:<br />
<br />
<code>$ vim /etc/yum.repos.d/ox.repo</code><br />
[ox-frontend]<br />
name=Open-Xchange-frontend<br />
baseurl=http://software.open-xchange.com/OX6/6.22/frontend/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-backend]<br />
name=Open-Xchange-backend<br />
baseurl=http://software.open-xchange.com/OX6/6.22/backend/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-usm]<br />
name=Open-Xchange-USM<br />
baseurl=http://software.open-xchange.com/OX6/6.22/usm/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
# if you have a valid maintenance subscription, please uncomment the <br />
# following and add the ldb account data to the url so that the most recent<br />
# packages get installed<br />
<br />
[ox-updates-frontend]<br />
name=Open-Xchange Updates-frontend<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.22/updates/frontend/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-updates-backend]<br />
name=Open-Xchange Updates-backend<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.22/updates/backend/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-updates-usm]<br />
name=Open-Xchange Updates-USM<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.22/updates/usm/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
In case there are issues with an username and password containing URL unsafe characters, e.g. an @, they have to be entered URL encoded. Details can be found at http://www.w3schools.com/tags/ref_urlencode.asp<br />
<br />
Please note that frontend and backend packages are now provided from two different repositories. Depending on your setup and the packages installed on the specific system you're updating it is possible that you only need one of these repositories. All packages providing <code>open-xchange-admin</code> functionality are included in the <code>backend</code> repository.<br />
<br />
= Updating repositories and update packages =<br />
<br />
Reload the package index and update all installed packages:<br />
<br />
$ yum update<br />
$ yum upgrade<br />
<br />
= Install additional language packages if necessary =<br />
<br />
Starting with v6.22 the localization files for German, French and British English are no longer part of the core packages. This change was necessary to allow customers to uninstall these languages when they are not needed. If you want to offer German, French and/or British English to your customers as language option, you need to install the corresponding packages after the update.<br />
<br />
For German:<br />
<br />
$ yum install open-xchange-l10n-de-de open-xchange-gui-l10n-de-de<br />
<br />
For French:<br />
<br />
$ yum install open-xchange-l10n-fr-fr open-xchange-gui-l10n-fr-fr<br />
<br />
For British English:<br />
<br />
$ yum install open-xchange-gui-l10n-en-gb<br />
<br />
= Restart Open-Xchange =<br />
<br />
To restart Open-Xchange Server after the update, run<br />
<br />
$ /etc/init.d/open-xchange restart<br />
<br />
This script will check on startup if the old processes for <code>open-xchange-groupware</code> and <code>open-xchange-admin</code> are running, and stops them if they are. You might still want to check with<br />
<br />
$ ps aux | grep open-xchange<br />
<br />
that there is now only one process running Open-Xchange Server.<br />
<br />
= Leftover configuration files and runtime data =<br />
<br />
After the update you may see leftover configuration files and runtime data below <code>/opt/open-xchange/etc</code>.<br />
<br />
Some of these files belong to packages which have been uninstalled during the update.<br />
Other orphaned files may be runtime data or temporary files which do not belong to any package and therefore couldn't be removed during the package update.<br />
<br />
<code>package-cleanup --orphans | grep open-x*</code><br />
<br />
Finally, there may be backup files created by the package manager during earlier updates.<br />
<br />
It is safe to remove:<br />
<br />
* All files and subdirectories below:<br />
<br />
/opt/open-xchange/etc/admindaemon<br />
/opt/open-xchange/etc/common<br />
/opt/open-xchange/etc/groupware<br />
<br />
unless you have built your own packages which install files into these directories.<br />
<br />
* All files ending in <code>.rpmsave</code> or <code>.rpmnew</code> once you are confident that your configuration is working after the update.</div>Sgablerhttps://oxpedia.org/wiki/index.php?title=OX6:Open-Xchange_620_622_Update_Guide_for_RHEL6&diff=11594OX6:Open-Xchange 620 622 Update Guide for RHEL62012-10-05T17:12:09Z<p>Sgabler: /* Update Open-Xchange Repositories */</p>
<hr />
<div>= Update of Open-Xchange Server v6.20 to v6.22 on RHEL 6 =<br />
<br />
This article will guide you through the update of an existing Open-Xchange Server 6 installation to the newest major release, v6.22.<br />
<br />
= Supported update path =<br />
<br />
Please note that the update to v6.22 is only supported from an installed version 6.20.7 or later. If you have an earlier version of Open-Xchange Server 6 installed, please update to the latest release of v6.20 before attempting an update to v6.22.<br />
<br />
The latest v6.20 release will remain accessible on our servers. If you need to access the repository after the release of v6.22, please use the following lines in your <code>yum</code> repository configuration to access v6.20 packages:<br />
<br />
Start a console and change the software repository file for Open-Xchange:<br />
<code>$ vim /etc/yum.repos.d/ox.repo</code><br />
[ox]<br />
name=Open-Xchange<br />
baseurl=http://software.open-xchange.com/OX6/6.20/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
# if you have a valid maintenance subscription, please uncomment the <br />
# following and add the ldb account data to the url so that the most recent<br />
# packages get installed<br />
<br />
[ox-updates]<br />
name=Open-Xchange Updates<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.20/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
= Requirements =<br />
* An Open-Xchange Server installation v6.20.7 or later. This update guide is valid for a system installed through our [[Open-Xchange_Installation_Guide_for_RHEL6|Download and Installation Guide for RHEL 6]]<br />
* If you have custom packages done by Open-Xchange, please discuss with your Open-Xchange contact when these packages are available for 6.22. Do not attempt the update earlier<br />
* If you have built custom packages yourself which install config files in the OX config tree, please check the page [[6.22_Packaging_Changes|v6.22 Packaging Changes]]<br />
* If you have custom plugins written by yourself which depend on Open-Xchange Server OSGI bundles, check the pages [[6.22_Packaging_Changes|v6.22 Packaging Changes]] and [[6.22_Necessary_Code_Changes|v6.22 Necessary Code Changes]] for changes you might need to do.<br />
* Custom packages built for 6.20.7 or earlier might not work with 6.22.<br />
* As for every update we strongly recommend that you make a backup of your system(s) before you proceed.<br />
<br />
= Update Open-Xchange Repositories =<br />
<br />
Add the following repositories to your <code>apt</code> configuration to access the v6.22 packages:<br />
<br />
<code>$ vim /etc/yum.repos.d/ox.repo</code><br />
[ox-frontend]<br />
name=Open-Xchange-frontend<br />
baseurl=http://software.open-xchange.com/OX6/6.22/frontend/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-backend]<br />
name=Open-Xchange-backend<br />
baseurl=http://software.open-xchange.com/OX6/6.22/backend/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-usm]<br />
name=Open-Xchange-USM<br />
baseurl=http://software.open-xchange.com/OX6/6.22/usm/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
# if you have a valid maintenance subscription, please uncomment the <br />
# following and add the ldb account data to the url so that the most recent<br />
# packages get installed<br />
<br />
[ox-updates-frontend]<br />
name=Open-Xchange Updates-frontend<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.22/updates/frontend/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-updates-backend]<br />
name=Open-Xchange Updates-backend<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.22/updates/backend/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-updates-usm]<br />
name=Open-Xchange Updates-USM<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.22/updates/usm/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
In case there are issues with an username and password containing URL unsafe characters, e.g. an @, they have to be entered URL encoded. Details can be found at http://www.w3schools.com/tags/ref_urlencode.asp<br />
<br />
Please note that frontend and backend packages are now provided from two different repositories. Depending on your setup and the packages installed on the specific system you're updating it is possible that you only need one of these repositories. All packages providing <code>open-xchange-admin</code> functionality are included in the <code>backend</code> repository.<br />
<br />
= Updating repositories and update packages =<br />
<br />
Reload the package index and update all installed packages:<br />
<br />
$ yum update<br />
$ yum upgrade<br />
<br />
= Install additional language packages if necessary =<br />
<br />
Starting with v6.22 the localization files for German, French and British English are no longer part of the core packages. This change was necessary to allow customers to uninstall these languages when they are not needed. If you want to offer German, French and/or British English to your customers as language option, you need to install the corresponding packages after the update.<br />
<br />
For German:<br />
<br />
$ yum install open-xchange-l10n-de-de open-xchange-gui-l10n-de-de<br />
<br />
For French:<br />
<br />
$ yum install open-xchange-l10n-fr-fr open-xchange-gui-l10n-fr-fr<br />
<br />
For British English:<br />
<br />
$ yum install open-xchange-gui-l10n-en-gb<br />
<br />
= Restart Open-Xchange =<br />
<br />
To restart Open-Xchange Server after the update, run<br />
<br />
$ /etc/init.d/open-xchange restart<br />
<br />
This script will check on startup if the old processes for <code>open-xchange-groupware</code> and <code>open-xchange-admin</code> are running, and stops them if they are. You might still want to check with<br />
<br />
$ ps aux | grep open-xchange<br />
<br />
that there is now only one process running Open-Xchange Server.<br />
<br />
= Leftover configuration files and runtime data =<br />
<br />
After the update you may see leftover configuration files and runtime data below <code>/opt/open-xchange/etc</code>.<br />
<br />
Some of these files belong to packages which have been uninstalled during the update.<br />
Other orphaned files may be runtime data or temporary files which do not belong to any package and therefore couldn't be removed during the package update.<br />
<br />
<code>package-cleanup --orphans | grep open-x*</code><br />
<br />
Finally, there may be backup files created by the package manager during earlier updates.<br />
<br />
It is safe to remove:<br />
<br />
* All files and subdirectories below:<br />
<br />
/opt/open-xchange/etc/admindaemon<br />
/opt/open-xchange/etc/common<br />
/opt/open-xchange/etc/groupware<br />
<br />
unless you have built your own packages which install files into these directories.<br />
<br />
* All files ending in <code>.rpmsave</code> or <code>.rpmnew</code> once you are confident that your configuration is working after the update.</div>Sgablerhttps://oxpedia.org/wiki/index.php?title=OX6:Open-Xchange_620_622_Update_Guide_for_RHEL5&diff=11592OX6:Open-Xchange 620 622 Update Guide for RHEL52012-10-05T17:10:26Z<p>Sgabler: /* Update Open-Xchange Repositories */</p>
<hr />
<div>= Update of Open-Xchange Server v6.20 to v6.22 on RHEL 5 =<br />
<br />
This article will guide you through the update of an existing Open-Xchange Server 6 installation to the newest major release, v6.22.<br />
<br />
= Supported update path =<br />
<br />
Please note that the update to v6.22 is only supported from an installed version 6.20.7 or later. If you have an earlier version of Open-Xchange Server 6 installed, please update to the latest release of v6.20 before attempting an update to v6.22.<br />
<br />
The latest v6.20 release will remain accessible on our servers. If you need to access the repository after the release of v6.22, please use the following lines in your <code>yum</code> repository configuration to access v6.20 packages:<br />
<br />
Start a console and change the software repository file for Open-Xchange:<br />
<code>$ vim /etc/yum.repos.d/ox.repo</code><br />
[ox]<br />
name=Open-Xchange<br />
baseurl=http://software.open-xchange.com/OX6/6.20/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
# if you have a valid maintenance subscription, please uncomment the <br />
# following and add the ldb account data to the url so that the most recent<br />
# packages get installed<br />
<br />
[ox-updates]<br />
name=Open-Xchange Updates<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.20/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
= Requirements =<br />
* An Open-Xchange Server installation v6.20.7 or later. This update guide is valid for a system installed through our [[Open-Xchange_Installation_Guide_for_RHEL_5|Download and Installation Guide for RHEL5]]<br />
* If you have custom packages done by Open-Xchange, please discuss with your Open-Xchange contact when these packages are available for 6.22. Do not attempt the update earlier<br />
* If you have built custom packages yourself which install config files in the OX config tree, please check the page [[6.22_Packaging_Changes|v6.22 Packaging Changes]]<br />
* If you have custom plugins written by yourself which depend on Open-Xchange Server OSGI bundles, check the pages [[6.22_Packaging_Changes|v6.22 Packaging Changes]] and [[6.22_Necessary_Code_Changes|v6.22 Necessary Code Changes]] for changes you might need to do.<br />
* Custom packages built for 6.20.7 or earlier might not work with 6.22.<br />
* As for every update we strongly recommend that you make a backup of your system(s) before you proceed.<br />
<br />
= Update Open-Xchange Repositories =<br />
<br />
Add the following repositories to your <code>apt</code> configuration to access the v6.22 packages:<br />
<br />
<code>$ vim /etc/yum.repos.d/ox.repo</code><br />
[ox-frontend]<br />
name=Open-Xchange-frontend<br />
baseurl=http://software.open-xchange.com/OX6/6.22/frontend/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-backend]<br />
name=Open-Xchange-backend<br />
baseurl=http://software.open-xchange.com/OX6/6.22/backend/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-usm]<br />
name=Open-Xchange-USM<br />
baseurl=http://software.open-xchange.com/OX6/6.22/usm/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
# if you have a valid maintenance subscription, please uncomment the <br />
# following and add the ldb account data to the url so that the most recent<br />
# packages get installed<br />
<br />
[ox-updates-frontend]<br />
name=Open-Xchange Updates-frontend<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.22/updates/frontend/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-updates-backend]<br />
name=Open-Xchange Updates-backend<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.22/updates/backend/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-updates-usm]<br />
name=Open-Xchange Updates-USM<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.22/updates/usm/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
In case there are issues with an username and password containing URL unsafe characters, e.g. an @, they have to be entered URL encoded. Details can be found at http://www.w3schools.com/tags/ref_urlencode.asp<br />
<br />
Please note that frontend and backend packages are now provided from two different repositories. Depending on your setup and the packages installed on the specific system you're updating it is possible that you only need one of these repositories. All packages providing <code>open-xchange-admin</code> functionality are included in the <code>backend</code> repository.<br />
<br />
= Updating repositories and update packages =<br />
<br />
Reload the package index and update all installed packages:<br />
<br />
$ yum update<br />
$ yum upgrade<br />
<br />
= Install additional language packages if necessary =<br />
<br />
Starting with v6.22 the localization files for German, French and British English are no longer part of the core packages. This change was necessary to allow customers to uninstall these languages when they are not needed. If you want to offer German, French and/or British English to your customers as language option, you need to install the corresponding packages after the update.<br />
<br />
For German:<br />
<br />
$ yum install open-xchange-l10n-de-de open-xchange-gui-l10n-de-de<br />
<br />
For French:<br />
<br />
$ yum install open-xchange-l10n-fr-fr open-xchange-gui-l10n-fr-fr<br />
<br />
For British English:<br />
<br />
$ yum install open-xchange-gui-l10n-en-gb<br />
<br />
= Restart Open-Xchange =<br />
<br />
To restart Open-Xchange Server after the update, run<br />
<br />
$ /etc/init.d/open-xchange restart<br />
<br />
This script will check on startup if the old processes for <code>open-xchange-groupware</code> and <code>open-xchange-admin</code> are running, and stops them if they are. You might still want to check with<br />
<br />
$ ps aux | grep open-xchange<br />
<br />
that there is now only one process running Open-Xchange Server.<br />
<br />
= Leftover configuration files and runtime data =<br />
<br />
After the update you may see leftover configuration files and runtime data below <code>/opt/open-xchange/etc</code>.<br />
<br />
Some of these files belong to packages which have been uninstalled during the update.<br />
Other orphaned files may be runtime data or temporary files which do not belong to any package and therefore couldn't be removed during the package update.<br />
<br />
<code>package-cleanup --orphans | grep open-x*</code><br />
<br />
Finally, there may be backup files created by the package manager during earlier updates.<br />
<br />
It is safe to remove:<br />
<br />
* All files and subdirectories below:<br />
<br />
/opt/open-xchange/etc/admindaemon<br />
/opt/open-xchange/etc/common<br />
/opt/open-xchange/etc/groupware<br />
<br />
unless you have built your own packages which install files into these directories.<br />
<br />
* All files ending in <code>.rpmsave</code> or <code>.rpmnew</code> once you are confident that your configuration is working after the update.</div>Sgablerhttps://oxpedia.org/wiki/index.php?title=OX6:Open-Xchange_620_622_Update_Guide_for_CentOS6&diff=11591OX6:Open-Xchange 620 622 Update Guide for CentOS62012-10-05T17:09:22Z<p>Sgabler: /* Update Open-Xchange Repositories */</p>
<hr />
<div>= Update of Open-Xchange Server v6.20 to v6.22 on CentOS 6 =<br />
<br />
This article will guide you through the update of an existing Open-Xchange Server 6 installation to the newest major release, v6.22.<br />
<br />
= Supported update path =<br />
<br />
Please note that the update to v6.22 is only supported from an installed version 6.20.7 or later. If you have an earlier version of Open-Xchange Server 6 installed, please update to the latest release of v6.20 before attempting an update to v6.22.<br />
<br />
The latest v6.20 release will remain accessible on our servers. If you need to access the repository after the release of v6.22, please use the following lines in your <code>yum</code> repository configuration to access v6.20 packages:<br />
<br />
Start a console and change the software repository file for Open-Xchange:<br />
<code>$ vim /etc/yum.repos.d/ox.repo</code><br />
[ox]<br />
name=Open-Xchange<br />
baseurl=http://software.open-xchange.com/OX6/6.20/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
# if you have a valid maintenance subscription, please uncomment the <br />
# following and add the ldb account data to the url so that the most recent<br />
# packages get installed<br />
<br />
[ox-updates]<br />
name=Open-Xchange Updates<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.20/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
= Requirements =<br />
* An Open-Xchange Server installation v6.20.7 or later. This update guide is valid for a system installed through our [[Open-Xchange_Installation_Guide_for_CentOS_6|Download and Installation Guide for CentOS 6]]<br />
* If you have custom packages done by Open-Xchange, please discuss with your Open-Xchange contact when these packages are available for 6.22. Do not attempt the update earlier<br />
* If you have built custom packages yourself which install config files in the OX config tree, please check the page [[6.22_Packaging_Changes|v6.22 Packaging Changes]]<br />
* If you have custom plugins written by yourself which depend on Open-Xchange Server OSGI bundles, check the pages [[6.22_Packaging_Changes|v6.22 Packaging Changes]] and [[6.22_Necessary_Code_Changes|v6.22 Necessary Code Changes]] for changes you might need to do.<br />
* Custom packages built for 6.20.7 or earlier might not work with 6.22.<br />
* As for every update we strongly recommend that you make a backup of your system(s) before you proceed.<br />
<br />
= Update Open-Xchange Repositories =<br />
<br />
Add the following repositories to your <code>apt</code> configuration to access the v6.22 packages:<br />
<br />
<code>$ vim /etc/yum.repos.d/ox.repo</code><br />
[ox-frontend]<br />
name=Open-Xchange-frontend<br />
baseurl=http://software.open-xchange.com/OX6/6.22/frontend/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-backend]<br />
name=Open-Xchange-backend<br />
baseurl=http://software.open-xchange.com/OX6/6.22/backend/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-usm]<br />
name=Open-Xchange-USM<br />
baseurl=http://software.open-xchange.com/OX6/6.22/usm/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
<br />
# if you have a valid maintenance subscription, please uncomment the <br />
# following and add the ldb account data to the url so that the most recent<br />
# packages get installed<br />
<br />
[ox-updates-frontend]<br />
name=Open-Xchange Updates-frontend<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.22/updates/frontend/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-updates-backend]<br />
name=Open-Xchange Updates-backend<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.22/updates/backend/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-updates-usm]<br />
name=Open-Xchange Updates-USM<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.22/updates/usm/RHEL6/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
In case there are issues with an username and password containing URL unsafe characters, e.g. an @, they have to be entered URL encoded. Details can be found at http://www.w3schools.com/tags/ref_urlencode.asp<br />
<br />
Please note that frontend and backend packages are now provided from two different repositories. Depending on your setup and the packages installed on the specific system you're updating it is possible that you only need one of these repositories. All packages providing <code>open-xchange-admin</code> functionality are included in the <code>backend</code> repository.<br />
<br />
= Updating repositories and update packages =<br />
<br />
Reload the package index and update all installed packages:<br />
<br />
$ yum update<br />
$ yum upgrade<br />
<br />
= Install additional language packages if necessary =<br />
<br />
Starting with v6.22 the localization files for German, French and British English are no longer part of the core packages. This change was necessary to allow customers to uninstall these languages when they are not needed. If you want to offer German, French and/or British English to your customers as language option, you need to install the corresponding packages after the update.<br />
<br />
For German:<br />
<br />
$ yum install open-xchange-l10n-de-de open-xchange-gui-l10n-de-de<br />
<br />
For French:<br />
<br />
$ yum install open-xchange-l10n-fr-fr open-xchange-gui-l10n-fr-fr<br />
<br />
For British English:<br />
<br />
$ yum install open-xchange-gui-l10n-en-gb<br />
<br />
= Restart Open-Xchange =<br />
<br />
To restart Open-Xchange Server after the update, run<br />
<br />
$ /etc/init.d/open-xchange restart<br />
<br />
This script will check on startup if the old processes for <code>open-xchange-groupware</code> and <code>open-xchange-admin</code> are running, and stops them if they are. You might still want to check with<br />
<br />
$ ps aux | grep open-xchange<br />
<br />
that there is now only one process running Open-Xchange Server.<br />
<br />
= Leftover configuration files and runtime data =<br />
<br />
After the update you may see leftover configuration files and runtime data below <code>/opt/open-xchange/etc</code>.<br />
<br />
Some of these files belong to packages which have been uninstalled during the update.<br />
Other orphaned files may be runtime data or temporary files which do not belong to any package and therefore couldn't be removed during the package update.<br />
<br />
<code>package-cleanup --orphans | grep open-x*</code><br />
<br />
Finally, there may be backup files created by the package manager during earlier updates.<br />
<br />
It is safe to remove:<br />
<br />
* All files and subdirectories below:<br />
<br />
/opt/open-xchange/etc/admindaemon<br />
/opt/open-xchange/etc/common<br />
/opt/open-xchange/etc/groupware<br />
<br />
unless you have built your own packages which install files into these directories.<br />
<br />
* All files ending in <code>.rpmsave</code> or <code>.rpmnew</code> once you are confident that your configuration is working after the update.</div>Sgablerhttps://oxpedia.org/wiki/index.php?title=OX6:Open-Xchange_620_622_Update_Guide_for_CentOS5&diff=11590OX6:Open-Xchange 620 622 Update Guide for CentOS52012-10-05T17:08:03Z<p>Sgabler: /* Update Open-Xchange Repositories */</p>
<hr />
<div>= Update of Open-Xchange Server v6.20 to v6.22 on CentOS 5 =<br />
<br />
This article will guide you through the update of an existing Open-Xchange Server 6 installation to the newest major release, v6.22.<br />
<br />
= Supported update path =<br />
<br />
Please note that the update to v6.22 is only supported from an installed version 6.20.7 or later. If you have an earlier version of Open-Xchange Server 6 installed, please update to the latest release of v6.20 before attempting an update to v6.22.<br />
<br />
The latest v6.20 release will remain accessible on our servers. If you need to access the repository after the release of v6.22, please use the following lines in your <code>yum</code> repository configuration to access v6.20 packages:<br />
<br />
Start a console and change the software repository file for Open-Xchange:<br />
<code>$ vim /etc/yum.repos.d/ox.repo</code><br />
[ox]<br />
name=Open-Xchange<br />
baseurl=http://software.open-xchange.com/OX6/6.20/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
# if you have a valid maintenance subscription, please uncomment the <br />
# following and add the ldb account data to the url so that the most recent<br />
# packages get installed<br />
<br />
[ox-updates]<br />
name=Open-Xchange Updates<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.20/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
= Requirements =<br />
* An Open-Xchange Server installation v6.20.7 or later. This update guide is valid for a system installed through our [[Open-Xchange_Installation_Guide_for_CentOS_5|Download and Installation Guide for CentOS 5]]<br />
* If you have custom packages done by Open-Xchange, please discuss with your Open-Xchange contact when these packages are available for 6.22. Do not attempt the update earlier<br />
* If you have built custom packages yourself which install config files in the OX config tree, please check the page [[6.22_Packaging_Changes|v6.22 Packaging Changes]]<br />
* If you have custom plugins written by yourself which depend on Open-Xchange Server OSGI bundles, check the pages [[6.22_Packaging_Changes|v6.22 Packaging Changes]] and [[6.22_Necessary_Code_Changes|v6.22 Necessary Code Changes]] for changes you might need to do.<br />
* Custom packages built for 6.20.7 or earlier might not work with 6.22.<br />
* As for every update we strongly recommend that you make a backup of your system(s) before you proceed.<br />
<br />
= Update Open-Xchange Repositories =<br />
<br />
Add the following repositories to your <code>apt</code> configuration to access the v6.22 packages:<br />
<br />
<code>$ vim /etc/yum.repos.d/ox.repo</code><br />
[ox-frontend]<br />
name=Open-Xchange-frontend<br />
baseurl=http://software.open-xchange.com/OX6/6.22/frontend/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-backend]<br />
name=Open-Xchange-backend<br />
baseurl=http://software.open-xchange.com/OX6/6.22/backend/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-usm]<br />
name=Open-Xchange-USM<br />
baseurl=http://software.open-xchange.com/OX6/6.22/usm/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
# if you have a valid maintenance subscription, please uncomment the <br />
# following and add the ldb account data to the url so that the most recent<br />
# packages get installed<br />
<br />
[ox-updates-frontend]<br />
name=Open-Xchange Updates-frontend<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.22/updates/frontend/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-updates-backend]<br />
name=Open-Xchange Updates-backend<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.22/updates/backend/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
[ox-updates-usm]<br />
name=Open-Xchange Updates-USM<br />
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/6.22/updates/usm/RHEL5/<br />
gpgkey=http://software.open-xchange.com/oxbuildkey.pub<br />
enabled=1<br />
gpgcheck=1<br />
metadata_expire=0m<br />
<br />
In case there are issues with an username and password containing URL unsafe characters, e.g. an @, they have to be entered URL encoded. Details can be found at http://www.w3schools.com/tags/ref_urlencode.asp<br />
<br />
Please note that frontend and backend packages are now provided from two different repositories. Depending on your setup and the packages installed on the specific system you're updating it is possible that you only need one of these repositories. All packages providing <code>open-xchange-admin</code> functionality are included in the <code>backend</code> repository.<br />
<br />
= Updating repositories and update packages =<br />
<br />
Reload the package index and update all installed packages:<br />
<br />
$ yum update<br />
$ yum upgrade<br />
<br />
= Install additional language packages if necessary =<br />
<br />
Starting with v6.22 the localization files for German, French and British English are no longer part of the core packages. This change was necessary to allow customers to uninstall these languages when they are not needed. If you want to offer German, French and/or British English to your customers as language option, you need to install the corresponding packages after the update.<br />
<br />
For German:<br />
<br />
$ yum install open-xchange-l10n-de-de open-xchange-gui-l10n-de-de<br />
<br />
For French:<br />
<br />
$ yum install open-xchange-l10n-fr-fr open-xchange-gui-l10n-fr-fr<br />
<br />
For British English:<br />
<br />
$ yum install open-xchange-gui-l10n-en-gb<br />
<br />
= Restart Open-Xchange =<br />
<br />
To restart Open-Xchange Server after the update, run<br />
<br />
$ /etc/init.d/open-xchange restart<br />
<br />
This script will check on startup if the old processes for <code>open-xchange-groupware</code> and <code>open-xchange-admin</code> are running, and stops them if they are. You might still want to check with<br />
<br />
$ ps aux | grep open-xchange<br />
<br />
that there is now only one process running Open-Xchange Server.<br />
<br />
= Leftover configuration files and runtime data =<br />
<br />
After the update you may see leftover configuration files and runtime data below <code>/opt/open-xchange/etc</code>.<br />
<br />
Some of these files belong to packages which have been uninstalled during the update.<br />
Other orphaned files may be runtime data or temporary files which do not belong to any package and therefore couldn't be removed during the package update.<br />
<br />
<code>package-cleanup --orphans | grep open-x*</code><br />
<br />
Finally, there may be backup files created by the package manager during earlier updates.<br />
<br />
It is safe to remove:<br />
<br />
* All files and subdirectories below:<br />
<br />
/opt/open-xchange/etc/admindaemon<br />
/opt/open-xchange/etc/common<br />
/opt/open-xchange/etc/groupware<br />
<br />
unless you have built your own packages which install files into these directories.<br />
<br />
* All files ending in <code>.rpmsave</code> or <code>.rpmnew</code> once you are confident that your configuration is working after the update.</div>Sgabler