Modularize docker stack: allow loading of addiditional scenarios (#467)

* Modularize docker stack: allow loading of addiditional scenarios
* Activate elasticsearch security / authentication

Author: mgruner

.env.dist

@@ -1,10 +1,35 @@
+#############################################
 # Docker Environment Variables
 # https://docs.zammad.org/en/latest/install/docker-compose/environment.html
+#############################################
 
-# ELASTICSEARCH_VERSION=8.17.1
+#############################################
+# docker-compose.yml - These variables only need to be set if they do not have the default value.
+#############################################
+
+# RESTART=always
+
+# Use a fixed Zammad version rather than the default. If you do so,
+#   you are responsible to update this to newer patch level versions yourself.
+# VERSION=6.4.1-45
+# You can also use floating versions that will give you automatic updates:
+# VERSION=6.2     # all patchlevel updates
+# VERSION=6       # including minor updates
+# VERSION=latest  # all updates of stable versions, including major
+# VERSION=develop # bleeding-edge development version
 # IMAGE_REPO=ghcr.io/zammad/zammad
+
+# ELASTICSEARCH_VERSION=8.17.1
 # MEMCACHE_SERVERS=zammad-memcached:11211
 # MEMCACHE_VERSION=1.6.36-alpine
+# REDIS_URL=redis://zammad-redis:6379
+# REDIS_VERSION=7.4.2-alpine
+# POSTGRES_VERSION=17.2-alpine
+
+# RAILS_TRUSTED_PROXIES=
+# ZAMMAD_HTTP_TYPE=
+# ZAMMAD_FQDN=
+
 # NGINX_PORT=8080
 # NGINX_EXPOSE_PORT=8080
 # NGINX_CLIENT_MAX_BODY_SIZE=50M
@@ -13,15 +38,46 @@
 # POSTGRES_USER=zammad
 # POSTGRES_HOST=zammad-postgresql
 # POSTGRES_PORT=5432
-# POSTGRES_VERSION=17.2-alpine
 # POSTGRESQL_OPTIONS=?pool=50
-# REDIS_URL=redis://zammad-redis:6379
-# REDIS_VERSION=7.4.2-alpine
-# RESTART=always
-# Use a fixed version. You are responsible to update this to newer patch level versions yourself.
-# VERSION=6.4.1-45
-# You can also use floating versions that will give you automatic updates:
-# VERSION=6.2     # all patchlevel updates
-# VERSION=6       # including minor updates
-# VERSION=latest  # all updates of stable versions, including major
-# VERSION=develop # bleeding-edge development version
+
+# ELASTICSEARCH_SCHEMA=http
+# ELASTICSEARCH_HOST=zammad-elasticsearch
+# ELASTICSEARCH_PORT=9200
+# ELASTICSEARCH_USER=elastic
+# ELASTICSEARCH_PASS=zammad
+# ELASTICSEARCH_NAMESPACE=zammad
+# ELASTICSEARCH_REINDEX=true
+
+# Variables used by ngingx-proxy container for reverse proxy creations,
+#   for docs refer to https://github.com/nginx-proxy/nginx-proxy.
+# VIRTUAL_HOST=
+# VIRTUAL_PORT=
+# Variables used by acme-companion for retrieval of LetsEncrypt certificate,
+#   for docs refer to https://github.com/nginx-proxy/acme-companion.
+# LETSENCRYPT_HOST=
+# LETSENCRYPT_EMAIL=
+
+#############################################
+# scenarios/add-cloudflare-tunnel.yml
+#############################################
+
+# CLOUDFLARE_TUNNEL_TOKEN=mytoken
+
+#############################################
+# scenarios/add-external-network-to-nginx.yml
+#############################################
+
+# ZAMMAD_NGINX_EXTERNAL_NETWORK=mynetwork
+
+#############################################
+# scenarios/add-external-network-to-elasticsearch.yml
+#############################################
+
+# ZAMMAD_ELASTICSEARCH_EXTERNAL_NETWORK=mynetwork
+
+#############################################
+# scenarios/add-hostport-to-elasticsearch.yml
+#############################################
+
+# Defaults to 9200, set this if you need another value.
+# ELASTICSEARCH_EXPOSE_HTTP_PORT=9200

.examples/proxy/certs/.gitkeep

@@ -0,0 +1,4 @@
+---
+rules:
+  line-length:
+    max: 120

.examples/proxy/docker-compose.proxy-example.yml

@@ -0,0 +1,10 @@
+#!/bin/sh
+
+# shellcheck source=/dev/null
+. "$(dirname "$0")/include/functions.sh"
+
+check_stack_start
+
+print_heading "check for presence cloudflare tunnel container"
+docker compose ps | grep cloudflare-tunnel
+print_heading "Success - cloudflare container is present"

.examples/proxy/docker-compose.yml

@@ -0,0 +1,10 @@
+#!/bin/sh
+
+# shellcheck source=/dev/null
+. "$(dirname "$0")/include/functions.sh"
+
+check_stack_start
+
+print_heading "check for presence of external network"
+docker inspect zammad-docker-compose-zammad-elasticsearch-1 | grep zammad-ci-external-network
+print_heading "Success - external network is present"

.github/linters/.yaml-lint.yml

@@ -0,0 +1,14 @@
+#!/bin/sh
+
+# shellcheck source=/dev/null
+. "$(dirname "$0")/include/functions.sh"
+
+check_stack_start
+
+print_heading "check for presence of external network"
+docker inspect zammad-docker-compose-zammad-nginx-1 | grep zammad-ci-external-network
+print_heading "Success - external network is present"
+
+print_heading "check that nginx is not exposed on the Host"
+docker inspect zammad-docker-compose-zammad-nginx-1 | grep HostPort && exit 1
+print_heading "Success - nginx is not exposed on the host"

.github/tests/add-cloudflare-tunnel.sh

@@ -0,0 +1,10 @@
+#!/bin/sh
+
+# shellcheck source=/dev/null
+. "$(dirname "$0")/include/functions.sh"
+
+check_stack_start
+
+print_heading "check for hostport"
+docker inspect zammad-docker-compose-zammad-elasticsearch-1 | grep HostPort | grep 9201
+print_heading "Success - hostport is present"

.github/tests/add-external-network-to-elasticsearch.sh

@@ -0,0 +1,10 @@
+#!/bin/sh
+
+# shellcheck source=/dev/null
+. "$(dirname "$0")/include/functions.sh"
+
+check_stack_start
+
+print_heading "check for presence nginx-proxy-manager container"
+docker compose ps | grep nginx-proxy-manager
+print_heading "Success - nginx-proxy-manager container is present"