Zammad#

Zammad Zammad is a web-based, open source user support/ticketing solution.

amd64
arm64
armv7

Information#

Docker Image: !!! LINK TO DOCKER IMAGE/ DOCKER HUB !!!
Current Image Version: 3.4.0-17

Requirements Hardware#

For Zammad and a database server like PostgreSQL we recommend at least:#
  • 2 CPU cores
  • 4 GB of RAM (+4 GB if you want to run Elasticsearch on the same server)
For optimal performance up to 40 agents:#
  • 4 CPU cores
  • 6 GB of RAM (+6 GB if you want to run Elasticsearch on the same server)

Of course at the end it depends on acutal load of concurent agents and data traffic.

SETUP#

Enabling zammad#

Command:#

vlab set zammad.enable True

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

zammad
enable: True

Finalising changes:#

run: vlab update_one service=zammad

FIRST RUN#

!!! DEVELOPERS: make sure that you include any information that the user requires to get started, below. !!!
!!! Below are some examples with headings, and with some example instructions !!!

ADMINISTRATOR SETUP#

Navigate to https://False/admin

Create an account with your desired username; as this is the first user, zammad makes this account the administrator.

SMTP/ MAIL#

  1. run vlab decrypt to decrypt the vault.yml file
  2. make some changes

SMTP Settings#

smtp:
host:
port:
user:
pass:
from_email:
from_name:
  1. run vlab update_one service=zammad to complete the changes

ACCESS#

zammad (HTTPS) link: https://zammad.vivumlab.xyz/ zammad (HTTP) link: http://zammad.vivumlab.xyz/

OPTIONS#

HTTPS_ONLY#

Default: False
Options: True/False

Command:#

vlab set zammad.https_only True

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

zammad
https_only: True
Finalising changes:#

run: vlab update_one service=zammad

AUTH#

Default: False
Options: True/False

Command:#

vlab set zammad.auth True

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

zammad
auth: True
Finalising changes:#

run: vlab update_one service=zammad

DOMAIN#

Default: False
NOTE: include the sitename and top level domain suffix. eg. name.com, site.net

Command:#

vlab set zammad.domain zammad.com

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

zammad
domain: zammad.com
Finalising changes:#

run: vlab update_one service=zammad

SUBDOMAIN#

Default: zammad
NOTE: Periods/ delimiters are not required. eg. 'media' will set the full URL as 'media.vivumlab.xyz'

Command:#

vlab set zammad.subdomain media

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

zammad
subdomain: media
Finalising changes:#

run: vlab update_one service=zammad

VERSION#

Default: 3.4.0-17
NOTE: Ensure that the version exists

Command:#

vlab set zammad.version 2.7

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

zammad
version: 2.7
Finalising changes:#

run: vlab update_one service=zammad

Need more help?#

Further information regarding services can be found.
General Information can be found in the documentation.
Additional assistance can be found on our Contact Us page.