zammad/bin/docker-entrypoint

#!/usr/bin/env bash

set -o errexit

# See DOCKERFILE for common environment variables required for the application to run.
#
# The following variables are only used by the docker entrypoint script.
: "${AUTOWIZARD_JSON:=''}"
: "${AUTOWIZARD_RELATIVE_PATH:='tmp/auto_wizard.json'}"
: "${ELASTICSEARCH_ENABLED:=true}"
: "${ELASTICSEARCH_HOST:=zammad-elasticsearch}"
: "${ELASTICSEARCH_PORT:=9200}"
: "${ELASTICSEARCH_SCHEMA:=http}"
: "${ELASTICSEARCH_NAMESPACE:=zammad}"
: "${ELASTICSEARCH_REINDEX:=true}"
: "${NGINX_PORT:=8080}"
: "${NGINX_CLIENT_MAX_BODY_SIZE:=50M}"
: "${NGINX_SERVER_NAME:=_}"
: "${NGINX_SERVER_SCHEME:=\$scheme}"
: "${POSTGRESQL_DB_CREATE:=true}"
: "${ZAMMAD_RAILSSERVER_HOST:=zammad-railsserver}"
: "${ZAMMAD_RAILSSERVER_PORT:=3000}"
: "${ZAMMAD_WEBSOCKET_HOST:=zammad-websocket}"
: "${ZAMMAD_WEBSOCKET_PORT:=6042}"
: "${RESTORE_DIR:=/var/tmp/zammad/restore}"

function check_no_restore_running {
  echo 'Checking for active restore operations...'
  until [ ! -d "${RESTORE_DIR}" ] || [ -z "$(ls "${RESTORE_DIR}")" ]; do
    echo "  waiting for restore to finish..."
    sleep 2
  done
}

function check_zammad_ready {
  check_no_restore_running

  echo 'Checking if Zammad is ready...'
  # Verify that migrations have been ran and seeds executed to process ENV vars like FQDN correctly.
  until bundle exec rails r 'ActiveRecord::Migration.check_all_pending!; Translation.any? || raise' &> /dev/null; do
    echo "  waiting for init container to finish install or update..."
    sleep 2
  done
}

function check_postgresql_ready {
  echo 'Checking if PostgreSQL is ready...'

  # Strip possible surrounding brackets from IPv6 addresses.
  CLEAN_POSTGRESQL_HOST=${POSTGRESQL_HOST#[}; CLEAN_POSTGRESQL_HOST=${CLEAN_POSTGRESQL_HOST%]}

  until (pg_isready -q -h "$CLEAN_POSTGRESQL_HOST" -p "$POSTGRESQL_PORT"); do
    echo "  waiting for postgresql server to be ready..."
    sleep 1
  done
}

# zammad init
if [ "$1" = 'zammad-init' ]; then
  # install / update zammad
  check_postgresql_ready

  check_no_restore_running

  # check if database exists / update to new version
  echo "initialising / updating database..."
  if ! (bundle exec rails r 'puts User.any?' 2> /dev/null | grep -q true); then
    if [ "${POSTGRESQL_DB_CREATE}" == "true" ]; then
      bundle exec rake db:create db:migrate db:seed
    else
      bundle exec rake db:migrate db:seed
    fi

    # create autowizard.json on first install
    if base64 -d <<< "${AUTOWIZARD_JSON}" &>> /dev/null; then
      echo "Saving autowizard json payload..."
      base64 -d <<< "${AUTOWIZARD_JSON}" > "${AUTOWIZARD_RELATIVE_PATH}"
    fi
  else
    echo Clearing cache...
    bundle exec rails r "Rails.cache.clear"

    echo Executing migrations...
    bundle exec rake db:migrate

    echo Synchronizing locales and translations...
    bundle exec rails r "Locale.sync; Translation.sync"
  fi

  # es config
  echo "changing settings..."
  if [ "${ELASTICSEARCH_ENABLED}" == "false" ]; then
    bundle exec rails r "Setting.set('es_url', '')"
  else
    bundle exec rails r "Setting.set('es_url', '${ELASTICSEARCH_SCHEMA}://${ELASTICSEARCH_HOST}:${ELASTICSEARCH_PORT}'); Setting.set('es_index', '${ELASTICSEARCH_NAMESPACE}')"

    if [ -n "${ELASTICSEARCH_USER}" ] && [ -n "${ELASTICSEARCH_PASS}" ]; then
      bundle exec rails r "Setting.set('es_user', \"${ELASTICSEARCH_USER}\"); Setting.set('es_password', \"${ELASTICSEARCH_PASS}\")"
    fi

    until (echo > /dev/tcp/"${ELASTICSEARCH_HOST}/${ELASTICSEARCH_PORT}") &> /dev/null; do
      echo "zammad-init waiting for elasticsearch server to be ready…"
      sleep 1
    done

    if [ "${ELASTICSEARCH_REINDEX}" == "true" ]; then
      if bundle exec rails r "SearchIndexBackend.index_exists?('Ticket') || exit(1)"
      then
        echo "Elasticsearch index exists, no automatic reindexing is needed."
      else
        echo "Elasticsearch index does not exist yet, create it now…"
        bundle exec rake zammad:searchindex:rebuild
      fi
    fi
  fi

# zammad nginx
elif [ "$1" = 'zammad-nginx' ]; then
  check_zammad_ready

  # configure nginx

  # Ensure that nginx has a short TTL so that recreated containers with new IP addresses are found.
  NAMESERVER=$(grep "^nameserver" --max-count 1 < /etc/resolv.conf | awk '{print $2}')
  echo "resolver $NAMESERVER valid=5s;" > /etc/nginx/conf.d/resolver.conf

  # Inject docker related settings into the nginx configuration.
  #
  # There is a workaround needed to support DNS resolution of upstream container names with short TTL:
  #   we set the proxy pass directly with a variable including the URL (!), rather than just referring to the
  #   upstream {} definition. For details, see https://tenzer.dk/nginx-with-dynamic-upstreams/.
  sed -e "s#\(listen\)\(.*\)80#\1\2${NGINX_PORT}#g" \
      -e "s#proxy_set_header X-Forwarded-Proto .*;#proxy_set_header X-Forwarded-Proto ${NGINX_SERVER_SCHEME};#g" \
      -e "s#proxy_pass http://zammad-railsserver;#set \$zammad_railsserver_url http://${ZAMMAD_RAILSSERVER_HOST}:${ZAMMAD_RAILSSERVER_PORT}; proxy_pass \$zammad_railsserver_url;#g" \
      -e "s#proxy_pass http://zammad-websocket;#set \$zammad_websocket_url http://${ZAMMAD_WEBSOCKET_HOST}:${ZAMMAD_WEBSOCKET_PORT}; proxy_pass \$zammad_websocket_url;#g" \
      -e "s#server_name .*#server_name ${NGINX_SERVER_NAME};#g" \
      -e "s#client_max_body_size .*#client_max_body_size ${NGINX_CLIENT_MAX_BODY_SIZE};#g" \
      -e 's#/var/log/nginx/zammad.\(access\|error\).log#/dev/stdout#g' < contrib/nginx/zammad.conf > /etc/nginx/sites-enabled/default

  #
  # Once we can use an nginx version >= 1.27.3, we can drop the proxy_pass workaround above and
  #   use the new dedicated syntax for configuring resolver usage on the upstream definitions directly:
  #
      #-e "s#server .*:3000#server ${ZAMMAD_RAILSSERVER_HOST}:${ZAMMAD_RAILSSERVER_PORT} resolve#g" \
      #-e "s#server .*:6042#server ${ZAMMAD_WEBSOCKET_HOST}:${ZAMMAD_WEBSOCKET_PORT} resolve#g" \

  echo "starting nginx..."

  exec /usr/sbin/nginx -g 'daemon off;'

# zammad-railsserver
elif [ "$1" = 'zammad-railsserver' ]; then
  check_zammad_ready

  echo "starting railsserver..."

  #shellcheck disable=SC2101
  exec bundle exec puma -b tcp://[::]:"${ZAMMAD_RAILSSERVER_PORT}" -e "${RAILS_ENV}"

# zammad-scheduler
elif [ "$1" = 'zammad-scheduler' ]; then
  check_zammad_ready

  echo "starting background services..."

  exec bundle exec script/background-worker.rb start

# zammad-websocket
elif [ "$1" = 'zammad-websocket' ]; then
  check_zammad_ready

  echo "starting websocket server..."

  exec bundle exec script/websocket-server.rb -b 0.0.0.0 -p "${ZAMMAD_WEBSOCKET_PORT}" start

# zammad-backup
elif [ "$1" = 'zammad-backup' ]; then
  check_postgresql_ready

  # Handles backup and restore operations.
  exec contrib/docker/backup.sh

# Pass all other container commands to shell
else
  exec "$@"
fi