From fccd18cc8c4d3d3349ba52f62602f26da5ceb9bb Mon Sep 17 00:00:00 2001 From: Ralf Schmid Date: Wed, 3 Dec 2025 16:32:44 +0100 Subject: [PATCH 1/6] WIP: added proxy page --- appendix/proxy.rst | 61 ++++++++++++++++++++++++++++++++++++++++++++++ index.rst | 1 + 2 files changed, 62 insertions(+) create mode 100644 appendix/proxy.rst diff --git a/appendix/proxy.rst b/appendix/proxy.rst new file mode 100644 index 00000000..aab5f4a1 --- /dev/null +++ b/appendix/proxy.rst @@ -0,0 +1,61 @@ +Proxy and Connections +====================== + +If you want to route Zammad's traffic over a proxy, you can find information +about it on this page. + +Proxy Variables +--------------- + +The following environment variables can be used to configure proxy settings. +Set it the way you want and adjust the values to your use case: + +.. code-block:: sh + + export HTTP_PROXY="http://127.0.0.1:8080" + +.. code-block:: sh + + export HTTPS_PROXY="http://127.0.0.1:8080" + +.. code-block:: sh + + export ES_JAVA_OPTS="-Dhttp.proxyHost=127.0.0.1 -Dhttp.proxyPort=8080 -Dhttps.proxyHost=127.0.0.1 -Dhttps.proxyPort=8080" + +Download Dependencies +--------------------- + +During installation and operation of Zammad, some connections to online services +are required. Depending on your installation method and Zammad configuration, +a connection to the following services is made: + +.. csv-table:: + :header: "Address", "Comment" + :widths: 40, 70 + + "artifacts.elastic.co", "Download of the ingest plugin (only ES < 8)" + "dl.packager.io", "Download of OS package (package installation)" + "go.packager.io", "As above; new package hosting service" + "geo.zammad.com", "Used for geo data" + "google.com", "Download of feast days for the calendar" + "index.rubygems.org", "Download of gems for ruby" + "registry.npmjs.org", "Download of js dependencies" + +Test Script +----------- + +You can use a script to check the connection state of your system. Run it either +by fetching it from the Zammad repository or by executing the local version on +your Zammad machine: + +Remote: + +.. code-block:: sh + + curl -fsSL https://raw.githubusercontent.com/zammad/zammad/refs/heads/stable/contrib/packager.io/test_download_dependencies_connection.sh | sh + +Local: + +.. code-block:: sh + + /opt/zammad/contrib/packager.io/test_download_dependencies_connection.sh diff --git a/index.rst b/index.rst index 7b0601fd..8ee61ba4 100644 --- a/index.rst +++ b/index.rst @@ -97,6 +97,7 @@ Zammad System Documentation /appendix/configure-database-server /appendix/migrate-to-postgresql /appendix/privacy + /appendix/proxy /appendix/single-sign-on /appendix/reporting-tools-thirdparty /appendix/redis From ead75bf37bbc00223197b21b6c580d361d979a38 Mon Sep 17 00:00:00 2001 From: Ralf Schmid Date: Thu, 4 Dec 2025 09:51:13 +0100 Subject: [PATCH 2/6] Small changes --- appendix/proxy.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/appendix/proxy.rst b/appendix/proxy.rst index aab5f4a1..8673f417 100644 --- a/appendix/proxy.rst +++ b/appendix/proxy.rst @@ -59,3 +59,7 @@ Local: .. code-block:: sh /opt/zammad/contrib/packager.io/test_download_dependencies_connection.sh + +This script will try to connect to the services mentioned above and show the +results. If everything is fine, you should see a checkmark for each contacted +service. From 9699a38220fea5c5befc84a227c5626b14b31f98 Mon Sep 17 00:00:00 2001 From: Ralf Schmid Date: Thu, 4 Dec 2025 10:03:26 +0100 Subject: [PATCH 3/6] Added firewall hint --- appendix/proxy.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/appendix/proxy.rst b/appendix/proxy.rst index 8673f417..134dc659 100644 --- a/appendix/proxy.rst +++ b/appendix/proxy.rst @@ -27,7 +27,8 @@ Download Dependencies During installation and operation of Zammad, some connections to online services are required. Depending on your installation method and Zammad configuration, -a connection to the following services is made: +a connection to the following services is made (maybe also helpful for firewall +configuration):: .. csv-table:: :header: "Address", "Comment" From e6a6006aeca38dd0ef51feb46766f7a90d60da58 Mon Sep 17 00:00:00 2001 From: Ralf Schmid Date: Thu, 4 Dec 2025 10:04:53 +0100 Subject: [PATCH 4/6] Fixed double colons --- appendix/proxy.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/appendix/proxy.rst b/appendix/proxy.rst index 134dc659..3d46016a 100644 --- a/appendix/proxy.rst +++ b/appendix/proxy.rst @@ -28,7 +28,7 @@ Download Dependencies During installation and operation of Zammad, some connections to online services are required. Depending on your installation method and Zammad configuration, a connection to the following services is made (maybe also helpful for firewall -configuration):: +configuration): .. csv-table:: :header: "Address", "Comment" From ff1aca63ef2afa7aa4f5f02dd658dd8ff01ab4b0 Mon Sep 17 00:00:00 2001 From: Ralf Schmid Date: Thu, 4 Dec 2025 13:54:44 +0100 Subject: [PATCH 5/6] Added lower case variables --- appendix/proxy.rst | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/appendix/proxy.rst b/appendix/proxy.rst index 3d46016a..0f295c3c 100644 --- a/appendix/proxy.rst +++ b/appendix/proxy.rst @@ -22,6 +22,16 @@ Set it the way you want and adjust the values to your use case: export ES_JAVA_OPTS="-Dhttp.proxyHost=127.0.0.1 -Dhttp.proxyPort=8080 -Dhttps.proxyHost=127.0.0.1 -Dhttps.proxyPort=8080" +.. hint:: + Depending on your environment, you might want to use the lower case variants + of the variables as well. If in doubt, set both variants, e.g. like that: + + .. code-block:: sh + + export HTTP_PROXY=$http_proxy + export HTTPS_PROXY=$https_proxy + export ES_JAVA_OPTS=$es_java_opts + Download Dependencies --------------------- From 1161e8a215d5e6c2842f7aacc76fc38f4bb67fc3 Mon Sep 17 00:00:00 2001 From: Ralf Schmid Date: Wed, 10 Dec 2025 14:30:08 +0100 Subject: [PATCH 6/6] Fixed lower case variants --- appendix/proxy.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/appendix/proxy.rst b/appendix/proxy.rst index 0f295c3c..dc83bd0b 100644 --- a/appendix/proxy.rst +++ b/appendix/proxy.rst @@ -28,9 +28,9 @@ Set it the way you want and adjust the values to your use case: .. code-block:: sh - export HTTP_PROXY=$http_proxy - export HTTPS_PROXY=$https_proxy - export ES_JAVA_OPTS=$es_java_opts + export http_proxy=$HTTP_PROXY + export https_proxy=$HTTPS_PROXY + export es_java_opts=$ES_JAVA_OPTS Download Dependencies ---------------------