Deploy SupportPal on Docker

Deploy SupportPal using a multi-node configuration with Docker Compose on GNU/Linux. Experience with Docker is recommended.

Contents

Prerequisites

Ensure your system meets our recommended system requirements. Operating system and software requirements are already satisfied by our Docker containers.

Additional software is required to deploy SupportPal on Docker:


Installation & Configuration

Install SupportPal

To start the installation, run the following:

Linux / MacOS


bash <(curl -LsS https://raw.githubusercontent.com/supportpal/helpdesk-install/master/templates/docker-compose/setup.sh)

Windows


winpty bash <(curl -LsS https://raw.githubusercontent.com/supportpal/helpdesk-install/master/templates/docker-compose/setup.sh)

Configure HTTPS

By default, the software will run on HTTP using port 80, however we recommend using HTTPS for added security. To allow HTTPS, we provide an integration with LetsEncrypt, start the process with the following steps:

  1. Change the current working directory to the docker-compose directory, for example:
    
            cd helpdesk-install/templates/docker-compose
            
  2. Stop the containers if they are currently running:
    make stop
  3. Copy the Docker composer override file:
    cp docker-compose.override.yml.dist docker-compose.override.yml
  4. Update the Makefile file, replacing the COMPOSE_FILES variable:
    COMPOSE_FILES=-f docker-compose.yml -f docker-compose.prod.yml -f docker-compose.override.yml
  5. If you haven't already done so, update your domain name in the .env file:
    DOMAIN_NAME=example.com

You may now either set up a self-signed SSL certificate (if your domain is not available to the public), or a full LetsEncrypt SSL certificate for your domain.

Self-Signed SSL Certificate

Execute the script, replacing the top level domain names with your own:

./../../configs/letsencrypt/create-self-signed.sh -- example.com www.example.com

LetsEncrypt SSL Certificate

Execute the script, replacing the domain names and email address:

./../../configs/letsencrypt/init-letsencrypt.sh --email user@company.com -- example.com www.example.com

Start Containers

Finally start the containers again:

make restart

Next Steps

Congratulations, you've successfully installed SupportPal!

You can control the state of the containers via the make command:

make help

We now recommend that you learn how to administer your installation.


Backup

You can use the backup command to generate a full backup of all your files and configuration inside your volumes.

  1. Change the current working directory to the docker-compose directory, for example:
    
            cd helpdesk-install/templates/docker-compose
            
  2. Run the backup command:
    
            make backup
            

Upgrade

You can upgrade SupportPal with the following steps:

  1. Change the current working directory to the docker-compose directory, for example:
    
            cd helpdesk-install/templates/docker-compose
            
  2. Take a full backup.
  3. Edit .env and update the app version as necessary:
    
            APP_VERSION=3.4.0
            
  4. Run the upgrade command:
    
            make upgrade
            

Uninstall

To completely remove your help desk installation, follow the steps below:

  1. Change the current working directory to the docker-compose directory, for example:
    
            cd helpdesk-install/templates/docker-compose
            
  2. Take a full backup.
  3. Run the uninstall command:

    Linux

    sudo make uninstall

    MacOS / Windows

    make uninstall