Publish your own library of FAQs, how-tos, internal SOPs and more with the knowledge base.
See a live demo at https://support.zammad.com/help.
This document describes how to ⚙ configure the knowledge base.
For details on how to
By default, only admin users are permitted to create, edit, and manage knowledge base articles. See :doc:`Roles </manage-roles>` for details on how to grant write access to agents or other users.
The knowledge base will not appear in the main menu until it has been enabled in the admin panel.
🌍Multi-language support 🙈Visibility settings (draft, staff-only, or public) 🔍Full text search 📅Scheduled publishing 📎File attachments 🔗Wiki-style internal linking to both 💡KB answers and 📋tickets 🖼️Rich text editor + embedded images
To enable the knowledge base, first select the languages/locales you wish to publish in:
Read on for details about each section of the knowledge base configuration.
|Icon & Link Color:||
Applies to all category & article entries in knowledge base menus, as well as hyperlinks in articles.
Applies to the area surrounding the search bar.
Defines the selection of icons that may be used when creating/editing categories.
Each category in the knowledge base must be given an icon. Icons appear prominently in the main menu, like so:
The knowledge base will automatically display the language matching each visitor’s locale. Visitors may always manually switch to another language via a dropdown menu in the footer.
The default locale is displayed when the visitor’s locale is not supported.
Articles that have not yet been translated into a given language will be hidden from that locale.
Target let's you decide if you want the link to be opened within a new
browser tab upon click or not.
Use this section to unify the knowledge base with your own website’s main navigation. Entries added here will appear in the knowledge base like so:
This feature is only available on self-hosted instances.
By default, the knowledge base will appear
at the same domain as your Zammad instance, under
If you wish to customize where it can be accessed, enter your desired URL here and configure your web server as described (instructions provided for Apache and NGINX only).
Use this panel to delete the knowledge base. If you wish to unpublish it without deleting all its content, simply disable it via the toggle button at the top of the window instead.