Introduction and Preparation
Firstly, you need to get Apromore running in a development environment or on a server. We currently don't have downloadable artifacts or install scripts that can be installed and run out of the box.
This software is still in development and requires the code to be compiled and packaged before running. The build process has been made as easy as possible and is changing to be easier all the time. Follow the steps below to find the instructions on how to get up and running.
Before you proceed building Apromore, make sure the following components are installed and are working properly. This guide does not cover the installation and configuration of these specific components however.
Apromore is based on Eclipse Virgo and has been successfully installed on the following platforms:
Linux (specifically ubuntu)
Mac OSX 10.8, 10.9
Ensure the following software is installed and operational:
Java Developer Kit (supported version: JDK7.1)
Maven ( supported version: 3.1.1)
Ant (supported version: 1.9.3)
MySQL (supported version: 5.6.x)
Subversion (supported version: 1.8.x)
Currently the following browsers are supported:
- Firefox (stable)
Unfortunately Internet Explorer is not supported yet.
MySQL is the default Database that is supported but there are plugins for Postgres and Oracle. In that case some extra setup will be required. This is not covered yet in this guide. Currently there are sql scripts to create and setup the database for H2 and MySQL only.
Step 1: Obtaining the sourcecode
Check out the Apromore source tree from the github repository at https://github.com/apromore/ApromoreCode.git
Step 2: Edit configuration properties
In the root directory of the source code checkout, copy the file
Edit, where applicable, the following entries in
site.host: Hostname (default set to localhost)
site.port: Port (default 9000). Sometimes you want to change the default port (e.g., when this port is in use already). Usually site.externalport should be the same, unless you’re behind a port redirector. If that’s the case, site.externalport should be the port visible to the outside world. For the Apromore public server for instance, site.port is 9000, there’s a redirector that maps incoming requests on port 80 to local port 9000, and site.externalport is 80.
editor.dir: This needs to reference an empty directory with write permission, e.g. on Linux or OSX you could use /tmp (the systems temp folder), or on Windows
C:/windows/temp (the windows temp folder, note the forwarding slashes).
fileshare.dir: This is a local directory which will be made accessible via WebDAV at http://localhost:9000/filestore/dav e.g.
NOTE: Be aware that whenever you edit
site.properties, you have to run “
ant apromore-site-config” to propagate the changes. Then you can run “
mvn clean install” as per usual.
Step 3: Setting up MySQL
Start MySQL on your platform of choice.
Set the root password of MySQL to the default used by Apromore
$ mysqladmin -u root password MAcri
Create a user named 'apromore' in your MySQL database.
$ mysql -u root -p MAcri
From the mysql prompt enter the following commands:
$ CREATE USER 'apromore'@'localhost' IDENTIFIED BY 'MAcri';
$ GRANT ALL PRIVILEGES ON * . * TO 'apromore'@'localhost';
$ FLUSH PRIVILEGES;
Navigate to the directory
/Supplements/database and execute
db-mysql.sql in your MySQL database.
This will create your database and setup the tables.
$ mysql --user=root --password=MAcri < Supplements/database/db-mysql.sql
At the end of the db-mysql.sql script is where some of the system data, including user information is populated. Currently, we have a few example users setup that are developers or affiliates and they can be used or you can choose to add your own. All passwords are encrypted but they are 'password' for the time being and we don't have a facility just yet to allow a user to change their password. This is coming soon as well as a setup utility to allow the creation of a user on first running.
Step 4: Compiling Apromore
You’re now ready to start building Apromore.
Change to the root of the project you checked out of SVN.
Run the ant command
ant apromore-pre-build. This will upload any libraries that are needed and not in any maven repository and builds some support libraries and places all of them in your local maven repository.
Run the maven command
mvn clean install. This will build the Apromore manager, portal and editor and all the extra plugins.
Run the ant command
ant start-virgo. This will install, configure and start Eclipse Virgo, and deploy Apromore.
Step 5: Lauch Apromore
Congratulations: You can now start using Apromore!
To launch the Portal, browse to http://localhost:9000/portal
The current configuration of Apromore running in Virgo does show errors on the startup. These can be ignored as they aren't related to Apromore.
Please keep track of this page as we are constantly changing the build to make it better. Also in the near future we will be releasing artifacts for all different system for an even easier setup.