AklaBox. The Ultimate Document Platform for your Cloud Infrastructure. Installation Guideline

Transcription

1 AklaBox The Ultimate Document Platform for your Cloud Infrastructure Installation Guideline

2 Contents Introduction... 3 Environment pre-requisite for Java... 3 About this documentation... 3 Pre-requisites... 4 Database... 4 Server... 5 Performances and general settings... 5 Architecture & Installation... 6 Aklabox Server installation... 7 Database... 7 Server... 8 Server Configuration... 8 Additional Components... 9 Running Aklabox... 10

3 Introduction This document is about Aklabox installation, the Ultimate Document Platform for your Cloud Infrastructure The Aklabox platform is available for download in 2 main versions : MySQL (packaged version) or PostgreSQL (scripts and configuration packaged) Derby Platform : all in one platform, ready to deploy The Aklabox platform includes a tomcat server which contains the web applications and the scripts for databases. The server is initially configured for a localhost environment. In order to set your server in production, follow strictly this documentation. The 3 steps explained in this documentation are the following ones : How to restore the databases Configuration and settings of the server Initial administration Environment pre-requisite for Java Your server environment (Unix or Windows) has to have a 1.6 Java version minimum. Your system parameter has to be like this one : JAVA_HOME = folder which contains your jdk About this documentation This documentation is about the Aklabox platform installation (version1.0, released January 2014). It describes the main steps of the installation

4 Pre-requisites Database Depending of the kind of database server you want (among the available supported by Aklabox for its own required databases), you need the database server to be installed. This database server is required for the aklabox database only Aklabox MySQL distribution We suggest to use the MySQL 5.6 server version. You need the database server to be installed and accessible from your Aklabox server (check the network configuration and the host configuration). The property lower-case_table_names needs to be set to 1. (config file mysqld) Create a biplatform (id) /biplatform (password) user. Aklabox PostgreSQL distribution We suggest to use the PostgreSQL 9.1 server version. You need the database server to be installed and accessible from your Aklabox server (check the network configuration and the host configuration). Create a biplatform (id) /biplatform (password) user. AklaBox Derby distribution You do not need to install any database server.

5 Server Windows Environment If you want to set Aklabox on a Windows server (we suggest to use Windows 2008 server R2), please read the following points. Java environment A Java 1.6 environment has to be installed on the server (JDK 6 of Sun). System variables The JAVA_HOME and PATH system variables have to be set correctly. JAVA_HOME refers to the location of the Java folder. PATH has to be completed (add ';' after the last one) with '%JAVA_HOME%\bin'. Port available Be sure that default ports used by Aklabox server are not already in use and not blocked on the server (8005,8009,8443 and 8080). Unix Environment If you set Aklabox on a Unix server (we suggest to use Debian 6 server), please read the following points. Java environment A Java 1.6 environment has to be installed on the server (JDK 6 of Sun). Port available Be sure that default ports used by Aklabox server are not already in use and not blocked on the server (8005,8009,8443 and 8080). Performances and general settings Processor 2 GHz recommended and DUAL CORE processor (QUADRI CORE depending on the use) Memory 4 Go of RAM Memory recommended (8Go depending on the use) Disk 10 Go of disk space available

6 Architecture & Installation Aklabox Architecture Servers download The 2 main versions of the Aklabox platform and the specific files in relation with a PostgreSQL installation are available for download at the following url : (download section)

7 Aklabox Server installation Database The databases scripts are available with the Aklabox platform. By default, the database is vanilladata The 3 default supported database servers are MySQL, PostgreSQL and Derby. We will detail how to restore the databases for this 3 kind of servers. MySQL version The MySQL scripts are together available with a HOWTO file which explains the step for restore. Restore your database through your administration interface (scripts created through MySQLAdministrator) and grant your user 'biplatform/biplatform' for all rights on these databases. Note that you have to check the 'ANSI Quote' options in your administration tool. (alternative on Windows environment : add 'ansi' in the [mysqld] section of the my.ini file) Note that is you have an Unix environment : add 'sql-mode=ansi' in the [mysqld] of the my.cnf file.

8 Server Once your compulsory databases for your Aklabox platform restored (Derby version not affected by the databases restoration), the platform is given with a defaut localhost configuration. In order to set your platform in production, follow strictly the following chapters. Unzip your Aklabox Archive : do not unzip the archive file in a path whose name contains spaces. Server Configuration You have to configure your platform in the following folder : 'vanilla-conf'. # AklaBox Connection Config bpm.login.interface.iscreatebuttonavailable=false bpm.login.interface.uservalidationmethod=payment # AklaBox ing system bpm.vanilla.mailer.smtp.host=smtp.gmail.com bpm.vanilla.mailer.smtp.port=465 bpm.vanilla.mailer.smtp.from=bpm.vanilla@gmail.com bpm.vanilla.mailer.smtp.user=bpm.vanilla@gmail.com bpm.vanilla.mailer.smtp.password=mypassword bpm.vanilla.mailer.smtp.auth=true bpm.vanilla.mailer.smtp.starttls.enable=true # AklaBox Files bpm.document.management.files=webapps/aklabox_files/

9 Additional Components Solr Lucene Support In order to index your document, you must have Solr Lucene installed and running on your computer Video Support In order to play videos and audios, you must have VLC Media Player installed and running on your computer. Note : be sure that you are running on 32-bit JDK or else uploading videos will not run on your server OpenOffice Support In order to generate thumbnails, you must have OpenOffice 4.01 installed and running on your computer. if your are using windows OS, edit start-aklabox.cmd, if you are using linux, edit startaklabox.sh example : "-Doffice.home=C:\Program Files (x86)\openoffice 4" This is the contents of on rem set JAVA_OPTS=-Dlog4j.configuration=log.xml -Dlog4j.debug=true - Dbpm.vanilla.configurationFile=%cd%/vanilla-conf/vanilla.properties set JAVA_OPTS=-Dlog4j.debug=true -Dbpm.vanilla.configurationFile=%cd%/vanillaconf/vanilla.properties -Dlog4j.configuration=%cd%/vanilla-conf/log.xml "-Doffice.home=C:\Program Files (x86)\openoffice 4"

10 Running Aklabox To have indexation, you need to run Solr/Lucene in parallel of Aklabox platform. Solr Lucene Before starting Aklabox, you need to run Solr-Lucene. To start the solr, go to the solr-4.4.0/example folder Run java -jar start.jar Aklabox Go to the root folder of Aklabox start-aklabox.cmd