From d5a188c509f37e5f78d15bac310cd1e2293903cb Mon Sep 17 00:00:00 2001 From: Casper Date: Sun, 12 Sep 2021 14:49:01 +0200 Subject: [PATCH] Switch to old setup.sh until release --- setup.sh | 318 +++++++++++++++++++++++++++++++++++++----------- setup.sh.10.2.0 | 239 ++++++++++++++++++++++++++++++++++++ 2 files changed, 483 insertions(+), 74 deletions(-) create mode 100755 setup.sh.10.2.0 diff --git a/setup.sh b/setup.sh index 6d8708d6..0fb0ae66 100755 --- a/setup.sh +++ b/setup.sh @@ -1,63 +1,37 @@ #! /bin/bash -# version v1.0.0 +# version v0.3.0 stable # executed manually / via Make # task wrapper for various setup scripts SCRIPT='setup.sh' +WHITE="\e[37m" +RED="\e[31m" +PURPLE="\e[35m" +YELLOW="\e[93m" +ORANGE="\e[38;5;214m" +CYAN="\e[96m" +BLUE="\e[34m" +LBLUE="\e[94m" +BOLD="\e[1m" +RESET="\e[0m" + set -euEo pipefail -trap '__err "${FUNCNAME[0]:-?}" "${BASH_COMMAND:-?}" "${LINENO:-?}" "${?:-?}"' ERR +trap '__log_err "${FUNCNAME[0]:-?}" "${BASH_COMMAND:-?}" "${LINENO:-?}" "${?:-?}"' ERR -function __err +function __log_err { - [[ ${4} -gt 1 ]] && exit 1 + printf "\n--- ${BOLD}${RED}UNCHECKED ERROR${RESET}\n%s\n%s\n%s\n%s\n\n" \ + " - script = ${SCRIPT:-${0}}" \ + " - function = ${1} / ${2}" \ + " - line = ${3}" \ + " - exit code = ${4}" >&2 - local ERR_MSG='--- \e[31m\e[1mUNCHECKED ERROR\e[0m' - ERR_MSG+="\n - script = ${SCRIPT:-${0}}" - ERR_MSG+="\n - function = ${1} / ${2}" - ERR_MSG+="\n - line = ${3}" - ERR_MSG+="\n - exit code = ${4}" - ERR_MSG+='\n' - - echo -e "${ERR_MSG}" -} - -function _show_local_usage -{ - local WHITE="\e[37m" - local ORANGE="\e[38;5;214m" - local LBLUE="\e[94m" - local RESET="\e[0m" - - # shellcheck disable=SC2059 - printf "${ORANGE}OPTIONS${RESET} - ${LBLUE}Config path, container or image adjustments${RESET} - -i IMAGE_NAME - Provides the name of the docker-mailserver image. The default value is - ${WHITE}docker.io/mailserver/docker-mailserver:latest${RESET} - - -c CONTAINER_NAME - Provides the name of the running container. - - -p PATH - Provides the config folder path to the temporary container (does not work if docker-mailserver container already exists). - - ${LBLUE}SELinux${RESET} - -z - Allows container access to the bind mount content that is shared among - multiple containers on a SELinux-enabled host. - - -Z - Allows container access to the bind mount content that is private and - unshared with other containers on a SELinux-enabled host. - -${ORANGE}EXIT STATUS${RESET} - Exit status is 0 if the command was successful. If there was an unexpected error, an error - message is shown describing the error. In case of an error, the script will exit with exit - status 1. - -" + printf "Make sure you use a version of this script that matches +the version / tag of docker-mailserver. Please read the +'Get the tools' section in the README on GitHub careful- +ly and use ./setup.sh help and read the VERSION section.\n" >&2 } function _get_absolute_script_directory @@ -65,8 +39,7 @@ function _get_absolute_script_directory if [[ "$(uname)" == "Darwin" ]] then readlink() { - # requires coreutils - greadlink "${@:+$@}" + greadlink "${@:+$@}" # Requires coreutils } fi if dirname "$(readlink -f "${0}")" &>/dev/null @@ -97,9 +70,7 @@ function _check_root { if [[ ${EUID} -ne 0 ]] then - echo "Curently, DMS doesn't support podman's rootless mode. -Please run this script as root user." - + echo "Curently docker-mailserver doesn't support podman's rootless mode, please run this script as root user." exit 1 fi } @@ -110,7 +81,7 @@ function _update_config_path then VOLUME=$(${CRI} inspect "${CONTAINER_NAME}" \ --format="{{range .Mounts}}{{ println .Source .Destination}}{{end}}" | \ - grep "/tmp/docker-mailserver$" 2>/dev/null || :) + grep "/tmp/docker-mailserver$" 2>/dev/null) fi if [[ -n ${VOLUME} ]] @@ -119,6 +90,137 @@ function _update_config_path fi } +function _inspect +{ + if _docker_image_exists "${IMAGE_NAME}" + then + echo "Image: ${IMAGE_NAME}" + else + echo "Image: '${IMAGE_NAME}' can’t be found." + fi + + if [[ -n ${CONTAINER_NAME} ]] + then + echo "Container: ${CONTAINER_NAME}" + echo "Config mount: ${CONFIG_PATH}" + else + echo "Container: Not running, please start docker-mailserver." + fi +} + +function _usage +{ + # shellcheck disable=SC2059 + printf "${PURPLE}SETUP${RED}(${YELLOW}1${RED}) + +${ORANGE}NAME${RESET} + ${SCRIPT:-${0}} - docker-mailserver administration script + +${ORANGE}SYNOPSIS${RESET} + ./${SCRIPT:-${0}} [ OPTIONS${RED}...${RESET} ] COMMAND [ help ${RED}|${RESET} ARGUMENTS${RED}...${RESET} ] + + COMMAND ${RED}:=${RESET} { email ${RED}|${RESET} alias ${RED}|${RESET} quota ${RED}|${RESET} config ${RED}|${RESET} relay ${RED}|${RESET} debug } SUBCOMMAND + +${ORANGE}DESCRIPTION${RESET} + This is the main administration script that you use for all interactions with your + mail server. Setup, configuration and much more is done with this script. + + Please note that this script executes most of its commands inside the running 'mailserver' container itself. + If it cannot find a running container, it will attempt to run one using any available tags + which include label=org.opencontainers.image.title=\"docker-mailserver\" and then run the necessary commands. + If the tag for the container is not found, this script will pull the ${WHITE}:latest${RESET} tag of + ${WHITE}docker.io/mailserver/docker-mailserver${RESET}. This tag refers to the latest release, + see the tagging convention in the README under + ${BLUE}https://github.com/docker-mailserver/docker-mailserver/blob/master/README.md${RESET} + + You will be able to see detailed information about the script you're invoking and + its arguments by appending ${WHITE}help${RESET} after your command. Currently, this + does not work with all scripts. + +${ORANGE}VERSION${RESET} + The current version of this script is backwards compatible with versions of + ${WHITE}docker-mailserver${RESET} ${BOLD}after${RESET} ${BLUE}8.0.1${RESET}. In case that there is not a more recent release, + this script is currently only working with the ${WHITE}:edge${RESET} tag. + + You can download the script for your release by substituting TAG from the + following URL, where TAG looks like 'vX.X.X': + https://raw.githubusercontent.com/docker-mailserver/docker-mailserver/TAG/setup.sh + +${ORANGE}OPTIONS${RESET} + ${LBLUE}Config path, container or image adjustments${RESET} + -i IMAGE_NAME + Provides the name of the docker-mailserver image. The default value is + ${WHITE}docker.io/mailserver/docker-mailserver:latest${RESET} + + -c CONTAINER_NAME + Provides the name of the running container. + + -p PATH + Provides the config folder path to the temporary container (does not work if docker-mailserver container already exists). The default is + ${WHITE}${DIR}/config/${RESET} + + ${LBLUE}SELinux${RESET} + -z + Allows container access to the bind mount content that is shared among + multiple containers on a SELinux-enabled host. + + -Z + Allows container access to the bind mount content that is private and + unshared with other containers on a SELinux-enabled host. + +${RED}[${ORANGE}SUB${RED}]${ORANGE}COMMANDS${RESET} + ${LBLUE}COMMAND${RESET} email ${RED}:=${RESET} + ${0} email ${CYAN}add${RESET} [] + ${0} email ${CYAN}update${RESET} [] + ${0} email ${CYAN}del${RESET} [ OPTIONS${RED}...${RESET} ] [ ${RED}...${RESET} ] + ${0} email ${CYAN}restrict${RESET} [] + ${0} email ${CYAN}list${RESET} + + ${LBLUE}COMMAND${RESET} alias ${RED}:=${RESET} + ${0} alias ${CYAN}add${RESET} + ${0} alias ${CYAN}del${RESET} + ${0} alias ${CYAN}list${RESET} + + ${LBLUE}COMMAND${RESET} quota ${RED}:=${RESET} + ${0} quota ${CYAN}set${RESET} [] + ${0} quota ${CYAN}del${RESET} + + ${LBLUE}COMMAND${RESET} config ${RED}:=${RESET} + ${0} config ${CYAN}dkim${RESET} [ ARGUMENTS${RED}...${RESET} ] + + ${LBLUE}COMMAND${RESET} relay ${RED}:=${RESET} + ${0} relay ${CYAN}add-domain${RESET} [] + ${0} relay ${CYAN}add-auth${RESET} [] + ${0} relay ${CYAN}exclude-domain${RESET} + + ${LBLUE}COMMAND${RESET} debug ${RED}:=${RESET} + ${0} debug ${CYAN}fetchmail${RESET} + ${0} debug ${CYAN}fail2ban${RESET} [unban ] + ${0} debug ${CYAN}show-mail-logs${RESET} + ${0} debug ${CYAN}inspect${RESET} + ${0} debug ${CYAN}login${RESET} + +${ORANGE}EXAMPLES${RESET} + ${WHITE}./setup.sh email add test@domain.tld${RESET} + Add the email account ${WHITE}test@domain.tld${RESET}. You will be prompted + to input a password afterwards since no password was supplied. + + ${WHITE}./setup.sh config dkim keysize 2048 domain 'whoami.com,whoareyou.org'${RESET} + Creates keys of length 2048 but in an LDAP setup where domains are not known to + Postfix by default, so you need to provide them yourself in a comma-separated list. + + ${WHITE}./setup.sh config dkim help${RESET} + This will provide you with a detailed explanation on how to use the ${WHITE} + config dkim${RESET} command, showing what arguments can be passed and what they do. + +${ORANGE}EXIT STATUS${RESET} + Exit status is 0 if the command was successful. If there was an unexpected error, an error + message is shown describing the error. In case of an error, the script will exit with exit + status 1. + +" +} + function _docker_image_exists { ${CRI} history -q "${1}" &>/dev/null @@ -134,9 +236,9 @@ function _docker_image ${CRI} pull "${IMAGE_NAME}" fi - ${CRI} run --rm "${USE_TTY}" \ + ${CRI} run --rm \ -v "${CONFIG_PATH}:/tmp/docker-mailserver${USE_SELINUX}" \ - "${IMAGE_NAME}" "${@:+$@}" + "${USE_TTY}" "${IMAGE_NAME}" "${@:+$@}" } function _docker_container @@ -145,8 +247,7 @@ function _docker_container then ${CRI} exec "${USE_TTY}" "${CONTAINER_NAME}" "${@:+$@}" else - # if no container is running, run a temporary one: - # https://github.com/docker-mailserver/docker-mailserver/pull/1874#issuecomment-809781531 + # If no container yet, run a temporary one: https://github.com/docker-mailserver/docker-mailserver/pull/1874#issuecomment-809781531 _docker_image "${@:+$@}" fi } @@ -162,7 +263,7 @@ function _main _check_root else echo "No supported Container Runtime Interface detected." - exit 1 + exit 10 fi INFO=$(${CRI} ps --no-trunc --format "{{.Image}};{{.Names}}" --filter \ @@ -187,29 +288,33 @@ function _main fi local OPTIND - while getopts ":c:i:p:zZ" OPT + while getopts ":c:i:p:hzZ" OPT do case ${OPT} in - ( i ) IMAGE_NAME="${OPTARG}" ;; - ( z | Z ) USE_SELINUX=":${OPTARG}" ;; - ( c ) CONTAINER_NAME="${OPTARG}" ;; + i ) IMAGE_NAME="${OPTARG}" ;; + z ) USE_SELINUX=":z" ;; + Z ) USE_SELINUX=":Z" ;; + c ) + # container specified, connect to running instance + CONTAINER_NAME="${OPTARG}" + ;; - ( p ) + p ) case "${OPTARG}" in - ( /* ) WISHED_CONFIG_PATH="${OPTARG}" ;; - ( * ) WISHED_CONFIG_PATH="${DIR}/${OPTARG}" ;; + /* ) WISHED_CONFIG_PATH="${OPTARG}" ;; + * ) WISHED_CONFIG_PATH="${DIR}/${OPTARG}" ;; esac if [[ ! -d ${WISHED_CONFIG_PATH} ]] then - echo "Specified directory '${WISHED_CONFIG_PATH}' doesn't exist" >&2 - exit 1 + echo "Directory doesn't exist" + _usage + exit 40 fi ;; - ( * ) + * ) echo "Invalid option: -${OPT}" >&2 - exit 1 ;; esac @@ -230,10 +335,75 @@ function _main CONFIG_PATH=${WISHED_CONFIG_PATH} fi - _docker_container setup "${@:+$@}" - [[ ${1} == 'help' ]] && _show_local_usage - return 0 + case ${1:-} in + + email ) + case ${2:-} in + add ) shift 2 ; _docker_container addmailuser "${@:+$@}" ;; + update ) shift 2 ; _docker_container updatemailuser "${@:+$@}" ;; + del ) shift 2 ; _docker_container delmailuser "${@:+$@}" ;; + restrict ) shift 2 ; _docker_container restrict-access "${@:+$@}" ;; + list ) _docker_container listmailuser ;; + * ) _usage ;; + esac + ;; + + alias ) + case ${2:-} in + add ) shift 2 ; _docker_container addalias "${1}" "${2}" ;; + del ) shift 2 ; _docker_container delalias "${1}" "${2}" ;; + list ) shift 2 ; _docker_container listalias ;; + * ) _usage ;; + esac + ;; + + quota ) + case ${2:-} in + set ) shift 2 ; _docker_container setquota "${@:+$@}" ;; + del ) shift 2 ; _docker_container delquota "${@:+$@}" ;; + * ) _usage ;; + esac + ;; + + config ) + case ${2:-} in + dkim ) shift 2 ; _docker_container open-dkim "${@:+$@}" ;; + * ) _usage ;; + esac + ;; + + relay ) + case ${2:-} in + add-domain ) shift 2 ; _docker_container addrelayhost "${@:+$@}" ;; + add-auth ) shift 2 ; _docker_container addsaslpassword "${@:+$@}" ;; + exclude-domain ) shift 2 ; _docker_container excluderelaydomain "${@:+$@}" ;; + * ) _usage ;; + esac + ;; + + debug ) + case ${2:-} in + fetchmail ) _docker_container debug-fetchmail ;; + fail2ban ) shift 2 ; _docker_container fail2ban "${@:+$@}" ;; + show-mail-logs ) _docker_container cat /var/log/mail/mail.log ;; + inspect ) _inspect ;; + login ) + shift 2 + if [[ -z ${1:-} ]] + then + _docker_container /bin/bash + else + _docker_container /bin/bash -c "${@:+$@}" + fi + ;; + * ) _usage ; exit 1 ;; + esac + ;; + + help ) _usage ;; + * ) _usage ; exit 1 ;; + esac } _main "${@:+$@}" diff --git a/setup.sh.10.2.0 b/setup.sh.10.2.0 new file mode 100755 index 00000000..6d8708d6 --- /dev/null +++ b/setup.sh.10.2.0 @@ -0,0 +1,239 @@ +#! /bin/bash + +# version v1.0.0 +# executed manually / via Make +# task wrapper for various setup scripts + +SCRIPT='setup.sh' + +set -euEo pipefail +trap '__err "${FUNCNAME[0]:-?}" "${BASH_COMMAND:-?}" "${LINENO:-?}" "${?:-?}"' ERR + +function __err +{ + [[ ${4} -gt 1 ]] && exit 1 + + local ERR_MSG='--- \e[31m\e[1mUNCHECKED ERROR\e[0m' + ERR_MSG+="\n - script = ${SCRIPT:-${0}}" + ERR_MSG+="\n - function = ${1} / ${2}" + ERR_MSG+="\n - line = ${3}" + ERR_MSG+="\n - exit code = ${4}" + ERR_MSG+='\n' + + echo -e "${ERR_MSG}" +} + +function _show_local_usage +{ + local WHITE="\e[37m" + local ORANGE="\e[38;5;214m" + local LBLUE="\e[94m" + local RESET="\e[0m" + + # shellcheck disable=SC2059 + printf "${ORANGE}OPTIONS${RESET} + ${LBLUE}Config path, container or image adjustments${RESET} + -i IMAGE_NAME + Provides the name of the docker-mailserver image. The default value is + ${WHITE}docker.io/mailserver/docker-mailserver:latest${RESET} + + -c CONTAINER_NAME + Provides the name of the running container. + + -p PATH + Provides the config folder path to the temporary container (does not work if docker-mailserver container already exists). + + ${LBLUE}SELinux${RESET} + -z + Allows container access to the bind mount content that is shared among + multiple containers on a SELinux-enabled host. + + -Z + Allows container access to the bind mount content that is private and + unshared with other containers on a SELinux-enabled host. + +${ORANGE}EXIT STATUS${RESET} + Exit status is 0 if the command was successful. If there was an unexpected error, an error + message is shown describing the error. In case of an error, the script will exit with exit + status 1. + +" +} + +function _get_absolute_script_directory +{ + if [[ "$(uname)" == "Darwin" ]] + then + readlink() { + # requires coreutils + greadlink "${@:+$@}" + } + fi + if dirname "$(readlink -f "${0}")" &>/dev/null + then + DIR="$(dirname "$(readlink -f "${0}")")" + elif realpath -e -L "${0}" &>/dev/null + then + DIR="$(realpath -e -L "${0}")" + DIR="${DIR%/setup.sh}" + fi +} + +DIR="$(pwd)" +_get_absolute_script_directory + +CRI= +CONFIG_PATH= +CONTAINER_NAME= +DEFAULT_CONFIG_PATH="${DIR}/config" +IMAGE_NAME= +INFO= +USE_TTY= +USE_SELINUX= +VOLUME= +WISHED_CONFIG_PATH= + +function _check_root +{ + if [[ ${EUID} -ne 0 ]] + then + echo "Curently, DMS doesn't support podman's rootless mode. +Please run this script as root user." + + exit 1 + fi +} + +function _update_config_path +{ + if [[ -n ${CONTAINER_NAME} ]] + then + VOLUME=$(${CRI} inspect "${CONTAINER_NAME}" \ + --format="{{range .Mounts}}{{ println .Source .Destination}}{{end}}" | \ + grep "/tmp/docker-mailserver$" 2>/dev/null || :) + fi + + if [[ -n ${VOLUME} ]] + then + CONFIG_PATH=$(echo "${VOLUME}" | awk '{print $1}') + fi +} + +function _docker_image_exists +{ + ${CRI} history -q "${1}" &>/dev/null + return ${?} +} + +function _docker_image +{ + # start temporary container with specified image + if ! _docker_image_exists "${IMAGE_NAME}" + then + echo "Image '${IMAGE_NAME}' not found. Pulling ..." + ${CRI} pull "${IMAGE_NAME}" + fi + + ${CRI} run --rm "${USE_TTY}" \ + -v "${CONFIG_PATH}:/tmp/docker-mailserver${USE_SELINUX}" \ + "${IMAGE_NAME}" "${@:+$@}" +} + +function _docker_container +{ + if [[ -n ${CONTAINER_NAME} ]] + then + ${CRI} exec "${USE_TTY}" "${CONTAINER_NAME}" "${@:+$@}" + else + # if no container is running, run a temporary one: + # https://github.com/docker-mailserver/docker-mailserver/pull/1874#issuecomment-809781531 + _docker_image "${@:+$@}" + fi +} + +function _main +{ + if command -v docker &>/dev/null + then + CRI=docker + elif command -v podman &>/dev/null + then + CRI=podman + _check_root + else + echo "No supported Container Runtime Interface detected." + exit 1 + fi + + INFO=$(${CRI} ps --no-trunc --format "{{.Image}};{{.Names}}" --filter \ + label=org.opencontainers.image.title="docker-mailserver" | tail -1) + + IMAGE_NAME=${INFO%;*} + CONTAINER_NAME=${INFO#*;} + + if [[ -z ${IMAGE_NAME} ]] + then + IMAGE_NAME=${NAME:-docker.io/mailserver/docker-mailserver:latest} + fi + + if test -t 0 + then + USE_TTY="-ti" + else + # GitHub Actions will fail (or really anything else + # lacking an interactive tty) if we don't set a + # value here; "-t" alone works for these cases. + USE_TTY="-t" + fi + + local OPTIND + while getopts ":c:i:p:zZ" OPT + do + case ${OPT} in + ( i ) IMAGE_NAME="${OPTARG}" ;; + ( z | Z ) USE_SELINUX=":${OPTARG}" ;; + ( c ) CONTAINER_NAME="${OPTARG}" ;; + + ( p ) + case "${OPTARG}" in + ( /* ) WISHED_CONFIG_PATH="${OPTARG}" ;; + ( * ) WISHED_CONFIG_PATH="${DIR}/${OPTARG}" ;; + esac + + if [[ ! -d ${WISHED_CONFIG_PATH} ]] + then + echo "Specified directory '${WISHED_CONFIG_PATH}' doesn't exist" >&2 + exit 1 + fi + ;; + + ( * ) + echo "Invalid option: -${OPT}" >&2 + exit 1 + ;; + + esac + done + + shift $(( OPTIND - 1 )) + + if [[ -z ${WISHED_CONFIG_PATH} ]] + then + # no wished config path + _update_config_path + + if [[ -z ${CONFIG_PATH} ]] + then + CONFIG_PATH=${DEFAULT_CONFIG_PATH} + fi + else + CONFIG_PATH=${WISHED_CONFIG_PATH} + fi + + _docker_container setup "${@:+$@}" + [[ ${1} == 'help' ]] && _show_local_usage + + return 0 +} + +_main "${@:+$@}"