Skip to content

musethno/MGS

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

83 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

MGS

License

This software is licensed using the MIT Software License (see file LICENSE for Details). In short, this means, the MGS is obtainable for free and you are free to do anything you want with it, as long as you include the copyright notice.

System Requirements

The MGS runs on the Play Framework. Please refer to the Play Documentation for more details on installation and usage in other setups than described here.

Server

  • The MGS is java based and is therefore cross-platform in theory. The current version has been tested on Debian GNU/Linux 8 "Jessie" only.
  • Play runs an own web server that listens on a given port (default: 9000). You can use a front-end server for proxying/load balancing. The current version works fine in combination with Apache 2.4.10.

Database

  • Play Framework supports a variety of common SQL database systems. The MGS is tested with MySQL 5.5

Play Framework dependencies

  • The Play Framework, current version tested with Play 2.4.6 ("Damiya")
  • JDK 8+ (Note: We're running it sucessfuly with OpenJDK 7)

Getting Started

Prepare the Database

Create a database and database user. Edit the application.conf (/MGS/conf/application.conf/) and provide the login credentials for your database:

  • db.default.url="jdbc:mysql://localhost/[your-database-name]?characterEncoding=UTF-8"
  • db.default.user="[your-database-user]"
  • db.default.password="[your-database-password]"

Installation

  1. Navigate to the installation directory of your choice. If you install the application outside your /home directory, be sure to fix the file permissions accordingly. If not, the MGS needs to be run with root privileges, which obviously is a bad idea.
  2. Clone this repository: git clone https://github.com/musethno/MGS.git .
  3. Run the application with: ./activator play start
  4. The MGS downloads missing dependencies, compiles and starts the web server, listening by default to 9000. Note that it might take a long time to compile if you run the application for the first time. Afterwards, play will only compile modified files.
  5. In your browser, navigate to localhost:9000