Zammad System Documentation

Hint

You are currently reading the Zammad system documentation. There are also administrator and user manuals available.

About

• Zammad
  • The Software
  • The Company - Zammad GmbH

Prerequisites

• Software
  • 1. Client Requirements
  • 2. Server Requirements
• Hardware
  • Minimum Setup
  • Example Setup
  • Performance Tuning

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
  • Get a SSL Certificate (recommended)
  • Adjusting the Webserver Configuration
• First Steps
  • Getting Started Wizard
  • Further Steps

Migration

• Migrating to Zammad

Administration via ...

• Web-UI (admin documentation)
• Console
  • Start Zammad’s Rails Console
  • Working on the console

Contributing / Development

• Start
  • Zammad Source Code
  • Documentation
  • Translation

REST API

• Introduction
  • API Clients
  • Authentication
  • Endpoints and Example Data
  • Content Type
  • Response Payloads (Expand)
  • Pagination
  • Search via API
  • Sorting Search Results
  • Actions On Behalf of Other Users
  • Encoding
• Calendar
  • List
  • Show
  • Create
  • Update
  • Delete
• Checklist Endpoints
  • Checklists
  • Checklist Items
  • Checklist Templates
  • List
• Generic CTI
• Group
  • List
  • Show
  • Create
  • Update
  • Delete
• Knowledge Base
  • Answers
  • Categories
  • Knowledge Base Overview
  • Show Knowledge Base
  • Change Knowledge Base Settings
  • Show Permissions
  • Change Permissions
  • Reorder Sub-Categories
  • Reorder Root Categories
• Online Notification
  • List
  • Show
  • Update
  • Delete
  • Mark All as Read
• Object
  • List
  • Show
  • Create
  • Update
  • Delete
  • Execute Database Migrations
• Organization
  • List
  • Show
  • Create
  • Update
  • Delete
• Roles
  • List
  • Show
  • Create
  • Update
• Service-Level Agreements (SLA)
  • List
  • Show
  • Create
  • Update
  • Delete
• Ticket Endpoints
  • Articles
  • Linking Tickets
  • Mentions
  • Priorities
  • Shared Drafts
  • States
  • Tags
  • Tickets
  • Ticket Summary
  • Time Accounting
• User
  • Me - Current User
  • List
  • Show
  • Create
  • Update
  • Delete
• User Access Token
  • List
  • Create
  • Delete

Appendix

• Backup & Restore (Package)
  • Getting Started
  • Limitations
• Backup & Restore (Docker)
  • Backup
  • Restore
• Environment Variables
  • Miscellaneous
  • Zammad
  • Elasticsearch
  • PostgreSQL
  • Nginx
  • Performance Tuning
  • HTTP Client Settings
  • How to Set Environment Variables
• Configure Database Server
• Migrate to PostgreSQL Server
  • Preparation
  • Migrate
  • Finishing
• Privacy & Data Retention
  • On-Premises Data
  • External Services
• Proxy and Connections
  • Proxy
  • External Connections
• Single Sign-On for Kerberos
  • Conceptual Overview
  • How Does it Work?
  • 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
• Redis Variables
  • Standard Setup
  • Sentinel Setup
• Custom Knowledge Base URL with NPM
  • Configure Zammad
  • Configure NPM
• Custom CSS for Public Knowledge Base