github.com/tiredofit/docker-osticket
About
This will build a Docker Image for OSTicket - An open source helpdesk / ticketing system.
- Automatically installs and sets up installation upon first start
Maintainer
Table of Contents
- About
- Maintainer
- Table of Contents
- Prerequisites and Assumptions
- Installation
- Configuration
- Maintenance
- Support
- License
- References
Prerequisites and Assumptions
- Assumes you are using some sort of SSL terminating reverse proxy such as:
- Requires access to a MySQL/MariaDB Server
Installation
Build from Source
Clone this repository and build the image with docker build -t (imagename) .
Prebuilt Images
Builds of the image are available on Docker Hub
docker pull docker.io/tiredofit/osticket:(imagetag)Builds of the image are also available on the Github Container Registry
docker pull ghcr.io/tiredofit/docker-osticket:(imagetag)The following image tags are available along with their tagged release based on what's written in the Changelog:
| Container OS | Tag |
|---|---|
| Debian | :latest |
Configuration
Quick Start
-
The quickest way to get started is using docker-compose. See the examples folder for a working docker-compose.yml that can be modified for development or production use.
-
Set various environment variables to understand the capabilities of this image.
-
Map persistent storage for access to configuration and data files for backup.
-
Make networking ports available for public access if necessary
The first boot can take from 2 minutes - 5 minutes depending on your CPU to setup the proper schemas.
- Login to the web server and enter in your admin email address, admin password and start configuring the system!
Persistent Storage
The following directories are used for configuration and can be mapped for persistent storage.
| Directory | Description |
|---|---|
/www/osticket |
(Not needed as we want to keep base clean, move to a custom/assets approach) Root Directory |
/www/logs |
Nginx and php-fpm logfiles |
Environment Variables
Base Images used
This image relies on an Alpine Linux or Debian Linux base image that relies on an init system for added capabilities. Outgoing SMTP capabilities are handlded via msmtp. Individual container performance monitoring is performed by zabbix-agent. Additional tools include: bash,curl,less,logrotate,nano.
Be sure to view the following repositories to understand all the customizable options:
| Image | Description |
|---|---|
| OS Base | Customized Image based on Debian Linux |
| Nginx | Nginx webserver |
| PHP-FPM | PHP Interpreter |
| Parameter | Description | default |
|---|---|---|
INSTALL_SECRET |
A Large and Random Installation String (Auto Generates on Install if empty) | |
INSTALL_EMAIL |
Installer Email (Use different email then ADMIN_EMAIL) | helpdesk@example.com |
INSTALL_NAME |
Site Name | My Helpdesk |
ADMIN_FIRSTNAME |
First name of Admin User | |
ADMIN_LASTNAME |
Last name of Admin User | |
ADMIN_EMAIL |
Admin Email address (Make sure it is different than INSTALL_EMAIL) | |
ADMIN_USER |
Admin Username Must be more than 5 characters | |
ADMIN_PASS |
Admin Password | |
CRON_INTERVAL |
Amount of time in Minutes to Check Incoming Mail | 10 |
DB_HOST |
Host or container name of MariaDB Server e.g. osticket-db |
|
DB_PORT |
MariaDB Port | 3306 |
DB_NAME |
MariaDB Database name e.g. osticket |
|
DB_USER |
MariaDB Username for above Database e.g. osticket |
|
DB_PASS |
MariaDB Password for above Database e.g. password |
|
DB_PREFIX |
Prefix for Tables | ost_ |
SMTP_HOST |
SMTP Host | postfix |
SMTP_PORT |
SMTP Host Port | 25 |
SMTP_FROM |
SMTP From Address | osticket@hostname.com |
SMTP_TLS |
Should TLS be used (0=no 1=yes) |
1 |
SMTP_USER |
SMTP Authentication user | |
SMTP_PASS |
SMTP Authentication password |
Networking
The following ports are exposed.
| Port | Description |
|---|---|
80 |
HTTP |
Maintenance
Shell Access
For debugging and maintenance purposes you may want access the containers shell.
bash docker exec -it (whatever your container name is) bash
Support
These images were built to serve a specific need in a production environment and gradually have had more functionality added based on requests from the community.
Usage
- The Discussions board is a great place for working with the community on tips and tricks of using this image.
- Consider sponsoring me for personalized support
Bugfixes
- Please, submit a Bug Report if something isn't working as expected. I'll do my best to issue a fix in short order.
Feature Requests
- Feel free to submit a feature request, however there is no guarantee that it will be added, or at what timeline.
- Consider sponsoring me regarding development of features.
Updates
- Best effort to track upstream changes, More priority if I am actively using the image in a production environment.
- Consider sponsoring me for up to date releases.
License
MIT. See LICENSE for more details.