Sirportly

Toggle Menu

Installation Guide

Hardware Requirements

Sirportly can be installed on any server with the following minimum specification:

  • At least 2GB of Memory, 4GB recommended
  • At least 1GB of disk space (for software files)

Software Requirements

Sirportly is currently only supported on Linux operating systems. The installer will inform you of specific dependencies for your Linux distro during the installation process. Before beginning the installation, you will need to install wget and ruby. These are required to run the installer.

# For Ubuntu or Debian
apt install ruby wget
# For RHEL or CentOS
yum install ruby wget

Create your MariaDB / MySQL database

Sirportly requires a MariaDB or MySQL database. This can be installed locally on the same machine running the application, or remotely. For a basic install, we recommend installing MariaDB on the same host that will be running Sirportly. This can be achieved as follows:

# For Debian and Ubuntu
apt install mariadb-server mariadb-client

# For RHEL and CentOS
yum install mariadb-server
systemctl start mariadb
systemctl enable mariadb

Login to your mysql terminal as the root user and create a Sirportly database. 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 -u  root -p your-mysql-password
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. At this stage any missing dependencies will be stated and you can install those before continuing with the installation.

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.

$ wget sirportly.com/install/installer.rb
$ ruby installer.rb install

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. By default the helpdesk will listen on port 8080 at the domain name specified during the install process.

  • Username: admin
  • Initial Password: changeme