OpenObelio eLETS Software Version 1.0 ===================================== Copyright (c) 2004-2009 Fundamentech Lutz Jaitner, 85399 Hallbergmoos, Germany This software is licenced under GNU General Public Licence (GPL) v3 for free distribution and usage of the source code. OpenObelio is provided by Fundamentech "as is", with no warranty. The user must not held Fundamentech liable for any damage that occurs through its usage. System Requirements: -------------------- SuSE Linux 9.3 for i386 MySQL 4.1 Apache 2.0 All modules compiled as dynamically loadable, prefork-version. qmail OpenObelio adheres to the POSIX standard as much as possible. The author is convinced that OpenObelio can be run under all versions of Linux with some changes to the installation script and virtually no changes to the source code. Extracting the Software: ------------------------ Copy the open-obelio.tar.bz2 archive to your root directory "/". Execute "bunzip2 open-opebelio.tar.bz2" and then "tar -xf open-obelio.tar". Now you see two new directories: /open-obelio/ and /open-obelio-archive. The former is the working directory of the OpenObelio software. The latter is an archive directory which is filled with backup data each time you execute the web interface command "OpenObelio Backup". The same command will be run every month by cron. Compiling the Code: ------------------- Enter directory "/open-obelio/src". Type "make". This creates the executable "open-obelio" and installs it into the /open-obelio/bin directory. Installing the OpenObelio Software: ----------------------------------- Make sure this directory is located or soft-linked at root level, i.e. its path should be "/open-obelio/". The OpenObelio backup directory should also be located or soft-linked to the root level, i.e. its path should be "/open-obelio-archive/". Please study the code of the installation script /open-obelio/obelio_install and its installation files at /open-obelio/conf carefully before running the script. The script will make significant changes to your Linux systems. You should modify the installation script and configuration files according to your needs. Then run /open-obelio/obelio_install. This will copy a number of files from the /open-obelio/conf directory to the appropriate places. The original versions of the system configuration files will be backed up to *.orig Adjusting the /open-obelio/bin/send_email Script: ------------------------------------------------- This script by default uses qmail to forward message via email to the users. If you like to use a different email software you need to modify the send_email script and the obelio_install script accordingly. How to Start and Stop the Apache2 HTTP Server: --------------------------------------------- Type "apache2ctl" to see the available command line options. The Apache server will start automatically after reboot, when the OpenObelio software has been installed as described above (test it!). How to Install, Start and Stop the MySQL Database Server: --------------------------------------------------------- Make sure you have installed the OpenObelio software first (see above). Then to initialize the grand tables of MySQL enter the shell command: mysql_install_db You can manually start the mysqld server by entering: /etc/init.d/mysql start You can manually shut down the mysqld server via: mysqladmin shutdown Please note that the mysqld server starts automatically after reboot, when the OpenObelio software has been installed as described above (test it!). Adjusting the OpenObelio Configuration File: -------------------------------------------- The open-oblio binary is started by Apache via the CGI interface. At each invokation the open-obelio code reads in the configuration file "/open-obelio/open-obelio.conf". You should modify this file according to your needs. At least you will need to change the our_domain parameter to reflect the domain of the OpenObelio web server. For the first tests you should leave all other parameters as they are. When your are fully familiar with OpenObelio and its database content you typically will have to modify just the the db_admin user name, password, and certificate. The corresponding entries in the database need to be adjusted accordingly. Adjust the qmail Configuration: ------------------------------- The directories /open-obelio/conf/control and /open-obelio/conf/alias contain the configuration of qmail. Please adjust according to your needs. Email forwarding cannot work correctly without proper adjustments. Adjusting the /open-obelio/conf/httpd.conf File: ------------------------------------------------ This file contains the configuration of the Apache web server. Please make yourself familiar with Apache configuration capabilities. You will need to modify the httpd.conf file if you need SSL support or if you want to host several subdomains on the same web server. SSL Support: ------------ SSL support in OpenObelio is disabled by default, because the code ships with no server certificate and key. However, the OpenObelio software is tested with SSL and can easily be made running with SSL encryption. For enabling SSL support you need to change the following: - the httpd.conf file - the home pages at /open-obelio/htdocs/xx/header.html, where xx is "en", "de", "fr", and "it". Change the link "dyn?cmd=my_account&sprache=xx" to "https://your-domain/xx/dyn?cmd=my_account&sprache=xx". - the source code at /open-obelio/src/obelio.c at line 908 to point to the link as above. - the /open-obelio/ssl directory to include your server certificate and private key - the /open-obelio/bin/apache2ctl script to include SSL support for the "start" option. Make sure you re-execute the obelio_install script again, which copies the apache2ctl script to the appropriate places. How to Build the Database and Administer the Portal: ---------------------------------------------------- Once you have installed the OpenObelio software you should test the connection between the Web browser client and the server by entering the domain specified in the open-obelio.conf file. Make sure the DNS name resolution works or a loop-back interface is configured in case your browser runs in the server. At the OpenObelio home page you select your language and click on "My Account". At the login window you should enter user name "Mustermann, Karin 1" and password "test" or the credentials you specified in open-obelio.conf respectively. After you have logged in you see the commands of the portal administrator. You can build the database by clicking "Create Database" and then "Import from Dump File". At /obelio/db_dump/ a database dump file is provided containing a test database. After importing this dump file you will see several accounts with different roles attached. The OpenObelio account is carrying the database administrator's role, which allows you to access database tables directly and view the log files etc. The "Meine Firma" account is similar to a subaccounts of a regular user. The "Mustermann, Karin 1" account carries the roles of a community administrator. The "Mustermann, karin 1P" account is a pension account, which can be used for long-time savings. Select different accounts and play around with them to see the differences between the roles. Enter Operation: ---------------- To make other users able to log in, you need to select the "OpenObelio" account and execute "Enter Operation". With the "Enter Maintenance" command you lock the database such that only the database administrator can work.