Zammad System Documentation Logo

About

  • Zammad

Prerequisites

  • Software
  • Hardware

Installation & Update

  • Install with Package Manager
  • Install with Docker
  • Install on Kubernetes
  • Install from Source
  • Elasticsearch
  • Updating Zammad
  • Host Upgrade and Repository Migration

Getting started

  • Configure the Webserver
  • First Steps

Migration

  • Migrating to Zammad

Administration via ...

  • Web-UI (admin documentation)
  • Console

Contributing / Development

  • Start

REST API

  • Introduction
  • Calendar
  • Checklist Endpoints
  • Generic CTI
  • Group
  • Knowledge Base
  • Online Notification
  • Object
  • Organization
  • Roles
  • Service-Level Agreements (SLA)
  • Ticket Endpoints
  • User
  • User Access Token

Appendix

  • Backup & Restore (Package)
  • Backup & Restore (Docker)
  • Environment Variables
  • Configure Database Server
  • Migrate to PostgreSQL Server
  • Privacy & Data Retention
  • Proxy and Connections
  • Single Sign-On for Kerberos
  • Reporting Tools (Third party)
  • Redis Variables
  • Custom Knowledge Base URL with NPM
Zammad System Documentation
  • Search

© Copyright 2026, Zammad.

Built with Sphinx using a theme provided by Read the Docs.