osTicket is an open source help desk management solution that offers ticket management and IT asset management within a suite. The system can be deployed on your Synology NAS and is suited for small and midsize enterprise customers. In this step by step guide I will show you how to install osTicket on your Synology NAS using Docker & Portainer.
STEP 1
Please Support My work by Making a Donation.
STEP 2
Install Portainer using my step by step guide. If you already have Portainer installed on your Synology NAS, skip this STEP. Attention: Make sure you have installed the latest Portainer version.
STEP 3
Make sure you have a synology.me Wildcard Certificate. Follow my guide to get a Wildcard Certificate. If you already have a synology.me Wildcard certificate, skip this STEP.
STEP 4
Go to Control Panel / Login Portal / Advanced Tab / click Reverse Proxy. Follow the instructions in the image below.
STEP 5
Now click the “Create” button. Follow the instructions in the image below.
STEP 6
After you click the Create button, the window below will open. Follow the instructions in the image below.
On the General area, set the Reverse Proxy Name description: type in osTicket. After that, add the following instructions:
Source:
Protocol: HTTPS
Hostname: osticket.yourname.synology.me
Port: 443
Check Enable HSTS
Destination:
Protocol: HTTP
Hostname: localhost
Port: 6784
STEP 7
On the Reverse Proxy Rules click the Custom Header tab. Click Create and then, from the drop-down menu, click WebSocket. After you click on WebSocket, two Header Names and two Values will be automatically added. Click Save. Follow the instructions in the image below.
STEP 8
Go to Control Panel / Network / Connectivity tab/ Check Enable HTTP/2 then click Apply. Follow the instructions in the image below.
STEP 9
Go to Control Panel / Security / Advanced tab/ Check Enable HTTP Compression then click Apply. Follow the instructions in the image below.
STEP 10
Go to File Station and open the docker folder. Inside the docker folder, create one new folder and name it osticket. Follow the instructions in the image below.
Note: Be careful to enter only lowercase, not uppercase letters.
STEP 11
Follow my step by step guide on how to activate SMTP for your Gmail account. This step is mandatory. Note: If you don’t want to use the easiest way for SMTP with Google and you already have SMTP details from your own Mail Server, you can just skip this STEP and use your personalized email SMTP details instead.
STEP 12
Log into Portainer using your username and password. On the left sidebar in Portainer, click on Stacks then + Add stack. Follow the instructions in the image below.
STEP 13
In the Name field type in osticket. Follow the instructions in the image below.
version: '3.9'
services:
osticket_db:
image: mariadb:11.3-jammy
container_name: OsTicket_DB
security_opt:
- no-new-privileges:true
- seccomp:unconfined
- apparmor:unconfined
environment:
- MYSQL_ROOT_PASSWORD=root_password
- MYSQL_USER=some_user
- MYSQL_PASSWORD=some_password
- MYSQL_DATABASE=my_database_name
volumes:
- /volume1/docker/osticket:/var/lib/mysql:rw
restart: on-failure:5
osticket:
image: devinsolutions/osticket:latest
container_name: OsTicket
ports:
- 6784:80
depends_on:
- osticket_db
environment:
MYSQL_USER: some_user
MYSQL_PASSWORD: some_password
MYSQL_DATABASE: my_database_name
MYSQL_HOST: osticket_db
INSTALL_SECRET: MariushostingMariushostingMari13
INSTALL_URL: https://osticket.yourname.synology.me
INSTALL_NAME: Marius Helpdesk
ADMIN_USERNAME: marius
ADMIN_PASSWORD: mariushosting
ADMIN_FIRSTNAME: Marius
ADMIN_LASTNAME: Lixandru
ADMIN_EMAIL: yourown@email
CRON_INTERVAL: 1
SMTP_USER: Your-own-gmail-address
SMTP_PASSWORD: Your-own-app-password
SMTP_HOST: smtp.gmail.com
SMTP_PORT: 587
SMTP_FROM: Your-own-gmail-address
SMTP_TLS: 1
restart: on-failure:5
Note: Before you paste the code above in the Web editor area below, change the value for INSTALL_SECRET and add your own SECRET. MariushostingMariushostingMari13 is an example for a SECRET. You should invent your own Value. Add 32 random characters, both letters and numbers.
Note: Before you paste the code above in the Web editor area below, change the value for INSTALL_URL and type in your own synology.me DDNS with https:// at the beginning that you have previously created at STEP 6.
Note: Before you paste the code above in the Web editor area below, change the value for INSTALL_NAME and type in your own Helpdesk name.
Note: Before you paste the code above in the Web editor area below, change the value for ADMIN_USERNAME and type in your own username. marius is an example for an username. You will need the username later at STEP 17.
Note: Before you paste the code above in the Web editor area below, change the value for ADMIN_PASSWORD and type in your own password. mariushosting is an example for a password. You will need this password later at STEP 17.
Note: Before you paste the code above in the Web editor area below, change the value for ADMIN_FIRSTNAME and ADMIN_LASTNAME and type in your own first and last name.
Note: Before you paste the code above in the Web editor area below, change the value for ADMIN_EMAIL and type in your own Email Address.
Note: Before you paste the code above in the Web editor area below, change the value for SMTP_USER and type in your own Gmail address. STEP 11.
Note: Before you paste the code above in the Web editor area below, change the value for SMTP_PASSWORD and type in your own Gmail address. STEP 11.
Note: Before you paste the code above in the Web editor area below, change the value for SMTP_FROM and type in your own Gmail address. STEP 11.
STEP 14
Scroll down on the page until you see a button named Deploy the stack. Click on it. Follow the instructions in the image below. The installation process can take up to a few minutes. It will depend on your Internet speed connection.
STEP 15
If everything goes right, you will see the following message at the top right of your screen: “Success Stack successfully deployed“.
STEP 16
Go back to STEP 1 or you will deal with karma 🙂.
STEP 17
The installation process can take up to a few seconds/minutes. Please wait approximately 2 minutes or you will get a blank synology error page if you try to connect too soon. Now open your browser and type in your HTTPS/SSL certificate like this https://osticket.yourname.synology.me/scp/login.php In my case it’s https://osticket.mariushosting.synology.me/scp/login.php If everything goes right, you will see the osTicket Admin Login page. Type in your own ADMIN_USERNAME and ADMIN_PASSWORD that you have previously added at STEP 13 then click Log In. Follow the instructions in the image below.
STEP 18
Click on the Admin Panel tab. Follow the instructions in the image below.
STEP 19
Check Force HTTPS then scroll down the page until you find the Save Changes button. Click on it to save the change. Follow the instructions in the image below.
STEP 20
Your Support Center Helpdesk will be available at https://osticket.yourname.synology.me and your admin page will be available at https://osticket.yourname.synology.me/scp/login.php
Enjoy osTicket!
If you encounter issues by using this container, make sure to check out the Common Docker issues article.
Note: Can I run Docker on my Synology NAS? See the supported models.
Note: How to Back Up Docker Containers on your Synology NAS.
Note: Find out how to update the osTicket container with the latest image.
Note: How to Free Disk Space on Your NAS if You Run Docker.
Note: How to Schedule Start & Stop For Docker Containers.
Note: How to Activate Email Notifications.
Note: How to Add Access Control Profile on Your NAS.
Note: How to Change Docker Containers Restart Policy.
Note: How to Use Docker Containers With VPN.
Note: Convert Docker Run Into Docker Compose.
Note: How to Clean Docker.
Note: How to Clean Docker Automatically.
Note: Best Practices When Using Docker and DDNS.
Note: Some Docker Containers Need WebSocket.
Note: Find out the Best NAS Models For Docker.
Note: Activate Gmail SMTP For Docker Containers.
This post was updated on Sunday / February 25th, 2024 at 10:46 PM