Fixes #312 - PGP: Add GnuPG to the server requirements

* Added GnuPG in software prerequisites * Changed GnuPG prerequisite * Added GPG_PATH
zammad · Jul 26, 2023 · b362290 · b362290
1 parent f1b8069
commit b362290
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 0 deletions.
diff --git a/appendix/configure-env-vars.rst b/appendix/configure-env-vars.rst
@@ -55,6 +55,18 @@ APP_RESTART_CMD
       that you have to allow the Zammad user via e.g. ``sudoers`` to run
       the required restart command.
 
+GPG_PATH
+   Defines the path to the GPG installation.
+
+   Default: **unset**
+
+   .. note::
+
+      Define the path if you installed Zammad from Source, if you want to use
+      different versions of PGP on your machine or if your PGP installation
+      differs from the standard installation.
+
+
 RAILS_LOG_TO_STDOUT
    Print output directly to standard output
    instead of ``/var/log/zammad/production.log``.

diff --git a/prerequisites/software.rst b/prerequisites/software.rst
@@ -309,3 +309,11 @@ An Elasticsearch plugin is required to index the contents of email attachments:
          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.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-Tools.
+Please have a look at the official `GnuPG website`_.
+
+.. _GnuPG website: https://www.gnupg.org/index.html