INSTALLATION

SYSTEM REQUIREMENTS

Mint Service Desk runs in Docker (a computer program that performs operating-system-level virtualization, which means that a virtual machine will be deployed in your server in order to have your MINT Service Desk up and running. The MINT Service Desk installation file for Docker includes an application, database, and web server embedded to deploy MINT Service Desk.

In order to install MINT Service Desk, the minimal server requirements are:

HARDWARE

MINIMAL SERVER REQUIREMENTS

CPU: Intel Xeon 2.0 GHz or equivalent

RAM: 8 GB

Disk space: 100GB

SOFTWARE

SUPPORTED SYSTEMS AND VERSIONS

Operating Systems:

Linux (all distributions supported by Docker)

Database (embedded):

PostgreSQL

Web browser:

Chrome

Firefox

Safari

GETTING STARTED

The following instructions will help you to install and setup the MINT Service Desk in your server.

DOWNLOADING MINT

First, you need to download the latest version of Mint Service Desk. You can do it on the following address https://www.mintsd.com/pages/download-center by clicking the “Download” button.

image0

Save the file on your hard drive.

INSTALLATION ON LINUX OS.

The following Installation guide was prepared based on the CentOS distribution of the Linux system.

Open up the Command-Line. Now, you need to move the file, that you downloaded a moment ago, to /opt folder from your computer to the server. Use the following command.

scp mint-service-desk-2.0.7.sip ssh root@YORSERVERIP:/opt

image1

If you downloaded a newer (than 2.0.7) version of the system you need to change the name of the file in that command. Also, replace “YOURSERVERIP” with your server IP.

Now type the ls command. You will see the Mint Service Desk .zip file.

image2

Installing Docker

As mentioned before, Mint Service Desk runs in Docker. The following instructions will help you to install and setup the MINT Service Desk in your server. Take notice that those instructions were made for Docker v19.03 and Docker Compose v1.25.5. In case of a version change, you will also need to change it in some steps (commands).

Please check the following links to setup Docker in your MINT SD server. Under each link, you will find the detailed instruction of how to install Docker (if you like to do it by yourself). Remember, that first, you need to create an account (DockerID) in order to be able to download Docker.

Once you downloaded Docker you can go back to Command-Line. Type the following command.

sudo yum install -y yum-utils

image3

Wait until the installation is finished.

image4

This has installed the yum-utils package (which provides the yum-config-manager utility) and set up the stable repository.

Now type the following command:

sudo yum-config-manager \

—add-repo \

If everything went fine you should see the following information

image5

Installing Docker Engine

Now, you need to install the latest version of the Docker Engine and container. Type the following command in Command-Line.

sudo yum install docker-ce docker-ce-cli containerd.io

After a while, you will be asked to confirm the installation. Type “y” for yes.

image6

Wait a moment and you will be asked for confirmation one more time. Type “y” for yes.

image7

The installation process can take a while. Once it is finished you should see the following information.

image8

Starting Docker

Once the Docker has been installed we can start it. Type the following command in the Command line

sudo systemctl start docker

Installing Docker Compose

Docker Compose is needed for the Mint Service Desk installation. In Linux OS you have to manually install it (depending on your Linux distribution this can change) by running the following command.

sudo curl -L “https://github.com/docker/compose/releases/download/1.25.5/docker-compose-$(uname -s)-$(uname -m)” -o /usr/local/bin/docker-compose

After a moment installation will be completed.

image9

Now you need to apply executable permissions to the binary. Use the following command.

sudo chmod +x /usr/local/bin/docker-compose

Now you should test the installation. Run the following command.

docker-compose –version

You should receive the following information.

image10

Extracting the MINT package.

Before you can proceed to the next step you need to extract the content of the Mint package you have downloaded at the very beginning of this guide.

Run the following command in the Command-Line.

yum install unzip

After a moment you will be asked for confirmation. Type “y” for yes.

image11

After a moment the process will finish.

Now let’s extract the files from the Mint package. Use the following command.

unzip mint-service-desk-2.0.7.zip -d /opt/mintsd

The process will only take seconds to complete.

Now, type ls command and you should see the following information.

image12

Now, change the location to ‘mintsd’ catalog. Use the following commands.

cd mintsd

then

ls

You should see the following information.

image13

Installing MINT

Once the package has been extracted you need to run the start script. Use the following command.

./start.sh

Now just follow a couple of steps described in the next sections until the end to complete the installation.

At the beginning, you will be asked to read and agree with the License Agreement. Type “y” if you accept them.

image14

Once the install files has been checked you can proceed.

First, you need to enter the domain address. By default it is “localhost’. Change it to your server’s IP or FQDN (Fully Qualified Domain Name).

image15

Let’s use 192.168.100.30 as an example.

image16

Now, enter Mint Service Desk system name. By default, it is “MintSD”. Change it to the desired one.

image17

Now you can either set up the passwords for ‘RabbitMQ’ and for Database or leave the default ones.

image18

Once you click enter you will have to wait a while until the process of configuration of docker environment, docker images, loading layers, and couple more things is finished.

If everything went fine you should see the following information.

image19

At this moment, you should stop and wait for a couple of minutes, because the services are starting for the first time.

Everything is ready! You can now move to your web browser and access mint.

FIRST LOGIN

Type your server IP on your web browser and login with the default admin account credentials (remember to change it):

Login: admin Password: admin1

image20

Now, in order to start using Mint Service Desk you need to:

  1. Define a new email account from which messages will be sent. You can do it in section Channels > Accounts. Right here you need to click on the small image21 button located on the right side of the search bar.

image22

Inside the “Create Account” view you will need to fill up the required information (fields marked with a *). Also, you can add some additional information inside the “Description” text field.

image23

Once you do that, click on the image24 button to proceed.

Now, in the next view, you will need to fill up some technical information.

image25

Once you finish, click on the image26 button to finish the process and save the new email account.

You will be moved to the list of existing accounts, where you will see a new position with some information about your new email account.

  1. Define at least one “Body” type template component which includes at least ‘{{EmailURL]}}’.

    You can do it in section Channels > Components.

    Right here you need to click on the small image27 button located on the right side of the search bar.

image28

In the view responsible for creating a new template component click the right mouse button in the ‘Description’ section and from the menu select Email > Url.

image29

Click on the image30 button.

  1. Define at least one template. You can do it in Channels > Templates section.

    Right here you need to click on the small image31 button located on the right side of the search bar.

image32

You need to choose a previously created Body type Component from the list in the ‘Select body’ section. Also, remember to create an appropriate name for this template and select “system” from the “Template type” part of this view.

image33

Click on the image34 button.

  1. Now you need to Set up ‘Email confirmation Template’. You can do it in the Settings section by clicking on ’Templates’ and choosing already created template from the list in the ‘Email confirmation template’ section.

image35

Once you do that, just click on the image36 button.

  1. Now you need to create at least one Agent type user. You can do it Users > User Manager section. Right here you need to click on the small image37 button located on the right side of the search bar.

image38

Inside, in the ‘Create User’ view, you need to fill up all of the required information and click on the image39 button once you do that. Take notice, that you need to select a correct ‘Role’ from the list.

image40

MINT Service Desk has one already predefined Agent role. If you want to learn more about adding and managing system Roles, you will find more information in the Admin part of this guide.
  1. Once Agent is created, the first attempt to login will send a verification email to the new Agent on his email address (given during the previous step). It will include a request to validate his email address.

    Once that’s done – you are ready to go.

UPGRADING

If you have a previous version of MINT Service Desk and you want to upgrade your system to the latest version, you can do it as follows.

First, you need to download the latest version of MINT Service Desk here:

https://mintsd.com/products/mint-service-desk-free

Then you just need to extract the package downloaded and run the start file as you did during the installation process:

on Linux/OSX:

./start.sh

on Windows:

./start.cmd

You are not going to go through all the same steps again like in the installation, the system will only apply the changes and upgrades needed from the previous version and it will keep your data safe.