Toggle Menu

Installation Guide

This guide will assume you have all the software components already installed (including Ruby, MySQL etc...) as defined on the system requirements page.

Create your MySQL database

All your Sirportly data is stored in a MySQL database which you will need to create before you can continue. Your database should be created with the utf8 character set and the utf8_unicode_ci collation. You can call the database whatever you want and you'll be asked later in this process. You should also create a user which has full access to your newly created database.

mysql$ CREATE DATABASE `sirportly` CHARSET utf8 COLLATE utf8_unicode_ci;
mysql$ GRANT ALL ON sirportly.* TO `sirportly`@`localhost` IDENTIFIED BY "a_secure_password";

Downloading & Installing Sirportly

To continue, you will need your 25 character licence key which will have been provided to you by e-mail when you purchased your licence. If you have not purchased a licence yet, you can do so here.

Once you have your key, you need to download our installation script and execute it from a bash terminal. This will then ask you to enter your licence key, we will download the latest version of the software and proceed to install it. During this stage you will also be prompted to accept our licence agreement, enter your database connection details as well as a few other details (including the path you wish to install the software into).

$ wget
$ bash
$ start sirportly

This installation script will perform a number of actions on your system:

  • A user called sirportly will be created which will run any Sirportly processes.
  • Your database schema will be populated into your database.
  • All dependencies and libraries required by the application will be installed.
  • An upstart configuration script will be added to /etc/init.

Logging into your new helpdesk

The setup tool will automatically create an admin user which you can use to login for the first time. Once you have logged in you should ensure that you change the password to something more secure.

  • Username: admin
  • Initial Password: changeme