soldin/docker-osticket repository overview

⁠docker-osticket

⁠Introduction

Docker image for running version 1.10 of OSTicket⁠.

This image has been created from the original docker-osticket image by Petter A. Helset⁠.

It has a few modifications:

• Ubuntu Trusty Base OS
• Now designed to work with a linked MySQL⁠ docker container.
• Automates configuration file & database installation

The setup/ directory has been renamed as setup_hidden/ and the file system permissions deny nginx access to this location. It was not removed as the setup files are required as part of the automatic configuration during container start.

⁠Quick Start

Ensure you have a MySQL container running that OSTicket can use to store its data.

docker run --name osticket_mysql -d -e MYSQL_ROOT_PASSWORD=secret -e MYSQL_USER=osticket -e MYSQL_PASSWORD=secret -e MYSQL_DATABASE=osticket mariadb

Now run this image and link the MySQL container.

docker run --name osticket -d --link osticket_mysql:mysql -p 8080:80 soldin/osticket

Wait for the installation to complete then browse to your OSTicket staff control panel at http://localhost:8080/scp/. Login with default admin user & password:

• username: ostadmin
• password: Admin1

Now configure as required. If you are intending on using this image in production, please make sure you change the passwords above and read the rest of this documentation!

Note: OSTicket automatically redirects http://localhost:8080/scp to http://localhost/scp/. Either serve this on port 80 or don't omit the trailing slash after scp/!

⁠MySQL connection

The recommended connection method is to link your MySQL container to this image with the alias name mysql. However, if you are using an external MySQL server then you can specify the connection details using environmental variables.

OSTicket requires that the MySQL connection specifies a user with full permissions to the specified database. This is required for the automatic database installation.

The OSTicket configuration file is re-created from the template every time the container is started. This ensures the MySQL connection details are always kept up to date automatically in case of any changes.

⁠Linked container Settings

There are no mandatory settings required when you link your MySQL container with the alias mysql as per the quick start example.

⁠External MySQL connection settings

The following environmental variables should be set when connecting to an external MySQL server.

MYSQL_HOST

The host name or IP address of the MySQL host to connect to. This is not required when you link a container with the alias mysql. This must be provided if not using a linked container.

MYSQL_PASSWORD

The password for the specified user used when connecting to the MySQL server. By default will use the environmental variable MYSQL_PASSWORD from the linked MySQL container if this is not explicitly specified. This must be provided if not using a linked container.

MYSQL_PREFIX

The table prefix for this installation. Unlikely you will need to change this as customisable table prefixes are designed for shared hosting with only a single MySQL database available. Defaults to 'ost_'.

MYSQL_DATABASE

The name of the database to connect to. Defaults to 'osticket'.

MYSQL_USER

The user name to use when connecting to the MySQL server. Defaults to 'osticket'.

⁠IMAP/POP3 Settings

CRON_INTERVAL

Specifies how often (in minutes) that OSTicket cron script should be ran to check for incoming emails. Defaults to 5 minutes. Set to 0 to disable running of cron script. Note that this works in conjuction with the email check interval specified in the admin control panel, you need to specify both to the value you'd like!

⁠Volumes

/var/www/html

⁠Environmental Variables

INSTALL_SECRET

Secret string value for OST installation. A random value is generated on start-up and persisted within the container if this is not provided.

If using in production you should specify this so that re-creating the container does not cause your installation secret to be lost!

INSTALL_CONFIG

If you require a configuration file for OSTicket with custom content then you should create one and mount it in your container as a volume. The placeholders for the MySQL connection must be retained as these will be populated automatically when the container starts. Set this environmental variable to the fully qualified file name of your custom configuration. If not specified, the default OSTicket sample configuration file is used.

INSTALL_EMAIL

Helpdesk email account. This is placed in the configuration file as well as the DB during installation. Defaults to '[email protected]⁠'

⁠Database Installation Only

The remaining environmental variables can be used as a convenience to provide defaults during the automated database installation but most of these settings can be changed through the admin panel if required. These are only used when creating the initial database.

INSTALL_NAME

The name of the helpdesk to create if installing. Defaults to "My Helpdesk".

ADMIN_FIRSTNAME

First name of automatically created administrative user. Defaults to 'Admin'.

ADMIN_LASTNAME

Last name of automatically created administrative user. Defaults to 'User'.

ADMIN_EMAIL

Email address of automatically created administrative user. Defaults to '[email protected]⁠'.

ADMIN_USERNAME

User name to use for automatically created administrative user. Defaults to 'ostadmin'.

ADMIN_PASSWORD

Password to use for automatically created administrative user. Defaults to 'Admin1'.

⁠Modifications

This image was put together relatively quickly and could probably be improved to meet other use cases.

Please feel free to open an issue if you have any changes you would like to see. All pull requests are also appreciated!

⁠License

This image and source code is made available under the MIT licence. See the LICENSE file for details.