From b39e9ba6917983f1bb7250c5ebf587b17932f715 Mon Sep 17 00:00:00 2001 From: ralf401 Date: Thu, 15 Aug 2024 16:22:35 +0200 Subject: [PATCH] Fixes #511 - Unified header structure across the repo --- about/zammad.rst | 9 +- admin/console.rst | 16 ++-- admin/console/dangerzone-for-experts.rst | 16 ++-- admin/console/hidden-settings.rst | 22 ++--- admin/console/other-useful-commands.rst | 8 +- admin/console/working-on-chat.rst | 4 +- admin/console/working-on-groups.rst | 4 +- admin/console/working-on-ticket-articles.rst | 6 +- admin/console/working-on-tickets.rst | 12 +-- admin/console/working-on-users.rst | 20 ++--- admin/console/zammad-settings.rst | 14 +-- api/calendar.rst | 12 +-- api/generic-cti/answer-event.rst | 6 +- api/generic-cti/hangup-event.rst | 2 +- api/generic-cti/index.rst | 2 +- api/generic-cti/newcall-event.rst | 11 ++- api/group.rst | 12 +-- api/intro.rst | 26 +++--- api/notification.rst | 14 +-- api/object.rst | 14 +-- api/organization.rst | 14 +-- api/role.rst | 10 +-- api/sla.rst | 12 +-- api/ticket/articles.rst | 16 ++-- api/ticket/index.rst | 14 +-- api/ticket/links.rst | 8 +- api/ticket/mentions.rst | 8 +- api/ticket/priorities.rst | 36 ++++---- api/ticket/shared_drafts.rst | 10 +-- api/ticket/states.rst | 12 +-- api/ticket/tags.rst | 26 +++--- api/ticket/timeaccounting.rst | 12 +-- api/user-access-token.rst | 8 +- api/user.rst | 18 ++-- appendix/backup-and-restore/index.rst | 12 +-- appendix/configure-database-server.rst | 4 +- appendix/configure-env-vars.rst | 10 +-- appendix/migrate-to-postgresql.rst | 24 +++--- appendix/privacy.rst | 6 +- appendix/reporting-tools-thirdparty.rst | 2 +- appendix/single-sign-on.rst | 14 +-- contributing/start.rst | 28 +++--- getting-started/configure-webserver.rst | 6 +- getting-started/first-steps.rst | 4 +- index.rst | 2 +- install/docker-compose.rst | 12 +-- install/elasticsearch.rst | 16 ++-- install/elasticsearch/indexed-attributes.rst | 20 ++--- install/elasticsearch/troubleshooting.rst | 6 +- install/includes/firewall-and-selinux.rst | 8 +- install/includes/manage-services.rst | 2 +- install/includes/next-steps.rst | 4 +- install/kubernetes.rst | 2 +- install/package.rst | 86 +++++++++++++++++-- install/source.rst | 40 ++++----- migration/freshdesk.rst | 14 +-- .../restarting-from-scratch.include.rst | 10 +-- migration/index.rst | 6 +- migration/kayako.rst | 14 +-- migration/otrs.rst | 20 ++--- migration/zendesk.rst | 14 +-- prerequisites/hardware.rst | 8 +- prerequisites/software.rst | 64 +++++++------- 63 files changed, 482 insertions(+), 410 deletions(-) diff --git a/about/zammad.rst b/about/zammad.rst index 5f88b6e7..5e79a0de 100644 --- a/about/zammad.rst +++ b/about/zammad.rst @@ -1,12 +1,15 @@ Zammad -****** +====== Do you receive many emails and want to answer them with a team of agents? You're going to love Zammad_! -Zammad is a web based open source helpdesk/customer support system with many features to manage customer communication via several channels like telephone, facebook, twitter, chat and emails. -It is distributed under version 3 of the GNU AFFERO General Public License (GNU AGPLv3). +Zammad is a web based open source helpdesk/customer support system with many +features to manage customer communication via several channels like telephone, +facebook, twitter, chat and emails. +It is distributed under version 3 of the GNU AFFERO General Public License +(GNU AGPLv3). The code is open source, and `available on GitHub`_! diff --git a/admin/console.rst b/admin/console.rst index ab526ca1..70b23748 100644 --- a/admin/console.rst +++ b/admin/console.rst @@ -1,5 +1,5 @@ Console -******* +======= Zammad uses Ruby on Rails so you can make use of the `rails console`_. @@ -14,11 +14,11 @@ Zammad uses Ruby on Rails so you can make use of the `rails console`_. To open the rails console on the shell you have to enter the following commands. -Start Zammad's Rails console -============================ +Start Zammad's Rails Console +---------------------------- -Running a single command ------------------------- +Running a Single Command +^^^^^^^^^^^^^^^^^^^^^^^^ The following command will allow you to run a single command, without running a shell (e.g. for automation). @@ -41,8 +41,8 @@ a shell (e.g. for automation). .. _rails_shell: -Running several commands in a shell ------------------------------------ +Running Several Commands in a Shell +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ The following command will provide you a rails console. It allows you to run several commands inside it. @@ -87,7 +87,7 @@ This reduces loading times greatly. 3.1.3 :001 > Working on the console -====================== +---------------------- Here's a topic list for quick jumping and better overview. diff --git a/admin/console/dangerzone-for-experts.rst b/admin/console/dangerzone-for-experts.rst index 32243698..c93771d2 100644 --- a/admin/console/dangerzone-for-experts.rst +++ b/admin/console/dangerzone-for-experts.rst @@ -1,5 +1,5 @@ -Deleting records -**************** +Deleting Records +================ .. danger:: @@ -9,7 +9,7 @@ Deleting records .. include:: /admin/console/missing-commands-ask-community.include.rst -Removing tickets (and their articles) +Removing Tickets (And Their Articles) ------------------------------------- .. code-block:: ruby @@ -24,7 +24,7 @@ Removing tickets (and their articles) >> tickets_to_keep = [1, 2, 3] >> Ticket.where.not(id: tickets_to_keep).destroy_all -Removing users +Removing Users -------------- .. warning:: @@ -62,7 +62,7 @@ Removing users is possible in 2 ways: A single user and in bulk. email: ['', ''] ).destroy_all -Removing organizations +Removing Organizations ---------------------- .. note:: Removing an organization does **not** delete associated customers. @@ -99,7 +99,7 @@ Step 3: Proceed with deletion org.destroy end -Removing system records +Removing System Records ----------------------- .. code-block:: ruby @@ -120,10 +120,10 @@ Removing system records .. _dangerzone_reset_zammad: -Reset Zammad installation +Reset Zammad Installation ------------------------- -.. hint:: +.. hint:: Below commands are incomplete intentionally, error outputs will hint you through! The following operations will cause data loss and are for diff --git a/admin/console/hidden-settings.rst b/admin/console/hidden-settings.rst index a8a5c132..e8ea8fc1 100644 --- a/admin/console/hidden-settings.rst +++ b/admin/console/hidden-settings.rst @@ -1,12 +1,12 @@ -Advanced customization settings -******************************* +Advanced Customization Settings +=============================== On this page you can find some settings that you won't find within the Zammad UI. Those settings might come in handy as it can change Zammad's behavior. .. include:: /admin/console/missing-commands-ask-community.include.rst -Send all outgoing E-Mails to a BCC-Mailbox +Send All Outgoing E-Mails to a BCC-Mailbox ------------------------------------------ This option allows you to send all outgoing E-Mails (not notifications) to a @@ -23,7 +23,7 @@ You can easily check the current BCC-Setting by running the following: >> Setting.get('system_bcc') -Activate counter on grouped overviews +Activate Counter on Grouped Overviews ------------------------------------- This is a hidden setting which you can only set via Command-Line. @@ -38,7 +38,7 @@ elements. .. image:: /images/console/ui_table_group_by_show_count-example.png -Default ticket type on creation +Default Ticket Type on Creation ------------------------------- Zammad allows you to define the default article type upon ticket creation. @@ -60,7 +60,7 @@ To check what setting is set currently, simply run: >> Setting.get('ui_ticket_create_default_type') -Adding a warning to the ticket creation process +Adding a Warning to the Ticket Creation Process ----------------------------------------------- If in case you need to give your agent a note or warning during ticket creation, @@ -97,7 +97,7 @@ Sample of the above setting: .. image:: /images/console/ui_ticket_create_notes.gif -Adding a warning to the article reply process +Adding a Warning to the Article Reply Process --------------------------------------------- In case you need to give your agent a warning during the ticket article reply, @@ -140,7 +140,7 @@ Sample of the above setting: .. image:: /images/console/ui_ticket_add_article_hint-example.gif -Show Email address of customer on customer selection (ticket creation) +Show Email Address of Customer on Customer Selection (Ticket Creation) ---------------------------------------------------------------------- By default Zammad will not display the E-Mail-Addresses of customers. @@ -156,8 +156,8 @@ Get the current state of this setting with: >> Setting.get('ui_user_organization_selector_with_email') -Change font settings for outgoing HTML mails --------------------------------------------- +Change Font Settings for Outgoing HTML Emails +--------------------------------------------- .. note:: @@ -177,7 +177,7 @@ If you want to check the current setting, you can simply run the below code. >> Setting.get('html_email_css_font') -Highlight customer's open ticket count +Highlight Customer's Open Ticket Count -------------------------------------- This option enhances the selected customer's open tickets count. It highlights diff --git a/admin/console/other-useful-commands.rst b/admin/console/other-useful-commands.rst index 92440563..cd598ddc 100644 --- a/admin/console/other-useful-commands.rst +++ b/admin/console/other-useful-commands.rst @@ -1,10 +1,10 @@ Other Useful Commands -********************* +===================== .. include:: /admin/console/missing-commands-ask-community.include.rst -Fetch Mails ------------ +Fetch Emails +------------ The below command will do a manual fetch of mail channels. This will also show errors that might appear within that process. @@ -85,7 +85,7 @@ for several languages. .. _Weblate: https://translations.zammad.org/ Translating Attributes -~~~~~~~~~~~~~~~~~~~~~~ +---------------------- By default Zammad will not translate custom attributes. With the following code you can enable translation. diff --git a/admin/console/working-on-chat.rst b/admin/console/working-on-chat.rst index 1f319c8c..a4242160 100644 --- a/admin/console/working-on-chat.rst +++ b/admin/console/working-on-chat.rst @@ -1,9 +1,9 @@ Working with chat logs -********************** +====================== .. include:: /admin/console/missing-commands-ask-community.include.rst -Removing IP address logs +Removing IP Address Logs ------------------------ Use the following command to remove all IP address records diff --git a/admin/console/working-on-groups.rst b/admin/console/working-on-groups.rst index b38b040f..a5e7bffc 100644 --- a/admin/console/working-on-groups.rst +++ b/admin/console/working-on-groups.rst @@ -1,9 +1,9 @@ Working with groups -******************* +=================== .. include:: /admin/console/missing-commands-ask-community.include.rst -Find group +Find Group ---------- .. code-block:: ruby diff --git a/admin/console/working-on-ticket-articles.rst b/admin/console/working-on-ticket-articles.rst index 37669b1c..f291e351 100644 --- a/admin/console/working-on-ticket-articles.rst +++ b/admin/console/working-on-ticket-articles.rst @@ -1,9 +1,9 @@ -Working with ticket articles -**************************** +Working with Ticket Articles +============================ .. include:: /admin/console/missing-commands-ask-community.include.rst -Count Public “Notes” toward SLAs +Count Public “Notes” Toward SLAs -------------------------------- Normally, :user-docs:`notes ` diff --git a/admin/console/working-on-tickets.rst b/admin/console/working-on-tickets.rst index 70e50134..6c6a30a9 100644 --- a/admin/console/working-on-tickets.rst +++ b/admin/console/working-on-tickets.rst @@ -1,10 +1,10 @@ -Working with ticket information -******************************* +Working with Ticket Information +=============================== .. include:: /admin/console/missing-commands-ask-community.include.rst -Get the RAW mail that Zammad fetched ------------------------------------- +Get the RAW Email That Zammad Fetched +------------------------------------- The following command will help you to check on received EML-files Zammad fetched. This comes in handy if you delete Mails upon fetching and you need to @@ -33,7 +33,7 @@ we get, we can then get the articles content. If you just use ``Ticket::Article.find(3)`` you can see further information (like who sent the mail, when we fetched it, ...). -Update all tickets of a specific customer +Update All Tickets of a Specific Customer ----------------------------------------- .. warning:: @@ -47,7 +47,7 @@ Update all tickets of a specific customer .. _state_types: -Get ticket state types +Get Ticket State Types ---------------------- .. Not removed because it is still referenced in API state creation. diff --git a/admin/console/working-on-users.rst b/admin/console/working-on-users.rst index 28414411..0877aa1b 100644 --- a/admin/console/working-on-users.rst +++ b/admin/console/working-on-users.rst @@ -1,9 +1,9 @@ -Working on user information -*************************** +Working on User Information +=========================== .. include:: /admin/console/missing-commands-ask-community.include.rst -Find user +Find User --------- In order to work on user information or to check for specific information, @@ -15,7 +15,7 @@ you'll need to find it first. >> User.find_by(email: 'your@email') # Searching for the user by his Email address >> User.find_by(login: 'john.doe') # Searching for the user by his login -Unlock a locked user account +Unlock a Locked User Account ---------------------------- .. tip:: @@ -45,7 +45,7 @@ logins) >> User.find(**USERID**).login_failed -Change / Update Email address of user +Change / Update Email Address of User ------------------------------------- If needed, you can simply change the Email address of the user. @@ -64,7 +64,7 @@ If needed, you can simply change the Email address of the user. You need to find the user ID of the user first for this. -Change / Update Login name of user +Change / Update Login Name of User ---------------------------------- Change the user name of the user (e.g. if you want to login with a shorter @@ -79,7 +79,7 @@ username instead of a mail address) You need to find the user ID of the user first for this. -Set admin rights for user +Set Admin Rights for User ------------------------- Don't have access to Zammad anymore? Grant yourself or another user @@ -91,7 +91,7 @@ administrative rights. >> u.roles = Role.where(name: ['Agent', 'Admin']) >> u.save! -Set password for user +Set Password for User --------------------- You or the user did forget his password? No problem! Simply reset it by hand @@ -100,8 +100,8 @@ if needed. .. code-block:: ruby >> User.find_by(email: 'you@example.com').update!(password: 'your_new_password') - -Remove password for user + +Remove Password for User ------------------------ If you added a second authentication method (e.g. LDAP) after launch, there diff --git a/admin/console/zammad-settings.rst b/admin/console/zammad-settings.rst index 5cb017b3..790cc1bc 100644 --- a/admin/console/zammad-settings.rst +++ b/admin/console/zammad-settings.rst @@ -1,9 +1,9 @@ -Query and set / update Zammad settings -************************************** +Query and Set / Update Zammad Settings +====================================== .. include:: /admin/console/missing-commands-ask-community.include.rst -ticket_hook setting +Ticket_hook Setting ------------------- This will give you the ticket hook that you'll find inside the ``[]`` in front @@ -14,7 +14,7 @@ this setting in a productive system. >> Setting.get('ticket_hook') -FQDN setting +FQDN Setting ------------ Get the current FQDN setting of Zammad and, if needed, adjust it. @@ -29,7 +29,7 @@ Get the current FQDN setting of Zammad and, if needed, adjust it. >> Setting.get('fqdn') # Get current FQDN >> Setting.set('fqdn', 'new.domain.tld') # Set a new FQDN -HTTP(s) setting +HTTP(s) Setting --------------- This setting indirectly belongs to your FQDN setting and is relevant for @@ -51,7 +51,7 @@ variable based URLs (e.g. in notifications) Zammad generated. >> Setting.get('http_type') # Get the current http type >> Setting.set('http_type', 'https') # Change the http type to HTTPs -Storage provider setting +Storage Provider Setting ------------------------ The storage provider setting is set to ``DB`` on default installations. @@ -96,7 +96,7 @@ to ensure that Zammad still can access Elasticsearch. >> Setting.set('es_attachment_max_size_in_mb', 50) # Limit the Attachment-Size to push to your elasticsearch index >> Setting.set('es_ssl_verify', 'false') # Turn SSL verification on or off -Enable proxy +Enable Proxy ------------ Zammad needs to use a proxy for network communication? Set it here. diff --git a/api/calendar.rst b/api/calendar.rst index feb8da6e..b634a412 100644 --- a/api/calendar.rst +++ b/api/calendar.rst @@ -1,12 +1,12 @@ Calendar -******** +======== .. note:: 🤓 Calendars belong to Zammads :doc:`SLA calculation `. List -==== +---- Required permission: ``admin.calendar`` @@ -110,7 +110,7 @@ Required permission: ``admin.calendar`` Show -==== +---- Required permission: ``admin.calendar`` @@ -211,7 +211,7 @@ Required permission: ``admin.calendar`` } Create -====== +------ Required permission: ``admin.calendar`` @@ -401,7 +401,7 @@ Response: Update -====== +------ Required permission: ``admin.calendar`` @@ -591,7 +591,7 @@ Response: Delete -====== +------ Required permission: ``admin.calendar`` diff --git a/api/generic-cti/answer-event.rst b/api/generic-cti/answer-event.rst index ff32d57e..e68df8ef 100644 --- a/api/generic-cti/answer-event.rst +++ b/api/generic-cti/answer-event.rst @@ -1,4 +1,4 @@ -Call answered +Call Answered ============= .. list-table:: Available attributes and sample data for answered events @@ -158,7 +158,7 @@ There's two options on how to ``POST`` the relevant data to Zammad. {} Sample curl command: - + .. code-block:: sh $ curl --request POST 'https://{FQDN-Zammad}/api/v1/cti/{instance specific token}' \ @@ -190,7 +190,7 @@ There's two options on how to ``POST`` the relevant data to Zammad. {} Sample curl command: - + .. code-block:: sh $ curl --request POST 'https://{FQDN-Zammad}/api/v1/cti/{instance specific token}' \ diff --git a/api/generic-cti/hangup-event.rst b/api/generic-cti/hangup-event.rst index ca403ffa..b3f013d0 100644 --- a/api/generic-cti/hangup-event.rst +++ b/api/generic-cti/hangup-event.rst @@ -1,4 +1,4 @@ -Call hangup +Call Hangup =========== .. list-table:: Available attributes and sample data for hangup events diff --git a/api/generic-cti/index.rst b/api/generic-cti/index.rst index 08331200..5c094659 100644 --- a/api/generic-cti/index.rst +++ b/api/generic-cti/index.rst @@ -1,5 +1,5 @@ Generic CTI -*********** +=========== This page describes the generic CTI API scopes and functionalities. diff --git a/api/generic-cti/newcall-event.rst b/api/generic-cti/newcall-event.rst index 12bcd12b..5c4ccada 100644 --- a/api/generic-cti/newcall-event.rst +++ b/api/generic-cti/newcall-event.rst @@ -1,6 +1,9 @@ -New call +New Call ======== +General +------- + .. list-table:: Available attributes and sample data for newCall events :widths: 20, 40, 40 :header-rows: 1 @@ -155,7 +158,7 @@ There's two options on how to ``POST`` the relevant data to Zammad. } Sample curl command: - + .. code-block:: sh $ curl --request POST 'https://{FQDN-Zammad}/api/v1/cti/{instance specific token}' \ @@ -186,7 +189,7 @@ There's two options on how to ``POST`` the relevant data to Zammad. {} Sample curl command: - + .. code-block:: sh $ curl --request POST 'https://{FQDN-Zammad}/api/v1/cti/{instance specific token}' \ @@ -198,7 +201,7 @@ There's two options on how to ``POST`` the relevant data to Zammad. --form 'user[]="Christopher Miller"' \ --form 'user[]="Emma Taylor"' -Situation specific responses +Situation Specific Responses ---------------------------- Depending on the chosen call direction, Zammad will return either a (optionally) diff --git a/api/group.rst b/api/group.rst index 20e46d92..c46e8efa 100644 --- a/api/group.rst +++ b/api/group.rst @@ -1,5 +1,5 @@ Group -***** +===== .. note:: @@ -10,7 +10,7 @@ Group Example: ``Sales::Europe::South`` List -==== +---- Required permission: ``admin.group`` @@ -88,7 +88,7 @@ Response: Show -==== +---- Required permission: ``admin.group`` @@ -123,7 +123,7 @@ Response: } Create -====== +------ Required permission: ``admin.group`` @@ -168,7 +168,7 @@ Response: Update -====== +------ Required permission: ``admin.group`` @@ -213,7 +213,7 @@ Response: Delete -====== +------ Required permission: ``admin.group`` diff --git a/api/intro.rst b/api/intro.rst index 64a30b28..ad59808c 100644 --- a/api/intro.rst +++ b/api/intro.rst @@ -1,5 +1,5 @@ Introduction -************ +============ Zammad provides a powerful REST-API which allows all operations that are available via UI as well. @@ -8,7 +8,7 @@ This page gives you a first impression for things that generally count for all endpoints and how to adapt. API clients -=========== +----------- There are API clients available. Please note that these clients may not provide access to all available @@ -27,7 +27,7 @@ endpoints listed here. Authentication -============== +-------------- Zammad supports three different authentication methods for its API. @@ -65,8 +65,8 @@ OAuth2 (token access) $ curl -H "Authorization: Bearer {your_token}" https://{fqdn}/{endpoint} -Endpoints and example data -========================== +Endpoints and Example Data +-------------------------- For simplicity we'll not provide specific commands on the next pages, but instead tell the possible call method (e.g. ``GET``) and the endpoint to use @@ -79,14 +79,14 @@ instance. Please keep in mind that you may see more fields or general information in case you added objects or other information. Content Type -============ +------------ Zammad returns JSON payloads whenever you retrieve data. If you're going to provide data, no matter of the general request type, don't forget to provide the content type ``application/json`` as well. -Response Payloads (expand) -========================== +Response Payloads (Expand) +-------------------------- Zammad always returns information including hints to all relations. If you need more information than that (because IDs may not be enough) you @@ -551,7 +551,7 @@ and user each. to learn more. Pagination -========== +---------- As Zammad limits the number of returned objects for performance reasons, you may have to use pagination at some points. @@ -572,8 +572,8 @@ more results. .. _sort_search_results: -Sorting search results -====================== +Sorting Search Results +---------------------- Zammad allows you to sort your search results by field if needed. @@ -592,8 +592,8 @@ order_by Usually you'll want to combine both parameters in your searches - e.g.: ``?query={search string}&sort_by={row name}&order_by={direction}`` -Actions on behalf of other users -================================ +Actions On Behalf of Other Users +-------------------------------- **Requirement:** the user used for running the query on behalf requires ``admin.user`` permission. diff --git a/api/notification.rst b/api/notification.rst index 0e95fcda..61acc753 100644 --- a/api/notification.rst +++ b/api/notification.rst @@ -1,5 +1,5 @@ Online Notification -******************* +=================== .. note:: @@ -9,7 +9,7 @@ Online Notification Please note that the best results are always achieved with *Agents*. List -==== +---- Required permission: ``any`` @@ -100,7 +100,7 @@ Response: Show -==== +---- Required permission: ``any`` @@ -127,7 +127,7 @@ Response: } Update -====== +------ Required permission: ``any`` @@ -160,7 +160,7 @@ Response: } Delete -====== +------ Required permission: ``any`` @@ -175,8 +175,8 @@ Response: {} -Mark all as read -================ +Mark All as Read +---------------- Required permission: ``any`` diff --git a/api/object.rst b/api/object.rst index 85ecede8..12b6dd8e 100644 --- a/api/object.rst +++ b/api/object.rst @@ -1,5 +1,5 @@ Object -****** +====== .. danger:: @@ -11,7 +11,7 @@ Object instead. For states and priorities use either API endpoints or rails console. List -==== +---- Required permission: ``admin.object`` @@ -422,7 +422,7 @@ Response: ] Show -==== +---- Required permission: ``admin.object`` @@ -496,7 +496,7 @@ Response: .. _create_object: Create -====== +------ Required permission: ``admin.object`` @@ -1521,7 +1521,7 @@ Required permission: ``admin.object`` } Update -====== +------ Required permission: ``admin.object`` @@ -1628,7 +1628,7 @@ Response: } Delete -====== +------ Required permission: ``admin.object`` @@ -1644,7 +1644,7 @@ Response: {} Execute Database Migrations -=========================== +--------------------------- Required permission: ``admin.object`` diff --git a/api/organization.rst b/api/organization.rst index 1f9bc5a0..b6299e98 100644 --- a/api/organization.rst +++ b/api/organization.rst @@ -1,8 +1,8 @@ Organization -************ +============ List -==== +---- Required permission: ``ticket.agent`` **or** ``admin.organization`` @@ -99,7 +99,7 @@ Response: ] Search -====== +------ Required permission: ``ticket.agent`` **or** ``admin.organization`` @@ -176,7 +176,7 @@ Response: ] Show -==== +---- Required permission: ``ticket.agent`` **or** ``admin.organization`` @@ -215,7 +215,7 @@ Response: } Create -====== +------ Required permission: ``admin.organization`` @@ -266,7 +266,7 @@ Response: } Update -====== +------ Required permission: ``admin.organization`` @@ -315,7 +315,7 @@ Response: } Delete -====== +------ Required permission: ``admin.organization`` diff --git a/api/role.rst b/api/role.rst index 777034f6..165e517e 100644 --- a/api/role.rst +++ b/api/role.rst @@ -1,8 +1,8 @@ Roles -***** +===== List -==== +---- Required permission: ``admin.role`` @@ -109,7 +109,7 @@ Response: ] Show -==== +---- Required permission: ``admin.role`` @@ -155,7 +155,7 @@ Response: } Create -====== +------ Required permission: ``admin.role`` @@ -220,7 +220,7 @@ Response: } Update -====== +------ Required permission: ``admin.role`` diff --git a/api/sla.rst b/api/sla.rst index e33780aa..7209025f 100644 --- a/api/sla.rst +++ b/api/sla.rst @@ -1,12 +1,12 @@ Service-Level Agreements (SLA) -****************************** +============================== .. note:: 🤓 SLAs depend on Zammads :doc:`Calendars `. List -==== +---- Required permission: ``admin.sla`` @@ -43,7 +43,7 @@ Response: Show -==== +---- Required permission: ``admin.sla`` @@ -77,7 +77,7 @@ Response: } Create -====== +------ Required permission: ``admin.sla`` @@ -129,7 +129,7 @@ Response: Update -====== +------ Required permission: ``admin.sla`` @@ -182,7 +182,7 @@ Response: Delete -====== +------ Required permission: ``admin.sla`` diff --git a/api/ticket/articles.rst b/api/ticket/articles.rst index 16d521fa..238ddfc0 100644 --- a/api/ticket/articles.rst +++ b/api/ticket/articles.rst @@ -1,7 +1,7 @@ Articles -******** +======== -General information about ticket articles +General Information About Ticket Articles ----------------------------------------- Some attributes of articles might not be straight forward or come with @@ -103,7 +103,7 @@ sender .. _retrieve_articles_attachments: List Articles by Ticket -======================= +----------------------- Required permission: ``ticket.agent`` **or** ``ticket.customer`` @@ -178,8 +178,8 @@ Response: } ] -List specific article -===================== +List Specific Article +--------------------- Required permission: ``ticket.agent`` **or** ``ticket.customer`` @@ -225,7 +225,7 @@ Response: Create -====== +------ Required permission: ``ticket.agent`` **or** ``ticket.customer`` @@ -438,8 +438,8 @@ Required permission: ``ticket.agent`` **or** ``ticket.customer`` "updated_by": "chris@chrispresso.com" } -Receive attachments -=================== +Receive Attachments +------------------- Now that you have all those fancy attachments within your tickets, you may want to download specific ones. diff --git a/api/ticket/index.rst b/api/ticket/index.rst index 5ddd2eae..9cf9dfd5 100644 --- a/api/ticket/index.rst +++ b/api/ticket/index.rst @@ -1,5 +1,5 @@ Tickets -******* +======= .. warning:: @@ -7,7 +7,7 @@ Tickets using is an **agent**. Because of this tickets may or may not be available. List -==== +---- Required permission: ``ticket.agent`` **or** ``ticket.customer`` @@ -104,7 +104,7 @@ Response: ] Search -====== +------ Required permission: ``ticket.agent`` **or** ``ticket.customer`` @@ -1153,7 +1153,7 @@ Response: *the total amount*. Show -==== +---- Required permission: ``ticket.agent`` **or** ``ticket.customer`` @@ -1207,7 +1207,7 @@ Response: } Create -====== +------ Required permission: ``ticket.agent`` **or** ``ticket.customer`` @@ -1300,7 +1300,7 @@ Response: For more article attributes and options have a look into :doc:`articles`. Update -====== +------ Required permission: ``ticket.agent`` **or** ``ticket.customer`` @@ -1384,7 +1384,7 @@ Response: instead. Delete -====== +------ Required permission: ``admin`` diff --git a/api/ticket/links.rst b/api/ticket/links.rst index 296d247e..741a6f5d 100644 --- a/api/ticket/links.rst +++ b/api/ticket/links.rst @@ -1,8 +1,8 @@ Linking Tickets -******************* +=============== Get -=== +--- Required permission: ``ticket.agent`` **or** ``admin`` @@ -676,7 +676,7 @@ Response: Add -=== +--- Required permission: ``ticket.agent`` **or** ``admin`` @@ -715,7 +715,7 @@ Response: } Delete -====== +------ Required permission: ``ticket.agent`` **or** ``admin`` diff --git a/api/ticket/mentions.rst b/api/ticket/mentions.rst index 49910944..850b680d 100644 --- a/api/ticket/mentions.rst +++ b/api/ticket/mentions.rst @@ -1,5 +1,5 @@ Mentions -******** +======== .. warning:: @@ -7,7 +7,7 @@ Mentions using is an **agent**. Because of this tickets may or may not be available. List -==== +---- Required permission: ``ticket.agent`` **or** ``ticket.customer`` @@ -44,7 +44,7 @@ Required permission: ``ticket.agent`` **or** ``ticket.customer`` } Create -====== +------ Required permission: ``ticket.agent`` @@ -78,7 +78,7 @@ Response: The mention will be created for the user of the current session. Delete -====== +------ Required permission: ``ticket.agent`` diff --git a/api/ticket/priorities.rst b/api/ticket/priorities.rst index 5e03899a..3df194eb 100644 --- a/api/ticket/priorities.rst +++ b/api/ticket/priorities.rst @@ -1,8 +1,8 @@ Priorities -********** +========== List -==== +---- Required permission: ``admin.object`` **or** ``ticket.agent`` **or** ``ticket.customer`` @@ -13,9 +13,9 @@ Response: .. code-block:: json :force: - + # HTTP-Code 200 Ok - + [ { "id": 1, @@ -60,7 +60,7 @@ Response: Show -==== +---- Required permission: ``admin.object`` **or** ``ticket.agent`` **or** ``ticket.customer`` @@ -71,9 +71,9 @@ Response: .. code-block:: json :force: - + # HTTP-Code 200 Ok - + { "id": 3, "name": "3 high", @@ -90,14 +90,14 @@ Response: Create -====== +------ Required permission: ``admin.object`` ``POST``-Request sent: ``/api/v1/ticket_priorities`` .. code-block:: json - + { "name": "4 disaster", "default_create": false, @@ -110,9 +110,9 @@ Response: .. code-block:: json :force: - + # HTTP-Code 201 Created - + { "id": 4, "name": "4 disaster", @@ -128,14 +128,14 @@ Response: } Update -====== +------ Required permission: ``admin.object`` ``PUT``-Request sent: ``/api/v1/ticket_priorities/{id}`` .. code-block:: json - + { "ui_icon": "", "ui_color": "", @@ -146,9 +146,9 @@ Response: .. code-block:: json :force: - + # HTTP-Code 200 Ok - + { "id": 3, "ui_icon": "", @@ -165,7 +165,7 @@ Response: Delete -====== +------ Required permission: ``admin.object`` @@ -186,7 +186,7 @@ Response: .. code-block:: json :force: - + # HTTP-Code 200 Ok - + {} diff --git a/api/ticket/shared_drafts.rst b/api/ticket/shared_drafts.rst index 5d59677f..6b0b1e43 100644 --- a/api/ticket/shared_drafts.rst +++ b/api/ticket/shared_drafts.rst @@ -1,8 +1,8 @@ Shared Drafts -************* +============= Show -==== +---- Required permission: ``ticket.agent``. @@ -591,7 +591,7 @@ Sample response (base64 coded inline image is cut off): } Create -====== +------ Required permission: ``ticket.agent``. @@ -1199,7 +1199,7 @@ Response: } Update -====== +------ Required permission: ``ticket.agent`` @@ -1820,7 +1820,7 @@ Response: } Remove -====== +------ Required permission: ``ticket.agent`` diff --git a/api/ticket/states.rst b/api/ticket/states.rst index a3902054..17bb3988 100644 --- a/api/ticket/states.rst +++ b/api/ticket/states.rst @@ -1,5 +1,5 @@ States -****** +====== .. warning:: @@ -8,7 +8,7 @@ States :admin-docs:`here `. List -==== +---- Required permission: ``admin.object`` **or** ``ticket.agent`` **or** ``ticket.customer`` @@ -131,7 +131,7 @@ Response: ] Show -==== +---- Required permission: ``admin.object`` **or** ``ticket.agent`` **or** ``ticket.customer`` @@ -163,7 +163,7 @@ Response: Create -====== +------ Required permission: ``admin.object`` @@ -212,7 +212,7 @@ Response: Update -====== +------ Required permission: ``admin.object`` @@ -249,7 +249,7 @@ Response: Delete -====== +------ Required permission: ``admin.object`` diff --git a/api/ticket/tags.rst b/api/ticket/tags.rst index 22778db5..dbcb47eb 100644 --- a/api/ticket/tags.rst +++ b/api/ticket/tags.rst @@ -1,11 +1,11 @@ Tags -**** +==== -Ticket scope -============ +Ticket Scope +------------ List ----- +^^^^ Required permission: ``ticket.agent`` **or** ``admin.tag`` @@ -27,7 +27,7 @@ Sample response: Search ------- +^^^^^^ Required permission: ``ticket.agent`` **or** ``admin.tag`` @@ -58,7 +58,7 @@ Sample response: ] Add ---- +^^^ Required permission: ``ticket.agent`` **or** ``admin.tag`` @@ -88,7 +88,7 @@ Response: true Remove ------- +^^^^^^ Required permission: ``ticket.agent`` **or** ``admin.tag`` @@ -111,11 +111,11 @@ Response: true -Administration scope -==================== +Administration Scope +-------------------- Admin - List ------------- +^^^^^^^^^^^^ Required permission: ``admin.tag`` @@ -147,7 +147,7 @@ Sample response: ] Admin - Create --------------- +^^^^^^^^^^^^^^ Required permission: ``admin.tag`` @@ -169,7 +169,7 @@ Response: {} Admin - Rename --------------- +^^^^^^^^^^^^^^ Required permission: ``admin.tag`` @@ -191,7 +191,7 @@ Response: {} Admin - Delete --------------- +^^^^^^^^^^^^^^ Required permission: ``admin.tag`` diff --git a/api/ticket/timeaccounting.rst b/api/ticket/timeaccounting.rst index 4e2c3020..3890a468 100644 --- a/api/ticket/timeaccounting.rst +++ b/api/ticket/timeaccounting.rst @@ -1,8 +1,8 @@ Time Accounting -*************** +=============== List -==== +---- Required permission: ``ticket.agent`` **or** ``admin.time_accounting`` @@ -50,7 +50,7 @@ Sample response: Show -==== +---- Required permission: ``ticket.agent`` **or** ``admin.time_accounting`` @@ -75,7 +75,7 @@ Sample response: } Create -====== +------ Required permission: ``ticket.agent`` **or** ``admin.time_accounting`` @@ -108,7 +108,7 @@ Response: } Update -====== +------ Required permission: ``admin.time_accounting`` @@ -143,7 +143,7 @@ Response: } Remove -====== +------ Required permission: ``admin.time_accounting`` diff --git a/api/user-access-token.rst b/api/user-access-token.rst index 9fbde8d8..c3bfdfdc 100644 --- a/api/user-access-token.rst +++ b/api/user-access-token.rst @@ -1,8 +1,8 @@ User Access Token -***************** +================= List -==== +---- Required permission: ``user_preferences.access_token`` @@ -903,7 +903,7 @@ Response: } Create -====== +------ Required permission: ``user_preferences.access_token`` @@ -934,7 +934,7 @@ Response: creation and can't be retrieved after. Delete -====== +------ Required permission: ``user_preferences.access_token`` diff --git a/api/user.rst b/api/user.rst index 67d402b1..ec82fd54 100644 --- a/api/user.rst +++ b/api/user.rst @@ -1,5 +1,5 @@ User -**** +==== .. note:: **🤓 To see or not to see** @@ -10,8 +10,8 @@ User Please see our :admin-docs:`Permission Guide ` to get better insights. -me - current user -================= +Me - Current User +----------------- Required permission: any @@ -159,7 +159,7 @@ Response: List -==== +---- Required permission: ``ticket.agent`` **or** ``admin.user`` @@ -966,7 +966,7 @@ Response: Search -====== +------ Required permission: ``ticket.agent`` **or** ``admin.user`` @@ -1115,7 +1115,7 @@ Response: ] Show -==== +---- Required permission: ``ticket.agent`` **or** ``admin.user`` **or** ``ticket.customer`` (shared organization) @@ -1176,7 +1176,7 @@ Response: } Create -====== +------ Required permission: ``admin.user`` **or** ``ticket.agent`` @@ -1317,7 +1317,7 @@ Response: } Update -====== +------ Required permission: ``admin.user`` **or** ``ticket.agent`` @@ -1443,7 +1443,7 @@ Response: } Delete -====== +------ Required permission: ``admin.user`` diff --git a/appendix/backup-and-restore/index.rst b/appendix/backup-and-restore/index.rst index 2bbcf2d7..7a827c28 100644 --- a/appendix/backup-and-restore/index.rst +++ b/appendix/backup-and-restore/index.rst @@ -1,5 +1,5 @@ Backup and Restore -****************** +================== Zammad ships scripts for backup & restore in package installations which you can use in your backup strategy. @@ -16,7 +16,7 @@ can use in your backup strategy. as needed. Getting Started -=============== +--------------- These scripts are located in ``/opt/zammad/contrib/backup``. The following files might be important for you: @@ -30,7 +30,7 @@ Head over to the next section for a simple backup configuration. In detailed explanation of the scripts. Basic Backup Setup ------------------- +^^^^^^^^^^^^^^^^^^ #. Rename/copy the ``config.dist`` file to ``config``. #. Change default parameters in the ``config`` file if needed. Learn more @@ -42,7 +42,7 @@ Basic Backup Setup .. _advanced_backup: Advanced Setup and Restore --------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^ .. toctree:: :hidden: @@ -67,7 +67,7 @@ Restore Backups :doc:`here `. Additional Information ----------------------- +^^^^^^^^^^^^^^^^^^^^^^ Migrating to a new host :doc:`Here ` you can read how to @@ -84,7 +84,7 @@ Helper scripts information. Limitations -=========== +----------- Please note the following limitations which may affect script functionality or availability: diff --git a/appendix/configure-database-server.rst b/appendix/configure-database-server.rst index 8fb545cb..c8558213 100644 --- a/appendix/configure-database-server.rst +++ b/appendix/configure-database-server.rst @@ -1,5 +1,5 @@ -Configure Database server -************************* +Configure Database Server +========================= .. note:: diff --git a/appendix/configure-env-vars.rst b/appendix/configure-env-vars.rst index 0f668002..a1ccb8d5 100644 --- a/appendix/configure-env-vars.rst +++ b/appendix/configure-env-vars.rst @@ -1,5 +1,5 @@ Configuration via Environment Variables -*************************************** +======================================= Use these environment variables to configure Zammad's behavior at runtime. @@ -36,7 +36,7 @@ Use these environment variables to configure Zammad's behavior at runtime. :doc:`kubernetes `. General Options -=============== +--------------- APP_RESTART_CMD The command Zammad will use to automatically restart the server @@ -102,7 +102,7 @@ ZAMMAD_FQDN .. _network_options: Network Options -=============== +--------------- .. note:: @@ -127,7 +127,7 @@ ZAMMAD_WEBSOCKET_PORT .. _performance_tuning: Performance Tuning -================== +------------------ **Each of below settings comes with its own tradeoffs.** @@ -245,7 +245,7 @@ MEMCACHE_SERVERS caching files small. ``1 GB`` should be a reasonable size. Storage Options -=============== +--------------- S3_URL Allows you to provide your S3 configuration. Please have a look in our admin diff --git a/appendix/migrate-to-postgresql.rst b/appendix/migrate-to-postgresql.rst index 2e240289..40c6f913 100644 --- a/appendix/migrate-to-postgresql.rst +++ b/appendix/migrate-to-postgresql.rst @@ -1,5 +1,5 @@ -Migrate to PostgreSQL server -**************************** +Migrate to PostgreSQL Server +============================ .. include:: /appendix/includes/mysql-deprication-note.rst @@ -19,7 +19,7 @@ migration process. Preparation -=========== +----------- #. Stop Zammad: @@ -31,7 +31,7 @@ Preparation Install PostgreSQL ------------------- +^^^^^^^^^^^^^^^^^^ .. include:: /install/includes/postgres-installation.rst @@ -49,7 +49,7 @@ Please also have a look at :doc:`/appendix/configure-database-server`. Install pgloader ----------------- +^^^^^^^^^^^^^^^^ .. tabs:: @@ -74,8 +74,8 @@ Install pgloader $ zypper install pgloader -Create pgloader command file ----------------------------- +Create pgloader Command File +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Create a command file for pgloader with: @@ -112,7 +112,7 @@ configuration of your current environment. Database Credentials --------------------- +^^^^^^^^^^^^^^^^^^^^ Adjust the configuration file to fill in the credentials for your new PostgreSQL server. Use ``postgresql`` as ``adapter``. @@ -121,8 +121,8 @@ PostgreSQL server. Use ``postgresql`` as ``adapter``. .. include:: /install/includes/postgres-permissions.rst -Create empty database ---------------------- +Create Empty Database +^^^^^^^^^^^^^^^^^^^^^ Now you need to create an empty database in PostgreSQL. @@ -143,7 +143,7 @@ Now you need to create an empty database in PostgreSQL. Migrate -======= +------- .. tabs:: @@ -165,7 +165,7 @@ Migrate Finishing -========= +--------- After the migration has completed, you'll better clear some cache files: diff --git a/appendix/privacy.rst b/appendix/privacy.rst index 99d9a40f..e1f4cfb1 100644 --- a/appendix/privacy.rst +++ b/appendix/privacy.rst @@ -1,10 +1,10 @@ Privacy & Data Retention -************************ +======================== How long does Zammad hold onto user data? How can I manage its user data retention behavior? On-Premises Data -================ +---------------- The following kinds of data are stored locally on the production system: @@ -57,7 +57,7 @@ Data Privacy Tasks Each entry in the data privacy task list is automatically deleted after 12 months. External Services -================= +----------------- Zammad utilizes third-party web services for certain functions, meaning that user data may occasionally be sent or exposed to third parties. diff --git a/appendix/reporting-tools-thirdparty.rst b/appendix/reporting-tools-thirdparty.rst index ce151459..4b10c88d 100644 --- a/appendix/reporting-tools-thirdparty.rst +++ b/appendix/reporting-tools-thirdparty.rst @@ -29,7 +29,7 @@ You will need .. include:: reporting-tools-thirdparty/include-requirements.rst -Third Party Reporting Tools known to be working +Third Party Reporting Tools Known to be Working ----------------------------------------------- .. toctree:: diff --git a/appendix/single-sign-on.rst b/appendix/single-sign-on.rst index f0f2ee72..738f71c1 100644 --- a/appendix/single-sign-on.rst +++ b/appendix/single-sign-on.rst @@ -31,8 +31,8 @@ so that anyone with an account on your local intranet will see :admin-docs:`Third-Party Authentication ` for alternatives. -How does it work? -^^^^^^^^^^^^^^^^^ +How Does it Work? +----------------- Once enabled, single sign-on activates an endpoint at ``https://your.zammad.host/auth/sso``. @@ -182,7 +182,7 @@ which offers Kerberos support through a plug-in module instead. .. note:: All commands in this section must be run as root (or with ``sudo``). -2a. Turn off NGINX +2a. Turn Off NGINX ^^^^^^^^^^^^^^^^^^ .. warning:: This will take your Zammad instance **offline** @@ -213,7 +213,7 @@ simply turn off Apache and restore NGINX: This documentation expects a already working Apache configuration. Please see :doc:`/getting-started/configure-webserver` before continuing. -2c. Install further Apache dependencies +2c. Install Further Apache Dependencies ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. tabs:: @@ -238,7 +238,7 @@ Please see :doc:`/getting-started/configure-webserver` before continuing. $ zypper ref $ zypper install krb5-client apache2-mod_auth_kerb -2d. Enable Apache modules +2d. Enable Apache Modules ^^^^^^^^^^^^^^^^^^^^^^^^^ SSO requires modules that are not enabled by default. By default you can use @@ -322,7 +322,7 @@ Replace the following placeholders in the sample config below: .. _sso-generate-keytab: -2f. Generate keytab +2f. Generate Keytab ^^^^^^^^^^^^^^^^^^^ Apache needs a Kerberos *keytab* (key table) @@ -439,7 +439,7 @@ lines! Keep only the one you need. RequestHeader set X-Forwarded-User "%{RU}e" env=RU -2g. Restart Apache to apply changes +2g. Restart Apache to Apply Changes ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code-block:: sh diff --git a/contributing/start.rst b/contributing/start.rst index 7f0a25ae..6c6a7b86 100644 --- a/contributing/start.rst +++ b/contributing/start.rst @@ -1,5 +1,5 @@ Start -***** +===== We will be very happy if you decide to contribute to Zammad. You can do this in several ways. Contributions are mainly done by forking one of our repos on @@ -12,14 +12,14 @@ You can contribute to: * :ref:`documentation` * :ref:`translation` -Plese have a look on our notes on how to contribute below. +Please have a look on our notes on how to contribute below. All repos can be found at https://github.com/zammad .. _source-code: Zammad Source Code -================== +------------------ The Zammad source code can be found on GitHub at https://github.com/zammad/zammad @@ -28,27 +28,27 @@ For more information on how to contribute to Zammad, please have a look at https://zammad.org/participate and at the `Developer Manual`_. Supported Branches / Versions ------------------------------ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ The main Zammad repository at https://github.com/zammad/zammad has several branches. ``develop`` -^^^^^^^^^^^ +""""""""""" * This is the current (unreleased) development state of next major release (this will become the new ``stable`` branch). * Don't use it for production! * Supported with bug and security fixes - see also our `Security Policy`_. ``stable`` -^^^^^^^^^^ +"""""""""" * This is the current stable release, e.g. Zammad 5.2. * Use this branch for production installations. * Supported with bug and security fixes - see also our `Security Policy`_. ``stable-x.y`` -^^^^^^^^^^^^^^ +"""""""""""""" * These are the branches of old versions of Zammad like ``stable-5.1`` for Zammad 5.1. @@ -59,7 +59,7 @@ branches. .. _documentation: Documentation -============= +------------- Do you want to contribute to the Zammad documentation? @@ -86,8 +86,8 @@ markup. .. _RestructuredText: -ReStructuredText markup ------------------------ +ReStructuredText Markup +^^^^^^^^^^^^^^^^^^^^^^^ If you like to edit the docs, use the ReStructuredText markup language. Information about this language can be found at: @@ -103,7 +103,7 @@ Thanks! ❤ ❤ ❤ .. _translation: Translation -=========== +----------- If you want to help us with translation and improve the multi-language support of Zammad and/or the documentation, you are welcome to contribute @@ -120,7 +120,7 @@ and want to dive deeper into it, their `translation documentation`_ is a good starting point. Basics ------- +^^^^^^ The translation of **Zammad** and the translation of the **documentation** are split into two projects in Weblate. When you click in the top menu under @@ -176,7 +176,7 @@ Documentation (latest)*: Screenshot showing translation status of different languages for the user documentation Translating ------------ +^^^^^^^^^^^ After selecting your languange you want to translate to, a good starting point is to select "*Untranslated strings*" (or the same meaning in your language, @@ -210,7 +210,7 @@ the user interface of Weblate: for languages, which are similar). Troubleshooting ---------------- +^^^^^^^^^^^^^^^ And finally some notes for "special" source strings, you might see in the documentation projects (see RestructuredText_ for details): diff --git a/getting-started/configure-webserver.rst b/getting-started/configure-webserver.rst index d806073b..bf4e2ebd 100644 --- a/getting-started/configure-webserver.rst +++ b/getting-started/configure-webserver.rst @@ -1,4 +1,4 @@ -Configure the webserver +Configure the Webserver ======================= You can find current sample configuration files for your webserver within @@ -16,7 +16,7 @@ install a configuration file to your nginx for you. | Please also note the environment information on :doc:`this page ` -Get a ssl certificate (recommended) +Get a SSL Certificate (recommended) ----------------------------------- Don't know how to get SSL certificates and install them on a webserver yet? @@ -204,7 +204,7 @@ directory and make sure to replace ``server_name localhost;`` (nginx) or .. _GlobalSign: https://www.globalsign.com/en/managed-ssl .. _openSSL documentation: https://www.openssl.org/docs/ -Adjusting the webserver configuration +Adjusting the Webserver Configuration ------------------------------------- .. warning:: diff --git a/getting-started/first-steps.rst b/getting-started/first-steps.rst index 432ab0c3..59d22bb8 100644 --- a/getting-started/first-steps.rst +++ b/getting-started/first-steps.rst @@ -1,5 +1,5 @@ -First steps -*********** +First Steps +=========== After successfully installing Zammad you'll have a couple of options. diff --git a/index.rst b/index.rst index cf909142..29f0242e 100644 --- a/index.rst +++ b/index.rst @@ -53,7 +53,7 @@ Zammad System Documentation :glob: :caption: Administration via ... - Web-UI + Web-UI (admin documentation) Console diff --git a/install/docker-compose.rst b/install/docker-compose.rst index 11965542..aa853180 100644 --- a/install/docker-compose.rst +++ b/install/docker-compose.rst @@ -1,5 +1,5 @@ Install with Docker -******************* +=================== Zammad can be deployed using Docker-Compose. You can even use graphical docker front ends like @@ -14,7 +14,7 @@ graphical docker front ends like to stick with :doc:`the package installation ` instead. Prerequisites -============= +------------- * This documentation expects you already have a working `Docker Compose `_ environment. @@ -26,7 +26,7 @@ Prerequisites $ sysctl -w vm.max_map_count=262144 Deployment with Portainer -========================= +------------------------- The easiest way to get Zammad running is via a graphical docker UI. We recommend `Portainer `_. For installation instructions, check out `Portainer's documentation `_. @@ -66,7 +66,7 @@ Step 3: **Deploy the Stack** Deployment with Docker-Compose -============================== +------------------------------ Step 1: **Clone the GitHub Repo** .. code-block:: sh @@ -97,7 +97,7 @@ Step 3: Start the stack After the stack is ready, you can access Zammad via the configured docker host and port, e.g. ``http://localhost:8080/``. Customizing the Zammad Stack -============================ +---------------------------- Sometimes it's necessary to apply local changes to the Zammad docker stack, e.g. to include additional services. If you plan to do so, we recommend that you do not change @@ -112,7 +112,7 @@ that includes all your modifications. Docker-Compose will /install/docker-compose/environment How to Run Commands in the Stack -================================ +-------------------------------- The docker entrypoint script sets up environment variables required by Zammad to function properly. That is why calling ``rails`` or ``rake`` on the console diff --git a/install/elasticsearch.rst b/install/elasticsearch.rst index 3d598223..176a002a 100644 --- a/install/elasticsearch.rst +++ b/install/elasticsearch.rst @@ -1,5 +1,5 @@ -Set up Elasticsearch -******************** +Set Up Elasticsearch +==================== Zammad's search function is powered by Elasticsearch, and requires the `ingest attachment plugin `_. @@ -12,7 +12,7 @@ If you installed from source, be sure to omit this prefix and run the bare ``rails ...`` or ``rake ...`` commands instead. Step 1: Installation -==================== +-------------------- Starting with Zammad 4.0, our packages allow you to decide whether to use ``elasticsearch`` or ``elasticsearch-oss``. @@ -118,8 +118,8 @@ ensure to enable it by default and start it. Setting the ``vm.max_map_count`` kernel parameter requires `additional steps `_. -Step 2: Suggested Configuration -=============================== +Step 2: Configuration +--------------------- We use the following settings to optimize the performance of our Elasticsearch servers. Your mileage may vary. @@ -152,7 +152,7 @@ servers. Your mileage may vary. .. _configure_zammad_with_elasticsearch: Step 3: Connect Zammad -====================== +---------------------- Before proceeding here, make sure to install Zammad before running below commands, as this will fail otherwise. @@ -178,7 +178,7 @@ authentication (see HTTP Basic below). Optional settings ------------------ +^^^^^^^^^^^^^^^^^ .. tabs:: @@ -249,7 +249,7 @@ Optional settings :admin-docs:`in the admin documentation `. Appendix -======== +-------- .. toctree:: :maxdepth: 0 diff --git a/install/elasticsearch/indexed-attributes.rst b/install/elasticsearch/indexed-attributes.rst index 4a8db73f..59ba439c 100644 --- a/install/elasticsearch/indexed-attributes.rst +++ b/install/elasticsearch/indexed-attributes.rst @@ -1,5 +1,5 @@ List of Indexed Attributes -************************** +========================== Below is a comprehensive list of all object attributes indexed by Elasticsearch. In other words, if you wish to find a ticket, article, or user @@ -28,7 +28,7 @@ fields below. This also applies to times provided by Elasticsearch Ticket -====== +------ .. tip:: @@ -237,7 +237,7 @@ Ticket - User ID that updated the ticket Ticket Priority -=============== +--------------- .. tip:: @@ -286,7 +286,7 @@ Ticket Priority - User ID of user last updating the priority Ticket State -============ +------------ .. tip:: @@ -355,7 +355,7 @@ Ticket State - User ID that updated state last Article -======= +------- .. tip:: @@ -439,7 +439,7 @@ Article - User that updated article User -==== +---- .. tip:: @@ -556,7 +556,7 @@ User - ZIP code Organization -============ +------------ .. tip:: @@ -621,7 +621,7 @@ Organization - Defines if the organization has VIP state Group -===== +----- .. tip:: @@ -702,7 +702,7 @@ Group - User ID that updated group CTI Log -======= +------- .. tip:: @@ -781,7 +781,7 @@ CTI Log - Last update of entry Chat Session -============ +------------ .. tip:: diff --git a/install/elasticsearch/troubleshooting.rst b/install/elasticsearch/troubleshooting.rst index 2253aa96..7670b5b6 100644 --- a/install/elasticsearch/troubleshooting.rst +++ b/install/elasticsearch/troubleshooting.rst @@ -1,5 +1,5 @@ Troubleshooting and FAQ -*********************** +======================= This guide will discuss frequently asked questions and how to resolve common problems with Elasticsearch. @@ -10,8 +10,8 @@ problems with Elasticsearch. can't find your particular issue described here, feel free to `ask the community `_ for technical assistance. -Data missing from the Web-UI / Search data missing or incomplete -================================================================ +Data Missing From the Web-UI / Search Data Missing or Incomplete +---------------------------------------------------------------- A commonly reported issue is data missing from the Web-UI. This could be tickets, articles, users or anything else diff --git a/install/includes/firewall-and-selinux.rst b/install/includes/firewall-and-selinux.rst index fc8ae278..79a6807e 100644 --- a/install/includes/firewall-and-selinux.rst +++ b/install/includes/firewall-and-selinux.rst @@ -1,10 +1,10 @@ Firewall & SELinux -================== +------------------ Some parts of these steps may not apply to you, feel free to skip them! SELinux -------- +^^^^^^^ .. tabs:: @@ -25,7 +25,7 @@ SELinux for more input if you wish to continue. Firewall --------- +^^^^^^^^ .. note:: @@ -115,7 +115,7 @@ Firewall After that locate ``FW_CONFIGURATIONS_EXT`` within ``/etc/sysconfig/SuSEfirewall2`` and add the option ``webserver`` to the - list. The list is seperated by spaces. + list. The list is separated by spaces. You may require a different zone, above covers the external zone. Now ensure to restart the firewall service. diff --git a/install/includes/manage-services.rst b/install/includes/manage-services.rst index 6fc9a76c..545bc0a4 100644 --- a/install/includes/manage-services.rst +++ b/install/includes/manage-services.rst @@ -1,5 +1,5 @@ Manage services of Zammad -========================= +------------------------- In general Zammad uses three services - these can be (re)started & stopped with the parent ``zammad``. diff --git a/install/includes/next-steps.rst b/install/includes/next-steps.rst index 52943267..f79e3745 100644 --- a/install/includes/next-steps.rst +++ b/install/includes/next-steps.rst @@ -1,5 +1,5 @@ -Next steps -========== +Next Steps +---------- With this Zammad technically is ready to go. However, you'll need to follow the following further steps to access diff --git a/install/kubernetes.rst b/install/kubernetes.rst index 00e247cf..38947191 100644 --- a/install/kubernetes.rst +++ b/install/kubernetes.rst @@ -1,5 +1,5 @@ Install on Kubernetes -********************* +===================== .. hint:: diff --git a/install/package.rst b/install/package.rst index 2dbb5d8a..3f062002 100644 --- a/install/package.rst +++ b/install/package.rst @@ -1,5 +1,5 @@ -Install from package -******************** +Package Installation +==================== .. note:: @@ -9,12 +9,15 @@ Install from package not used. Prerequisites -============= +------------- Additional software dependencies -------------------------------- -In addition to already mentioned :ref:`Package dependencies `, +1. Install Required Tools +^^^^^^^^^^^^^^^^^^^^^^^^^ + +In addition to already mentioned :ref:`software dependencies `, some operating systems may require additional packages if not already installed. .. tabs:: @@ -41,15 +44,82 @@ some operating systems may require additional packages if not already installed. $ yum install wget epel-release -.. include:: /install/includes/prerequisites.rst +2. Install Elasticsearch +^^^^^^^^^^^^^^^^^^^^^^^^ + +Elasticsearch is not a hard dependency of Zammad, but strongly recommended! It +needs to be installed before Zammad. Please take a look at the +:doc:`instructions ` first. + +3. Ensure Correct Locale +^^^^^^^^^^^^^^^^^^^^^^^^ + +To make Zammad work correctly, your system has to use the correct locales. + +.. tabs:: + + .. tab:: Ubuntu / Debian + + List your current locale settings. + + .. code-block:: sh + + $ locale |grep "LANG=" + + .. include:: /install/includes/include-utf-8-clause.rst + + .. code-block:: sh + + $ sudo apt install locales + $ sudo locale-gen en_US.UTF-8 + $ echo "LANG=en_US.UTF-8" > sudo /etc/default/locale + + .. tab:: CentOS + + List your current locale settings. + + .. code-block:: sh -Add Repository and install Zammad -================================= + $ locale |grep "LANG=" + + .. include:: /install/includes/include-utf-8-clause.rst + + .. code-block:: sh + + $ sudo localectl set-locale LANG=en_US.utf8 + + .. tab:: OpenSUSE / SLES + + List your current locale settings. + + .. code-block:: sh + + $ localectl status |grep "LC_CTYPE" + + .. include:: /install/includes/include-utf-8-clause.rst + + .. code-block:: sh + + $ sudo localectl set-locale LC_CTYPE=en_US.UTF-8 + + .. hint:: + + By default OpenSUSE uses ``POSIX`` as ``LANG`` value for the root + user. Learn more about this within the `OpenSUSE documentation + `_. + + This does not affect other users and thus can be ignored. + + +Add Repository and Install Zammad +--------------------------------- .. hint:: Packager.io may not be accessible from IPv6-only environments, so make sure to consider this when performing the steps below. Add Repository +^^^^^^^^^^^^^^ + .. tabs:: .. tab:: Ubuntu @@ -131,6 +201,8 @@ Add Repository https://dl.packager.io/srv/zammad/zammad/stable/installer/sles/15.repo Install Zammad +^^^^^^^^^^^^^^ + .. tabs:: .. tab:: Ubuntu / Debian diff --git a/install/source.rst b/install/source.rst index 556ed764..8603664c 100644 --- a/install/source.rst +++ b/install/source.rst @@ -1,5 +1,5 @@ -Install from source -******************* +Source Installation +=================== The source installation is the most difficult installation type of Zammad. If you're not too experienced with Linux and all that, you may want to use @@ -19,16 +19,16 @@ another installation type: `here `_. Prerequisites -============= +------------- -Software dependencies ---------------------- +Software Dependencies +^^^^^^^^^^^^^^^^^^^^^ Please ensure that you already provided mentioned :doc:`Software requirements `. -Add user --------- +Add User +^^^^^^^^ .. code-block:: sh @@ -36,10 +36,10 @@ Add user $ groupadd zammad Installation -============ +------------ -Step 1: Get the source ----------------------- +Step 1: Get the Source +^^^^^^^^^^^^^^^^^^^^^^ .. note:: @@ -50,8 +50,8 @@ Step 1: Get the source .. _source_dependency_installation: -Step 2: Install dependencies ----------------------------- +Step 2: Install Dependencies +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. About this section: The RVM installation part uses definition list instead @@ -173,8 +173,8 @@ older versions. A list of required versions can be found on the .. include:: /install/includes/postgres-dependencies.rst -Step 3: Configure database settings ------------------------------------ +Step 3: Configure Database Settings +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. include:: /install/includes/postgres-permissions.rst @@ -204,8 +204,8 @@ file could look like. Please also have a look at .. include:: /install/source/include-chmod-database-yml.rst -Step 4: Initialize your database --------------------------------- +Step 4: Initialize Your Database +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. warning:: @@ -236,8 +236,8 @@ Step 4: Initialize your database $ rails r "Locale.sync" $ rails r "Translation.sync" -Step 5: Pre compile all Zammad assets -------------------------------------- +Step 5: Pre-compile All Zammad Assets +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code-block:: sh @@ -245,8 +245,8 @@ Step 5: Pre compile all Zammad assets .. _source-install-systemd-reference: -Step 6: Start Zammad or install as service ------------------------------------------- +Step 6: Start Zammad or Install As Service +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. note:: diff --git a/migration/freshdesk.rst b/migration/freshdesk.rst index 45a6cd3c..8f937872 100644 --- a/migration/freshdesk.rst +++ b/migration/freshdesk.rst @@ -1,8 +1,8 @@ From Freshdesk -************** +============== Limitations -=========== +----------- Please note below Freshdesk specific limitations. These are additional limitations to the @@ -23,7 +23,7 @@ These are additional limitations to the Prerequisites -============= +------------- Zammad requires API access which is why you'll need to `create an API key`_ for the migration. The migrator will request your Freshdesk subdomain and @@ -37,8 +37,8 @@ API key. .. _create an API key: https://support.freshdesk.com/support/solutions/articles/215517-how-to-find-your-api-key -Importing Freshdesk data -======================== +Importing Freshdesk Data +------------------------ Generally you have two options on how to migrate data. If you have a fairly big instance with a lot of data, you may want to @@ -247,8 +247,8 @@ consider using the console over the browser version. .. include:: /migration/includes/commands-after-migration.include.rst -After migration -=============== +After Migration +--------------- As the migration technically skips the getting started wizard, please note that you want to adjust your diff --git a/migration/includes/restarting-from-scratch.include.rst b/migration/includes/restarting-from-scratch.include.rst index 0951a78f..bd316dc9 100644 --- a/migration/includes/restarting-from-scratch.include.rst +++ b/migration/includes/restarting-from-scratch.include.rst @@ -1,6 +1,6 @@ -Restarting from scratch -======================= +Restarting From Scratch +----------------------- -Turned wrong at some point? -You can find the required commands to reset Zammad in our -:ref:`Dangerzone `. +Turned wrong at some point? +You can find the required commands to reset Zammad in our +:ref:`dangerzone `. diff --git a/migration/index.rst b/migration/index.rst index 3c69d337..8cf9f6b7 100644 --- a/migration/index.rst +++ b/migration/index.rst @@ -1,5 +1,5 @@ Migrating to Zammad -******************* +=================== Zammad will migrate the following information: @@ -15,7 +15,7 @@ done *after migration*. .. _migration_limitations: Limitations -=========== +----------- There might be source dependent limitations which we will be covering on the direct migration pages. @@ -29,7 +29,7 @@ However, these limitations count for all migrations: specific information specific groups, tickets or users. Available Migration Options -=========================== +--------------------------- .. toctree:: :maxdepth: 1 diff --git a/migration/kayako.rst b/migration/kayako.rst index 45ef656f..c0af6e61 100644 --- a/migration/kayako.rst +++ b/migration/kayako.rst @@ -1,8 +1,8 @@ From Kayako -*********** +=========== Limitations -=========== +----------- Please note below Kayako specific limitations. These are additional limitations to the @@ -29,7 +29,7 @@ These are additional limitations to the Prerequisites -============= +------------- Zammad requires API access which is why the migrator will request your Kayako-URL, email address and password. @@ -39,8 +39,8 @@ Kayako-URL, email address and password. Ensure to provide an user account with **full administrative** permissions. Less privileged users will end in a broken migration. -Importing Kayako data -===================== +Importing Kayako Data +--------------------- Generally you have two options on how to migrate data. If you have a fairly big instance with a lot of data, you may want to @@ -252,8 +252,8 @@ consider using the console over the browser version. .. include:: /migration/includes/commands-after-migration.include.rst -After migration -=============== +After Migration +--------------- As the migration technically skips the getting started wizard, please note that you want to adjust your diff --git a/migration/otrs.rst b/migration/otrs.rst index aa8077ae..d84815a8 100644 --- a/migration/otrs.rst +++ b/migration/otrs.rst @@ -1,8 +1,8 @@ Migration from OTRS -******************** +=================== Limitations -=========== +----------- Please note below OTRS specific limitations. These are additional limitations to the :ref:`general ones listed `. @@ -20,10 +20,10 @@ These are additional limitations to the :ref:`general ones listed `_. Example Setup -============= +------------- This is a basic setup for **up to 40 agents**. As mentioned above, it highly depends on many factors, but this can be a good starting point for dimensioning @@ -51,7 +51,7 @@ your system. * 6 GB of RAM (+6 GB if you want to run Elasticsearch on the same server) Performance Tuning -================== +------------------ As the number of active users and/or tickets grows, performance will eventually degrade. You should have a look at diff --git a/prerequisites/software.rst b/prerequisites/software.rst index c0922ddb..a4b7a636 100644 --- a/prerequisites/software.rst +++ b/prerequisites/software.rst @@ -1,14 +1,14 @@ Software -******** +======== -1. Client requirements -====================== +1. Client Requirements +---------------------- Please note that, while Zammad being a web application, there's some requirements for your clients. This ensures that Zammad works as expected. -1.1. Supported Browsers ------------------------ +1.1 Supported Browsers +^^^^^^^^^^^^^^^^^^^^^^ .. list-table:: Zammad/Browser version compatibility :header-rows: 1 @@ -38,8 +38,8 @@ Zammads function which is not a bug. For example the Google Chrome translation module is known to do odd things, especially to state names. Use Zammads internal translations instead. -1.2. Network requirements -------------------------- +1.2 Network Requirements +^^^^^^^^^^^^^^^^^^^^^^^^ Zammad uses web sockets. Some application firewalls may filter these connections. This may lead to decreased browser performance. @@ -51,8 +51,8 @@ In case you're having issues with field selection, you can activate the :admin-docs:`AJAX Mode for "Core Workflows" ` separately. -2. Server requirements -====================== +2. Server Requirements +---------------------- If you want to install Zammad, you need the following software. @@ -62,8 +62,8 @@ If you want to install Zammad, you need the following software. version) are minimum requirements of Zammad. We strongly encourage you to use most current possible versions that *are not end of life*. -2.1. Ruby Programming Language ------------------------------- +2.1 Ruby Programming Language +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. hint:: **🤓 Only relevant for source code installations** @@ -89,8 +89,8 @@ different Zammad versions: "3.1 - 3.3", "2.5.5" "2.5 - 3.0", "2.4.4" -2.2. Supported distributions ----------------------------- +2.2 Supported Distributions +^^^^^^^^^^^^^^^^^^^^^^^^^^^ Zammad provides binary packages for the most recent two stable / long-term-support releases of the supported Linux distributions, until they @@ -124,8 +124,8 @@ Below you can find all distributions Zammad provides packages for. .. _package_dependencies: -2.3. Package Dependencies -------------------------- +2.3 Package Dependencies +^^^^^^^^^^^^^^^^^^^^^^^^ The below dependencies need to be installed on your system. If you're using the package install, the packages below will automatically @@ -149,8 +149,8 @@ installed with the Zammad-Package. | *However:* If you have to use ``bundle install`` for e.g. custom Gems or development, you'll need to install it! -2.4. Database Server --------------------- +2.4 Database Server +^^^^^^^^^^^^^^^^^^^ Zammad will store all content in a Database. You can choose between the following database servers: @@ -176,8 +176,8 @@ You may also want to consider the following settings for your **MySQL** server:: innodb_large_prefix = 1 innodb_file_format_max = Barracuda -2.5. Node.js ------------- +2.5 Node.js +^^^^^^^^^^^ Node.js is required for asset compiling. @@ -197,8 +197,8 @@ any javascript or stylesheet files via ``rake assets:precompile``. "5.2 - 6.1", "16.0+" "5.0 - 5.1", "10.0+" -2.6. Reverse Proxy ------------------- +2.6 Reverse Proxy +^^^^^^^^^^^^^^^^^ In a typical web environment today, you use a reverse proxy to deliver the static content of your application. Only the "expensive" app required HTTP @@ -217,7 +217,7 @@ The following reverse proxies are supported: 2.7 Redis -~~~~~~~~~~~ +^^^^^^^^^ Starting with Zammad 6.0, `Redis `_ is required for realtime communication via web socket. @@ -228,8 +228,8 @@ tight security on your installation. .. _prerequisites_elasticsearch: -2.8. Elasticsearch (optional) ------------------------------ +2.8 Elasticsearch (optional) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Zammad uses Elasticsearch to @@ -274,17 +274,11 @@ Starting with Zammad 4.0 you can decide if you want to use An Elasticsearch plugin is required to index the contents of email attachments: ``ingest-attachment``. -2.9. Optional tools of improved caching and distribution --------------------------------------------------------- +2.9 Memcached (optional) +^^^^^^^^^^^^^^^^^^^^^^^^ -These features / integrations below are optional. You should consider using -them to have a better performance or if you want to use the corresponding -feature. - -You can also have a look in our :ref:`performance_tuning` section. - -2.9.1 Memcached -~~~~~~~~~~~~~~~ +This feature is optional. You should consider using it to have a better +performance. You can also have a look in our :ref:`performance_tuning` section. Instead of storing Zammads cache files within your filesystem, you can also do so in `Memcached `_. This can allow you to restrict @@ -295,7 +289,7 @@ Please follow the official vendor guides and ensure to have a tight security on your installation. 2.10 GnuPG (optional) ---------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^ If you want to use the PGP integration for sending and receiving signed and encrypted emails, you need to install the GnuPG-Tool. Please have a look at the official `GnuPG website`_.