#!/usr/bin/env bash # shellcheck shell=bash # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ##@Version : 202308230218-git # @@Author : Jason Hempstead # @@Contact : jason@casjaysdev.pro # @@License : WTFPL # @@ReadME : docker-entrypoint --help # @@Copyright : Copyright: (c) 2023 Jason Hempstead, Casjays Developments # @@Created : Wednesday, Aug 23, 2023 02:18 EDT # @@File : docker-entrypoint # @@Description : # @@Changelog : New script # @@TODO : Better documentation # @@Other : # @@Resource : # @@Terminal App : no # @@sudo/root : no # @@Template : other/docker-entrypoint # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - # shellcheck disable=SC2016 # shellcheck disable=SC2031 # shellcheck disable=SC2120 # shellcheck disable=SC2155 # shellcheck disable=SC2199 # shellcheck disable=SC2317 # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - # Set bash options CONTAINER_NAME="couchdb" SCRIPT_NAME="$(basename "$0" 2>/dev/null)" [ "$DEBUGGER" = "on" ] && echo "Enabling debugging" && set -o pipefail -x$DEBUGGER_OPTIONS || set -o pipefail # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - # remove whitespaces from beginning argument while :; do [ "$1" = " " ] && shift 1 || break; done # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - [ "$1" = "$0" ] && shift 1 [ "$1" = "$SCRIPT_NAME" ] && shift 1 # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - # import the functions file if [ -f "/usr/local/etc/docker/functions/entrypoint.sh" ]; then . "/usr/local/etc/docker/functions/entrypoint.sh" else echo "Can not load functions from /usr/local/etc/docker/functions/entrypoint.sh" exit 1 fi # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - # Create the default env files __create_env_file "/config/env/default.sh" "/root/env.sh" &>/dev/null # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - # import variables from files for set_env in "/root/env.sh" "/usr/local/etc/docker/env"/*.sh "/config/env"/*.sh; do [ -f "$set_env" ] && . "$set_env" done # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - # Builtin functions __is_dir_empty() { [ "$(ls -A "$1" 2>/dev/null | wc -l)" -eq 0 ] && return 0 || return 1; } # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - # Custom functions # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - # Define script variables SERVICE_USER="root" # execute command as another user SERVICE_GROUP="" # Set user group for permission fix SERVICE_UID="0" # set the user id for creation of user SERVICE_PORT="" # specifiy port which service is listening on # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - # Healthcheck variables HEALTH_ENABLED="yes" # enable healthcheck [yes/no] SERVICES_LIST="tini" # comma seperated list of processes for the healthcheck SERVER_PORTS="" # ports : 80,443 HEALTH_ENDPOINTS="" # url endpoints: [http://localhost/health,http://localhost/test] # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - # Additional PHP_INI_DIR="${PHP_INI_DIR:-$(__find_php_ini)}" PHP_BIN_DIR="${PHP_BIN_DIR:-$(__find_php_bin)}" HTTPD_CONFIG_FILE="${HTTPD_CONFIG_FILE:-$(__find_httpd_conf)}" NGINX_CONFIG_FILE="${NGINX_CONFIG_FILE:-$(__find_nginx_conf)}" MYSQL_CONFIG_FILE="${MYSQL_CONFIG_FILE:-$(__find_mysql_conf)}" PGSQL_CONFIG_FILE="${PGSQL_CONFIG_FILE:-$(__find_pgsql_conf)}" MONGODB_CONFIG_FILE="${MONGODB_CONFIG_FILE:-$(__find_mongodb_conf)}" # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - # Overwrite variables # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - __run_message() { return } # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - # variables based on env/files [ "$SERVICE_PORT" = "443" ] && SSL_ENABLED="true" [ -f "/config/enable/ssl" ] && SSL_ENABLED="true" [ -f "/config/enable/ssh" ] && SSH_ENABLED="true" # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - # export variables # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - # is already Initialized [ -f "$ENTRYPOINT_DATA_INIT_FILE" ] && DATA_DIR_INITIALIZED="true" || DATA_DIR_INITIALIZED="false" [ -f "$ENTRYPOINT_CONFIG_INIT_FILE" ] && CONFIG_DIR_INITIALIZED="true" || CONFIG_DIR_INITIALIZED="false" { [ -f "$ENTRYPOINT_PID_FILE" ] || [ -f "$ENTRYPOINT_INIT_FILE" ]; } && ENTRYPOINT_FIRST_RUN="no" || ENTRYPOINT_FIRST_RUN="true" # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - # Default directories BACKUP_DIR="${BACKUP_DIR:-/data/backups}" LOCAL_BIN_DIR="${LOCAL_BIN_DIR:-/usr/local/bin}" WWW_ROOT_DIR="${WWW_ROOT_DIR:-/usr/share/webapps}" DEFAULT_DATA_DIR="${DEFAULT_DATA_DIR:-/usr/local/share/template-files/data}" DEFAULT_CONF_DIR="${DEFAULT_CONF_DIR:-/usr/local/share/template-files/config}" DEFAULT_TEMPLATE_DIR="${DEFAULT_TEMPLATE_DIR:-/usr/local/share/template-files/defaults}" # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - # Rewrite base on env WWW_DIR="${ENV_WWW_DIR:-$WWW_DIR}" # set default web dir WWW_ROOT_DIR="${WWW_DIR:-$WWW_ROOT_DIR}" # set default web dir DATABASE_DIR="${ENV_DATABASE_DIR:-$DATABASE_DIR}" # set database dir # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - # clean ENV_PORTS variables ENV_PORTS="${ENV_PORTS//,/ }" # ENV_PORTS="${ENV_PORTS//\/*/}" # # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - # clean SERVER_PORTS variables SERVER_PORTS="${SERVER_PORTS//,/ }" # SERVER_PORTS="${SERVER_PORTS//\/*/}" # # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - # clean WEB_SERVER_PORTS variables WEB_SERVER_PORTS="${SERVICE_PORT//\/*/}" # WEB_SERVER_PORTS="${WEB_SERVER_PORTS//\/*/}" # WEB_SERVER_PORTS="${SERVICE_PORT//,/ } ${WEB_SERVER_PORTS//,/ }" # # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - # rewrite and merge variables ENV_PORTS="$(echo "$ENV_PORTS" | tr ' ' '\n' | sort -u | grep -v '^$' | tr '\n' ' ' | grep '^' || false)" WEB_SERVER_PORTS="$(echo "$WEB_SERVER_PORTS" | tr ' ' '\n' | sort -u | grep -v '^$' | tr '\n' ' ' | grep '^' || false)" ENV_PORTS="$(echo "$SERVER_PORTS" "$WEB_SERVER_PORTS" "$ENV_PORTS" "$SERVER_PORTS" | tr ' ' '\n' | sort -u | grep -v '^$' | tr '\n' ' ' | grep '^' || false)" # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - # HEALTH_ENDPOINTS="${HEALTH_ENDPOINTS//,/ }" # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - # create required directories mkdir -p "/run" mkdir -p "/tmp" mkdir -p "/root" mkdir -p "/var/run" mkdir -p "/var/tmp" mkdir -p "/run/cron" mkdir -p "/data/logs" mkdir -p "/run/init.d" mkdir -p "/config/enable" mkdir -p "/config/secure" # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - # create required files touch "/data/logs/entrypoint.log" # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - # fix permissions chmod -f 777 "/run" chmod -f 777 "/tmp" chmod -f 700 "/root" chmod -f 777 "/var/run" chmod -f 777 "/var/tmp" chmod -f 777 "/run/cron" chmod -f 777 "/data/logs" chmod -f 777 "/run/init.d" chmod -f 666 "/dev/stderr" chmod -f 666 "/dev/stdout" chmod -f 777 "/config/enable" chmod -f 777 "/config/secure" chmod -f 777 "/data/logs/entrypoint.log" ################## END OF CONFIGURATION ##################### # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - # Create the backup dir [ -n "$BACKUP_DIR" ] && { [ -d "$BACKUP_DIR" ] || mkdir -p "$BACKUP_DIR"; } # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - if [ "$ENTRYPOINT_FIRST_RUN" != "no" ]; then # Show start message if [ "$CONFIG_DIR_INITIALIZED" = "false" ] || [ "$DATA_DIR_INITIALIZED" = "false" ]; then [ "$ENTRYPOINT_MESSAGE" = "yes" ] && echo "Executing entrypoint script for couchdb" fi # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - # Set reusable variables { { [ -w "/etc" ] && [ ! -e "/etc/hosts" ]; } || [ -w "/etc/hosts" ]; } && UPDATE_FILE_HOSTS="true" { { [ -w "/etc" ] && [ ! -e "/etc/timezone" ]; } || [ -w "/etc/timezone" ]; } && UPDATE_FILE_TZ="true" { { [ -w "/etc" ] && [ ! -e "/etc/resolv.conf" ]; } || [ -w "/etc/resolv.conf" ]; } && UPDATE_FILE_RESOLV="true" # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - # Set timezone [ -n "$TZ" ] && [ "$UPDATE_FILE_TZ" = "true" ] && echo "$TZ" >"/etc/timezone" [ -f "/usr/share/zoneinfo/$TZ" ] && [ "$UPDATE_FILE_TZ" = "true" ] && ln -sf "/usr/share/zoneinfo/$TZ" "/etc/localtime" # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - # if ipv6 add it to /etc/hosts if [ "$UPDATE_FILE_HOSTS" = "true" ]; then echo "# known hostname mappings" >"/etc/hosts" if [ -n "$(ip a 2>/dev/null | grep 'inet6.*::' || ifconfig 2>/dev/null | grep 'inet6.*::')" ]; then echo "127.0.0.1 localhost" >>"/etc/hosts" echo "::1 localhost" >>"/etc/hosts" else echo "127.0.0.1 localhost" >>"/etc/hosts" fi fi # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - # add .home domain if [ "$UPDATE_FILE_HOSTS" = "true" ] && [ -n "$HOSTNAME" ]; then __grep_test " $HOSTNAME" "/etc/hosts" || echo "${CONTAINER_IP4_ADDRESS:-127.0.0.1} $HOSTNAME" >>"/etc/hosts" __grep_test " ${HOSTNAME%%.*}.home" "/etc/hosts" || echo "${CONTAINER_IP4_ADDRESS:-127.0.0.1} ${HOSTNAME%%.*}.home" >>"/etc/hosts" fi # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - # add domainname if [ "$UPDATE_FILE_HOSTS" = "true" ] && [ "$DOMAINNAME" != "home" ] && [ -n "$DOMAINNAME" ] && [ "$HOSTNAME.$DOMAINNAME" != "$DOMAINNAME" ]; then __grep_test " $HOSTNAME.$DOMAINNAME" "/etc/hosts" || echo "${CONTAINER_IP4_ADDRESS:-127.0.0.1} $HOSTNAME.$DOMAINNAME" >>"/etc/hosts" fi # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - # Set containers hostname [ -n "$HOSTNAME" ] && [ "$UPDATE_FILE_HOSTS" = "true" ] && echo "$HOSTNAME" >"/etc/hostname" # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - # Set containers hostname with domain [ -n "$DOMAINNAME" ] && [ "$UPDATE_FILE_HOSTS" = "true" ] && echo "$HOSTNAME.$DOMAINNAME" >"/etc/hostname" # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - if [ -f "/etc/hostname" ]; then [ -n "$(type -P hostname)" ] && hostname -F "/etc/hostname" &>/dev/null || HOSTNAME="$(<"/etc/hostname")" export HOSTNAME fi # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - # import hosts file into container [ -f "/usr/local/etc/hosts" ] && [ "$UPDATE_FILE_HOSTS" = "true" ] && cat "/usr/local/etc/hosts" | grep -vF "$HOSTNAME" >>"/etc/hosts" # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - # import resolv.conf file into container [ "$CUSTOM_DNS" != "true" ] && [ -f "/usr/local/etc/resolv.conf" ] && [ "$UPDATE_FILE_RESOLV" = "true" ] && cat "/usr/local/etc/resolv.conf" >"/etc/resolv.conf" # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - if [ -d "/usr/local/etc/skel" ]; then cp -Rf "/usr/local/etc/skel/." "$HOME/" fi # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - fi # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - # Delete any .gitkeep files [ -d "/data" ] && rm -Rf "/data/.gitkeep" "/data"/*/*.gitkeep [ -d "/config" ] && rm -Rf "/config/.gitkeep" "/config"/*/*.gitkeep [ -f "/usr/local/bin/.gitkeep" ] && rm -Rf "/usr/local/bin/.gitkeep" # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - # Setup bin directory __initialize_custom_bin_dir # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - # Copy default config __initialize_default_templates # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - # Copy custom config files __initialize_config_dir # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - # Copy custom data files __initialize_data_dir # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - # Replace variables before copying to system __initialize_replace_variables "/config" # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - # Copy /config to /etc __initialize_system_etc # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - # Copy html files __initialize_www_root # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - __initialize_ssl_certs # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - # run pre-execute function __run_pre "$@" # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - if [ -f "$ENTRYPOINT_PID_FILE" ] || [ -f "$ENTRYPOINT_INIT_FILE" ]; then START_SERVICES="no" ENTRYPOINT_MESSAGE="no" ENTRYPOINT_FIRST_RUN="no" touch "$ENTRYPOINT_PID_FILE" elif [ -d "/config" ]; then echo "$$" >"$ENTRYPOINT_PID_FILE" echo "Initialized on: $INIT_DATE" >"$ENTRYPOINT_INIT_FILE" fi # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - # Check if this is a new container if [ -f "$ENTRYPOINT_DATA_INIT_FILE" ]; then DATA_DIR_INITIALIZED="true" elif [ -d "/data" ]; then echo "Initialized on: $INIT_DATE" >"$ENTRYPOINT_DATA_INIT_FILE" fi # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - if [ -f "$ENTRYPOINT_CONFIG_INIT_FILE" ]; then CONFIG_DIR_INITIALIZED="true" elif [ -d "/config" ]; then echo "Initialized on: $INIT_DATE" >"$ENTRYPOINT_CONFIG_INIT_FILE" fi # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - if [ "$ENTRYPOINT_FIRST_RUN" != "no" ]; then # setup the smtp server __setup_mta fi # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - [ "$ENTRYPOINT_MESSAGE" = "yes" ] && echo "Container ip address is: $CONTAINER_IP4_ADDRESS" # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - # Show configured listing processes if [ "$ENTRYPOINT_MESSAGE" = "yes" ] && [ -n "$ENV_PORTS" ]; then show_port="" for port in $ENV_PORTS; do [ -n "$port" ] && show_port+="$(printf '%s ' "${port// /}") "; done printf '%s\n' "The following ports are open: $show_port" unset port show_port fi # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - # Show message __run_message # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - # execute init script if [ -f "/tmp/init" ]; then sh "/tmp/init"; fi # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - # Just start services START_SERVICES="${START_SERVICES:-SYSTEM_INIT}" # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - # Begin options case "$1" in --help) # Help message echo 'Docker container for '$APPNAME'' echo "Usage: $APPNAME [cron exec start init shell certbot ssl procs ports healthcheck backup command]" echo "" exit 0 ;; init) shift 1 echo "Container has been Initialized" exit 0 ;; cron) shift 1 __cron "$@" & ;; backup) # backup data and config dirs shift 1 save="${1:-$BACKUP_DIR}" backupExit=0 date="$(date '+%Y%m%d-%H%M')" file="$save/$date.tar.gz" echo "Backing up /data /config to $file" sleep 1 tar cfvz "$file" --exclude="$save" "/data" "/config" || backupExit=1 backupExit=$? [ $backupExit -eq 0 ] && echo "Backed up /data /config has finished" || echo "Backup of /data /config has failed" exit $backupExit ;; healthcheck) # Docker healthcheck healthStatus=0 services="${SERVICES_LIST:-$@}" healthEnabled="${HEALTH_ENABLED:-}" healthPorts="${WEB_SERVER_PORTS:-}" healthEndPoints="${HEALTH_ENDPOINTS:-}" healthMessage="Everything seems to be running" services="${services//,/ }" [ "$healthEnabled" = "yes" ] || exit 0 for proc in $services; do if [ -n "$proc" ]; then if ! __pgrep "$proc"; then echo "$proc is not running" >&2 healthStatus=$((healthStatus + 1)) fi fi done for port in $ports; do if [ -n "$(type -P netstat)" ] && [ -n "$port" ]; then netstat -taupln | grep -q ":$port " || healthStatus=$((healthStatus + 1)) fi done for endpoint in $healthEndPoints; do if [ -n "$endpoint" ]; then __curl "$endpoint" || healthStatus=$((healthStatus + 1)) fi done [ "$healthStatus" -eq 0 ] || healthMessage="Errors reported see: docker logs --follow $CONTAINER_NAME" [ -n "$healthMessage" ] && echo "$healthMessage" exit $healthStatus ;; ports) # show open ports shift 1 ports="$(__netstat -taupln | awk -F ' ' '{print $4}' | awk -F ':' '{print $2}' | sort --unique --version-sort | grep -v '^$' | grep '^' || echo '')" [ -n "$ports" ] && printf '%s\n%s\n' "The following are servers:" "$ports" | tr '\n' ' ' exit $? ;; procs) # show running processes shift 1 ps="$(__ps axco command | grep -vE 'COMMAND|grep|ps' | sort -u || grep '^' || echo '')" [ -n "$ps" ] && printf '%s\n%s\n' "Found the following processes" "$ps" | tr '\n' ' ' exit $? ;; ssl) # setup ssl shift 1 __create_ssl_cert exit $? ;; certbot) # manage ssl certificate shift 1 CERT_BOT_ENABLED="true" if [ "$1" = "create" ]; then shift 1 __certbot "create" elif [ "$1" = "renew" ]; then shift 1 __certbot "renew certonly --force-renew" else __exec_command "certbot" "$@" fi exit $? ;; */bin/sh | */bin/bash | bash | sh | shell) # Launch shell shift 1 __exec_command "${@:-/bin/bash}" exit $? ;; exec) # execute commands shift 1 __exec_command "${@:-exit}" ;; start) # show/start init scripts shift 1 PATH="/usr/local/etc/docker/init.d:$PATH" if [ $# -eq 0 ]; then scripts="$(ls -A "/usr/local/etc/docker/init.d")" [ -n "$scripts" ] && echo "$scripts" || echo "No scripts found in: /usr/local/etc/docker/init.d" elif [ "$1" = "all" ]; then shift $# echo "$$" >"/run/init.d/entrypoint.pid" __start_init_scripts "/usr/local/etc/docker/init.d" elif [ -f "/usr/local/etc/docker/init.d/$1" ]; then eval "/usr/local/etc/docker/init.d/$1" fi __no_exit ;; *) # Execute primary command if [ $# -eq 0 ]; then if [ "$START_SERVICES" = "yes" ] || [ ! -f "/run/init.d/entrypoint.pid" ]; then echo "$$" >"/run/init.d/entrypoint.pid" __start_init_scripts "/usr/local/etc/docker/init.d" __no_exit fi else __exec_command "$@" fi ;; esac # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - # end of entrypoint # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - # ex: ts=2 sw=2 et filetype=sh