Ansible Role: Zammad

:warning: This project is no longer active! :warning:

This role has been moved to our hifis.toolkit collection:

• https://github.com/hifis-net/ansible-collection-toolkit
• https://galaxy.ansible.com/ui/repo/published/hifis/toolkit/

This Ansible Role installs and sets up the web-based open source user support/ticketing solution Zammad.

Note: This role does not install Elasticsearch and PostgreSQL server. See Dependencies.

Requirements

The following requirements are needed on the target machine:

• cryptography version >= 1.6.0

Role Variables

zammad_version: "6.2.0"

This sets the version of Zammad to be installed.

zammad_release_channel: "stable"

Choose a different release channel for the Zammad packages. Check https://packager.io/gh/zammad/zammad for a full list.

zammad_domain_name: "{{ ansible_fqdn }}"

This is the fully qualified domain name for Zammad.

zammad_nginx_config_path: "/etc/nginx/sites-available/zammad.conf"

Path to Zammad's Nginx configuration file.

zammad_ssl_cert_path: "/etc/ssl/certs/zammad_cert.pem"

Path to the SSL/TLS certificate for HTTPS.

zammad_ssl_key_path: "/etc/ssl/private/zammad_key.pem"

Path to the SSL/TLS private key for HTTPS.

zammad_ssl_cert:

Content of the SSL/TLS certificate (required).

zammad_ssl_key:

Content of the SSL/TLS private key (required).
Important: If you have already set up an SSL key pair on the host (e.g., via Let's Encrypt), do not configure zammad_ssl_cert and zammad_ssl_key. The role will check if the specified SSL files are valid.

zammad_nginx_server_tokens: "off"

Turn on or off showing the Nginx version in error pages or response headers. See the Nginx documentation for more info.

zammad_nginx_additional_server_configs:
  - |
      server {
        listen 80;
        server_name zammad.example.com zammad-old.example.com;
        return 301 https://zammad.example.com$request_uri;
      }
  - |
      server {
        listen 443 ssl;

        # ... SSL configuration

        server_name zammad-old.example.com;
        return 301 https://zammad.example.com$request_uri;
      }

Add additional settings to the Nginx configuration. This lets you set up custom adjustments, like handling multiple domains or redirecting old domains to the new one.

elasticsearch_url: "http://localhost:9200"

Address of the Elasticsearch server.

Dependencies

Zammad needs Elasticsearch and PostgreSQL database server. This role has been tested with the following roles:

• Elasticsearch - geerlingguy.elasticsearch
• PostgreSQL - geerlingguy.postgresql

Example Playbook

    - hosts: servers
      roles:
         - role: hifis.zammad
           become: yes

License

MIT

Author Information

This role was created in 2020 by HIFIS Software Services.