capeit/kix repository overview

⁠What is KIX ?

KIX is a web-based open source servicedesk. The software is a fork of OTRS 5 created in 2015. The first release was in early 2016. KIX supports your organization in managing and organizing your IT service, technical service, maintenance and repair and customer service.

⁠Supported tags

• latest

• 17

• 17.1

• 17.1.0

• 17.2

• 17.2.0

• 17.3

• 17.3.0

• 17.3.1

• 17.3.2

• 17.3.3

• 17.4

• 17.4.0

• 17.5

• 17.5.0

⁠Quick Reference

Where to get help the KIX community forum⁠

Where to file issues At the moment, please write an email to [email protected]⁠

Maintained by c.a.p.e. IT GmbH

⁠Requirements

The application stores its data into a database. You either need a MySQL-based (i.e. MySQL itself, MariaDB, Percona) or a PostgreSQL database server to run KIX. The database has to be persistent.

⁠Start the KIX container

To start the KIX container you have to provide an empty database with a user who has DDL and DML permission.

The following environment variables have to be set during startup:

KIXDB_DBMS
Depending on the DBMS you are using for KIX, you have to set this to mysql or postgresql

KIXDB_DATABASE This is the name of the database.

KIXDB_HOST
This is the host (or container link) of the database server.

KIXDB_USER
The name of the database user.

KIXDB_PASSWORD
The password for the database user.

The following environment variables are optional during startup:

KIX_PUBLIC_FQDN
The FQDN that should be used in external communication. If omitted, the FQDN will be automatically created using the hostname and domainname of the container.

To start KIX, simply use a run command like in the following example. In this example KIX will be used with a PostgreSQL database server running in another container named "postgres". This container will be linked to the host "dbhost" in the KIX container. The database in this example is named "kix" and the database user is named identically. The password of the database user is "mypass" This example also binds the exposed port 8080 to the host.

$ docker run -it --user 10001001 --link postgres:dbhost --name KIX -p 0.0.0.0:8080:8080 -e KIXDB_DBMS=postgresql -e KIXDB_DATABASE=kix -e KIXDB_HOST=dbhost -e KIXDB_USER=kix -e KIXDB_PASSWORD=mypass -d kix:17

It's recommended to start the container with some anonymous UserID like the one used in the example above.

⁠Usage

** Service Agent Interface ** To access the service agent interface in our example above, you have to use the following URL: http://<docker host>:8080/kix/index.pl

The initial admin user is root@localhost with the password root.

** Customer Self Service Portal ** To access the customers self service portal, use the following URL: http://<docker host>:8080/kix/customer.pl

Initially no users exist that are able to login to the customer portal. Service Agents cannot. So the admin has to create customers and customer contacts.

** Public FAQ Frontend ** To access the public FAQ portal, use the following URL: http://<docker host>:8080/kix/public.pl

⁠Limitations

At the moment this image only supports the community version of KIX. KIX Professional and the corresponding maintenance modules are not supported at the moment.