Merge pull request #296 from zammad/pre-release

Pre-release

admin/console.rst

@@ -51,6 +51,41 @@ This reduces loading times greatly.
 
 .. include:: /admin/console-rails-shell.include.rst
 
+.. hint:: **Starting Rails Console in Safe Mode**
+
+   Normally, starting rails console requires certain
+   :doc:`third-party services </prerequisites/software>` to be up and running.
+   You may receive errors and console will refuse to start in case they are not
+   available.
+
+   However, it's possible to start rails console in safe mode by setting
+   :ref:`a special environment variable <safe_mode>`. With
+   ``ZAMMAD_SAFE_MODE=1`` set, availability of these services will be ignored.
+
+   .. tabs::
+
+      .. code-tab:: console Package Installation
+
+         $ ZAMMAD_SAFE_MODE=1 zammad run rails c
+         Zammad is running in safe mode. Any third-party services like Redis are ignored.
+
+         There was an error trying to connect to Redis via redis://localhost:6379.
+         Please provide a Redis instance at localhost:6379 or set REDIS_URL to point to a different location.
+         ＃<Redis::CannotConnectError: Error connecting to Redis on localhost:6379 (Errno::ECONNREFUSED)>
+         Loading production environment (Rails 6.1.7.3)
+         3.1.3 :001 >
+
+      .. code-tab:: console Source Installation
+
+         $ ZAMMAD_SAFE_MODE=1 rails c
+         Zammad is running in safe mode. Any third-party services like Redis are ignored.
+
+         There was an error trying to connect to Redis via redis://localhost:6379.
+         Please provide a Redis instance at localhost:6379 or set REDIS_URL to point to a different location.
+         ＃<Redis::CannotConnectError: Error connecting to Redis on localhost:6379 (Errno::ECONNREFUSED)>
+         Loading production environment (Rails 6.1.7.3)
+         3.1.3 :001 >
+
 Working on the console
 ======================
 

appendix/configure-env-vars.rst

@@ -67,6 +67,22 @@ RAILS_LOG_TO_STDOUT
 
    Default: **unset**
 
+.. _safe_mode:
+
+ZAMMAD_SAFE_MODE
+   Ignore availability of third-party services when running Zammad commands.
+   Possible values: ``1`` or ``true``
+
+   .. warning::
+
+      **Be careful** when running Zammad commands on production systems in
+      safe mode.
+
+      While it may allow an escape hatch for certain commands, it has a
+      potential to break regular Zammad operations.
+
+   Default: **unset**
+
 .. _network_options:
 
 🖧 Network Options

prerequisites/software.rst

@@ -222,7 +222,20 @@ The following reverse proxies are supported:
 * Nginx 1.3+
 * Apache 2.2+
 
-2.7. Elasticsearch (optional)
+2.7 Redis
+~~~~~~~~~~~
+
+Starting with Zammad 6.0, `Redis <https://redis.io/>`_ is required for realtime communication
+via web socket.
+
+   .. note::
+
+      Configuration and installation is out of our scope.
+      Please follow the official vendor guides and ensure to have a
+      tight security on your installation.
+
+
+2.8. Elasticsearch (optional)
 -----------------------------
 
 Zammad uses Elasticsearch to
@@ -274,7 +287,7 @@ but search performance will be degraded, and some features will be disabled.
 An Elasticsearch plugin is required to index the contents of email attachments:
 ``ingest-attachment``.
 
-2.8. Optional tools of improved caching and distribution
+2.9. Optional tools of improved caching and distribution
 --------------------------------------------------------
 
 .. note:: **The features / integrations below were introduced by Zammad 5.0**
@@ -284,24 +297,7 @@ An Elasticsearch plugin is required to index the contents of email attachments:
 
    We consider this topic as :ref:`performance_tuning`.
 
-2.8.1 Redis
-~~~~~~~~~~~
-
-   Using `Redis <https://redis.io/>`_ allows you to store all web socket
-   information in Redis instead of your file system.
-
-      .. note::
-
-         Configuration and installation is out of our scope.
-         Please follow the official vendor guides and ensure to have a
-         tight security on your installation.
-
-      .. hint:: **Redis will become a regular dependency in Zammad 6**
-
-         Starting with Zammad 6.0, Redis will be required to operate Zammad,
-         not just as a performance optimization.
-
-2.8.2 Memcached
+2.9.1 Memcached
 ~~~~~~~~~~~~~~~
 
    Instead of storing Zammads cache files within your filesystem, you can also