From 6b459afe80a9fb277460cb95a2749afd47ba5784 Mon Sep 17 00:00:00 2001 From: ralf401 Date: Mon, 1 Jun 2026 12:25:03 +0200 Subject: [PATCH] Maintenance: Apply formatting, indentation and wording fixes --- admin/console/hidden-settings.rst | 6 +- admin/console/zammad-settings.rst | 4 +- api/generic-cti/answer-event.rst | 8 +- ...cti_context-note-configuration.include.rst | 6 +- api/generic-cti/hangup-event.rst | 6 +- api/generic-cti/index.rst | 20 +-- api/generic-cti/newcall-event.rst | 4 +- api/group.rst | 4 +- api/intro.rst | 6 +- api/object.rst | 17 +- api/ticket/articles.rst | 6 +- appendix/backup-and-restore/configuration.rst | 4 +- .../docker-file-handling.rst | 4 +- appendix/backup-and-restore/index.rst | 27 ++- .../backup-and-restore/little-helpers.rst | 15 +- appendix/backup-and-restore/migrate-hosts.rst | 10 +- appendix/backup-and-restore/restore.rst | 10 +- appendix/custom-kb-url.rst | 4 +- appendix/privacy.rst | 6 +- appendix/reporting-tools-thirdparty.rst | 4 +- .../reporting-tools-thirdparty/grafana.rst | 82 +++++---- .../include-requirements.rst | 12 +- appendix/single-sign-on.rst | 24 +-- contributing/start.rst | 64 +++---- getting-started/configure-webserver.rst | 26 +-- getting-started/first-steps.rst | 38 ++--- getting-started/include-dhparam-webserver.rst | 4 +- .../includes/apache-config-paths.include.rst | 6 +- .../includes/nginx-config-paths.include.rst | 6 +- install/docker-compose.rst | 8 +- .../docker-compose-scenarios.rst | 2 +- .../connect-configure-elasticsearch.rst | 6 +- install/elasticsearch/indexed-attributes.rst | 161 +++++++++--------- install/package.rst | 4 +- install/source.rst | 4 +- migration/freshdesk.rst | 24 +-- migration/index.rst | 16 +- migration/kayako.rst | 36 ++-- migration/otrs.rst | 18 +- migration/zendesk.rst | 24 +-- prerequisites/hardware.rst | 8 +- prerequisites/software.rst | 4 +- 42 files changed, 369 insertions(+), 379 deletions(-) diff --git a/admin/console/hidden-settings.rst b/admin/console/hidden-settings.rst index ee5899e9..02cdcb89 100644 --- a/admin/console/hidden-settings.rst +++ b/admin/console/hidden-settings.rst @@ -58,9 +58,9 @@ By default this will be a incoming phone call. You can choose between - * ``phone-in`` (incoming call, **default**), - * ``phone-out`` (outgoing call) and - * ``email-out`` (Sending an email out). +- ``phone-in`` (incoming call, **default**), +- ``phone-out`` (outgoing call) and +- ``email-out`` (Sending an email out). .. code-block:: irb diff --git a/admin/console/zammad-settings.rst b/admin/console/zammad-settings.rst index 0b4343f2..b9c8abfd 100644 --- a/admin/console/zammad-settings.rst +++ b/admin/console/zammad-settings.rst @@ -118,8 +118,8 @@ seconds, e.g. ``1``: The following settings are available in a default installation: - * ``DB`` (database) - * ``File`` (Filesystem (``/opt/zammad/storage/``)) +- ``DB`` (database) +- ``File`` (Filesystem (``/opt/zammad/storage/``)) Configuring Elasticsearch ------------------------- diff --git a/api/generic-cti/answer-event.rst b/api/generic-cti/answer-event.rst index a5b1a7f9..e5713967 100644 --- a/api/generic-cti/answer-event.rst +++ b/api/generic-cti/answer-event.rst @@ -34,9 +34,9 @@ Call Answered - Zammad will look up for a user with given value, the following attributes will be evaluated in given order: - * ``user.phone`` - * ``user.login`` - * ``user.id`` + - ``user.phone`` + - ``user.login`` + - ``user.id`` This value is optional. * - ``user`` @@ -203,4 +203,4 @@ There's two options on how to ``POST`` the relevant data to Zammad. --form 'caller="Emma Taylor"' The next logical step within call session context would be: - * :doc:`hangup ` (call ending) + - :doc:`hangup ` (call ending) diff --git a/api/generic-cti/generic-cti_context-note-configuration.include.rst b/api/generic-cti/generic-cti_context-note-configuration.include.rst index 58b34d63..dd05dae3 100644 --- a/api/generic-cti/generic-cti_context-note-configuration.include.rst +++ b/api/generic-cti/generic-cti_context-note-configuration.include.rst @@ -4,11 +4,11 @@ **Outbound:** - * Destination caller ID ``4989*`` set outbound caller ID + - Destination caller ID ``4989*`` set outbound caller ID ``498999998145`` with note "All from munich" - * Destination caller ID ``4930*`` set outbound caller ID + - Destination caller ID ``4930*`` set outbound caller ID ``493023125877`` "All from Berlin" **Other settings:** - * Default caller ID for outbound calls ``496990009111`` + - Default caller ID for outbound calls ``496990009111`` diff --git a/api/generic-cti/hangup-event.rst b/api/generic-cti/hangup-event.rst index 9f218661..00ea1966 100644 --- a/api/generic-cti/hangup-event.rst +++ b/api/generic-cti/hangup-event.rst @@ -56,9 +56,9 @@ Call Hangup - Zammad will look up for a user with given value, the following attributes will be evaluated in given order: - * ``user.phone`` - * ``user.login`` - * ``user.id`` + - ``user.phone`` + - ``user.login`` + - ``user.id`` This value is optional. diff --git a/api/generic-cti/index.rst b/api/generic-cti/index.rst index 4cb332c3..b528d9ae 100644 --- a/api/generic-cti/index.rst +++ b/api/generic-cti/index.rst @@ -5,25 +5,25 @@ This page describes the generic CTI API scopes and functionalities. .. warning:: **🚧 Limitations / Notes 🚧** - * Authentication on this endpoint works fundamentally different compared to + - Authentication on this endpoint works fundamentally different compared to the rest of the API. - * API clients *do not* work with the CTI endpoints unless explicitly stated + - API clients *do not* work with the CTI endpoints unless explicitly stated by the client vendor! - * The CTI endpoints are relevant for PBX systems only. + - The CTI endpoints are relevant for PBX systems only. Features Here's a small condensed list of the possibilities this CTI API provides. Inbound - * :user-docs:`Caller log functions ` for your + - :user-docs:`Caller log functions ` for your agents. - * Blocking of CallerIDs during signaling. + - Blocking of CallerIDs during signaling. Outbound - * :user-docs:`Caller log functions ` for your + - :user-docs:`Caller log functions ` for your agents. - * Set outbound caller IDs depending on the caller ID target. + - Set outbound caller IDs depending on the caller ID target. Endpoint The endpoint can be found in the generic CTI integration and contains a @@ -45,9 +45,9 @@ Events There are several events in terms of an ongoing call. These actions always come from your PBX system and may be: - * :doc:`"newCall" event ` (initiation of a call) - * :doc:`"hangup" event ` (call ending) - * :doc:`"answer" event ` (aka picking up the phone) + - :doc:`"newCall" event ` (initiation of a call) + - :doc:`"hangup" event ` (call ending) + - :doc:`"answer" event ` (aka picking up the phone) In some situations Zammad may provide a return on your PBX calls (e.g. a reject) if you blocked a specific caller. Zammad will never initiate diff --git a/api/generic-cti/newcall-event.rst b/api/generic-cti/newcall-event.rst index af6dc92c..e77e64af 100644 --- a/api/generic-cti/newcall-event.rst +++ b/api/generic-cti/newcall-event.rst @@ -259,5 +259,5 @@ configured one or both options, the return will be empty. {} The next logical steps within call session context would be: - * :doc:`hangup ` (call ending) - * :doc:`answer ` (aka picking up the phone) + - :doc:`hangup ` (call ending) + - :doc:`answer ` (aka picking up the phone) diff --git a/api/group.rst b/api/group.rst index 4cb944cf..22db05ee 100644 --- a/api/group.rst +++ b/api/group.rst @@ -3,9 +3,9 @@ Group .. note:: - * Please note that ``follow_up_possible`` may not work as expected. + - Please note that ``follow_up_possible`` may not work as expected. The possible values are ``yes`` or ``new_ticket``! - * If you want to create or update **subgroups**, use ``::`` as delimiter for + - If you want to create or update **subgroups**, use ``::`` as delimiter for the names. You also have to name the complete hierarchy in the name. Example: ``Sales::Europe::South`` diff --git a/api/intro.rst b/api/intro.rst index 9a76cc31..7d0be270 100644 --- a/api/intro.rst +++ b/api/intro.rst @@ -4387,9 +4387,9 @@ by a different user. To do so, add a new HTTP header named ``From`` to your request. The value of this header can be one of the following: - * user ID - * user login - * user email +- user ID +- user login +- user email ``From`` is available for all endpoints. diff --git a/api/object.rst b/api/object.rst index 5eb241e9..66cf1426 100644 --- a/api/object.rst +++ b/api/object.rst @@ -1078,11 +1078,10 @@ Required permission: ``admin.object`` Zammad input fields can have 4 different types: - * ``email`` - * ``tel`` - * ``text`` - * | ``url`` - | ⚠ *URL* does not support link-templates ⚠ + - ``email`` + - ``tel`` + - ``text`` + - ``url`` (URL does not support link-templates) Depending on the chosen input type, Zammad expects different formats of data. E.g.: *email* demands a email address to be provided. @@ -1354,10 +1353,10 @@ Required permission: ``admin.object`` The attribute ``object`` controls which context is being used: - * ``Ticket`` - * ``User`` - * ``Organisation`` - * ``Group`` + - ``Ticket`` + - ``User`` + - ``Organisation`` + - ``Group`` .. tabs:: diff --git a/api/ticket/articles.rst b/api/ticket/articles.rst index 8003d262..64e807da 100644 --- a/api/ticket/articles.rst +++ b/api/ticket/articles.rst @@ -89,9 +89,9 @@ internal sender Indicates which use did create the article. You can choose from: - * ``Agent`` - * ``Customer`` - * ``System`` + - ``Agent`` + - ``Customer`` + - ``System`` .. warning:: diff --git a/appendix/backup-and-restore/configuration.rst b/appendix/backup-and-restore/configuration.rst index e886b1ab..10d77d87 100644 --- a/appendix/backup-and-restore/configuration.rst +++ b/appendix/backup-and-restore/configuration.rst @@ -41,8 +41,8 @@ parameter in the table below. **Examples:** - * ``1`` will keep backups of the last 25 hours - * ``-1`` will remove all available backups (except the new one) + - ``1`` will keep backups of the last 25 hours + - ``-1`` will remove all available backups (except the new one) * - ``FULL_FS_DUMP`` - ``no`` - If set to ``yes``, the backup includes also application files. diff --git a/appendix/backup-and-restore/docker-file-handling.rst b/appendix/backup-and-restore/docker-file-handling.rst index df7a8501..165b104a 100644 --- a/appendix/backup-and-restore/docker-file-handling.rst +++ b/appendix/backup-and-restore/docker-file-handling.rst @@ -81,7 +81,7 @@ sure to provide additional volumes for persistence (e.g. for their database). .. tab:: Via Portainer In your Portainer web UI, go to **Containers** in the left menu and - click the **Add container** button. + click the ``Add container`` button. Add the following information: @@ -91,7 +91,7 @@ sure to provide additional volumes for persistence (e.g. for their database). container. - Advanced container settings: - - Switch to **Volumes** and click the **map additional volume** button. + - Switch to **Volumes** and click the ``map additional volume`` button. - Enter ``/srv`` in the container section and select the volume containing ``zammad-backup`` diff --git a/appendix/backup-and-restore/index.rst b/appendix/backup-and-restore/index.rst index d731a669..f3377af8 100644 --- a/appendix/backup-and-restore/index.rst +++ b/appendix/backup-and-restore/index.rst @@ -91,19 +91,18 @@ Limitations Please note the following limitations which may affect script functionality or availability: - * These scripts won't work in container and source code based installations. - * They only work for PostgreSQL installations. - * The backup is always a full dump (no incremental backup). - * Partial backup and restore (e.g. only specific data like tickets, users) - is not possible. - * Switching database system **is not** possible. See - :doc:`here ` how to manually switch - databases. - * System settings (like - :doc:`environment variables `) are - not backed up. - * Restore to an older Zammad version is not possible. - * **Do not** restore backup files from custom scripts with the - provided scripts by Zammad. This might cause problems. +- These scripts won't work in container and source code based installations. +- The backup is always a full dump (no incremental backup). +- Partial backup and restore (e.g. only specific data like tickets, users) + is not possible. +- Switching database system **is not** possible. See + :doc:`here ` how to manually switch + databases. +- System settings (like + :doc:`environment variables `) are + not backed up. +- Restore to an older Zammad version is not possible. +- **Do not** restore backup files from custom scripts with the + provided scripts by Zammad. This might cause problems. diff --git a/appendix/backup-and-restore/little-helpers.rst b/appendix/backup-and-restore/little-helpers.rst index ab8d7e60..4c01be8f 100644 --- a/appendix/backup-and-restore/little-helpers.rst +++ b/appendix/backup-and-restore/little-helpers.rst @@ -15,26 +15,25 @@ Database Helper: (Re)set Password ================================= Limitations - * This script is working for PostgreSQL installations only. - * Only local database servers are supported (script changes user). - * This script requires to be run as ``root`` or similar privileged user. - * Be aware that the script will automatically stop and start Zammad! + - Only local database servers are supported (script changes user). + - This script requires to be run as ``root`` or similar privileged user. + - Be aware that the script will automatically stop and start Zammad! Scopes Mostly the following installation types will be affected / relevant: - * package installations (especially CentOS & SUSE) - * possibly source code installations + - package installations (especially CentOS & SUSE) + - possibly source code installations Functionality The script will do the following actions automatically for you, depending on the situation. It will ask for your confirmation before performing actions. - * If ``database.yml`` contains an empty password line, a new password + - If ``database.yml`` contains an empty password line, a new password will be generated and set for the database user of Zammad. It will also be saved to the configuration file. - * If ``database.yml`` contains a password, it will be used to set + - If ``database.yml`` contains a password, it will be used to set the password of the Zammad database user. Usage diff --git a/appendix/backup-and-restore/migrate-hosts.rst b/appendix/backup-and-restore/migrate-hosts.rst index abdaaf30..5aa6142e 100644 --- a/appendix/backup-and-restore/migrate-hosts.rst +++ b/appendix/backup-and-restore/migrate-hosts.rst @@ -29,8 +29,8 @@ Step 2: Install Zammad on the destination host Have a look at the installation instructions: - * :doc:`Package Installation ` - * :doc:`Install with Docker ` + - :doc:`Package Installation ` + - :doc:`Install with Docker ` Step 3: Activate maintenance mode This ends all agent and customer sessions. @@ -97,9 +97,9 @@ Step 9: Run required maintenance tasks after restoring This step is only needed, if one of the following points is met: - * The source and destination Zammad versions are not the same - * The Zammad installation is not a source code installation - * The Zammad backup is not an export from our hosted setup + - The source and destination Zammad versions are not the same + - The Zammad installation is not a source code installation + - The Zammad backup is not an export from our hosted setup Full dumps for source code installations are not covered, however, basically the same below applies to you: You have to ensure that diff --git a/appendix/backup-and-restore/restore.rst b/appendix/backup-and-restore/restore.rst index 75021509..3b698361 100644 --- a/appendix/backup-and-restore/restore.rst +++ b/appendix/backup-and-restore/restore.rst @@ -17,17 +17,17 @@ your data. - The restoration process **stops & restarts** Zammad. Therefore you have to run the restore script with appropriate permissions (e.g. as ``root``). - * This is **mandatory** for *package installations* - * On *source code installations*, this does not work because of different + - This is **mandatory** for *package installations* + - On *source code installations*, this does not work because of different environments. You could load it beforehand as root user to have access to Zammad specific commands. - * If both approaches above do not fit your case, consider + - If both approaches above do not fit your case, consider adjusting the backup and restore scripts to your need in an independent directory. You're working out of script and documentation scope! -* It will drop and re-create the database! -* You require at least twice the backed up Zammad instance size of free +- It will drop and re-create the database! +- You require at least twice the backed up Zammad instance size of free storage. If you have the dump only, factor 3 could be a good number. Restore diff --git a/appendix/custom-kb-url.rst b/appendix/custom-kb-url.rst index 13534f42..75d292d5 100644 --- a/appendix/custom-kb-url.rst +++ b/appendix/custom-kb-url.rst @@ -15,8 +15,8 @@ Configure Zammad - Go to "Knowledge Base" in Zammad's admin settings and select the "Custom URL" tab - Add the URL you want to publish your knowledge base under and click the - **Submit** button -- Click on the **Web Server Configuration** button to get the configuration for + ``Submit`` button +- Click on the ``Web Server Configuration`` button to get the configuration for your NPM. You can already copy the snippet or just leave it open, it is needed for the NPM configuration. diff --git a/appendix/privacy.rst b/appendix/privacy.rst index 73a0952f..a4c95e8d 100644 --- a/appendix/privacy.rst +++ b/appendix/privacy.rst @@ -18,7 +18,7 @@ Tickets and users (*e.g.* in compliance with a β€œRight to Forget” request under the GDPR), you can use the :admin-docs:`data privacy functions ` - in the admin panel or + in the admin settings or :doc:`use the console `. Chat sessions @@ -46,7 +46,7 @@ User sessions Zammad maintains session information about every user currently logged in. This information is automatically purged when a user logs out, - and can be viewed or manually deleted via the admin panel (under **System β†’ Sessions**). + and can be viewed or manually deleted via the admin settings (under **System β†’ Sessions**). Users may also delete their own session information via the user preferences menu, under **Device**. @@ -61,7 +61,7 @@ External Services Zammad utilizes third party web services for certain functions, meaning that user data may occasionally be sent or exposed to third parties. -These functions can be individually disabled in the admin panel +These functions can be individually disabled in the admin settings under **Settings β†’ System β†’ Services**. .. note:: By default, the third party services that Zammad relies on diff --git a/appendix/reporting-tools-thirdparty.rst b/appendix/reporting-tools-thirdparty.rst index 53334115..88f9ba20 100644 --- a/appendix/reporting-tools-thirdparty.rst +++ b/appendix/reporting-tools-thirdparty.rst @@ -34,9 +34,9 @@ This guide will discuss how to set up third party reporting tools with Zammad. Getting Started --------------- -You will need +You will need: - * An instance of the reporting tool of your choice (hosted or self-hosted) +- An instance of the reporting tool of your choice (hosted or self-hosted) .. include:: reporting-tools-thirdparty/include-requirements.rst diff --git a/appendix/reporting-tools-thirdparty/grafana.rst b/appendix/reporting-tools-thirdparty/grafana.rst index 9ac29abb..f0fca8fb 100644 --- a/appendix/reporting-tools-thirdparty/grafana.rst +++ b/appendix/reporting-tools-thirdparty/grafana.rst @@ -26,11 +26,11 @@ Overview -------- **Quickly jump to...** - * `Setting up required data sources`_ - * `The Dashboards`_ + - `Setting up required data sources`_ + - `The Dashboards`_ You will need - * A Grafana 10.3+ instance (hosted or self hosted) + - A Grafana 10.3+ instance (hosted or self hosted) .. include:: include-requirements.rst @@ -159,30 +159,28 @@ Ticket statistics :alt: Screenshot showing the Ticket dashboard with demo data. This dashboard provides graphs for: - * ticket opening and closing [2]_ - * created articles - * ticket SLA (in time *and* violation) per type [2]_ [3]_ + - ticket opening and closing [2]_ + - created articles + - ticket SLA (in time *and* violation) per type [2]_ [3]_ It also contains specific ticket and article meta information: - * ticket group distribution - * sender ratio (e.g. Customer / Agent) [1]_ - * article type ratio (e.g. email, phone) [1]_ - * article content type - * escalation ratios [2]_ - * average first response, update time and close time [3]_ - * top 10 - - * organization of ticket customer [2]_ - * ticket customers [2]_ - * ticket owners [2]_ - * average accounted time on ticket - * ticket tags [2]_ - * last 10 escalated tickets + - ticket group distribution + - sender ratio (e.g. Customer / Agent) [1]_ + - article type ratio (e.g. email, phone) [1]_ + - article content type + - escalation ratios [2]_ + - average first response, update time and close time [3]_ + - organization of ticket customer [2]_ + - ticket customers [2]_ + - ticket owners [2]_ + - average accounted time on ticket + - ticket tags [2]_ + - last 10 escalated tickets Required data sources: - * ``ES - Ticket Articles`` - * ``ES - Tickets by created_at`` - * ``ES - Tickets by closed_at`` + - ``ES - Ticket Articles`` + - ``ES - Tickets by created_at`` + - ``ES - Tickets by closed_at`` .. [1] Specific reference IDs are not the same on every instance and thus the panel may not work or show incorrect data. Check the panels description @@ -203,22 +201,20 @@ Chat-Session statistics :alt: Screenshot showing the Chat dashboard with demo data. This dashboard provides graphs for: - * Chat session creations + - Chat session creations It also contains specific chat session meta information: - * top 10 - - * chat tags - * chat agents - * chat exit pages - * city origins - * chat topic ratio - * average number of messages within chat-sessions - * average chatting time - * World map with chat origin countries + - chat tags + - chat agents + - chat exit pages + - city origins + - chat topic ratio + - average number of messages within chat-sessions + - average chatting time + - World map with chat origin countries Required data sources: - * ``ES - Chat Sessions`` + - ``ES - Chat Sessions`` CTI-Log statistics ^^^^^^^^^^^^^^^^^^ @@ -231,16 +227,14 @@ CTI-Log statistics :alt: Screenshot showing the CTI dashboard with demo data. This dashboard provides graphs for: - * number of calls per direction (in / out) + - number of calls per direction (in / out) It also contains specific chat session meta information: - * call ratio (in / out) - * average waiting time - * average talking time - * top 10 - - * callers (in) - * call answerers (in) + - call ratio (in / out) + - average waiting time + - average talking time + - callers (in) + - call answerers (in) Required data sources: - * ``ES - CTI Log`` + - ``ES - CTI Log`` diff --git a/appendix/reporting-tools-thirdparty/include-requirements.rst b/appendix/reporting-tools-thirdparty/include-requirements.rst index 46f1f424..d1d53c5b 100644 --- a/appendix/reporting-tools-thirdparty/include-requirements.rst +++ b/appendix/reporting-tools-thirdparty/include-requirements.rst @@ -1,8 +1,8 @@ - * (read) access to your Elasticsearch index +- (read) access to your Elasticsearch index - .. warning:: + .. warning:: + Never expose Elasticsearch to the public if you're not sure how to + do it. Especially **never** without authentication! Zammad stores + **very sensitive** information within the Elasticsearch Index. - Never expose Elasticsearch to the public if you're not sure how to - do it. Especially **never** without authentication! Zammad stores - **very sensitive** information within the Elasticsearch Index. - * a Zammad instance (version 4 or above) that supports your use case +- a Zammad instance (version 4 or above) that supports your use case diff --git a/appendix/single-sign-on.rst b/appendix/single-sign-on.rst index f96bc23a..6156bc53 100644 --- a/appendix/single-sign-on.rst +++ b/appendix/single-sign-on.rst @@ -36,9 +36,9 @@ at ``https://your.zammad.host/auth/sso``. When the Zammad server receives a GET request at this endpoint with a valid username in **any one of the following**: -* an ``X-Forwarded-User`` request header -* a ``REMOTE_USER`` web server environment variable -* an ``HTTP_REMOTE_USER`` web server environment variable +- an ``X-Forwarded-User`` request header +- a ``REMOTE_USER`` web server environment variable +- an ``HTTP_REMOTE_USER`` web server environment variable it creates a new session for that user. @@ -76,17 +76,17 @@ Getting Started You will need: -* a Microsoft Active Directory environment with +- a Microsoft Active Directory environment with - * root access - * support for AES 256-bit encryption + - root access + - support for AES 256-bit encryption -* a Zammad host with +- a Zammad host with - * root access - * a fully-qualified domain name (FQDN) + - root access + - a fully-qualified domain name (FQDN) -* some familiarity with system administration (*e.g.,* Apache configuration) +- some familiarity with system administration (*e.g.,* Apache configuration) For best results, set up :admin-docs:`LDAP integration ` to make sure your Active Directory and Zammad user accounts @@ -543,9 +543,9 @@ Zammad users must: Troubleshooting --------------- -* Are all relevant FQDNs/hostnames reachable +- Are all relevant FQDNs/hostnames reachable from your Active Directory and Zammad servers (including each other's)? -* Are the system clocks of your Active Directory and Zammad servers synchronized +- Are the system clocks of your Active Directory and Zammad servers synchronized within five minutes of each other? (Kerberos is a time-sensitive protocol.) diff --git a/contributing/start.rst b/contributing/start.rst index 6c6a7b86..dba74e83 100644 --- a/contributing/start.rst +++ b/contributing/start.rst @@ -8,9 +8,9 @@ see below). πŸš€ You can contribute to: - * :ref:`source-code` - * :ref:`documentation` - * :ref:`translation` + - :ref:`source-code` + - :ref:`documentation` + - :ref:`translation` Please have a look on our notes on how to contribute below. @@ -35,24 +35,24 @@ branches. ``develop`` """"""""""" -* This is the current (unreleased) development state of next major release +- 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`_. +- 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`_. +- 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 +- These are the branches of old versions of Zammad like ``stable-5.1`` for Zammad 5.1. -* No support for bug or security issues is provided. +- No support for bug or security issues is provided. .. _Security Policy: https://github.com/zammad/zammad/blob/develop/SECURITY.md @@ -65,18 +65,18 @@ Do you want to contribute to the Zammad documentation? Open a new GitHub pull request at - * https://github.com/zammad/zammad-documentation (this documentation) - * https://github.com/zammad/zammad-admin-documentation - * https://github.com/zammad/zammad-user-documentation +- https://github.com/zammad/zammad-documentation (this documentation) +- https://github.com/zammad/zammad-admin-documentation +- https://github.com/zammad/zammad-user-documentation with your changes. The Zammad documentation is hosted on `Read the Docs`_. You can read it there at - * https://docs.zammad.org (this documentation) - * https://admin-docs.zammad.org - * https://user-docs.zammad.org +- https://docs.zammad.org (this documentation) +- https://admin-docs.zammad.org +- https://user-docs.zammad.org or browse the files via GitHub which also renders the used ReStructuredText markup. @@ -92,9 +92,9 @@ ReStructuredText Markup If you like to edit the docs, use the ReStructuredText markup language. Information about this language can be found at: - * http://www.sphinx-doc.org/en/stable/rest.html - * http://docutils.sourceforge.net/docs/user/rst/quickref.html - * http://docs.readthedocs.io/en/latest/_themes/sphinx_rtd_theme/demo_docs/source/demo.html +- http://www.sphinx-doc.org/en/stable/rest.html +- http://docutils.sourceforge.net/docs/user/rst/quickref.html +- http://docs.readthedocs.io/en/latest/_themes/sphinx_rtd_theme/demo_docs/source/demo.html Thanks! ❀ ❀ ❀ @@ -136,18 +136,18 @@ projects: Structure of translation projects in Weblate: -* Documentation +- Documentation - * User Documentation (latest) - * User Documentation (pre-release) - * Admin Documentation (latest) - * Admin Documentation (pre-release) + - User Documentation (latest) + - User Documentation (pre-release) + - Admin Documentation (latest) + - Admin Documentation (pre-release) -* Zammad +- Zammad - * Zammad (development version) - * Zammad (stable version) - * *Some more which aren't relevant here* + - Zammad (development version) + - Zammad (stable version) + - *Some more which aren't relevant here* .. note:: @@ -199,13 +199,13 @@ the user interface of Weblate: from the glossary are highlighted in the source strings, as well. 4. **Some useful tabs**: - * **Nearby strings**: shows you the context of the word or string - * **Automatic suggestions**: here you can find automatic suggestions from + - **Nearby strings**: shows you the context of the word or string + - **Automatic suggestions**: here you can find automatic suggestions from DeepL and suggestions from similar strings, which are already translated. Use the "*Clone to translation*" button to insert it in the translation field to apply changes. Use the "*Accept*" button to accept the suggested translation and automatically switch to the next string. - * **Other languages**: here you can get an overview, which languages are + - **Other languages**: here you can get an overview, which languages are translated and you can also see the translated strings (could be useful for languages, which are similar). diff --git a/getting-started/configure-webserver.rst b/getting-started/configure-webserver.rst index 4fcf6bb7..75c60e6f 100644 --- a/getting-started/configure-webserver.rst +++ b/getting-started/configure-webserver.rst @@ -161,9 +161,9 @@ directory and make sure to replace ``server_name localhost;`` (Nginx) or The easiest way to get certificates is to buy an annual subscription through a commercial CA, such as: - * `Sectigo (formerly Comodo)`_ - * `Secorio`_ - * `GlobalSign`_ + - `Sectigo (formerly Comodo)`_ + - `Secorio`_ + - `GlobalSign`_ (Zammad is not affiliated with these CAs in any way.) @@ -250,13 +250,13 @@ Adjusting the Webserver Configuration certificates your obtained on the prior steps. Adjust the following directives to match your setup: - * ``ssl_certificate`` (your ssl certificate) - * ``ssl_certificate_key`` (the certificates private key) - * ``ssl_trusted_certificate`` (the public CA certificate) + - ``ssl_certificate`` (your ssl certificate) + - ``ssl_certificate_key`` (the certificates private key) + - ``ssl_trusted_certificate`` (the public CA certificate) - .. note:: + .. note:: - Technically this is not a hard requirement, but recommended! + Technically this is not a hard requirement, but recommended! .. include:: /getting-started/include-dhparam-webserver.rst @@ -338,13 +338,13 @@ Adjusting the Webserver Configuration certificates your obtained on the prior steps. Adjust the following directives to match your setup: - * ``SSLCertificateFile`` (your ssl certificate) - * ``SSLCertificateKeyFile`` (the certificates private key) - * ``SSLCertificateChainFile`` (the public CA certificate) + - ``SSLCertificateFile`` (your ssl certificate) + - ``SSLCertificateKeyFile`` (the certificates private key) + - ``SSLCertificateChainFile`` (the public CA certificate) - .. note:: + .. note:: - Technically this is not a hard requirement, but recommended! + Technically this is not a hard requirement, but recommended! .. include:: /getting-started/include-dhparam-webserver.rst diff --git a/getting-started/first-steps.rst b/getting-started/first-steps.rst index cf6a2dfd..515ced4b 100644 --- a/getting-started/first-steps.rst +++ b/getting-started/first-steps.rst @@ -3,9 +3,9 @@ First Steps After successfully installing Zammad you'll have a couple of options. - * :doc:`Migrate from a supported source ` - * :ref:`Restore Zammad from an existing backup ` - * Start from scratch (move on to the next section) +- :doc:`Migrate from a supported source ` +- :ref:`Restore Zammad from an existing backup ` +- Start from scratch (move on to the next section) Getting Started Wizard ---------------------- @@ -28,9 +28,9 @@ Step 1: Create your very first administrator account Zammad does require the following password security by default: - * Password length of 10 or more - * 2 upper and 2 lower characters - * contains at least one digit + - Password length of 10 or more + - 2 upper and 2 lower characters + - contains at least one digit Step 2: Provide company information You can upload a custom logo fitting to your company here. @@ -74,19 +74,19 @@ In our opinion the next step order would like below sample. You can skip parts you don't need or adapt. All parts are described within :admin-docs:`Zammad's admin documentation `. - #. Configure your required groups - #. Adjust triggers as needed - #. Add postmaster filters if needed - #. Configure SLAs if needed - #. | add email / social media channels & signatures - | (go back to group settings to add outgoing email addresses) - #. Add Text Modules - #. Add Organizations - #. Configure roles if needed - #. Consider Third Party logins or LDAP integration for easier logins - #. Add agent accounts (users) - #. Consider backup strategies for Zammad, see - :doc:`/appendix/backup-and-restore/index` +#. Configure your required groups +#. Adjust triggers as needed +#. Add postmaster filters if needed +#. Configure SLAs if needed +#. | add email / social media channels & signatures + | (go back to group settings to add outgoing email addresses) +#. Add Text Modules +#. Add Organizations +#. Configure roles if needed +#. Consider Third Party logins or LDAP integration for easier logins +#. Add agent accounts (users) +#. Consider backup strategies for Zammad, see + :doc:`/appendix/backup-and-restore/index` From point 5 on you'll be able to work productive in theory. πŸ™Œ diff --git a/getting-started/include-dhparam-webserver.rst b/getting-started/include-dhparam-webserver.rst index 546e1b65..85e33b33 100644 --- a/getting-started/include-dhparam-webserver.rst +++ b/getting-started/include-dhparam-webserver.rst @@ -8,8 +8,8 @@ You can find the path by looking at your webserver configuration by looking for: - * ``ssl_dhparam`` directive (Nginx) - * ``SSLOpenSSLConfCmd DHParameters`` directive (Apache2) + - ``ssl_dhparam`` directive (Nginx) + - ``SSLOpenSSLConfCmd DHParameters`` directive (Apache2) .. code-block:: console diff --git a/getting-started/includes/apache-config-paths.include.rst b/getting-started/includes/apache-config-paths.include.rst index 9ac31473..12dc93f0 100644 --- a/getting-started/includes/apache-config-paths.include.rst +++ b/getting-started/includes/apache-config-paths.include.rst @@ -1,3 +1,3 @@ -* ``/etc/apache2/conf.d/`` -* ``/etc/httpd/vhosts.d/`` -* ``/etc/apache2/sites-available/`` +- ``/etc/apache2/conf.d/`` +- ``/etc/httpd/vhosts.d/`` +- ``/etc/apache2/sites-available/`` diff --git a/getting-started/includes/nginx-config-paths.include.rst b/getting-started/includes/nginx-config-paths.include.rst index 8bfdae80..1f0d502b 100644 --- a/getting-started/includes/nginx-config-paths.include.rst +++ b/getting-started/includes/nginx-config-paths.include.rst @@ -1,3 +1,3 @@ -* ``/etc/nginx/conf.d/`` -* ``/etc/nginx/vhosts.d/`` -* ``/etc/nginx/sites-available/`` +- ``/etc/nginx/conf.d/`` +- ``/etc/nginx/vhosts.d/`` +- ``/etc/nginx/sites-available/`` diff --git a/install/docker-compose.rst b/install/docker-compose.rst index a9d66009..5e1aefd4 100644 --- a/install/docker-compose.rst +++ b/install/docker-compose.rst @@ -16,10 +16,10 @@ graphical Docker front ends like Prerequisites ------------- -* This documentation expects you already have a working +- This documentation expects you already have a working `Docker Compose `_ environment. -* Make sure to have at least 4 GB of RAM to run the containers. -* Adjust your host's settings to run Elasticsearch properly: +- Make sure to have at least 4 GB of RAM to run the containers. +- Adjust your host's settings to run Elasticsearch properly: .. code-block:: console @@ -62,7 +62,7 @@ Step 2: Build From Repository :alt: Screenshot showing stack creation with necessary information Step 3: Deploy the Stack - Finally, click the **Deploy the stack** button. The first time, it may take + Finally, click the ``Deploy the stack`` button. The first time, it may take some time until the Docker images are fetched. After the stack is ready, you can access Zammad via the configured Docker diff --git a/install/docker-compose/docker-compose-scenarios.rst b/install/docker-compose/docker-compose-scenarios.rst index da081f9b..5a900480 100644 --- a/install/docker-compose/docker-compose-scenarios.rst +++ b/install/docker-compose/docker-compose-scenarios.rst @@ -49,7 +49,7 @@ General Usage :doc:`general deployment guide <../docker-compose>` and apply the following changes. - Below the "Compose path" field, click on the **Add file** button. This opens + Below the "Compose path" field, click on the ``Add file`` button. This opens the "Additional paths" section where you can specify the scenario you want to use. Add ``scenarios/{scenario you want to use}.yml`` and replace the last part in ``{}`` brackets with the name of one of the scenario files. You can diff --git a/install/elasticsearch/connect-configure-elasticsearch.rst b/install/elasticsearch/connect-configure-elasticsearch.rst index 8a0a07dd..a6b82679 100644 --- a/install/elasticsearch/connect-configure-elasticsearch.rst +++ b/install/elasticsearch/connect-configure-elasticsearch.rst @@ -9,8 +9,8 @@ Connect Zammad with Elasticsearch Before proceeding here, make sure to install Zammad before running below commands, as this will fail otherwise. -* Install from :doc:`package <../package>` -* Install with :doc:`Docker <../docker-compose>` (the default stack already includes Elasticsearch) +- Install from :doc:`package <../package>` +- Install with :doc:`Docker <../docker-compose>` (the default stack already includes Elasticsearch) .. note:: This guide uses the ``zammad run`` command prefix in command line examples. @@ -79,7 +79,7 @@ Add certificate to Zammad (Elasticsearch 8 and newer) this: .. figure:: /images/install/elasticsearch/admin-certificate-management.png - :alt: Screenshot shows certificate management in Zammad's admin panel + :alt: Screenshot shows certificate management in Zammad's admin settings :align: center .. _es-rebuild-searchindex: diff --git a/install/elasticsearch/indexed-attributes.rst b/install/elasticsearch/indexed-attributes.rst index a3554326..43a5ead3 100644 --- a/install/elasticsearch/indexed-attributes.rst +++ b/install/elasticsearch/indexed-attributes.rst @@ -17,16 +17,15 @@ fields below. .. hint:: **Below you can find some hints:** - * **(SLA)**: Attributes marked as SLA attribute are only set if the ticket is - affected by SLA calculation. Please note that some attributes may - not be set if specific conditions are not met. - - Also note that some attributes may be reset to ``null`` if no - longer applicable. - * ``note`` **attribute**: Note attributes usually are empty if not - specified via console or API. - * **Timestamps**: All timestamps provided by Zammad are UTC by default. - This also applies to times provided by Elasticsearch + - **(SLA)**: Attributes marked as SLA attribute are only set if the ticket is + affected by SLA calculation. Please note that some attributes may + not be set if specific conditions are not met. + Also note that some attributes may be reset to ``null`` if no + longer applicable. + - ``note`` **attribute**: Note attributes usually are empty if not + specified via console or API. + - **Timestamps**: All timestamps provided by Zammad are UTC by default. + This also applies to times provided by Elasticsearch Ticket ------ @@ -74,13 +73,13 @@ Ticket * - create_article_sender - Contains these attributes: - * note: ``null`` - * updated_at: ``2021-03-03T14:50:20.812Z`` - * name: ``Customer`` - * created_at: ``2021-03-03T14:50:20.812Z`` - * updated_by_id: ``1`` - * id: ``2`` - * created_by_id: ``1`` + - note: ``null`` + - updated_at: ``2021-03-03T14:50:20.812Z`` + - name: ``Customer`` + - created_at: ``2021-03-03T14:50:20.812Z`` + - updated_by_id: ``1`` + - id: ``2`` + - created_by_id: ``1`` - Sender of the article (System, Agent, Customer) * - create_article_sender_id - ``1``, ``2`` @@ -88,15 +87,15 @@ Ticket * - create_article_type - Contains these attributes: - * note: ``null`` - * updated_at: ``2021-03-03T14:50:20.812Z`` - * name: ``phone``, ``email``, ``web`` - * active: ``true`` - * created_at: ``2021-03-03T14:50:20.812Z`` - * updated_by_id: ``1`` - * id: ``5`` - * created_by_id: ``1`` - * communication: ``true``, ``false`` + - note: ``null`` + - updated_at: ``2021-03-03T14:50:20.812Z`` + - name: ``phone``, ``email``, ``web`` + - active: ``true`` + - created_at: ``2021-03-03T14:50:20.812Z`` + - updated_by_id: ``1`` + - id: ``5`` + - created_by_id: ``1`` + - communication: ``true``, ``false`` - Information of first article type and nature * - create_article_type_id @@ -124,9 +123,9 @@ Ticket - Time stamp of the next applicable escalation. One of the following attributes: - * ``close_escalation_at`` - * ``first_response_escalation_at`` - * ``update_escalation_at`` + - ``close_escalation_at`` + - ``first_response_escalation_at`` + - ``update_escalation_at`` **(SLA)** * - first_response_at @@ -346,13 +345,13 @@ Ticket State * - state_type - Contains these attributes: - * created_at: ``2021-03-03T14:50:20.582Z`` - * created_by_id: ``1`` - * id: ``4`` - * name: ``pending action`` - * note: ``null`` - * updated_at: ``2021-03-03T14:50:20.582Z`` - * updated_by_id: ``1`` + - created_at: ``2021-03-03T14:50:20.582Z`` + - created_by_id: ``1`` + - id: ``4`` + - name: ``pending action`` + - note: ``null`` + - updated_at: ``2021-03-03T14:50:20.582Z`` + - updated_by_id: ``1`` - Contains all available information of the states type * - state_type_id - ``4`` @@ -667,17 +666,17 @@ Group * - email_address - Contains these attributes: - * active: ``true`` - * channel_id: ``3`` - * created_at: ``2021-03-24T23:54:58.187Z`` - * created_by_id: ``3`` - * email: ``alias@domain.tld`` - * id: ``1`` - * note: ``null`` - * realname: ``Zammad GmbH`` - * updated_at: ``2021-03-24T23:54:58.187Z`` - * updated_by_id: ``3`` - * preferences: ``null`` + - active: ``true`` + - channel_id: ``3`` + - created_at: ``2021-03-24T23:54:58.187Z`` + - created_by_id: ``3`` + - email: ``alias@domain.tld`` + - id: ``1`` + - note: ``null`` + - realname: ``Zammad GmbH`` + - updated_at: ``2021-03-24T23:54:58.187Z`` + - updated_by_id: ``3`` + - preferences: ``null`` - Contains all available information of the groups email address * - email_address_id - ``3`` @@ -700,15 +699,15 @@ Group * - signature - Contains these attributes: - * active: ``true`` - * body: ``
#{user.firstname} #{user.lastname}
--
That Inc`` - * created_at: ``2021-03-03T14:50:19.775Z`` - * created_by_id: ``1`` - * id: ``1`` - * name: ``default`` - * note: ``null`` - * updated_at: ``2021-03-03T14:50:19.775Z`` - * updated_by_id: ``1`` + - active: ``true`` + - body: ``
#{user.firstname} #{user.lastname}
--
That Inc`` + - created_at: ``2021-03-03T14:50:19.775Z`` + - created_by_id: ``1`` + - id: ``1`` + - name: ``default`` + - note: ``null`` + - updated_at: ``2021-03-03T14:50:19.775Z`` + - updated_by_id: ``1`` - Contains all available information of the groups signature * - signature_id - ``1`` @@ -817,20 +816,20 @@ Chat Session * - chat - Contains these attributes: - * active: ``true`` - * block_country: ``null`` - * block_ip: ``null`` - * created_at: ``2021-03-03T14:50:22.607Z`` - * created_by_id: ``1`` - * id: ``1`` - * max_queue: ``5`` - * name: ``default`` - * note: ``""`` - * preferences: ``{}`` - * public: ``false`` - * updated_at: ``2021-03-03T14:50:22.607Z`` - * updated_by_id: ``1`` - * whitelisted_websites: ``null`` + - active: ``true`` + - block_country: ``null`` + - block_ip: ``null`` + - created_at: ``2021-03-03T14:50:22.607Z`` + - created_by_id: ``1`` + - id: ``1`` + - max_queue: ``5`` + - name: ``default`` + - note: ``""`` + - preferences: ``{}`` + - public: ``false`` + - updated_at: ``2021-03-03T14:50:22.607Z`` + - updated_by_id: ``1`` + - whitelisted_websites: ``null`` - Contains various preferences of the chat topic in charge * - chat_id - ``1`` @@ -847,12 +846,12 @@ Chat Session * - messages - ``(Array)`` - Array entries contain these attributes: - * chat_session_id: ``1`` - * content: ``Hello dear customer`` - * created_at: ``2021-03-25T10:26:35.977Z`` - * created_by_id: ``null``, ``3`` - * id: ``1`` - * updated_at: ``2021-03-25T10:26:35.977Z`` + - chat_session_id: ``1`` + - content: ``Hello dear customer`` + - created_at: ``2021-03-25T10:26:35.977Z`` + - created_by_id: ``null``, ``3`` + - id: ``1`` + - updated_at: ``2021-03-25T10:26:35.977Z`` - Array with all messages of chat * - name - ``null``, ``John Doe`` @@ -860,11 +859,11 @@ Chat Session * - preferences - Contains these attributes: - * dns_name: ``host.domain.tld`` - * geo_ip: ``{}`` - * participants: ``Array``, ``["47118371175780", "47118371850300"]`` - * remote_ip: ``192.168.2.19`` - * url: ``https://zammad.com/en/company/contact`` + - dns_name: ``host.domain.tld`` + - geo_ip: ``{}`` + - participants: ``Array``, ``["47118371175780", "47118371850300"]`` + - remote_ip: ``192.168.2.19`` + - url: ``https://zammad.com/en/company/contact`` - Various internal Meta data of the session_id * - session_id - ``92f2909631f1ad5ff4d5d1e046952be8`` diff --git a/install/package.rst b/install/package.rst index 10245294..f03334da 100644 --- a/install/package.rst +++ b/install/package.rst @@ -463,6 +463,6 @@ Zammad's Web-UI and getting started with it. If you expect usage with 5 agents or more you may also want to consider the following pages. - * :doc:`/appendix/environment-variables` - * :doc:`/appendix/configure-database-server` + - :doc:`/appendix/environment-variables` + - :doc:`/appendix/configure-database-server` diff --git a/install/source.rst b/install/source.rst index 2b025d57..07f263f5 100644 --- a/install/source.rst +++ b/install/source.rst @@ -7,8 +7,8 @@ The source installation is the most difficult installation type of Zammad. If you're not too experienced with Linux and system configuration and don't want to use Zammad's cloud service, try another installation type: - * :doc:`/install/package` - * :doc:`/install/docker-compose` +- :doc:`/install/package` +- :doc:`/install/docker-compose` We decided to remove the instructions to install Zammad from source from this documentation because of better alternatives for production deployments. diff --git a/migration/freshdesk.rst b/migration/freshdesk.rst index 1bb6f12a..12bb3d58 100644 --- a/migration/freshdesk.rst +++ b/migration/freshdesk.rst @@ -8,18 +8,18 @@ Please note below Freshdesk specific limitations. These are additional limitations to the :ref:`general ones listed `. - * Differential migrations are **not** supported! - The general suggestion is to run a test import before to learn - how long the migration is going to take. - * **Important:** Please note that migration speed highly depends on your - Freshdesk plan (API rate limits apply). - * Due to API limitations Zammad will not show the total number of objects - to import, but instead correct them in steps of ``100``. - * Your Freshdesk plan has to provide API support. This may not apply to all - available plans. - * User passwords are not migrated and will require the user to use the - :admin-docs:`password reset link ` - on the login page. +- Differential migrations are **not** supported! + The general suggestion is to run a test import before to learn + how long the migration is going to take. +- **Important:** Please note that migration speed highly depends on your + Freshdesk plan (API rate limits apply). +- Due to API limitations Zammad will not show the total number of objects + to import, but instead correct them in steps of ``100``. +- Your Freshdesk plan has to provide API support. This may not apply to all + available plans. +- User passwords are not migrated and will require the user to use the + :admin-docs:`password reset link ` + on the login page. Prerequisites ------------- diff --git a/migration/index.rst b/migration/index.rst index 8cf9f6b7..0be1e0a9 100644 --- a/migration/index.rst +++ b/migration/index.rst @@ -3,10 +3,10 @@ Migrating to Zammad Zammad will migrate the following information: - * Tickets and their Articles - * Groups / Queues - * Organizations - * Agents and Customers (if applicable) + - Tickets and their Articles + - Groups / Queues + - Organizations + - Agents and Customers (if applicable) After migrating to Zammad you'll want to continue with the :doc:`/getting-started/first-steps` to configure Zammad. This has to be @@ -21,11 +21,11 @@ There might be source dependent limitations which we will be covering on the dir However, these limitations count for all migrations: - * Migrations are only possible on new instances. - * Migrations are only possible from **one sources**. + - Migrations are only possible on new instances. + - Migrations are only possible from **one sources**. Several migration sources on one instance are *not* supported. - * Zammad can't migrate object types it doesn't know, migrations will fail. - * Zammad migrates **all or nothing**. This means that you can't deselect + - Zammad can't migrate object types it doesn't know, migrations will fail. + - Zammad migrates **all or nothing**. This means that you can't deselect specific information specific groups, tickets or users. Available Migration Options diff --git a/migration/kayako.rst b/migration/kayako.rst index fe66947e..2937a229 100644 --- a/migration/kayako.rst +++ b/migration/kayako.rst @@ -8,24 +8,24 @@ Please note below Kayako specific limitations. These are additional limitations to the :ref:`general ones listed `. - * Differential migrations are **not** supported! - The general suggestion is to run a test import before to learn - how long the migration is going to take. - * Self hosted installations (Kayako classic) are **not** supported. - * The following ticket field customizations are being ignored - (affects "Scale" plan): - - * Custom ticket states, - * Custom ticket priorities, and - * Custom ticket types. - - * **Important:** Please note that migration speed highly depends on your - Kayako plan (API rate limits apply). - * Your Kayako plan has to provide API support. This may not apply to all - available plans. - * User passwords are not migrated and will require the user to use the - :admin-docs:`password reset link ` - on the login page. +- Differential migrations are **not** supported! + The general suggestion is to run a test import before to learn + how long the migration is going to take. +- Self hosted installations (Kayako classic) are **not** supported. +- The following ticket field customizations are being ignored + (affects "Scale" plan): + + - Custom ticket states, + - Custom ticket priorities, and + - Custom ticket types. + +- **Important:** Please note that migration speed highly depends on your + Kayako plan (API rate limits apply). +- Your Kayako plan has to provide API support. This may not apply to all + available plans. +- User passwords are not migrated and will require the user to use the + :admin-docs:`password reset link ` + on the login page. Prerequisites ------------- diff --git a/migration/otrs.rst b/migration/otrs.rst index 5eef7662..39ecdaf0 100644 --- a/migration/otrs.rst +++ b/migration/otrs.rst @@ -7,17 +7,17 @@ Limitations Please note below OTRS specific limitations. These are additional limitations to the :ref:`general ones listed `. - * Password migration works for OTRS >= 3.3 only (on older instances, a - password reset within Zammad will be required) - * If you plan to import a differential migration after, - do not change any data in Zammad! - * Only customers of tickets are imported - * Zammad expects your OTRS timestamps to be UTC and won't adjust them - * If you plan to import a differential after, **do not** change any data in Zammad! +- Password migration works for OTRS >= 3.3 only (on older instances, a + password reset within Zammad will be required) +- If you plan to import a differential migration after, + do not change any data in Zammad! +- Only customers of tickets are imported +- Zammad expects your OTRS timestamps to be UTC and won't adjust them +- If you plan to import a differential after, **do not** change any data in Zammad! - .. note:: +.. note:: - Supported OTRS versions: **3.1** up to **6.x** + Supported OTRS versions: **3.1** up to **6.x** Prerequisites ------------- diff --git a/migration/zendesk.rst b/migration/zendesk.rst index 92339272..d5a7e0d6 100644 --- a/migration/zendesk.rst +++ b/migration/zendesk.rst @@ -8,18 +8,18 @@ Please note below Zendesk specific limitations. These are additional limitations to the :ref:`general ones listed `. - * Differential migrations are **not** supported! - The general suggestion is to run a test import before to learn - how long the migration is going to take. - * **Important:** Please note that migration speed highly depends on your - Zendesk plan (API rate limits apply). - * Your Zendesk plan has to provide API support. This may not apply to all - available plans. - * User passwords are not migrated and will require the user to use the - :admin-docs:`password reset link ` - on the login page. - * Objects with cyrillic strings can't be migrated. Make sure to rename them - before starting the migration. +- Differential migrations are **not** supported! + The general suggestion is to run a test import before to learn + how long the migration is going to take. +- **Important:** Please note that migration speed highly depends on your + Zendesk plan (API rate limits apply). +- Your Zendesk plan has to provide API support. This may not apply to all + available plans. +- User passwords are not migrated and will require the user to use the + :admin-docs:`password reset link ` + on the login page. +- Objects with cyrillic strings can't be migrated. Make sure to rename them + before starting the migration. Prerequisites ------------- diff --git a/prerequisites/hardware.rst b/prerequisites/hardware.rst index b989b745..3da04ed2 100644 --- a/prerequisites/hardware.rst +++ b/prerequisites/hardware.rst @@ -35,8 +35,8 @@ Minimum Setup For a minimalistic Zammad deployment with a PostgreSQL database server, you should not go below the following values: -* 2 CPU cores -* 6 GB of RAM (+4 GB if you want to run Elasticsearch on the same server) +- 2 CPU cores +- 6 GB of RAM (+4 GB if you want to run Elasticsearch on the same server) If you run your Elasticsearch instance on a lightweight machine like this and your RAM got exhausted, you could try a less-than-ideal solution like @@ -49,8 +49,8 @@ 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 your system. -* 6 CPU cores -* 6 GB of RAM (+6 GB if you want to run Elasticsearch on the same server) +- 6 CPU cores +- 6 GB of RAM (+6 GB if you want to run Elasticsearch on the same server) Performance Tuning ------------------ diff --git a/prerequisites/software.rst b/prerequisites/software.rst index 35aa3f61..0d3ff1e4 100644 --- a/prerequisites/software.rst +++ b/prerequisites/software.rst @@ -168,8 +168,8 @@ requests are forwarded to the application server. The following reverse proxies are supported: -* Nginx 1.3+ -* Apache 2.2+ +- Nginx 1.3+ +- Apache 2.2+ .. hint::