Welcome to Zammad’s documentation!

The Zammad documentation consists of three parts:

• Zammad system installation and configuration (this documentation)
• Zammad administration (https://admin-docs.zammad.org)
• Zammad user documentation (https://user-docs.zammad.org)

This system documentation for Zammad is organized into a couple of sections:

• About
• Prerequisites
• Installation & Update
• Getting started
• Migration
• Administration via console
• Contributing / Development
• REST API
• Appendix

About

• Zammad

Prerequisites

• Software
  • 1. Ruby Programming Language
  • 2. Database Server
  • 3. Reverse Proxy
  • 4. Elasticsearch
• Hardware
  • For Zammad and a database server like PostgreSQL we recommend at least:
  • For optimal performance up to 40 agents:

Installation & Update

• Install from source (generic)
  • Setup Elasticsearch
  • For PostgreSQL (note, the option says “without … mysql”)
  • For MySQL (note, the option says “without … postgres”)
  • Starting all servers manually
  • Starting servers with Systemd
  • Reset a Zammad installation (for a fresh start after testing)
• Install from source (Debian 7, 8 / Ubuntu 16.04 / Ubuntu 18.04)
  • Prerequisites
  • Add User
  • Create MySQL user zammad (for Debian: upgrade MySQL to v5.6+ before, see: http://dev.mysql.com/downloads/repo/apt/)
  • Get Zammad
  • Install environnment
  • Install Zammad
  • Start Zammad
  • Create Nginx Config & restart Nginx
  • Go to http://localhost and you’ll see:
• Install from source (Mac OS 10.8)
• Install on CentOS via RPM
  • Prerequisites
  • Add Zammad-Repo and Install Zammad
  • Go to http://localhost and you’ll see:
  • You can manage the Zammad services manually:
• Install on Debian via DEB
  • Prerequisites
  • Add Zammad DEB repo and install
  • Go to http://localhost and you’ll see:
  • Change your webserver configuration (non localhost connections):
  • You can manage the Zammad services manually:
• Install on Ubuntu via DEB
  • Prerequisites
  • Add Zammad DEB Repo
  • Go to http://localhost and you’ll see:
  • Change your webserver configuration (non localhost connections):
  • You can manage the Zammad services manually:
• Install on SUSE via RPM
  • Install dependencies
  • Add Zammad RPM repo and install
  • Go to http://localhost and you’ll see:
  • Change your webserver configuration (non localhost connections):
  • You can manage the Zammad services manually:
• Set up Elasticsearch
• Install Elasticsearch and its Attachment plugin
  • Generic install Elasticsearch 2.4 (mapper-attachments):
  • Generic install Elasticsearch 5.0-5.5 (mapper-attachments):
  • Generic install Elasticsearch 5.6 (ingest-attachment):
  • CentOS 7:
  • Debian 8:
  • Debian 9:
  • Ubuntu 16.04 & 18.04:
• Configure Zammad to work with Elasticsearch
• Create Elasticsearch index
• Optional settings
• Using Elasticsearch on another server
• List of values which are stored in ElasticSearch
  • Ticket
  • Article
  • User
• Install with Docker-Compose
  • Install Docker Environment
  • Getting started with zammad-docker-compose
  • Go to http://localhost and you’ll see:
  • Maintenance
• Install on Kubernetes via Helm
  • Add Helm repo
  • Install / Upgrade Zammad
• Updating Zammad
  • Source update
  • Update with RPM
  • Update with DEB

Getting started

• First steps

Migration

• from OTRS
  • Install plugins on OTRS
  • Import via Browser
  • Import via command line
  • Importing a diff
  • Restarting from scratch
• from Zendesk

Administration via webfrontend

• Admin-Documentation

Administration via console

• Console
  • Start Zammad’s Rails console
  • Example commands

Contributing / Development

• Start
  • Source Code
  • Documentation
• Branches
  • Master
  • Develop
  • Stable
  • Stable-X.x
• Packages
• Continuous integration
  • Internal
  • External
• Code quality
  • Rubocop
  • Codeclimate
• Install with Docker
  • Run the Docker Container
  • Go to http://localhost and you’ll see:
• Install with Vagrant
  • Clone the Vagrant file
  • Run Vagrant
  • Go to http://localhost:8080 and you’ll see:
  • SSH into the machine
  • Problems starting the VM?

REST API

• Introduction
  • The API
  • Authentication
  • Request Format
  • Example CURL Requests
  • Example CURL Requests (for tickets and users)
  • Example CURL Request on behalf of a different user
  • Response Format
  • Response Format (expanded)
  • Pagination
  • API clients
• User
  • me - current user
  • List
  • Search
  • Show
  • Create
  • Update
  • Delete
• Organization
  • List
  • Search
  • Show
  • Create
  • Update
  • Delete
• Group
  • List
  • Show
  • Create
  • Update
  • Delete
• Ticket
  • List
  • Search
  • Show
  • Create
  • Update
  • Delete
• Ticket State
  • List
  • Show
  • Create
  • Update
  • Delete
• Ticket Priority
  • List
  • Show
  • Create
  • Update
  • Delete
• Ticket Article
  • By Ticket
  • Show
  • Create
• Online Notification
  • List
  • Show
  • Update
  • Delete
  • Mark all as read
• Object
  • List
  • Show
  • Create
  • Update
  • Execute Database Migrations
• Tags
  • List
  • Search
  • Add
  • Remove
  • Admin - List
  • Admin - Create
  • Admin - Rename
  • Admin - Delete
• User Access Token
  • List
  • Create
  • Delete

CTI API

• Introduction
  • Feature list
• Push API
  • How it works
  • Endpoint
  • Events

Appendix

• Backup and Restore
  • Configuration
  • Create Backup
  • Migrating from another Zammad-Host
  • Restore everything
  • What to do after restoration has been completed
• Configure environment variables
  • Configure IP
  • Configure ports
  • Application Servers
  • Configure Restart Command
• Package Repo Files
  • CentOS 7
  • Debian 8
  • Debian 9
  • Ubuntu 16.04
  • Ubuntu 18.04
  • SLES 12
  • Note
• Privacy
  • What information is stored exactly on images.zammad.com, and for how long?
  • Which other parts of the system do send data?