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)

About

• Zammad

Prerequisites

• Software
  • 1. Ruby Programming Language
  • 2. Supported distributions
  • 3. Package Dependencies
  • 4. Database Server
  • 5. Node.js
  • 6. Reverse Proxy
  • 7. Elasticsearch (optional)
  • 8. Optional tools of improved caching and distribution
• Hardware
  • For Zammad and a database server like PostgreSQL we recommend at least:
  • For optimal performance up to 40 agents:
  • Performance Tuning

Installation & Update

• Install from package
• Install from source
• Set up Elasticsearch
• Install with Docker Compose
• Install on Kubernetes via Helm
• Installation on Univention Corporate Server via App Center
• Updating Zammad

Getting started

• Configure the webserver
  • Get a ssl certificate (recommended)
  • Adjusting the webserver configuration
• First steps
  • Getting Started Wizard
  • Further Steps

Migration

• Migrating to Zammad

Administration via ...

• Web-UI
• Console
  • Start Zammad’s Rails console
  • Working on the console

Contributing / Development

• Start
  • Source Code
  • Documentation
• Branches
  • Develop
  • Stable
  • Stable-X.x
• Packages
• Continuous integration
  • Internal
  • External
  • Local
• 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
  • API clients
  • Authentication
  • Endpoints and example data
  • Content Type
  • Response Payloads (expand)
  • Pagination
  • Sorting search results
  • Actions on behalf of other users
  • Encoding
• User
  • me - current user
  • List
  • Search
  • Show
  • Create
  • Update
  • Delete
• Organization
  • List
  • Search
  • Show
  • Create
  • Update
  • Delete
• Group
  • List
  • Show
  • Create
  • Update
  • Delete
• Calendar
  • List
  • Show
  • Create
  • Update
  • Delete
• Service-Level Agreements (SLA)
  • List
  • Show
  • Create
  • Update
  • Delete
• Ticket endpoints
  • Tickets
  • Articles
  • Priorities
  • States
  • Tags
  • Linking Tickets
  • Mentions
• Online Notification
  • List
  • Show
  • Update
  • Delete
  • Mark all as read
• Object
  • List
  • Show
  • Create
  • Update
  • Delete
  • Execute Database Migrations
• 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
• Configuration via Environment Variables
  • General Options
  • 🖧 Network Options
  • 🎛️ Performance Tuning
• Configure Database server
• Privacy & Data Retention
  • On-Premises Data
  • External Services
• Single Sign-On for Kerberos
  • Conceptual Overview
  • Getting Started
  • Step 1: Configure Active Directory
  • Step 2: Remove NGINX, Set up Apache + Kerberos
  • Step 3: Enable SSO in Zammad
  • Step 4: Configure Client System (Windows Only)
  • Troubleshooting
• Reporting Tools (Third party)
  • Getting Started
  • Third Party Reporting Tools known to be working