Installation
monitrix is implemented based on the Play! Framework, and uses MongoDB for its backend. For the time being, please be sure to use Play! version 2.0.4, since monitrix is not yet compatible with Play 2.1!
Play! requires the Java 6 SDK (not just the JRE!) to be installed on your machine. To install Play!, download the version 2.0.4 binary package, extract the archive where you have both read and write access, and add the play script to your PATH. Detailed instructions are available here.
Refer to the official manual for information on how to install and start MongoDB on your system. (On Linux distributions, MongoDB is usually available through the package manager as well.)
Clone the Monitrix repository to a location of your choice. E.g.
> git clone https://github.com/ukwa/monitrix.git
Git will clone Monitrix into a subdirectory called monitrix. To start monitrix, change into the subdirectory and start the application.
> cd monitrix
> play run
Play will dowload library dependencies (this might take a while), and indicate completion with the following message:
[info] play - Listening for HTTP on port 9000...
(Server started, use Ctrl+D to stop and go back to the console...)
After that, monitrix will be available at http://localhost:9000
Unfortunately, there are no pre-compiled installation packages produced on a regular basis (yet). Refer to the instructions on creating installation packages manually if you want/need to create your own installation package. The installation package eliminates the need to set up Play! and Git. It also includes all library dependencies, so there is no need for an Internet connection on the machine.
Once you have an installation package, set up Monitrix like so:
- Unzip the installation package to a location of your choice
- Change into the root folder of the unzipped package
- Type
target/startto launch Monitrix.
Open the monitrix configuration file, located at conf/application.conf. All the defaults should be fine. The only thing to make sure is that the MongoDB settings match your environment. The relevant lines are at the bottom of the configuration file. Modify hostname, port (and database name) if needed.
# MongoDB configuration
# ~~~~~
mongo.host=localhost
mongo.port=27017
mongo.db.name=monitrix
-
Launch monitrix by changing into the project root folder and typing
play run. The application will be at http://localhost:9000 -
To (properly) shut down monitrix, hit CTRL-D