Open-Xchange cPanel Installation

Install Open-Xchange on WHM/cPanel

BETA

Mode of operation

It is recommended to run Open-Xchange on one or more separate machines. See the "Hosting Edition deployment tutorials" at Main_Page_HESE#quickinstall. The connection between cPanel and Open-Xchange is done via some cPanel/WHM hooks and UI plugins using SOAP as communication channel. That means that SOAP must be enabled on Open-Xchange.

Once the package open-xchange-cpanel is installed on the cPanel/WHM system, every cPanel user created within WHM will be created as an admin account and context in Open-Xchange. In addition, there's a single program to create all existing cPanel Accounts in Open-Xchange.

Known issues

• error handling needs to be improved.
• addon domain handling needs to be improved
• unable to indicate errors in open-xchange account creation when adding users in WHM/cPanel because the WHM/cPanel hooks have no possibility to transport any error to the ui.
• /usr/local/cpanel/logs/open-xchange_log is readable by everyone

Debugging

• run the command

$ sudo /usr/local/cpanel/bin/oxcpanelenable -c

to check Open-Xchange connection before doing anything else. It must output connection check successfull

• All errors happening during cPanel account creation and mail account creation are logged into the files /usr/local/cpanel/logs/open-xchange_log and /usr/local/cpanel/logs/error_log. If something does not work, check these logs first!
• /usr/local/cpanel/bin/oxcpanelinstall creates a debug output file with every execution, check its output, e.g.:

$ /usr/local/cpanel/bin/oxcpanelinstall --oxurl http://myox.example.com --oxadmin-password secret
running installer, please wait. Debugoutput is placed into file /tmp/cpoxinst3542.out

Install and prepare Open-Xchange

• Follow one of the Open-Xchange installation guides to install Open-Xchange with the following exceptions:
  • Install the package open-xchange-admin-plugin-reseller-soap from the repository http://software.open-xchange.com/OX6/OXtender-unstable/cPanel/ (see below)
  • add the following argument to initconfigdb: --addon-sql "reseller.sql autocid.sql"
  • instead of open-xchange-authentication-database, install the package open-xchange-authentication-imap
  • do NOT create a context, just follow the installation guide up to the database registration
• run the command

$ /opt/open-xchange/sbin/initrestrictions -A oxadminmaster -P secret

once you've finished the open-xchange installation

• Take care to install the packages open-xchange-gui-wizard-plugin open-xchange-gui-wizard-plugin-gui. The wizard must be used to enforce the user to provide a real valid displayname.
• edit file /opt/open-xchange/etc/groupware/imapauth.properties and set

USE_MULTIPLE=true

• edit file /opt/open-xchange/etc/groupware/settings/open-xchange-gui-wizard-plugin.properties and set

ui/wizard/firstrunmode=true

• edit file /opt/open-xchange/etc/groupware/mail.properties and set

com.openexchange.mail.adminMailLoginEnabled=true

• edit file /opt/open-xchange/etc/groupware/sessiond.properties and set

com.openexchange.sessiond.autologin=true

• edit file /opt/open-xchange/etc/admindaemon/User.properties and set

PRIMARY_MAIL_UNCHANGEABLE=false

Install on OX AppSuite

Debian GNU/Linux 11.0

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

deb https://software.open-xchange.com/products/OXtender-unstable/cPanel/DebianBullseye/ /
# if you have a valid maintenance subscription, please uncomment the 
# following and add the ldb account data to the url so that the most recent
# packages get installed
# deb https://[CUSTOMERID:PASSWORD]@software.open-xchange.com/products/OXtender-unstable/cPanel/updates/DebianBullseye/ /

and run

$ apt-get update
$ apt-get install open-xchange-admin-plugin-reseller-soap

Debian GNU/Linux 12.0

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

deb https://software.open-xchange.com/products/OXtender-unstable/cPanel/DebianBookworm/ /
# if you have a valid maintenance subscription, please uncomment the 
# following and add the ldb account data to the url so that the most recent
# packages get installed
# deb https://[CUSTOMERID:PASSWORD]@software.open-xchange.com/products/OXtender-unstable/cPanel/updates/DebianBookworm/ /

and run

$ apt-get update
$ apt-get install open-xchange-admin-plugin-reseller-soap

Install and prepare WHM/cPanel on CentOS5

Note: Choose either CentOS5 or RHEL5. Nothing else is supported to integrate Open-Xchange with cPanel.

• Follow the installation guide http://docs.cpanel.net/twiki/bin/view/AllDocumentation/InstallationGuide/Quick-StartInstallationGuide
• run /scripts/upcp
• run /scripts/perlinstaller SOAP::Lite

NOTE: This can take very long and it might look like it is hanging at

We are about to install SOAP::Lite and for your convenience will provide
you with list of modules and prerequisites, so you'll be able to choose
only modules you need for your configuration.

XMLRPC::Lite, UDDI::Lite, and XML::Parser::Lite are included by default.
Installed transports can be used for both SOAP::Lite and XMLRPC::Lite.

Press <enter> to see the detailed list.  

Just be patient and wait for it to finish.

• add the repository http://software.open-xchange.com/OX6/OXtender-unstable/cPanel/RHEL5 to your yum configuration

$ vi /etc/yum.repos.d/oxintegration.repo
[oxcpintegration]
name=Open-Xchange cPanel
baseurl=http://LDBACCOUNT:LDBPASSWORD@software.open-xchange.com/OX6/OXtender-unstable/cPanel/RHEL5
gpgkey=http://software.open-xchange.com/oxbuildkey.pub
enabled=1
gpgcheck=1
metadata_expire=0m

• install the package open-xchange-cpanel

$ yum install open-xchange-cpanel

• run the installer (-h for help):

$ /usr/local/cpanel/bin/oxcpanelinstall --oxurl http://ox.example.com --oxadmin-password oxadminmasterpassword

Now your Open-Xchange server is integrated with your cPanel installation.

To check the connection, run

$ /usr/local/cpanel/bin/oxcpanelenable -c

This program can also be used to enable all existing cPanel users in OX. Run

$ /usr/local/cpanel/bin/oxcpanelenable -h

for more information.