== Installing from Binaries ==
[http://build.opensuse.org/project/show?project=home%3Acsa7fff%3Aadei ADEI Project] is hosted at [https://build.opensuse.org SuSe Build System]. You will need to install at least ''adei'' and one of configuration packages ''adei-config-*''. In order to redirect users from the site entrance to the ADEI, please, install ''adei-webroot'' package as well.

== Accessing project repository ==
 * Performing initial import
{{{
bzr checkout http://darksoft.org/bzr/adei/trunk/
}}}

 * Updating to the current revision
{{{
bzr update
}}}

== Branches ==
 * There is no active branches available at the moment

== Configuration ==
 * Setup Apache, MySQL 5, and PHP 5.2 with all dependencies
  * Apache modules: mod_php, mod_rewrite, mod_proxy, mod_proxy_http
  * PHP modules: zlib, zip, mysql, pdo, odbc (''needs fixes''), json, nls, xml, session, sockets, imagick, simplexml, gettext
  * PHP/PEAR modules: Spreadsheet_Excel_Writer
  * PHP/PECL modules: pecl-stats
  * Other applications: microsoft true type fonts, jpgraph
  * MSSQL connectivity: freetds (''needs fixes'')
 * Enable specified apache modules in configuration
 * In Apache configuration: Enable all options and allow configuration overriding by .htaccess files
 * In PHP configuration: Allow short opening tags and disable reporting E_NOTICE conditions. The limits of script execution time and memory usage may be raised as well.
 * Disable binary logging in MySQL configuration, otherwise mysql user accessing caching database would need a '''SUPER''' privilege. Read more on the topic in [http://dev.mysql.com/doc/refman/5.1/en/stored-programs-logging.html Binary Logging of Stored Programs] in the MySQL documentation.
 * Install ADEI
  * Create MySQL account with full permissions to manage certain database. Configure this account and the database in ''config.actual.php'' in the root of ADEI installation.
  * Provide required setups under ''setups'' directory in ADEI tree. Set default setup in ''config.actual.php''.

== Running behind port-forwarding firewall == 
 * The ADEI Apache server should run on the port users specify in the location. Lets consider that remote users are using http://gateway.domain.net:8000/adei to access ADEI running at http://adei.domain.net:80/adei and the gateway does port forwarding. In this case, it is necessary that local web requests bypassing the gateway server, but directed to the port 8000 to be served by Apache server. This is achieved either by running Apache on both ports 80 and 8000 or by performing local port redirection from 8000 to 80.
 * The default configuration also requires that local requests directed to http://gateway.domain.net:8000 to be redirect back to the ADEI server. If the gateway configuration does not perform port forwarding for requests from local interface, it is necessary to change ''RewriteRule'' in the ADEI ''services/.htaccess'. The following statement should be written instead of the default one.
{{{
RewriteRule ^([\w\d_]+)(\.php)?$  http://127.0.0.1/%1service.php?service=$1&%{QUERY_STRING} [L,P]
}}}


== Platform-specific Installation Instructions ==
 * [wiki:adeiSUSE OpenSuSe]

== Project-specific Notes ==
 * [wiki:adeiKATRIN KATRIN]