Peter's OX Server Admin GUI

Oktober 11, 2009

Peter’s OX Admin GUI 0.1.17 (en)

Filed under: Einführung — oxgui @ 4:53 am

Welcome to the release (v0.1.17) of Peter’s OX Admin GUI for the Open-Xchange Community Editionn. Some informations to this project can be found at this thread OX-Forums (german). German version of this installation guide.

This release supports the creation and modification of…

  • Contexts
  • Users
  • Resources
  • Groups

Release information: http://oxgui.sciencesoft.at/oxversioninfo.txt

Prerequisites

Install OX according followig installations guides: OX 6.20 or OX 6.22

Important infos for a new installation and a update of the GUI

For OX 6.22.2 and higher following file/value must be changed:
/opt/open-xchange/etc/server.properties
Set
com.openexchange.connector.maxRequestParameters: 30
to the value 300.

For older OX 6.20.x versions following file must be changed – see forum

/opt/open-xchange/etc/ajp.properties
increase this value
AJP_MAX_REQUEST_PARAMETER_COUNT: 30
to
AJP_MAX_REQUEST_PARAMETER_COUNT: 300

Update from version 0.1.x to 0.1.16 for a  OX server  version lower than 6.22

wget http://oxgui.sciencesoft.at/patch/v0.1.16/at.sciencesoft.oxadmingui.jar

Replace the existing file

/opt/open-xchange/bundles/at.sciencesoft.oxadmingui.jar

against the new bundle. Restart the OX Server  But be aware – wget doesn’t overwritte existing files. The new file will be stored with slightly other file name.

New: Update  to 0.1.17 / OX-Server Version 6.22

Update the OX sever according following installation guide: http://oxpedia.org/wiki/index.php?title=Update_to_6_22

wget http://oxgui.sciencesoft.at/patch/v0.1.17/at.sciencesoft.oxadmingui.jar

Replace the existing file

/opt/open-xchange/bundles/at.sciencesoft.oxadmingui.jar

against the new OSGI bundle. Copy following file

wget http://oxgui.sciencesoft.at/patch/v0.1.17/at.sciencesoft.oxadmingui.ini

into the directory

/opt/open-xchange/osgi/bundle.d

Then restart the OX server

/etc/init.d/open-xchange restart

New installation

OX 6.20

wget http://oxgui.sciencesoft.at/psoxgui.0.1.16.tar.gz
tar -C / -xvzf  psoxgui.0.1.16.tar.gz
chown -R root:open-xchange /opt/open-xchange/etc/psoxgui

Stop the OX server 
/etc/init.d/open-xchange-groupware stop
/etc/init.d/open-xchange-admin stop
Start the OX server
/etc/init.d/open-xchange-groupware start
/etc/init.d/open-xchange-admin start

OX 6.22

wget http://oxgui.sciencesoft.at/psoxgui.0.1.17.tar.gz
tar -C / -xvzf  psoxgui.0.1.17.tar.gz
chown -R open-xchange:open-xchange /opt/open-xchange/etc/psoxgui

Restart the OX server
/etc/init.d/open-xchange restart

Check the installation

Wait some seconds after the start of the OX server. The OX server should be up and running.
/opt/open-xchange/sbin/listbundles  
Following bundles should be listed:
bundlename: org.eclipse.osgi status: ACTIVE 
bundlename: at.sciencesoft.oxadmingui status: ACTIVE 
bundlename: com.openexchange.authentication.database status: ACTIVE 
... 

If the GUI bundle shows RESOLVED instead ACTIVE or is missing, then there is lib dependency problem, 
which prevents the loading of the bundle. 

Please review following log files for more informations: 

tail -f -n200 /var/log/open-xchange/open-xchange.log.0
tail -f -n200 /var/log/open-xchange/open-xchange-osgi.log

Deinstallation

rm /opt/open-xchange/bundles/at.sciencesoft.oxadmingui.jar
rm /opt/open-xchange/lib/freemarker.jar
rm -r /opt/open-xchange/etc/psoxgui/
OX 6.20: rm /opt/open-xchange/etc/groupware/osgi/bundle.d/at.sciencesoft.oxadmingui.ini
OX 6.22: rm /opt/open-xchange/osgi/bundle.d/at.sciencesoft.oxadmingui.ini

Manual

Start URL of the GUI:
http://oxserver/servlet/webserver/index.html

login_en

After login please select the menu Context, which displays all existing contexts.

context_en

Hint: For existing contexts you must set user and password of the ContextAdmin (Login). Select the context and and apply the menu  ‚Set ContextAdmin‘  which asks you for the login data. This addional step isn’t necessary for contexts, which were created by the GUI. Context data like login, default values, etc. are stored according  following schema:

/opt/open-xchange/etc/psoxgui/context/1.properties

Property name is equals OX context ID.

To create/modify a context related user, group or resource you must set an actual context.

actual_context_en

The rest of this admin GUI should be self-explanatory  😉

Configuration files

/opt/open-xchange/etc/psoxgui/

e.g. psoxgui.properties – contains gloabl settings like language, time zone etc

Report Errors & Problems

Please report any error or problem to following email:

oxgui@sciencesoft.at

Translation

Please help me to improve the translation of the englisch version. Please report any incorrect translation to oxgui@sciencesoft.at.
You can test easily any text change on the fly. Following XML file

/tmp/psoxgui/content.xml

contains all text messages. But be aware, this temporary file will be rewritten after each restart of the OSGI  bundle at.sciencesoft.oxadmingui.jar.

Sources

OX 6.20: http://oxgui.sciencesoft.at/psoxgui.0.1.16.src.zip

OX 6.22: http://oxgui.sciencesoft.at/psoxgui.0.1.17.src.zip

This is a Netbeans project which contains all necessary sources and libraries. The development enviroment ist Windows. OX  RMI calls are passed with the help of PuTTY and a SSH tunnel through the OX server.


Advertisements

Bloggen auf WordPress.com.