From 11c439a9382f9b4a641fdedd18d58a343d29896b Mon Sep 17 00:00:00 2001 From: Bitnami Bot Date: Fri, 10 Jul 2020 10:51:34 +0000 Subject: [PATCH] 0.20180422.202005011246-debian-10-r68 release --- bitnami/dokuwiki/0/debian-10/Dockerfile | 44 +- .../dokuwiki/0/debian-10/docker-compose.yml | 6 +- .../prebuildfs/build/bitnami-user.sh | 6 - .../prebuildfs/build/install-nami.sh | 7 - .../prebuildfs/opt/bitnami/base/functions | 120 --- .../prebuildfs/opt/bitnami/base/helpers | 40 - .../opt/bitnami/scripts/libbitnami.sh | 51 ++ .../opt/bitnami/scripts/libcomponent.sh | 69 ++ .../prebuildfs/opt/bitnami/scripts/libfile.sh | 80 ++ .../prebuildfs/opt/bitnami/scripts/libfs.sh | 183 +++++ .../prebuildfs/opt/bitnami/scripts/liblog.sh | 110 +++ .../prebuildfs/opt/bitnami/scripts/libnet.sh | 140 ++++ .../prebuildfs/opt/bitnami/scripts/libos.sh | 279 +++++++ .../opt/bitnami/scripts/libpersistence.sh | 122 ++++ .../opt/bitnami/scripts/libservice.sh | 205 ++++++ .../opt/bitnami/scripts/libvalidations.sh | 248 +++++++ .../opt/bitnami/scripts/libversion.sh | 49 ++ .../opt/bitnami/scripts/libwebserver.sh | 364 ++++++++++ .../debian-10/prebuildfs/usr/sbin/bitnami-pkg | 215 ------ .../0/debian-10/rootfs/apache-init.sh | 24 - .../0/debian-10/rootfs/apache-inputs.json | 5 - .../0/debian-10/rootfs/app-entrypoint.sh | 15 - .../0/debian-10/rootfs/dokuwiki-inputs.json | 8 - .../apache/conf/bitnami/certs/server.crt | 17 + .../apache/conf/bitnami/certs/server.key | 27 + .../opt/bitnami/apache/conf/deflate.conf | 5 + .../apache/conf/vhosts/00_status-vhost.conf | 6 + .../rootfs/opt/bitnami/scripts/apache-env.sh | 69 ++ .../scripts/apache-modphp/postunpack.sh | 30 + .../app-generic-http-vhost.conf.tpl | 5 + .../app-generic-https-vhost.conf.tpl | 8 + .../app-generic-prefix.conf.tpl | 1 + .../bitnami-templates/app-http-vhost.conf.tpl | 13 + .../app-https-vhost.conf.tpl | 16 + .../bitnami-templates/app-prefix.conf.tpl | 9 + .../bitnami-templates/bitnami-ssl.conf.tpl | 30 + .../apache/bitnami-templates/bitnami.conf.tpl | 19 + .../opt/bitnami/scripts/apache/entrypoint.sh | 27 + .../opt/bitnami/scripts/apache/postunpack.sh | 115 +++ .../opt/bitnami/scripts/apache/reload.sh | 18 + .../opt/bitnami/scripts/apache/restart.sh | 17 + .../rootfs/opt/bitnami/scripts/apache/run.sh | 18 + .../opt/bitnami/scripts/apache/setup.sh | 26 + .../opt/bitnami/scripts/apache/start.sh | 32 + .../opt/bitnami/scripts/apache/status.sh | 21 + .../rootfs/opt/bitnami/scripts/apache/stop.sh | 32 + .../opt/bitnami/scripts/dokuwiki-env.sh | 57 ++ .../bitnami/scripts/dokuwiki/entrypoint.sh | 32 + .../bitnami/scripts/dokuwiki/postunpack.sh | 42 ++ .../opt/bitnami/scripts/dokuwiki/setup.sh | 26 + .../rootfs/opt/bitnami/scripts/libapache.sh | 687 ++++++++++++++++++ .../rootfs/opt/bitnami/scripts/libdokuwiki.sh | 118 +++ .../rootfs/opt/bitnami/scripts/libphp.sh | 129 ++++ .../rootfs/opt/bitnami/scripts/php-env.sh | 67 ++ .../opt/bitnami/scripts/php/postunpack.sh | 34 + .../rootfs/opt/bitnami/scripts/php/run.sh | 19 + .../rootfs/opt/bitnami/scripts/php/setup.sh | 28 + bitnami/dokuwiki/README.md | 372 ++++++---- bitnami/dokuwiki/docker-compose.yml | 6 +- 59 files changed, 3946 insertions(+), 622 deletions(-) delete mode 100755 bitnami/dokuwiki/0/debian-10/prebuildfs/build/bitnami-user.sh delete mode 100755 bitnami/dokuwiki/0/debian-10/prebuildfs/build/install-nami.sh delete mode 100644 bitnami/dokuwiki/0/debian-10/prebuildfs/opt/bitnami/base/functions delete mode 100644 bitnami/dokuwiki/0/debian-10/prebuildfs/opt/bitnami/base/helpers create mode 100644 bitnami/dokuwiki/0/debian-10/prebuildfs/opt/bitnami/scripts/libbitnami.sh create mode 100644 bitnami/dokuwiki/0/debian-10/prebuildfs/opt/bitnami/scripts/libcomponent.sh create mode 100644 bitnami/dokuwiki/0/debian-10/prebuildfs/opt/bitnami/scripts/libfile.sh create mode 100644 bitnami/dokuwiki/0/debian-10/prebuildfs/opt/bitnami/scripts/libfs.sh create mode 100644 bitnami/dokuwiki/0/debian-10/prebuildfs/opt/bitnami/scripts/liblog.sh create mode 100644 bitnami/dokuwiki/0/debian-10/prebuildfs/opt/bitnami/scripts/libnet.sh create mode 100644 bitnami/dokuwiki/0/debian-10/prebuildfs/opt/bitnami/scripts/libos.sh create mode 100644 bitnami/dokuwiki/0/debian-10/prebuildfs/opt/bitnami/scripts/libpersistence.sh create mode 100644 bitnami/dokuwiki/0/debian-10/prebuildfs/opt/bitnami/scripts/libservice.sh create mode 100644 bitnami/dokuwiki/0/debian-10/prebuildfs/opt/bitnami/scripts/libvalidations.sh create mode 100644 bitnami/dokuwiki/0/debian-10/prebuildfs/opt/bitnami/scripts/libversion.sh create mode 100644 bitnami/dokuwiki/0/debian-10/prebuildfs/opt/bitnami/scripts/libwebserver.sh delete mode 100755 bitnami/dokuwiki/0/debian-10/prebuildfs/usr/sbin/bitnami-pkg delete mode 100644 bitnami/dokuwiki/0/debian-10/rootfs/apache-init.sh delete mode 100644 bitnami/dokuwiki/0/debian-10/rootfs/apache-inputs.json delete mode 100755 bitnami/dokuwiki/0/debian-10/rootfs/app-entrypoint.sh delete mode 100644 bitnami/dokuwiki/0/debian-10/rootfs/dokuwiki-inputs.json create mode 100644 bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/apache/conf/bitnami/certs/server.crt create mode 100644 bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/apache/conf/bitnami/certs/server.key create mode 100644 bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/apache/conf/deflate.conf create mode 100644 bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/apache/conf/vhosts/00_status-vhost.conf create mode 100644 bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/apache-env.sh create mode 100755 bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/apache-modphp/postunpack.sh create mode 100644 bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/apache/bitnami-templates/app-generic-http-vhost.conf.tpl create mode 100644 bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/apache/bitnami-templates/app-generic-https-vhost.conf.tpl create mode 100644 bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/apache/bitnami-templates/app-generic-prefix.conf.tpl create mode 100644 bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/apache/bitnami-templates/app-http-vhost.conf.tpl create mode 100644 bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/apache/bitnami-templates/app-https-vhost.conf.tpl create mode 100644 bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/apache/bitnami-templates/app-prefix.conf.tpl create mode 100644 bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/apache/bitnami-templates/bitnami-ssl.conf.tpl create mode 100644 bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/apache/bitnami-templates/bitnami.conf.tpl create mode 100755 bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/apache/entrypoint.sh create mode 100755 bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/apache/postunpack.sh create mode 100755 bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/apache/reload.sh create mode 100755 bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/apache/restart.sh create mode 100755 bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/apache/run.sh create mode 100755 bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/apache/setup.sh create mode 100755 bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/apache/start.sh create mode 100755 bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/apache/status.sh create mode 100755 bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/apache/stop.sh create mode 100644 bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/dokuwiki-env.sh create mode 100755 bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/dokuwiki/entrypoint.sh create mode 100755 bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/dokuwiki/postunpack.sh create mode 100755 bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/dokuwiki/setup.sh create mode 100644 bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/libapache.sh create mode 100644 bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/libdokuwiki.sh create mode 100644 bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/libphp.sh create mode 100644 bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/php-env.sh create mode 100755 bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/php/postunpack.sh create mode 100755 bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/php/run.sh create mode 100755 bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/php/setup.sh diff --git a/bitnami/dokuwiki/0/debian-10/Dockerfile b/bitnami/dokuwiki/0/debian-10/Dockerfile index fff3563b31d7..fb2680551193 100644 --- a/bitnami/dokuwiki/0/debian-10/Dockerfile +++ b/bitnami/dokuwiki/0/debian-10/Dockerfile @@ -1,41 +1,43 @@ FROM docker.io/bitnami/minideb:buster LABEL maintainer "Bitnami " -ENV PATH="/opt/bitnami/php/bin:/opt/bitnami/php/sbin:/opt/bitnami/apache/bin:/opt/bitnami/common/bin:/opt/bitnami/nami/bin:$PATH" +ENV HOME="/" \ + OS_ARCH="amd64" \ + OS_FLAVOUR="debian-10" \ + OS_NAME="linux" COPY prebuildfs / # Install required system packages and dependencies -RUN install_packages ca-certificates curl gzip libaudit1 libbsd0 libbz2-1.0 libc6 libcap-ng0 libcom-err2 libcurl4 libexpat1 libffi6 libfftw3-double3 libfontconfig1 libfreetype6 libgcc1 libgcrypt20 libglib2.0-0 libgmp10 libgnutls30 libgomp1 libgpg-error0 libgssapi-krb5-2 libhogweed4 libicu63 libidn2-0 libjpeg62-turbo libk5crypto3 libkeyutils1 libkrb5-3 libkrb5support0 liblcms2-2 libldap-2.4-2 liblqr-1-0 libltdl7 liblzma5 libmagickcore-6.q16-6 libmagickwand-6.q16-6 libmcrypt4 libmemcached11 libmemcachedutil2 libncurses6 libnettle6 libnghttp2-14 libp11-kit0 libpam0g libpcre3 libpng16-16 libpq5 libpsl5 libreadline7 librtmp1 libsasl2-2 libsqlite3-0 libssh2-1 libssl1.1 libstdc++6 libsybdb5 libtasn1-6 libtidy5deb1 libtinfo6 libunistring2 libuuid1 libx11-6 libxau6 libxcb1 libxdmcp6 libxext6 libxml2 libxslt1.1 libzip4 procps sudo tar zlib1g -RUN /build/bitnami-user.sh -RUN /build/install-nami.sh -RUN bitnami-pkg unpack php-7.3.19-2 --checksum 25bba77655b298c62ab474954837acbc167a4bcc8555c39b419644c999207c5f -RUN bitnami-pkg unpack apache-2.4.43-5 --checksum e9faded57e3703fe9fcea650eb302e673d969a399fe9dfafa67e173465637665 -RUN bitnami-pkg install libphp-7.3.19-2 --checksum c5dddf3ea541f5c0d6f65fa7d743de710de5ec53cdf8458a25c74e70f0c8397d -RUN bitnami-pkg install tini-0.19.0-0 --checksum 9a8ae20be31a518f042fcec359f2cf35bfdb4e2a56f2fa8ff9ef2ecaf45da80c -RUN bitnami-pkg install gosu-1.12.0-1 --checksum 51cfb1b7fd7b05b8abd1df0278c698103a9b1a4964bdacd87ca1d5c01631d59c -RUN bitnami-pkg unpack dokuwiki-0.20180422.202005011246-1 --checksum d11672322fd41ac461dc53c739c401d26f27135cb646f0a18b88295279e85ad0 +RUN install_packages acl ca-certificates curl gzip libaudit1 libbsd0 libbz2-1.0 libc6 libcap-ng0 libcom-err2 libcurl4 libexpat1 libffi6 libfftw3-double3 libfontconfig1 libfreetype6 libgcc1 libgcrypt20 libglib2.0-0 libgmp10 libgnutls30 libgomp1 libgpg-error0 libgssapi-krb5-2 libhogweed4 libicu63 libidn2-0 libjpeg62-turbo libk5crypto3 libkeyutils1 libkrb5-3 libkrb5support0 liblcms2-2 libldap-2.4-2 liblqr-1-0 libltdl7 liblzma5 libmagickcore-6.q16-6 libmagickwand-6.q16-6 libmcrypt4 libmemcached11 libmemcachedutil2 libncurses6 libnettle6 libnghttp2-14 libp11-kit0 libpam0g libpcre3 libpng16-16 libpq5 libpsl5 libreadline7 librtmp1 libsasl2-2 libsqlite3-0 libssh2-1 libssl1.1 libstdc++6 libsybdb5 libtasn1-6 libtidy5deb1 libtinfo6 libunistring2 libuuid1 libx11-6 libxau6 libxcb1 libxdmcp6 libxext6 libxml2 libxslt1.1 libzip4 procps tar zlib1g +RUN . /opt/bitnami/scripts/libcomponent.sh && component_unpack "php" "7.3.19-3" --checksum afa209bbdf622ab11b677cd01082acd7f9a190b30e68d5434aced4e69e033dde +RUN . /opt/bitnami/scripts/libcomponent.sh && component_unpack "apache" "2.4.43-5" --checksum e9faded57e3703fe9fcea650eb302e673d969a399fe9dfafa67e173465637665 +RUN . /opt/bitnami/scripts/libcomponent.sh && component_unpack "libphp" "7.3.19-2" --checksum c5dddf3ea541f5c0d6f65fa7d743de710de5ec53cdf8458a25c74e70f0c8397d +RUN . /opt/bitnami/scripts/libcomponent.sh && component_unpack "render-template" "1.0.0-1" --checksum a94f94357aa06f3718db1550fa5f5188cd61383d66bf754eef49c58a18bf02cc +RUN . /opt/bitnami/scripts/libcomponent.sh && component_unpack "gosu" "1.12.0-1" --checksum 51cfb1b7fd7b05b8abd1df0278c698103a9b1a4964bdacd87ca1d5c01631d59c +RUN . /opt/bitnami/scripts/libcomponent.sh && component_unpack "dokuwiki" "0.20180422.202005011246-2" --checksum 3b16e33eae89b4c392f35e747a5e579893b2eeb5a2ecdbdc8d57844079a9e1f2 RUN apt-get update && apt-get upgrade -y && \ rm -r /var/lib/apt/lists /var/cache/apt/archives -RUN ln -sf /dev/stdout /opt/bitnami/apache/logs/access_log && \ - ln -sf /dev/stderr /opt/bitnami/apache/logs/error_log COPY rootfs / +RUN /opt/bitnami/scripts/php/postunpack.sh +RUN /opt/bitnami/scripts/apache/postunpack.sh +RUN /opt/bitnami/scripts/apache-modphp/postunpack.sh +RUN /opt/bitnami/scripts/dokuwiki/postunpack.sh ENV APACHE_ENABLE_CUSTOM_PORTS="no" \ APACHE_HTTPS_PORT_NUMBER="" \ APACHE_HTTP_PORT_NUMBER="" \ BITNAMI_APP_NAME="dokuwiki" \ - BITNAMI_IMAGE_VERSION="0.20180422.202005011246-debian-10-r67" \ + BITNAMI_IMAGE_VERSION="0.20180422.202005011246-debian-10-r68" \ DOKUWIKI_EMAIL="user@example.com" \ DOKUWIKI_FULL_NAME="Full Name" \ DOKUWIKI_PASSWORD="bitnami1" \ DOKUWIKI_USERNAME="superuser" \ - DOKUWIKI_WIKI_NAME="Bitnami DokuWiki" \ - OS_ARCH="amd64" \ - OS_FLAVOUR="debian-10" \ - OS_NAME="linux" \ - PHP_MEMORY_LIMIT="256M" + DOKUWIKI_WIKI_NAME="" \ + PATH="/opt/bitnami/php/bin:/opt/bitnami/php/sbin:/opt/bitnami/apache/bin:/opt/bitnami/common/bin:$PATH" \ + PHP_MEMORY_LIMIT="" -EXPOSE 80 443 +EXPOSE 8080 8443 -ENTRYPOINT [ "/app-entrypoint.sh" ] -CMD [ "httpd", "-f", "/opt/bitnami/apache/conf/httpd.conf", "-DFOREGROUND" ] +USER 1001 +ENTRYPOINT [ "/opt/bitnami/scripts/dokuwiki/entrypoint.sh" ] +CMD [ "/opt/bitnami/scripts/apache/run.sh" ] diff --git a/bitnami/dokuwiki/0/debian-10/docker-compose.yml b/bitnami/dokuwiki/0/debian-10/docker-compose.yml index e7ee2b517ff9..16f8853b5531 100644 --- a/bitnami/dokuwiki/0/debian-10/docker-compose.yml +++ b/bitnami/dokuwiki/0/debian-10/docker-compose.yml @@ -3,10 +3,10 @@ services: dokuwiki: image: 'docker.io/bitnami/dokuwiki:0-debian-10' ports: - - '80:80' - - '443:443' + - '80:8080' + - '443:8443' volumes: - - 'dokuwiki_data:/bitnami' + - 'dokuwiki_data:/bitnami/dokuwiki' volumes: dokuwiki_data: driver: local diff --git a/bitnami/dokuwiki/0/debian-10/prebuildfs/build/bitnami-user.sh b/bitnami/dokuwiki/0/debian-10/prebuildfs/build/bitnami-user.sh deleted file mode 100755 index 0b21a219a4f3..000000000000 --- a/bitnami/dokuwiki/0/debian-10/prebuildfs/build/bitnami-user.sh +++ /dev/null @@ -1,6 +0,0 @@ -#!/bin/bash - -useradd -ms /bin/bash bitnami -mkdir -p /opt/bitnami -sed -i -e 's/\s*Defaults\s*secure_path\s*=/# Defaults secure_path=/' /etc/sudoers -echo 'bitnami ALL=NOPASSWD: ALL' >> /etc/sudoers diff --git a/bitnami/dokuwiki/0/debian-10/prebuildfs/build/install-nami.sh b/bitnami/dokuwiki/0/debian-10/prebuildfs/build/install-nami.sh deleted file mode 100755 index 455022638541..000000000000 --- a/bitnami/dokuwiki/0/debian-10/prebuildfs/build/install-nami.sh +++ /dev/null @@ -1,7 +0,0 @@ -#!/bin/bash - -curl --silent -L https://nami-prod.s3.amazonaws.com/tools/nami/releases/nami-2.0.0-0-linux-x64.tar.gz > /tmp/nami-linux-x64.tar.gz -echo "63e836f3d752cb157b175e1efe2238e5b4e04ab139097c682ca5a0651f0df65c /tmp/nami-linux-x64.tar.gz" | sha256sum --check -mkdir -p /opt/bitnami/nami /opt/bitnami/licenses -tar xzf /tmp/nami-linux-x64.tar.gz --strip 1 -C /opt/bitnami/nami && rm /tmp/nami-linux-x64.tar.gz -curl --silent -L https://raw.githubusercontent.com/bitnami/nami/master/COPYING > /opt/bitnami/licenses/nami-2.0.0-0.txt diff --git a/bitnami/dokuwiki/0/debian-10/prebuildfs/opt/bitnami/base/functions b/bitnami/dokuwiki/0/debian-10/prebuildfs/opt/bitnami/base/functions deleted file mode 100644 index c0eaff78f63e..000000000000 --- a/bitnami/dokuwiki/0/debian-10/prebuildfs/opt/bitnami/base/functions +++ /dev/null @@ -1,120 +0,0 @@ -#!/bin/bash - -[[ ${BASH_DEBUG:-false} = true ]] && set -x - -# Constants -MODULE="$(basename "$0")" -BITNAMI_PREFIX=/opt/bitnami - -# Color Palette -RESET='\033[0m' -BOLD='\033[1m' - -## Foreground -BLACK='\033[38;5;0m' -RED='\033[38;5;1m' -GREEN='\033[38;5;2m' -YELLOW='\033[38;5;3m' -BLUE='\033[38;5;4m' -MAGENTA='\033[38;5;5m' -CYAN='\033[38;5;6m' -WHITE='\033[38;5;7m' - -## Background -ON_BLACK='\033[48;5;0m' -ON_RED='\033[48;5;1m' -ON_GREEN='\033[48;5;2m' -ON_YELLOW='\033[48;5;3m' -ON_BLUE='\033[48;5;4m' -ON_MAGENTA='\033[48;5;5m' -ON_CYAN='\033[48;5;6m' -ON_WHITE='\033[48;5;7m' - -# Functions - -######################## -# Print to STDERR -# Arguments: -# Message to print -# Returns: -# None -######################### -stderr_print() { - printf "%b\\n" "${*}" >&2 -} - -######################## -# Log message -# Arguments: -# Message to log -# Returns: -# None -######################### -log() { - stderr_print "${NAMI_DEBUG:+${CYAN}${MODULE:-} ${MAGENTA}$(date "+%T.%2N ")}${RESET}${*}" -} -######################## -# Log an 'info' message -# Arguments: -# Message to log -# Returns: -# None -######################### -info() { - log "${GREEN}INFO ${RESET} ==> ${*}" -} -######################## -# Log message -# Arguments: -# Message to log -# Returns: -# None -######################### -warn() { - log "${YELLOW}WARN ${RESET} ==> ${*}" -} -######################## -# Log an 'error' message -# Arguments: -# Message to log -# Returns: -# None -######################### -error() { - log "${RED}ERROR${RESET} ==> ${*}" -} -######################## -# Print the welcome page -# Globals: -# DISABLE_WELCOME_MESSAGE -# BITNAMI_APP_NAME -# Arguments: -# None -# Returns: -# None -######################### -print_welcome_page() { - if [[ -z "${DISABLE_WELCOME_MESSAGE:-}" ]]; then - if [[ -n "$BITNAMI_APP_NAME" ]]; then - print_image_welcome_page - fi - fi -} -######################## -# Print the welcome page for a Bitnami Docker image -# Globals: -# BITNAMI_APP_NAME -# Arguments: -# None -# Returns: -# None -######################### -print_image_welcome_page() { - local github_url="https://github.com/bitnami/bitnami-docker-${BITNAMI_APP_NAME}" - - log "" - log "${BOLD}Welcome to the Bitnami ${BITNAMI_APP_NAME} container${RESET}" - log "Subscribe to project updates by watching ${BOLD}${github_url}${RESET}" - log "Submit issues and feature requests at ${BOLD}${github_url}/issues${RESET}" - log "" -} diff --git a/bitnami/dokuwiki/0/debian-10/prebuildfs/opt/bitnami/base/helpers b/bitnami/dokuwiki/0/debian-10/prebuildfs/opt/bitnami/base/helpers deleted file mode 100644 index da35a1975ec6..000000000000 --- a/bitnami/dokuwiki/0/debian-10/prebuildfs/opt/bitnami/base/helpers +++ /dev/null @@ -1,40 +0,0 @@ -#!/bin/bash - -. /opt/bitnami/base/functions - -######################## -# Helper function to initialize a single nami module -# Arguments: -# Module to initialize -# Returns: -# None -# Description: -# Initialize an unpacked nami module with the `nami initialize` command. -# Command arguments can be specified as function argumnts after the module name. -# `--log-level trace` flag is added to the command if `NAMI_DEBUG` env variable exists. -# The log level can be overriden using the `NAMI_LOG_LEVEL` env variable. -######################### -nami_initialize_one() { - local module="${1:?module not specified}" - if nami inspect $module | grep -q '"lifecycle": "unpacked"'; then - local inputs= - if [[ -f "/${module}-inputs.json" ]]; then - inputs="--inputs-file=/${module}-inputs.json" - fi - nami ${NAMI_DEBUG:+--log-level ${NAMI_LOG_LEVEL:-trace}} initialize $module $inputs "${@:2}" - fi -} - -######################## -# Helper function to initialize one or more nami modules -# Arguments: -# Module to initialize -# Returns: -# None -######################### -nami_initialize() { - local module="${1:?module not specified}" - for module in "${@}"; do - nami_initialize_one $module - done -} diff --git a/bitnami/dokuwiki/0/debian-10/prebuildfs/opt/bitnami/scripts/libbitnami.sh b/bitnami/dokuwiki/0/debian-10/prebuildfs/opt/bitnami/scripts/libbitnami.sh new file mode 100644 index 000000000000..ef29e361dad1 --- /dev/null +++ b/bitnami/dokuwiki/0/debian-10/prebuildfs/opt/bitnami/scripts/libbitnami.sh @@ -0,0 +1,51 @@ +#!/bin/bash +# +# Bitnami custom library + +# shellcheck disable=SC1091 + +# Load Generic Libraries +. /opt/bitnami/scripts/liblog.sh + +# Constants +BOLD='\033[1m' + +# Functions + +######################## +# Print the welcome page +# Globals: +# DISABLE_WELCOME_MESSAGE +# BITNAMI_APP_NAME +# Arguments: +# None +# Returns: +# None +######################### +print_welcome_page() { + if [[ -z "${DISABLE_WELCOME_MESSAGE:-}" ]]; then + if [[ -n "$BITNAMI_APP_NAME" ]]; then + print_image_welcome_page + fi + fi +} + +######################## +# Print the welcome page for a Bitnami Docker image +# Globals: +# BITNAMI_APP_NAME +# Arguments: +# None +# Returns: +# None +######################### +print_image_welcome_page() { + local github_url="https://github.com/bitnami/bitnami-docker-${BITNAMI_APP_NAME}" + + log "" + log "${BOLD}Welcome to the Bitnami ${BITNAMI_APP_NAME} container${RESET}" + log "Subscribe to project updates by watching ${BOLD}${github_url}${RESET}" + log "Submit issues and feature requests at ${BOLD}${github_url}/issues${RESET}" + log "" +} + diff --git a/bitnami/dokuwiki/0/debian-10/prebuildfs/opt/bitnami/scripts/libcomponent.sh b/bitnami/dokuwiki/0/debian-10/prebuildfs/opt/bitnami/scripts/libcomponent.sh new file mode 100644 index 000000000000..76083e1e0a1d --- /dev/null +++ b/bitnami/dokuwiki/0/debian-10/prebuildfs/opt/bitnami/scripts/libcomponent.sh @@ -0,0 +1,69 @@ +#!/bin/bash +# +# Library for managing Bitnami components + +# Constants +CACHE_ROOT="/tmp/bitnami/pkg/cache" +DOWNLOAD_URL="https://downloads.bitnami.com/files/stacksmith" + +# Functions + +######################## +# Download and unpack a Bitnami package +# Globals: +# OS_NAME +# OS_ARCH +# OS_FLAVOUR +# Arguments: +# $1 - component's name +# $2 - component's version +# Returns: +# None +######################### +component_unpack() { + local name="${1:?name is required}" + local version="${2:?version is required}" + local base_name="${name}-${version}-${OS_NAME}-${OS_ARCH}-${OS_FLAVOUR}" + local package_sha256="" + local directory="/opt/bitnami" + + # Validate arguments + shift 2 + while [ "$#" -gt 0 ]; do + case "$1" in + -c|--checksum) + shift + package_sha256="${1:?missing package checksum}" + ;; + *) + echo "Invalid command line flag $1" >&2 + return 1 + ;; + esac + shift + done + + echo "Downloading $base_name package" + if [ -f "${CACHE_ROOT}/${base_name}.tar.gz" ]; then + echo "${CACHE_ROOT}/${base_name}.tar.gz already exists, skipping download." + cp "${CACHE_ROOT}/${base_name}.tar.gz" . + rm "${CACHE_ROOT}/${base_name}.tar.gz" + if [ -f "${CACHE_ROOT}/${base_name}.tar.gz.sha256" ]; then + echo "Using the local sha256 from ${CACHE_ROOT}/${base_name}.tar.gz.sha256" + package_sha256="$(< "${CACHE_ROOT}/${base_name}.tar.gz.sha256")" + rm "${CACHE_ROOT}/${base_name}.tar.gz.sha256" + fi + else + curl --remote-name --silent "${DOWNLOAD_URL}/${base_name}.tar.gz" + fi + if [ -n "$package_sha256" ]; then + echo "Verifying package integrity" + echo "$package_sha256 ${base_name}.tar.gz" | sha256sum --check - + fi + tar --directory "${directory}" --extract --gunzip --file "${base_name}.tar.gz" --no-same-owner --strip-components=2 "${base_name}/files/" + rm "${base_name}.tar.gz" + + # Include metadata about the package + touch "${directory}/.bitnami_packages" + echo "$base_name" >> "${directory}/.bitnami_packages" +} diff --git a/bitnami/dokuwiki/0/debian-10/prebuildfs/opt/bitnami/scripts/libfile.sh b/bitnami/dokuwiki/0/debian-10/prebuildfs/opt/bitnami/scripts/libfile.sh new file mode 100644 index 000000000000..b09575cbe4a6 --- /dev/null +++ b/bitnami/dokuwiki/0/debian-10/prebuildfs/opt/bitnami/scripts/libfile.sh @@ -0,0 +1,80 @@ +#!/bin/bash +# +# Library for managing files + +# Functions + +######################## +# Replace a regex in a file +# Arguments: +# $1 - filename +# $2 - match regex +# $3 - substitute regex +# $4 - use POSIX regex. Default: true +# Returns: +# None +######################### +replace_in_file() { + local filename="${1:?filename is required}" + local match_regex="${2:?match regex is required}" + local substitute_regex="${3:?substitute regex is required}" + local posix_regex=${4:-true} + + local result + + # We should avoid using 'sed in-place' substitutions + # 1) They are not compatible with files mounted from ConfigMap(s) + # 2) We found incompatibility issues with Debian10 and "in-place" substitutions + del=$'\001' # Use a non-printable character as a 'sed' delimiter to avoid issues + if [[ $posix_regex = true ]]; then + result="$(sed -E "s${del}${match_regex}${del}${substitute_regex}${del}g" "$filename")" + else + result="$(sed "s${del}${match_regex}${del}${substitute_regex}${del}g" "$filename")" + fi + echo "$result" > "$filename" +} + +######################## +# Remove a line in a file based on a regex +# Arguments: +# $1 - filename +# $2 - match regex +# $3 - use POSIX regex. Default: true +# Returns: +# None +######################### +remove_in_file() { + local filename="${1:?filename is required}" + local match_regex="${2:?match regex is required}" + local posix_regex=${3:-true} + local result + + # We should avoid using 'sed in-place' substitutions + # 1) They are not compatible with files mounted from ConfigMap(s) + # 2) We found incompatibility issues with Debian10 and "in-place" substitutions + if [[ $posix_regex = true ]]; then + result="$(sed -E "/$match_regex/d" "$filename")" + else + result="$(sed "/$match_regex/d" "$filename")" + fi + echo "$result" > "$filename" +} + +######################## +# Appends text after the last line matching a pattern +# Arguments: +# $1 - file +# $2 - match regex +# $3 - contents to add +# Returns: +# None +######################### +append_file_after_last_match() { + local file="${1:?missing file}" + local match_regex="${2:?missing pattern}" + local value="${3:?missing value}" + + # We read the file in reverse, replace the first match (0,/pattern/s) and then reverse the results again + result="$(tac "$file" | sed -E "0,/($match_regex)/s||${value}\n\1|" | tac)" + echo "$result" > "$file" +} diff --git a/bitnami/dokuwiki/0/debian-10/prebuildfs/opt/bitnami/scripts/libfs.sh b/bitnami/dokuwiki/0/debian-10/prebuildfs/opt/bitnami/scripts/libfs.sh new file mode 100644 index 000000000000..8f37ecbd823e --- /dev/null +++ b/bitnami/dokuwiki/0/debian-10/prebuildfs/opt/bitnami/scripts/libfs.sh @@ -0,0 +1,183 @@ +#!/bin/bash +# +# Library for file system actions + +# shellcheck disable=SC1091 + +# Load Generic Libraries +. /opt/bitnami/scripts/liblog.sh + +# Functions + +######################## +# Ensure a file/directory is owned (user and group) but the given user +# Arguments: +# $1 - filepath +# $2 - owner +# Returns: +# None +######################### +owned_by() { + local path="${1:?path is missing}" + local owner="${2:?owner is missing}" + + chown "$owner":"$owner" "$path" +} + +######################## +# Ensure a directory exists and, optionally, is owned by the given user +# Arguments: +# $1 - directory +# $2 - owner +# Returns: +# None +######################### +ensure_dir_exists() { + local dir="${1:?directory is missing}" + local owner="${2:-}" + + mkdir -p "${dir}" + if [[ -n $owner ]]; then + owned_by "$dir" "$owner" + fi +} + +######################## +# Checks whether a directory is empty or not +# arguments: +# $1 - directory +# returns: +# boolean +######################### +is_dir_empty() { + local dir="${1:?missing directory}" + + if [[ ! -e "$dir" ]] || [[ -z "$(ls -A "$dir")" ]]; then + true + else + false + fi +} + +######################## +# Checks whether a mounted directory is empty or not +# arguments: +# $1 - directory +# returns: +# boolean +######################### +is_mounted_dir_empty() { + local dir="${1:?missing directory}" + + if is_dir_empty "$dir" || find "$dir" -mindepth 1 -maxdepth 1 -not -name ".snapshot" -not -name "lost+found" -exec false {} +; then + true + else + false + fi +} + +######################## +# Checks whether a file can be written to or not +# arguments: +# $1 - file +# returns: +# boolean +######################### +is_file_writable() { + local file="${1:?missing file}" + local dir + dir="$(dirname "$file")" + + if [[ ( -f "$file" && -w "$file" ) || ( ! -f "$file" && -d "$dir" && -w "$dir" ) ]]; then + true + else + false + fi +} + +######################## +# Relativize a path +# arguments: +# $1 - path +# $2 - base +# returns: +# None +######################### +relativize() { + local -r path="${1:?missing path}" + local -r base="${2:?missing base}" + pushd "$base" >/dev/null + realpath -q --no-symlinks --relative-base="$base" "$path" | sed -e 's|^/$|.|' -e 's|^/||' + popd >/dev/null +} + +######################## +# Configure permisions and ownership recursively +# Globals: +# None +# Arguments: +# $1 - paths (as a string). +# Flags: +# -f|--file-mode - mode for directories. +# -d|--dir-mode - mode for files. +# -u|--user - user +# -g|--group - group +# Returns: +# None +######################### +configure_permissions_ownership() { + local -r paths="${1:?paths is missing}" + local dir_mode="" + local file_mode="" + local user="" + local group="" + + # Validate arguments + shift 1 + while [ "$#" -gt 0 ]; do + case "$1" in + -f|--file-mode) + shift + file_mode="${1:?missing mode for files}" + ;; + -d|--dir-mode) + shift + dir_mode="${1:?missing mode for directories}" + ;; + -u|--user) + shift + user="${1:?missing user}" + ;; + -g|--group) + shift + group="${1:?missing group}" + ;; + *) + echo "Invalid command line flag $1" >&2 + return 1 + ;; + esac + shift + done + + read -r -a filepaths <<< "$paths" + for p in "${filepaths[@]}"; do + if [[ -e "$p" ]]; then + if [[ -n $dir_mode ]]; then + find -L "$p" -type d -exec chmod "$dir_mode" {} \; + fi + if [[ -n $file_mode ]]; then + find -L "$p" -type f -exec chmod "$file_mode" {} \; + fi + if [[ -n $user ]] && [[ -n $group ]]; then + chown -LR "$user":"$group" "$p" + elif [[ -n $user ]] && [[ -z $group ]]; then + chown -LR "$user" "$p" + elif [[ -z $user ]] && [[ -n $group ]]; then + chgrp -LR "$group" "$p" + fi + else + stderr_print "$p does not exist" + fi + done +} diff --git a/bitnami/dokuwiki/0/debian-10/prebuildfs/opt/bitnami/scripts/liblog.sh b/bitnami/dokuwiki/0/debian-10/prebuildfs/opt/bitnami/scripts/liblog.sh new file mode 100644 index 000000000000..60ec4cbfc32a --- /dev/null +++ b/bitnami/dokuwiki/0/debian-10/prebuildfs/opt/bitnami/scripts/liblog.sh @@ -0,0 +1,110 @@ +#!/bin/bash +# +# Library for logging functions + +# Constants +RESET='\033[0m' +RED='\033[38;5;1m' +GREEN='\033[38;5;2m' +YELLOW='\033[38;5;3m' +MAGENTA='\033[38;5;5m' +CYAN='\033[38;5;6m' + +# Functions + +######################## +# Print to STDERR +# Arguments: +# Message to print +# Returns: +# None +######################### +stderr_print() { + # 'is_boolean_yes' is defined in libvalidations.sh, but depends on this file so we cannot source it + local bool="${BITNAMI_QUIET:-false}" + # comparison is performed without regard to the case of alphabetic characters + shopt -s nocasematch + if ! [[ "$bool" = 1 || "$bool" =~ ^(yes|true)$ ]]; then + printf "%b\\n" "${*}" >&2 + fi +} + +######################## +# Log message +# Arguments: +# Message to log +# Returns: +# None +######################### +log() { + stderr_print "${CYAN}${MODULE:-} ${MAGENTA}$(date "+%T.%2N ")${RESET}${*}" +} +######################## +# Log an 'info' message +# Arguments: +# Message to log +# Returns: +# None +######################### +info() { + log "${GREEN}INFO ${RESET} ==> ${*}" +} +######################## +# Log message +# Arguments: +# Message to log +# Returns: +# None +######################### +warn() { + log "${YELLOW}WARN ${RESET} ==> ${*}" +} +######################## +# Log an 'error' message +# Arguments: +# Message to log +# Returns: +# None +######################### +error() { + log "${RED}ERROR${RESET} ==> ${*}" +} +######################## +# Log a 'debug' message +# Globals: +# BITNAMI_DEBUG +# Arguments: +# None +# Returns: +# None +######################### +debug() { + # 'is_boolean_yes' is defined in libvalidations.sh, but depends on this file so we cannot source it + local bool="${BITNAMI_DEBUG:-false}" + # comparison is performed without regard to the case of alphabetic characters + shopt -s nocasematch + if [[ "$bool" = 1 || "$bool" =~ ^(yes|true)$ ]]; then + log "${MAGENTA}DEBUG${RESET} ==> ${*}" + fi +} + +######################## +# Indent a string +# Arguments: +# $1 - string +# $2 - number of indentation characters (default: 4) +# $3 - indentation character (default: " ") +# Returns: +# None +######################### +indent() { + local string="${1:-}" + local num="${2:?missing num}" + local char="${3:-" "}" + # Build the indentation unit string + local indent_unit="" + for ((i = 0; i < num; i++)); do + indent_unit="${indent_unit}${char}" + done + echo "$string" | sed "s/^/${indent_unit}/" +} diff --git a/bitnami/dokuwiki/0/debian-10/prebuildfs/opt/bitnami/scripts/libnet.sh b/bitnami/dokuwiki/0/debian-10/prebuildfs/opt/bitnami/scripts/libnet.sh new file mode 100644 index 000000000000..d658d7607277 --- /dev/null +++ b/bitnami/dokuwiki/0/debian-10/prebuildfs/opt/bitnami/scripts/libnet.sh @@ -0,0 +1,140 @@ +#!/bin/bash +# +# Library for network functions + +# shellcheck disable=SC1091 + +# Load Generic Libraries +. /opt/bitnami/scripts/liblog.sh + +# Functions + +######################## +# Resolve dns +# Arguments: +# $1 - Hostname to resolve +# Returns: +# IP +######################### +dns_lookup() { + local host="${1:?host is missing}" + getent ahosts "$host" | awk '/STREAM/ {print $1 }' +} + +######################### +# Wait for a hostname and return the IP +# Arguments: +# $1 - hostname +# $2 - number of retries +# $3 - seconds to wait between retries +# Returns: +# - IP address that corresponds to the hostname +######################### +wait_for_dns_lookup() { + local hostname="${1:?hostname is missing}" + local retries="${2:-5}" + local seconds="${3:-1}" + check_host() { + if [[ $(dns_lookup "$hostname") == "" ]]; then + false + else + true + fi + } + # Wait for the host to be ready + retry_while "check_host ${hostname}" "$retries" "$seconds" + dns_lookup "$hostname" +} + +######################## +# Get machine's IP +# Arguments: +# None +# Returns: +# Machine IP +######################### +get_machine_ip() { + local -a ip_addresses + local hostname + hostname="$(hostname)" + read -r -a ip_addresses <<< "$(dns_lookup "$hostname" | xargs echo)" + if [[ "${#ip_addresses[@]}" -gt 1 ]]; then + warn "Found more than one IP address associated to hostname ${hostname}: ${ip_addresses[*]}, will use ${ip_addresses[0]}" + elif [[ "${#ip_addresses[@]}" -lt 1 ]]; then + error "Could not find any IP address associated to hostname ${hostname}" + exit 1 + fi + echo "${ip_addresses[0]}" +} + +######################## +# Check if the provided argument is a resolved hostname +# Arguments: +# $1 - Value to check +# Returns: +# Boolean +######################### +is_hostname_resolved() { + local -r host="${1:?missing value}" + if [[ -n "$(dns_lookup "$host")" ]]; then + true + else + false + fi +} + +######################## +# Parse URL +# Globals: +# None +# Arguments: +# $1 - uri - String +# $2 - component to obtain. Valid options (scheme, authority, userinfo, host, port, path, query or fragment) - String +# Returns: +# String +parse_uri() { + local uri="${1:?uri is missing}" + local component="${2:?component is missing}" + + # Solution based on https://tools.ietf.org/html/rfc3986#appendix-B with + # additional sub-expressions to split authority into userinfo, host and port + # Credits to Patryk Obara (see https://stackoverflow.com/a/45977232/6694969) + local -r URI_REGEX='^(([^:/?#]+):)?(//((([^@/?#]+)@)?([^:/?#]+)(:([0-9]+))?))?(/([^?#]*))?(\?([^#]*))?(#(.*))?' + # || | ||| | | | | | | | | | + # |2 scheme | ||6 userinfo 7 host | 9 port | 11 rpath | 13 query | 15 fragment + # 1 scheme: | |5 userinfo@ 8 :... 10 path 12 ?... 14 #... + # | 4 authority + # 3 //... + local index=0 + case "$component" in + scheme) + index=2 + ;; + authority) + index=4 + ;; + userinfo) + index=6 + ;; + host) + index=7 + ;; + port) + index=9 + ;; + path) + index=10 + ;; + query) + index=13 + ;; + fragment) + index=14 + ;; + *) + stderr_print "unrecognized component $component" + return 1 + ;; + esac + [[ "$uri" =~ $URI_REGEX ]] && echo "${BASH_REMATCH[${index}]}" +} diff --git a/bitnami/dokuwiki/0/debian-10/prebuildfs/opt/bitnami/scripts/libos.sh b/bitnami/dokuwiki/0/debian-10/prebuildfs/opt/bitnami/scripts/libos.sh new file mode 100644 index 000000000000..17309d011b4f --- /dev/null +++ b/bitnami/dokuwiki/0/debian-10/prebuildfs/opt/bitnami/scripts/libos.sh @@ -0,0 +1,279 @@ +#!/bin/bash +# +# Library for operating system actions + +# shellcheck disable=SC1091 + +# Load Generic Libraries +. /opt/bitnami/scripts/liblog.sh + +# Functions + +######################## +# Check if an user exists in the system +# Arguments: +# $1 - user +# Returns: +# Boolean +######################### +user_exists() { + local user="${1:?user is missing}" + id "$user" >/dev/null 2>&1 +} + +######################## +# Check if a group exists in the system +# Arguments: +# $1 - group +# Returns: +# Boolean +######################### +group_exists() { + local group="${1:?group is missing}" + getent group "$group" >/dev/null 2>&1 +} + +######################## +# Create a group in the system if it does not exist already +# Arguments: +# $1 - group +# Returns: +# None +######################### +ensure_group_exists() { + local group="${1:?group is missing}" + + if ! group_exists "$group"; then + groupadd "$group" >/dev/null 2>&1 + fi +} + +######################## +# Create an user in the system if it does not exist already +# Arguments: +# $1 - user +# $2 - group +# Returns: +# None +######################### +ensure_user_exists() { + local user="${1:?user is missing}" + local group="${2:-}" + + if ! user_exists "$user"; then + useradd "$user" >/dev/null 2>&1 + fi + + if [[ -n "$group" ]]; then + ensure_group_exists "$group" + usermod -a -G "$group" "$user" >/dev/null 2>&1 + fi +} + +######################## +# Check if the script is currently running as root +# Arguments: +# $1 - user +# $2 - group +# Returns: +# Boolean +######################### +am_i_root() { + if [[ "$(id -u)" = "0" ]]; then + true + else + false + fi +} + +######################## +# Get total memory available +# Arguments: +# None +# Returns: +# Memory in bytes +######################### +get_total_memory() { + echo $(($(grep MemTotal /proc/meminfo | awk '{print $2}') / 1024)) +} + +######################## +# Get machine size depending on specified memory +# Globals: +# None +# Arguments: +# None +# Flags: +# --memory - memory size (optional) +# Returns: +# Detected instance size +######################### +get_machine_size() { + local memory="" + # Validate arguments + while [[ "$#" -gt 0 ]]; do + case "$1" in + --memory) + shift + memory="${1:?missing memory}" + ;; + *) + echo "Invalid command line flag $1" >&2 + return 1 + ;; + esac + shift + done + if [[ -z "$memory" ]]; then + debug "Memory was not specified, detecting available memory automatically" + memory="$(get_total_memory)" + fi + sanitized_memory=$(convert_to_mb "$memory") + if [[ "$sanitized_memory" -gt 26000 ]]; then + echo 2xlarge + elif [[ "$sanitized_memory" -gt 13000 ]]; then + echo xlarge + elif [[ "$sanitized_memory" -gt 6000 ]]; then + echo large + elif [[ "$sanitized_memory" -gt 3000 ]]; then + echo medium + elif [[ "$sanitized_memory" -gt 1500 ]]; then + echo small + else + echo micro + fi +} + +######################## +# Get machine size depending on specified memory +# Globals: +# None +# Arguments: +# $1 - memory size (optional) +# Returns: +# Detected instance size +######################### +get_supported_machine_sizes() { + echo micro small medium large xlarge 2xlarge +} + +######################## +# Convert memory size from string to amount of megabytes (i.e. 2G -> 2048) +# Globals: +# None +# Arguments: +# $1 - memory size +# Returns: +# Result of the conversion +######################### +convert_to_mb() { + local amount="${1:-}" + if [[ $amount =~ ^([0-9]+)(m|M|g|G) ]]; then + size="${BASH_REMATCH[1]}" + unit="${BASH_REMATCH[2]}" + if [[ "$unit" = "g" || "$unit" = "G" ]]; then + amount="$((size * 1024))" + else + amount="$size" + fi + fi + echo "$amount" +} + + +######################### +# Redirects output to /dev/null if debug mode is disabled +# Globals: +# BITNAMI_DEBUG +# Arguments: +# $@ - Command to execute +# Returns: +# None +######################### +debug_execute() { + if ${BITNAMI_DEBUG:-false}; then + "$@" + else + "$@" >/dev/null 2>&1 + fi +} + +######################## +# Retries a command a given number of times +# Arguments: +# $1 - cmd (as a string) +# $2 - max retries. Default: 12 +# $3 - sleep between retries (in seconds). Default: 5 +# Returns: +# Boolean +######################### +retry_while() { + local cmd="${1:?cmd is missing}" + local retries="${2:-12}" + local sleep_time="${3:-5}" + local return_value=1 + + read -r -a command <<< "$cmd" + for ((i = 1 ; i <= retries ; i+=1 )); do + "${command[@]}" && return_value=0 && break + sleep "$sleep_time" + done + return $return_value +} + +######################## +# Generate a random string +# Arguments: +# -t|--type - String type (ascii, alphanumeric, numeric), defaults to ascii +# -c|--count - Number of characters, defaults to 32 +# Arguments: +# None +# Returns: +# None +# Returns: +# String +######################### +generate_random_string() { + local type="ascii" + local count="32" + local filter + local result + # Validate arguments + while [[ "$#" -gt 0 ]]; do + case "$1" in + -t|--type) + shift + type="$1" + ;; + -c|--count) + shift + count="$1" + ;; + *) + echo "Invalid command line flag $1" >&2 + return 1 + ;; + esac + shift + done + # Validate type + case "$type" in + ascii) + filter="[:print:]" + ;; + alphanumeric) + filter="a-zA-Z0-9" + ;; + numeric) + filter="0-9" + ;; + *) + echo "Invalid type ${type}" >&2 + return 1 + esac + # Obtain count + 10 lines from /dev/urandom to ensure that the resulting string has the expected size + # Note there is a very small chance of strings starting with EOL character + # Therefore, the higher amount of lines read, this will happen less frequently + result="$(head -n "$((count + 10))" /dev/urandom | tr -dc "$filter" | head -c "$count")" + echo "$result" +} diff --git a/bitnami/dokuwiki/0/debian-10/prebuildfs/opt/bitnami/scripts/libpersistence.sh b/bitnami/dokuwiki/0/debian-10/prebuildfs/opt/bitnami/scripts/libpersistence.sh new file mode 100644 index 000000000000..452c1f4b2831 --- /dev/null +++ b/bitnami/dokuwiki/0/debian-10/prebuildfs/opt/bitnami/scripts/libpersistence.sh @@ -0,0 +1,122 @@ +#!/bin/bash +# +# Bitnami persistence library +# Used for bringing persistence capabilities to applications that don't have clear separation of data and logic + +# shellcheck disable=SC1091 + +# Load Generic Libraries +. /opt/bitnami/scripts/libfs.sh +. /opt/bitnami/scripts/libos.sh +. /opt/bitnami/scripts/liblog.sh +. /opt/bitnami/scripts/libversion.sh + +# Functions + +######################## +# Persist an application directory +# Globals: +# BITNAMI_ROOT_DIR +# BITNAMI_VOLUME_DIR +# Arguments: +# $1 - App folder name +# $2 - List of app files to persist +# Returns: +# true if all steps succeeded, false otherwise +######################### +persist_app() { + local -r app="${1:?missing app}" + local -a files_to_restore + read -r -a files_to_persist <<< "$2" + local -r install_dir="${BITNAMI_ROOT_DIR}/${app}" + local -r persist_dir="${BITNAMI_VOLUME_DIR}/${app}" + # Persist the individual files + if [[ "${#files_to_persist[@]}" -lt 0 ]]; then + warn "No files are configured to be persisted" + return + fi + pushd "$install_dir" >/dev/null + local file_to_persist_relative file_to_persist_destination file_to_persist_destination_folder + local -r tmp_file="/tmp/perms.acl" + for file_to_persist in "${files_to_persist[@]}"; do + if [[ ! -f "$file_to_persist" && ! -d "$file_to_persist" ]]; then + error "Cannot persist '${file_to_persist}' because it does not exist" + return 1 + fi + file_to_persist_relative="$(relativize "$file_to_persist" "$install_dir")" + file_to_persist_destination="${persist_dir}/${file_to_persist_relative}" + file_to_persist_destination_folder="$(dirname "$file_to_persist_destination")" + # Get original permissions for existing files, which will be applied later + # Exclude the root directory with 'sed', to avoid issues when copying the entirety of it to a volume + getfacl -R "$file_to_persist_relative" | sed -E '/# file: (\..+|[^.])/,$!d' > "$tmp_file" + # Copy directories to the volume + ensure_dir_exists "$file_to_persist_destination_folder" + cp -Lr --preserve=links "$file_to_persist_relative" "$file_to_persist_destination_folder" + # Restore permissions + pushd "$persist_dir" >/dev/null + if am_i_root; then + setfacl --restore="$tmp_file" + else + # When running as non-root, don't change ownership + setfacl --restore=<(grep -E -v '^# (owner|group):' "$tmp_file") + fi + popd >/dev/null + done + popd >/dev/null + rm -f "$tmp_file" + # Install the persisted files into the installation directory, via symlinks + restore_persisted_app "$@" +} + +######################## +# Restore a persisted application directory +# Globals: +# BITNAMI_ROOT_DIR +# BITNAMI_VOLUME_DIR +# FORCE_MAJOR_UPGRADE +# Arguments: +# $1 - App folder name +# $2 - List of app files to restore +# Returns: +# true if all steps succeeded, false otherwise +######################### +restore_persisted_app() { + local -r app="${1:?missing app}" + local -a files_to_restore + read -r -a files_to_restore <<< "$2" + local -r install_dir="${BITNAMI_ROOT_DIR}/${app}" + local -r persist_dir="${BITNAMI_VOLUME_DIR}/${app}" + # Restore the individual persisted files + if [[ "${#files_to_restore[@]}" -lt 0 ]]; then + warn "No persisted files are configured to be restored" + return + fi + local file_to_restore_relative file_to_restore_origin file_to_restore_destination + for file_to_restore in "${files_to_restore[@]}"; do + file_to_restore_relative="$(relativize "$file_to_restore" "$install_dir")" + # We use 'realpath --no-symlinks' to ensure that the case of '.' is covered and the directory is removed + file_to_restore_origin="$(realpath --no-symlinks "${install_dir}/${file_to_restore_relative}")" + file_to_restore_destination="$(realpath --no-symlinks "${persist_dir}/${file_to_restore_relative}")" + rm -rf "$file_to_restore_origin" + ln -sfn "$file_to_restore_destination" "$file_to_restore_origin" + done +} + +######################## +# Check if an application directory was already persisted +# Globals: +# BITNAMI_VOLUME_DIR +# Arguments: +# $1 - App folder name +# Returns: +# true if all steps succeeded, false otherwise +######################### +is_app_initialized() { + local -r app="${1:?missing app}" + local -r persist_dir="${BITNAMI_VOLUME_DIR}/${app}" + if ! is_mounted_dir_empty "$persist_dir"; then + true + else + false + fi +} diff --git a/bitnami/dokuwiki/0/debian-10/prebuildfs/opt/bitnami/scripts/libservice.sh b/bitnami/dokuwiki/0/debian-10/prebuildfs/opt/bitnami/scripts/libservice.sh new file mode 100644 index 000000000000..0fa91f65fc4f --- /dev/null +++ b/bitnami/dokuwiki/0/debian-10/prebuildfs/opt/bitnami/scripts/libservice.sh @@ -0,0 +1,205 @@ +#!/bin/bash +# +# Library for managing services + +# shellcheck disable=SC1091 + +# Load Generic Libraries +. /opt/bitnami/scripts/libvalidations.sh + +# Functions + +######################## +# Read the provided pid file and returns a PID +# Arguments: +# $1 - Pid file +# Returns: +# PID +######################### +get_pid_from_file() { + local pid_file="${1:?pid file is missing}" + + if [[ -f "$pid_file" ]]; then + if [[ -n "$(< "$pid_file")" ]] && [[ "$(< "$pid_file")" -gt 0 ]]; then + echo "$(< "$pid_file")" + fi + fi +} + +######################## +# Check if a provided PID corresponds to a running service +# Arguments: +# $1 - PID +# Returns: +# Boolean +######################### +is_service_running() { + local pid="${1:?pid is missing}" + + kill -0 "$pid" 2>/dev/null +} + +######################## +# Stop a service by sending a termination signal to its pid +# Arguments: +# $1 - Pid file +# $2 - Signal number (optional) +# Returns: +# None +######################### +stop_service_using_pid() { + local pid_file="${1:?pid file is missing}" + local signal="${2:-}" + local pid + + pid="$(get_pid_from_file "$pid_file")" + [[ -z "$pid" ]] || ! is_service_running "$pid" && return + + if [[ -n "$signal" ]]; then + kill "-${signal}" "$pid" + else + kill "$pid" + fi + + local counter=10 + while [[ "$counter" -ne 0 ]] && is_service_running "$pid"; do + sleep 1 + counter=$((counter - 1)) + done +} + +######################## +# Start cron daemon +# Arguments: +# None +# Returns: +# true if started correctly, false otherwise +######################### +cron_start() { + if [[ -x "/usr/sbin/cron" ]]; then + /usr/sbin/cron + elif [[ -x "/usr/sbin/crond" ]]; then + /usr/sbin/crond + else + false + fi +} + +######################## +# Generate a cron configuration file for a given service +# Arguments: +# $1 - Service name +# $2 - Command +# Flags: +# --run-as - User to run as (default: root) +# --schedule - Cron schedule configuration (default: * * * * *) +# Returns: +# None +######################### +generate_cron_conf() { + local service_name="${1:?service name is missing}" + local cmd="${2:?command is missing}" + local run_as="root" + local schedule="* * * * *" + + # Parse optional CLI flags + shift 2 + while [[ "$#" -gt 0 ]]; do + case "$1" in + --run-as) + shift + run_as="$1" + ;; + --schedule) + shift + schedule="$1" + ;; + *) + echo "Invalid command line flag ${1}" >&2 + return 1 + ;; + esac + shift + done + + mkdir -p /etc/cron.d + echo "${schedule} ${run_as} ${cmd}" > /etc/cron.d/"$service_name" +} + +######################## +# Generate a monit configuration file for a given service +# Arguments: +# $1 - Service name +# $2 - Pid file +# $3 - Start command +# $4 - Stop command +# Flags: +# --disabled - Whether to disable the monit configuration +# Returns: +# None +######################### +generate_monit_conf() { + local service_name="${1:?service name is missing}" + local pid_file="${2:?pid file is missing}" + local start_command="${3:?start command is missing}" + local stop_command="${4:?stop command is missing}" + local monit_conf_dir="/etc/monit/conf.d" + local disabled="no" + + # Parse optional CLI flags + shift 4 + while [[ "$#" -gt 0 ]]; do + case "$1" in + --disabled) + shift + disabled="$1" + ;; + *) + echo "Invalid command line flag ${1}" >&2 + return 1 + ;; + esac + shift + done + + is_boolean_yes "$disabled" && conf_suffix=".disabled" + mkdir -p "$monit_conf_dir" + cat >"${monit_conf_dir}/${service_name}.conf${conf_suffix:-}" <"${logrotate_conf_dir}/${service_name}" <= 0 )); then + true + else + false + fi +} + +######################## +# Check if the provided argument is a boolean or is the string 'yes/true' +# Arguments: +# $1 - Value to check +# Returns: +# Boolean +######################### +is_boolean_yes() { + local -r bool="${1:-}" + # comparison is performed without regard to the case of alphabetic characters + shopt -s nocasematch + if [[ "$bool" = 1 || "$bool" =~ ^(yes|true)$ ]]; then + true + else + false + fi +} + +######################## +# Check if the provided argument is a boolean yes/no value +# Arguments: +# $1 - Value to check +# Returns: +# Boolean +######################### +is_yes_no_value() { + local -r bool="${1:-}" + if [[ "$bool" =~ ^(yes|no)$ ]]; then + true + else + false + fi +} + +######################## +# Check if the provided argument is a boolean true/false value +# Arguments: +# $1 - Value to check +# Returns: +# Boolean +######################### +is_true_false_value() { + local -r bool="${1:-}" + if [[ "$bool" =~ ^(true|false)$ ]]; then + true + else + false + fi +} + +######################## +# Check if the provided argument is an empty string or not defined +# Arguments: +# $1 - Value to check +# Returns: +# Boolean +######################### +is_empty_value() { + local -r val="${1:-}" + if [[ -z "$val" ]]; then + true + else + false + fi +} + +######################## +# Validate if the provided argument is a valid port +# Arguments: +# $1 - Port to validate +# Returns: +# Boolean and error message +######################### +validate_port() { + local value + local unprivileged=0 + + # Parse flags + while [[ "$#" -gt 0 ]]; do + case "$1" in + -unprivileged) + unprivileged=1 + ;; + --) + shift + break + ;; + -*) + stderr_print "unrecognized flag $1" + return 1 + ;; + *) + break + ;; + esac + shift + done + + if [[ "$#" -gt 1 ]]; then + echo "too many arguments provided" + return 2 + elif [[ "$#" -eq 0 ]]; then + stderr_print "missing port argument" + return 1 + else + value=$1 + fi + + if [[ -z "$value" ]]; then + echo "the value is empty" + return 1 + else + if ! is_int "$value"; then + echo "value is not an integer" + return 2 + elif [[ "$value" -lt 0 ]]; then + echo "negative value provided" + return 2 + elif [[ "$value" -gt 65535 ]]; then + echo "requested port is greater than 65535" + return 2 + elif [[ "$unprivileged" = 1 && "$value" -lt 1024 ]]; then + echo "privileged port requested" + return 3 + fi + fi +} + +######################## +# Validate if the provided argument is a valid IPv4 address +# Arguments: +# $1 - IP to validate +# Returns: +# Boolean +######################### +validate_ipv4() { + local ip="${1:?ip is missing}" + local stat=1 + + if [[ $ip =~ ^[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}$ ]]; then + read -r -a ip_array <<< "$(tr '.' ' ' <<< "$ip")" + [[ ${ip_array[0]} -le 255 && ${ip_array[1]} -le 255 \ + && ${ip_array[2]} -le 255 && ${ip_array[3]} -le 255 ]] + stat=$? + fi + return $stat +} + +######################## +# Validate a string format +# Arguments: +# $1 - String to validate +# Returns: +# Boolean +######################### +validate_string() { + local string + local min_length=-1 + local max_length=-1 + + # Parse flags + while [ "$#" -gt 0 ]; do + case "$1" in + -min-length) + shift + min_length=${1:-} + ;; + -max-length) + shift + max_length=${1:-} + ;; + --) + shift + break + ;; + -*) + stderr_print "unrecognized flag $1" + return 1 + ;; + *) + break + ;; + esac + shift + done + + if [ "$#" -gt 1 ]; then + stderr_print "too many arguments provided" + return 2 + elif [ "$#" -eq 0 ]; then + stderr_print "missing string" + return 1 + else + string=$1 + fi + + if [[ "$min_length" -ge 0 ]] && [[ "${#string}" -lt "$min_length" ]]; then + echo "string length is less than $min_length" + return 1 + fi + if [[ "$max_length" -ge 0 ]] && [[ "${#string}" -gt "$max_length" ]]; then + echo "string length is great than $max_length" + return 1 + fi +} diff --git a/bitnami/dokuwiki/0/debian-10/prebuildfs/opt/bitnami/scripts/libversion.sh b/bitnami/dokuwiki/0/debian-10/prebuildfs/opt/bitnami/scripts/libversion.sh new file mode 100644 index 000000000000..66d4f457bdd2 --- /dev/null +++ b/bitnami/dokuwiki/0/debian-10/prebuildfs/opt/bitnami/scripts/libversion.sh @@ -0,0 +1,49 @@ +#!/bin/bash +# +# Library for managing versions strings + +# shellcheck disable=SC1091 + +# Load Generic Libraries +. /opt/bitnami/scripts/liblog.sh + +# Functions +######################## +# Gets semantic version +# Arguments: +# $1 - version: string to extract major.minor.patch +# $2 - section: 1 to extract major, 2 to extract minor, 3 to extract patch +# Returns: +# array with the major, minor and release +######################### +get_sematic_version () { + local version="${1:?version is required}" + local section="${2:?section is required}" + local -a version_sections + + #Regex to parse versions: x.y.z + local -r regex='([0-9]+)(\.([0-9]+)(\.([0-9]+))?)?' + + if [[ "$version" =~ $regex ]]; then + local i=1 + local j=1 + local n=${#BASH_REMATCH[*]} + + while [[ $i -lt $n ]]; do + if [[ -n "${BASH_REMATCH[$i]}" ]] && [[ "${BASH_REMATCH[$i]:0:1}" != '.' ]]; then + version_sections[$j]=${BASH_REMATCH[$i]} + ((j++)) + fi + ((i++)) + done + + local number_regex='^[0-9]+$' + if [[ "$section" =~ $number_regex ]] && (( $section > 0 )) && (( $section <= 3 )); then + echo "${version_sections[$section]}" + return + else + stderr_print "Section allowed values are: 1, 2, and 3" + return 1 + fi + fi +} diff --git a/bitnami/dokuwiki/0/debian-10/prebuildfs/opt/bitnami/scripts/libwebserver.sh b/bitnami/dokuwiki/0/debian-10/prebuildfs/opt/bitnami/scripts/libwebserver.sh new file mode 100644 index 000000000000..d74114834f8e --- /dev/null +++ b/bitnami/dokuwiki/0/debian-10/prebuildfs/opt/bitnami/scripts/libwebserver.sh @@ -0,0 +1,364 @@ +#!/bin/bash +# +# Bitnami web server handler library + +# shellcheck disable=SC1091 + +# Load generic libraries +. /opt/bitnami/scripts/liblog.sh + +# Load web server libraries +[[ -f "/opt/bitnami/scripts/libapache.sh" ]] && . /opt/bitnami/scripts/libapache.sh +[[ -f "/opt/bitnami/scripts/libnginx.sh" ]] && . /opt/bitnami/scripts/libnginx.sh + +# Load environment for all configured web servers +[[ -f "/opt/bitnami/scripts/apache-env.sh" ]] && . /opt/bitnami/scripts/apache-env.sh +[[ -f "/opt/bitnami/scripts/nginx-env.sh" ]] && . /opt/bitnami/scripts/nginx-env.sh + +######################## +# Prints the currently-enabled web server type +# Globals: +# WEB_SERVER_TYPE +# Arguments: +# None +# Returns: +# None +######################### +web_server_type() { + echo "$WEB_SERVER_TYPE" +} + +######################## +# Validate that a supported web server is configured +# Globals: +# WEB_SERVER_* +# Arguments: +# None +# Returns: +# None +######################### +web_server_validate() { + local error_code=0 + local supported_web_servers=("apache" "nginx") + + # Auxiliary functions + print_validation_error() { + error "$1" + error_code=1 + } + + if [[ -z "$(web_server_type)" || ! " ${supported_web_servers[*]} " == *" $(web_server_type) "* ]]; then + print_validation_error "Could not detect any supported web servers. It must be one of: ${supported_web_servers[*]}" + elif ! type -t "is_$(web_server_type)_running" >/dev/null; then + print_validation_error "Could not load the $(web_server_type) web server library from /opt/bitnami/scripts. Check that it exists and is readable." + fi + + return "$error_code" +} + +######################## +# Check whether the web server is running +# Globals: +# * +# Arguments: +# None +# Returns: +# true if the web server is running, false otherwise +######################### +is_web_server_running() { + "is_$(web_server_type)_running" +} + +######################## +# Start web server +# Globals: +# * +# Arguments: +# None +# Returns: +# None +######################### +web_server_start() { + "${BITNAMI_ROOT_DIR}/scripts/$(web_server_type)/start.sh" +} + +######################## +# Stop web server +# Globals: +# * +# Arguments: +# None +# Returns: +# None +######################### +web_server_stop() { + "${BITNAMI_ROOT_DIR}/scripts/$(web_server_type)/stop.sh" +} + +######################## +# Restart web server +# Globals: +# * +# Arguments: +# None +# Returns: +# None +######################### +web_server_restart() { + "${BITNAMI_ROOT_DIR}/scripts/$(web_server_type)/restart.sh" +} + +######################## +# Reload web server +# Globals: +# * +# Arguments: +# None +# Returns: +# None +######################### +web_server_reload() { + "${BITNAMI_ROOT_DIR}/scripts/$(web_server_type)/reload.sh" +} + +######################## +# Ensure a web server application configuration exists (i.e. Apache virtual host format or NGINX server block) +# It serves as a wrapper for the specific web server function +# Globals: +# * +# Arguments: +# $1 - App name +# Flags: +# --hosts - Hosts to enable +# --type - Application type, which has an effect on which configuration template to use +# --allow-remote-connections - Whether to allow remote connections or to require local connections +# --disabled - Whether to render the file with a .disabled prefix +# --enable-https - Enable app configuration on HTTPS port +# --http-port - HTTP port number +# --https-port - HTTPS port number +# --document-root - Path to document root directory +# Apache-specific flags: +# --apache-additional-configuration - Additional vhost configuration (no default) +# --apache-before-vhost-configuration - Configuration to add before the directive (no default) +# --apache-allow-override - Whether to allow .htaccess files (only allowed when --move-htaccess is set to 'no') +# --apache-extra-directory-configuration - Extra configuration for the document root directory +# --apache-move-htaccess - Move .htaccess files to a common place so they can be loaded during Apache startup +# NGINX-specific flags: +# --nginx-additional-configuration - Additional server block configuration (no default) +# Returns: +# true if the configuration was enabled, false otherwise +######################## +ensure_web_server_app_configuration_exists() { + local app="${1:?missing app}" + local -a args=("$app") + # Validate arguments + shift + while [[ "$#" -gt 0 ]]; do + case "$1" in + # Common flags + --hosts \ + | --type \ + | --allow-remote-connections \ + | --disabled \ + | --enable-https \ + | --http-port \ + | --https-port \ + | --document-root \ + ) + args+=("$1" "${2:?missing value}") + shift + ;; + + # Specific Apache flags + --apache-additional-configuration \ + | --apache-before-vhost-configuration \ + | --apache-allow-override \ + | --apache-extra-directory-configuration \ + | --apache-move-htaccess \ + ) + [[ "$(web_server_type)" == "apache" ]] && args+=("${1//apache-/}" "${2:?missing value}") + shift + ;; + + # Specific NGINX flags + --nginx-additional-configuration) + [[ "$(web_server_type)" == "nginx" ]] && args+=("${1//nginx-/}" "${2:?missing value}") + shift + ;; + + *) + echo "Invalid command line flag $1" >&2 + return 1 + ;; + esac + shift + done + "ensure_$(web_server_type)_app_configuration_exists" "${args[@]}" +} + +######################## +# Ensure a web server application configuration does not exist anymore (i.e. Apache virtual host format or NGINX server block) +# It serves as a wrapper for the specific web server function +# Globals: +# * +# Arguments: +# $1 - App name +# Returns: +# true if the configuration was disabled, false otherwise +######################## +ensure_web_server_app_configuration_not_exists() { + local app="${1:?missing app}" + "ensure_$(web_server_type)_app_configuration_not_exists" "$app" +} + +######################## +# Ensure the web server loads the configuration for an application in a URL prefix +# It serves as a wrapper for the specific web server function +# Globals: +# * +# Arguments: +# $1 - App name +# Flags: +# --allow-remote-connections - Whether to allow remote connections or to require local connections +# --document-root - Path to document root directory +# --prefix - URL prefix from where it will be accessible (i.e. /myapp) +# --type - Application type, which has an effect on what configuration template will be used +# Apache-specific flags: +# --apache-additional-configuration - Additional vhost configuration (no default) +# --apache-allow-override - Whether to allow .htaccess files (only allowed when --move-htaccess is set to 'no') +# --apache-extra-directory-configuration - Extra configuration for the document root directory +# --apache-move-htaccess - Move .htaccess files to a common place so they can be loaded during Apache startup +# NGINX-specific flags: +# --nginx-additional-configuration - Additional server block configuration (no default) +# Returns: +# true if the configuration was enabled, false otherwise +######################## +ensure_web_server_prefix_configuration_exists() { + local app="${1:?missing app}" + local -a args=("$app") + # Validate arguments + shift + while [[ "$#" -gt 0 ]]; do + case "$1" in + # Common flags + --allow-remote-connections \ + | --document-root \ + | --prefix \ + | --type \ + ) + args+=("$1" "${2:?missing value}") + shift + ;; + + # Specific Apache flags + --apache-additional-configuration \ + | --apache-allow-override \ + | --apache-extra-directory-configuration \ + | --apache-move-htaccess \ + ) + [[ "$(web_server_type)" == "apache" ]] && args+=("${1//apache-/}" "$2") + shift + ;; + + # Specific NGINX flags + --nginx-additional-configuration) + [[ "$(web_server_type)" == "nginx" ]] && args+=("${1//nginx-/}" "$2") + shift + ;; + + *) + echo "Invalid command line flag $1" >&2 + return 1 + ;; + esac + shift + done + "ensure_$(web_server_type)_prefix_configuration_exists" "${args[@]}" +} + +######################## +# Ensure a web server application configuration is updated with the runtime configuration (i.e. ports) +# It serves as a wrapper for the specific web server function +# Globals: +# * +# Arguments: +# $1 - App name +# Flags: +# --hosts - Hosts to enable +# --enable-https - Update HTTPS app configuration +# --http-port - HTTP port number +# --https-port - HTTPS port number +# Returns: +# true if the configuration was updated, false otherwise +######################## +web_server_update_app_configuration() { + local app="${1:?missing app}" + local -a args=("$app") + # Validate arguments + shift + while [[ "$#" -gt 0 ]]; do + case "$1" in + # Common flags + --hosts \ + | --enable-https \ + | --http-port \ + | --https-port \ + ) + args+=("$1" "${2:?missing value}") + shift + ;; + + *) + echo "Invalid command line flag $1" >&2 + return 1 + ;; + esac + shift + done + "$(web_server_type)_update_app_configuration" "${args[@]}" +} + +######################## +# Enable loading page, which shows users that the initialization process is not yet completed +# Globals: +# * +# Arguments: +# None +# Returns: +# None +######################### +web_server_enable_loading_page() { + ensure_web_server_app_configuration_exists "__loading" --hosts "_default_" \ + --apache-additional-configuration " +# Show a HTTP 503 Service Unavailable page by default +RedirectMatch 503 ^/$ +# Show index.html if server is answering with 404 Not Found or 503 Service Unavailable status codes +ErrorDocument 404 /index.html +ErrorDocument 503 /index.html" \ + --nginx-additional-configuration " +# Show a HTTP 503 Service Unavailable page by default +location / { + return 503; +} +# Show index.html if server is answering with 404 Not Found or 503 Service Unavailable status codes +error_page 404 @installing; +error_page 503 @installing; +location @installing { + rewrite ^(.*)$ /index.html break; +}" + web_server_reload +} + +######################## +# Enable loading page, which shows users that the initialization process is not yet completed +# Globals: +# * +# Arguments: +# None +# Returns: +# None +######################### +web_server_disable_install_page() { + ensure_web_server_app_configuration_not_exists "__loading" + web_server_reload +} diff --git a/bitnami/dokuwiki/0/debian-10/prebuildfs/usr/sbin/bitnami-pkg b/bitnami/dokuwiki/0/debian-10/prebuildfs/usr/sbin/bitnami-pkg deleted file mode 100755 index eb0ea3c02952..000000000000 --- a/bitnami/dokuwiki/0/debian-10/prebuildfs/usr/sbin/bitnami-pkg +++ /dev/null @@ -1,215 +0,0 @@ -#!/bin/bash -e -. /opt/bitnami/base/functions - -print_usage() { - log "Usage: bitnami-pkg - [OPTIONS] -- [ARGS]" - log "" - log "Download and install Bitnami packages" - log "" - log "Commands:" - log " install Download and install a package." - log " unpack Download and unpack a package." - log "" - log "Options:" - log " -b, --bucket Package release bucket (default: stacksmith)." - log " -c, --checksum SHA256 verification checksum." - log " -h, --help Show this help message and exit." - log "" - log "If the package is already available in the /tmp/bitnami/pkg/cache/" - log "directory, the download will be skipped. If there is a corresponding" - log "file of the same name post-fixed with .sha256 in the directory," - log "that sha will be used instead of the --checksum option." - log "" - log "Examples:" - log " - Unpack package" - log " \$ bitnami-pkg unpack nginx-1.9.10-0" - log "" - log " - Verify and Install package" - log " \$ bitnami-pkg install nginx-1.9.10-0 --checksum 15565d06b18c2e3710fc08e579ddb3d0e39aa663264a0f7404f0743cb4cdb58d" - log "" - log " - Install package with arguments" - log " \$ bitnami-pkg install mariadb-10.1.11-0 -- --password bitnami" - log "" - log " - Install package from testing" - log " \$ bitnami-pkg install mariadb-10.1.11-0 --bucket testing" - log "" -} - -identify_distro() { - distro="${IMAGE_OS:-unknown}" - if [ "${distro}" == "unknown" -a -f /etc/os-release ]; then - distro="$(grep "^ID=" /etc/os-release | cut -d'=' -f2 | cut -d'"' -f2)-$(grep "^VERSION_ID=" /etc/os-release | cut -d'=' -f2 | cut -d'"' -f2 | cut -d'.' -f1)" - fi - echo "$distro" -} - -identify_arch() { - local arch=$(uname -m) - - case "${arch}" in - ppc64le) - ;; # no-op - x86_64) - case $(identify_distro) in - debian-*) - arch=amd64 - ;; - ol-*) - arch=x86_64 - ;; - centos-*) - arch=x86_64 - ;; - rhel-*) - arch=x86_64 - ;; - photon-*) - arch=x86_64 - ;; - esac - ;; - *) - arch="unknown" - ;; - esac - echo $arch -} - -# break up command line for easy parsing and check legal options -ARGS=$(getopt -o b:c:h -l "bucket:,checksum:,help" -n "bitnami-pkg" -- "$@") -if [ $? -ne 0 ]; -then - exit 1 -fi - -eval set -- "$ARGS"; -while true; do - case "$1" in - -b|--bucket) - shift - if [ -n "$1" ]; then - RELEASE_BUCKET=$1 - shift - fi - ;; - -c|--checksum) - shift - if [ -n "$1" ]; then - PACKAGE_SHA256=$1 - shift - fi - ;; - -h|--help) - print_usage - exit 0 - ;; - --) - shift - break - ;; - esac -done - -# weed out unrecognized commands -case "$1" in - install|unpack) ;; - *) - error "Unrecognized command: $1" - print_usage - exit 1 - ;; -esac - -# install/unpack command need to be supplied a package name -if [ $# -lt 2 ]; then - print_usage - exit 1 -fi - -INSTALL_ROOT=/tmp/bitnami/pkg/install -CACHE_ROOT=/tmp/bitnami/pkg/cache - -PACKAGE="$2-linux-$(identify_arch)-$(identify_distro)" -PACKAGE_ARGS=${@:3} -PACKAGE_NAME=$(echo $PACKAGE | sed 's/-[0-9].*//') -RELEASE_BUCKET=${RELEASE_BUCKET:-stacksmith} - -mkdir -p $INSTALL_ROOT -cd $INSTALL_ROOT - -info "Downloading $PACKAGE package" -if [ -f $CACHE_ROOT/$PACKAGE.tar.gz ]; then - info "$CACHE_ROOT/$PACKAGE.tar.gz already exists, skipping download." - cp $CACHE_ROOT/$PACKAGE.tar.gz . - if [ -f $CACHE_ROOT/$PACKAGE.tar.gz.sha256 ]; then - info "Using the local sha256 from $CACHE_ROOT/$PACKAGE.tar.gz.sha256" - PACKAGE_SHA256=$(cat $CACHE_ROOT/$PACKAGE.tar.gz.sha256) - fi -else - # display cURL progress bar when a tty is attached - if tty -s; then - CURL_ARGS="-#" - else - CURL_ARGS="-sS" - fi - if ! curl $CURL_ARGS -LOf "https://downloads.bitnami.com/files/$RELEASE_BUCKET/$PACKAGE.tar.gz"; then - warn "Package name '$PACKAGE' does not exist, will try '${PACKAGE%-$(identify_distro)}'..." - if curl $CURL_ARGS -LOf "https://downloads.bitnami.com/files/$RELEASE_BUCKET/${PACKAGE%-$(identify_distro)}.tar.gz"; then - PACKAGE="${PACKAGE%-$(identify_distro)}" - else - error "Could not find the requested package..." - exit 1 - fi - fi -fi - -if ! tar tzf $PACKAGE.tar.gz >/dev/null 2>&1; then - error "Invalid or corrupt '$PACKAGE' package." - exit 1 -fi - -if [ "$PACKAGE_SHA256" ]; then - info "Verifying package integrity" - echo "$PACKAGE_SHA256 $PACKAGE.tar.gz" | sha256sum -c - -fi - -# If the tarball has too many files, it can trigger a bug -# in overlayfs when using tar. Install bsdtar in the container image -# to workaround it. As the overhead is too big (~40 MB), it is not added by -# default. Source: https://github.com/coreos/bugs/issues/1095 -if which bsdtar >/dev/null 2>&1; then - bsdtar -xf $PACKAGE.tar.gz -else - tar xzf $PACKAGE.tar.gz -fi - -case "$1" in - install) info "Installing $PACKAGE" ;; - unpack) info "Unpacking $PACKAGE" ;; -esac - -nami $1 $PACKAGE $PACKAGE_ARGS -rm -rf $INSTALL_ROOT - -if [ "$BITNAMI_PKG_EXTRA_DIRS" ]; then - info "Creating extra directories" - for i in ${BITNAMI_PKG_EXTRA_DIRS}; do - mkdir -p $i - done -fi - -if [ "$BITNAMI_PKG_CHMOD" ]; then - DIRS="/.nami /bitnami $BITNAMI_PKG_EXTRA_DIRS" - if ! [[ $PACKAGE_NAME =~ .*-client ]]; then - mkdir -p /bitnami/$PACKAGE_NAME - fi - # We need to be in $HOME in order to nami inspect works - cd $HOME - DIRS+=" $(nami inspect $PACKAGE_NAME | grep -e '"installdir"' | cut -f4 -d\")" - info "Fixing permissions: chmod $BITNAMI_PKG_CHMOD $DIRS" - chmod $BITNAMI_PKG_CHMOD $DIRS -fi - -# Include metadata about the package -touch "${BITNAMI_PREFIX}/.bitnami_packages" -echo "${PACKAGE}" >> "${BITNAMI_PREFIX}/.bitnami_packages" diff --git a/bitnami/dokuwiki/0/debian-10/rootfs/apache-init.sh b/bitnami/dokuwiki/0/debian-10/rootfs/apache-init.sh deleted file mode 100644 index b22b41cc9e72..000000000000 --- a/bitnami/dokuwiki/0/debian-10/rootfs/apache-init.sh +++ /dev/null @@ -1,24 +0,0 @@ -#!/bin/bash - -# Check whether Apache ports must be configured -if [[ -n "${APACHE_HTTP_PORT_NUMBER:-}" || -n "${APACHE_HTTPS_PORT_NUMBER:-}" ]]; then - export APACHE_ENABLE_CUSTOM_PORTS="yes" -fi - -# Copy vhosts file -if [[ "$(ls -A /vhosts 2>/dev/null)" ]]; then - info "Found vhost definitions in /vhosts. Copying them to /opt/bitnami/apache/conf/vhosts" - cp -r /vhosts/* /opt/bitnami/apache/conf/vhosts -fi - -# Mount certificate files -if [[ -d "/opt/bitnami/apache/certs" ]]; then - warn "The directory '/opt/bitnami/apache/certs' was externally mounted. This is a legacy configuration and will be deprecated soon. Please mount certificate files at '/opt/bitnami/apache/conf/bitnami/certs' instead. Find an example at: https://github.com/bitnami/bitnami-docker-apache#using-custom-ssl-certificates" - warn "Restoring certificates at '/opt/bitnami/apache/certs' to '/opt/bitnami/apache/conf/bitnami/certs'..." - rm -rf /opt/bitnami/apache/conf/bitnami/certs - ln -sf /opt/bitnami/apache/certs /opt/bitnami/apache/conf/bitnami/certs -elif [ "$(ls -A /certs 2>/dev/null)" ]; then - info "Mounting certificates files from /certs..." - rm -rf /opt/bitnami/apache/conf/bitnami/certs - ln -sf /certs /opt/bitnami/apache/conf/bitnami/certs -fi diff --git a/bitnami/dokuwiki/0/debian-10/rootfs/apache-inputs.json b/bitnami/dokuwiki/0/debian-10/rootfs/apache-inputs.json deleted file mode 100644 index 77ab9593775e..000000000000 --- a/bitnami/dokuwiki/0/debian-10/rootfs/apache-inputs.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "enableCustomPorts": "{{$global.env.APACHE_ENABLE_CUSTOM_PORTS}}", - "httpPort": "{{$global.env.APACHE_HTTP_PORT_NUMBER}}", - "httpsPort": "{{$global.env.APACHE_HTTPS_PORT_NUMBER}}" -} \ No newline at end of file diff --git a/bitnami/dokuwiki/0/debian-10/rootfs/app-entrypoint.sh b/bitnami/dokuwiki/0/debian-10/rootfs/app-entrypoint.sh deleted file mode 100755 index 80d8b88614f9..000000000000 --- a/bitnami/dokuwiki/0/debian-10/rootfs/app-entrypoint.sh +++ /dev/null @@ -1,15 +0,0 @@ -#!/bin/bash -e - -. /opt/bitnami/base/functions -. /opt/bitnami/base/helpers - -print_welcome_page - -if [[ "$1" == "nami" && "$2" == "start" ]] || [[ "$1" == "httpd" ]]; then - . /apache-init.sh - nami_initialize php apache dokuwiki - info "Starting dokuwiki... " - . /post-init.sh -fi - -exec tini -- "$@" diff --git a/bitnami/dokuwiki/0/debian-10/rootfs/dokuwiki-inputs.json b/bitnami/dokuwiki/0/debian-10/rootfs/dokuwiki-inputs.json deleted file mode 100644 index 86ac5083c505..000000000000 --- a/bitnami/dokuwiki/0/debian-10/rootfs/dokuwiki-inputs.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "email": "{{$global.env.DOKUWIKI_EMAIL}}", - "fullName": "{{$global.env.DOKUWIKI_FULL_NAME}}", - "password": "{{$global.env.DOKUWIKI_PASSWORD}}", - "phpMemoryLimit": "{{$global.env.PHP_MEMORY_LIMIT}}", - "username": "{{$global.env.DOKUWIKI_USERNAME}}", - "wikiName": "{{$global.env.DOKUWIKI_WIKI_NAME}}" -} \ No newline at end of file diff --git a/bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/apache/conf/bitnami/certs/server.crt b/bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/apache/conf/bitnami/certs/server.crt new file mode 100644 index 000000000000..466bbeab9ff4 --- /dev/null +++ b/bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/apache/conf/bitnami/certs/server.crt @@ -0,0 +1,17 @@ +-----BEGIN CERTIFICATE----- +MIICqDCCAZACCQCz8T3726LYsjANBgkqhkiG9w0BAQUFADAWMRQwEgYDVQQDDAtl +eGFtcGxlLmNvbTAeFw0xMjExMTQxMTE4MjdaFw0yMjExMTIxMTE4MjdaMBYxFDAS +BgNVBAMMC2V4YW1wbGUuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKC +AQEA5NHl5TfZtO6zugau2tp5mWIcQYJhuwKTmYeXDLYAGJpoD2SixwPL5c8glneI +Rz1N2EQIZVeaWGbS0FLFlPdOkCkplpW9isYVC4XqKrk5b4HW4+YC+Cup0k+Kd4NM +eZOTUvWr5N6dIpdibkVumBc/pao8VtdwywlCL/PwGRsQtkXrRICzdtRa3MXqTmEF +foyVCGgBRtronlB9x4Plfb8Psk4GrPkjrWYgO8peKrl0O5+F+sYg7Gj95zCH73BQ +ANzCVNrgD9fs9cyx3ru9CUdEoIxAAJwQFkjm7xr6xqhIlSgnQ7B0uOSTNRcXY6rw +s+PxGneec/kRPRgzjC/QHY6n8QIDAQABMA0GCSqGSIb3DQEBBQUAA4IBAQBbyMqF +RDsX8zX1EW5qA8AQ8Jb2XqWrVeSO8blMV3WagJ2airMm3+c/82FCwsd/cZ08UXhA +/Kou0gi/F16tV26PiiUdp590Qao3d8H2qxc1rzzULimZPgxH4iA4vRyMHtyZN6h4 +7Fdn7O9xNMPu8siOz8rrzsEdEX5URbOMkDLCZsbTIUWVv2XmqrR0K10d5VuLWeLi +r+4G6c6jpa244WmqT9ClqceJ12G1Wnmezy7ybiW0l5M2iuIKFEiRP5Hj0J15o1I2 +pXAbKysAdWRHsJSQOtcgO8Vh9k0wo3tKg4HDp1hbrEzoGzOv92Vjg3lG8X+hzbMJ +MQURotHkD4Gk57wL +-----END CERTIFICATE----- diff --git a/bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/apache/conf/bitnami/certs/server.key b/bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/apache/conf/bitnami/certs/server.key new file mode 100644 index 000000000000..1904ca7090ae --- /dev/null +++ b/bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/apache/conf/bitnami/certs/server.key @@ -0,0 +1,27 @@ +-----BEGIN RSA PRIVATE KEY----- +MIIEpAIBAAKCAQEA5NHl5TfZtO6zugau2tp5mWIcQYJhuwKTmYeXDLYAGJpoD2Si +xwPL5c8glneIRz1N2EQIZVeaWGbS0FLFlPdOkCkplpW9isYVC4XqKrk5b4HW4+YC ++Cup0k+Kd4NMeZOTUvWr5N6dIpdibkVumBc/pao8VtdwywlCL/PwGRsQtkXrRICz +dtRa3MXqTmEFfoyVCGgBRtronlB9x4Plfb8Psk4GrPkjrWYgO8peKrl0O5+F+sYg +7Gj95zCH73BQANzCVNrgD9fs9cyx3ru9CUdEoIxAAJwQFkjm7xr6xqhIlSgnQ7B0 +uOSTNRcXY6rws+PxGneec/kRPRgzjC/QHY6n8QIDAQABAoIBACo3G131tuGtpFTu +xLW11vdYZXQklNlGuWp63IBI162yVv54B5wF9Ek6tH1uIiNaiREcRBxGVEB4/+3V +R4SbN9Ba98RDbgu7TcipdTFaqOEMqFO1bNjSXWtip14zSBmqA2Ur1AHOnFj0awGD +J8tBhsmOpcEz0Ch1VdO5ApPvLV8jH9wQiMI/Q6yYQMtmzTMCUMYdMqe+LOziIOzL +oqN/WXnKL5E5TiO1bIxSpWPbT+IVn1c3/PShmvmRrLWsFUQlkwXJKMYZPO+rCCfe +b+Q9lMLMnj+vOnM3z16WC3aiiJGCZjVTvQ+x22YrBTRPxZmHO2eZ4H/cUQM7Y/tw +I7RjEM0CgYEA9Kxt1t8bWonzBii3P0rwyx0IECvg63k+pp4BpxpeWQKL7NVdSzk3 +AyJVcNjUoZgi2kVPdxzZGLrnZfuZ691xQB3oZF0LwBzQ4GFHkTRCB0s8ZA5lcJaI +9pBu91bhz2VOZSTeQWpdMMURjXVyTXZInU1mwzmjVOIAYmO33shH9gcCgYEA72mX +UoIrFPLkOTSZOb7UbjYH01vf6ThQiYCEWg7mD3CbY7n9oobIcQMzNnt7xN4wOl/V +eKfZ7G56q8enfqm45Dyo9aCBCENVzmwO8wLe5UnvJBNL20KjvtwG8w5A6UZQzC7p +3QS+U2zxVQNEeaE6a8Wrq2d1PlhVAHYw8odgNEcCgYBN38+58xrmrz99d1oTuAt5 +6kyVsRGOgPGS4HmQMRFUbT4R7DscZSKASd4945WRtTVqmWLYe4MRnvNlfzYXX0zb +ZmmAAClsRP+qWuwHaEWXwrd+9SIOOqtvJrta1/lZJFpWUOy4j10H18Flb7sosnwc +LPWHL4Iv0xriNfDg5Iga4wKBgQDLJBU59SkJBW+Q+oho7vrg6QeK15IOGbJ8eYfT +woCC6VFwNQh5N1QsUELMH8rNKJpTba18SzAl5ThBOY9tciVnw/C5Og9CK6BLHnUw +zWbDtxAq1BSxXsIB2EAtTBLX3MoB9myJFNVJhE7hi3w2mA8yEu+u6IIa/Ghjk+XE +ZAnFUQKBgQDjMinRZrK5wA09jcetI+dNiLnKHoQG6OaXDDsNCatex0O2F36BvVXE +P78qDz/i5aBMWsLx6VDvWJAkBIpZoNS5UsOn17tFaocGUSkcm48bs8Dn6VvsE8Bd +XMPAHyKuILlKYifBvNq5T22KhqKX7yGmk/AeOOiKr2KeMnh27JYrCA== +-----END RSA PRIVATE KEY----- diff --git a/bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/apache/conf/deflate.conf b/bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/apache/conf/deflate.conf new file mode 100644 index 000000000000..ca9bc1d6e4b6 --- /dev/null +++ b/bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/apache/conf/deflate.conf @@ -0,0 +1,5 @@ + + AddOutputFilterByType DEFLATE text/html text/plain text/xml text/css + AddOutputFilterByType DEFLATE application/x-javascript application/javascript application/ecmascript + AddOutputFilterByType DEFLATE application/rss+xml + diff --git a/bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/apache/conf/vhosts/00_status-vhost.conf b/bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/apache/conf/vhosts/00_status-vhost.conf new file mode 100644 index 000000000000..a0b032243bd2 --- /dev/null +++ b/bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/apache/conf/vhosts/00_status-vhost.conf @@ -0,0 +1,6 @@ + + ServerName status.localhost + + SetHandler server-status + + diff --git a/bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/apache-env.sh b/bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/apache-env.sh new file mode 100644 index 000000000000..e5a4aa18b097 --- /dev/null +++ b/bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/apache-env.sh @@ -0,0 +1,69 @@ +#!/bin/bash +# +# Environment configuration for apache + +# The values for all environment variables will be set in the below order of precedence +# 1. Custom environment variables defined below after Bitnami defaults +# 2. Constants defined in this file (environment variables with no default), i.e. BITNAMI_ROOT_DIR +# 3. Environment variables overridden via external files using *_FILE variables (see below) +# 4. Environment variables set externally (i.e. current Bash context/Dockerfile/userdata) + +export BITNAMI_ROOT_DIR="/opt/bitnami" +export BITNAMI_VOLUME_DIR="/bitnami" + +# Logging configuration +export MODULE="${MODULE:-apache}" +export BITNAMI_DEBUG="${BITNAMI_DEBUG:-false}" + +# By setting an environment variable matching *_FILE to a file path, the prefixed environment +# variable will be overridden with the value specified in that file +apache_env_vars=( + APACHE_HTTP_PORT_NUMBER + APACHE_HTTPS_PORT_NUMBER + +) +for env_var in "${apache_env_vars[@]}"; do + file_env_var="${env_var}_FILE" + if [[ -n "${!file_env_var:-}" ]]; then + export "${env_var}=$(< "${!file_env_var}")" + unset "${file_env_var}" + fi +done +unset apache_env_vars +export WEB_SERVER_TYPE="apache" + +# Paths +export APACHE_BASE_DIR="${BITNAMI_ROOT_DIR}/apache" +export APACHE_BIN_DIR="${APACHE_BASE_DIR}/bin" +export APACHE_CONF_DIR="${APACHE_BASE_DIR}/conf" +export APACHE_HTDOCS_DIR="${APACHE_BASE_DIR}/htdocs" +export APACHE_TMP_DIR="${APACHE_BASE_DIR}/var/run" +export APACHE_LOGS_DIR="${APACHE_BASE_DIR}/logs" +export APACHE_VHOSTS_DIR="${APACHE_CONF_DIR}/vhosts" +export APACHE_HTACCESS_DIR="${APACHE_VHOSTS_DIR}/htaccess" +export APACHE_MOD_PAGESPEED_CACHE_DIR="${APACHE_BASE_DIR}/var/cache" +export APACHE_CONF_FILE="${APACHE_CONF_DIR}/httpd.conf" +export APACHE_PID_FILE="${APACHE_TMP_DIR}/httpd.pid" +export PATH="${APACHE_BIN_DIR}:${BITNAMI_ROOT_DIR}/common/bin:${PATH}" + +# System users (when running with a privileged user) +export APACHE_DAEMON_USER="daemon" +export WEB_SERVER_DAEMON_USER="$APACHE_DAEMON_USER" +export APACHE_DAEMON_GROUP="daemon" +export WEB_SERVER_DAEMON_GROUP="$APACHE_DAEMON_GROUP" +export WEB_SERVER_GROUP="$APACHE_DAEMON_GROUP" + +# Apache configuration +export APACHE_DEFAULT_HTTP_PORT_NUMBER="8080" # only used at build time +export WEB_SERVER_DEFAULT_HTTP_PORT_NUMBER="$APACHE_DEFAULT_HTTP_PORT_NUMBER" +export APACHE_DEFAULT_HTTPS_PORT_NUMBER="8443" # only used at build time +export WEB_SERVER_DEFAULT_HTTPS_PORT_NUMBER="$APACHE_DEFAULT_HTTPS_PORT_NUMBER" +export APACHE_HTTP_PORT_NUMBER="${APACHE_HTTP_PORT_NUMBER:-}" +export WEB_SERVER_HTTP_PORT_NUMBER="$APACHE_HTTP_PORT_NUMBER" + +export APACHE_HTTPS_PORT_NUMBER="${APACHE_HTTPS_PORT_NUMBER:-"${APACHE_HTTPS_PORT:-}"}" +export APACHE_HTTPS_PORT_NUMBER="${APACHE_HTTPS_PORT_NUMBER:-"${WEB_SERVER_HTTPS_PORT:-}"}" +export APACHE_HTTPS_PORT_NUMBER="${APACHE_HTTPS_PORT_NUMBER:-}" +export WEB_SERVER_HTTPS_PORT_NUMBER="$APACHE_HTTPS_PORT_NUMBER" + +# Custom environment variables may be defined below diff --git a/bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/apache-modphp/postunpack.sh b/bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/apache-modphp/postunpack.sh new file mode 100755 index 000000000000..7a907f80b477 --- /dev/null +++ b/bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/apache-modphp/postunpack.sh @@ -0,0 +1,30 @@ +#!/bin/bash + +# shellcheck disable=SC1091 + +set -o errexit +set -o nounset +set -o pipefail +# set -o xtrace # Uncomment this line for debugging purpose + +# Load libraries +. /opt/bitnami/scripts/libapache.sh + +# Load Apache environment +. /opt/bitnami/scripts/apache-env.sh +. /opt/bitnami/scripts/php-env.sh + +# Enable required Apache modules +apache_enable_module "mpm_prefork_module" +apache_enable_module "php7_module" "modules/libphp7.so" + +# Disable incompatible Apache modules +apache_disable_module "mpm_event_module" + +# Write Apache configuration +apache_php_conf_file="${APACHE_CONF_DIR}/bitnami/php.conf" +cat > "$apache_php_conf_file" < + ServerAlias * + {{additional_configuration}} + diff --git a/bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/apache/bitnami-templates/app-generic-https-vhost.conf.tpl b/bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/apache/bitnami-templates/app-generic-https-vhost.conf.tpl new file mode 100644 index 000000000000..b7e33c754376 --- /dev/null +++ b/bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/apache/bitnami-templates/app-generic-https-vhost.conf.tpl @@ -0,0 +1,8 @@ +{{before_vhost_configuration}} + + ServerAlias * + SSLEngine on + SSLCertificateFile "{{APACHE_CONF_DIR}}/bitnami/certs/server.crt" + SSLCertificateKeyFile "{{APACHE_CONF_DIR}}/bitnami/certs/server.key" + {{additional_configuration}} + diff --git a/bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/apache/bitnami-templates/app-generic-prefix.conf.tpl b/bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/apache/bitnami-templates/app-generic-prefix.conf.tpl new file mode 100644 index 000000000000..c895e537502a --- /dev/null +++ b/bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/apache/bitnami-templates/app-generic-prefix.conf.tpl @@ -0,0 +1 @@ +{{additional_configuration}} diff --git a/bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/apache/bitnami-templates/app-http-vhost.conf.tpl b/bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/apache/bitnami-templates/app-http-vhost.conf.tpl new file mode 100644 index 000000000000..97bc1927b542 --- /dev/null +++ b/bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/apache/bitnami-templates/app-http-vhost.conf.tpl @@ -0,0 +1,13 @@ +{{before_vhost_configuration}} + + ServerAlias * + DocumentRoot {{document_root}} + + Options -Indexes +FollowSymLinks -MultiViews + AllowOverride {{allow_override}} + {{acl_configuration}} + {{extra_directory_configuration}} + + {{additional_configuration}} + {{htaccess_include}} + diff --git a/bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/apache/bitnami-templates/app-https-vhost.conf.tpl b/bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/apache/bitnami-templates/app-https-vhost.conf.tpl new file mode 100644 index 000000000000..c6debd7f56d4 --- /dev/null +++ b/bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/apache/bitnami-templates/app-https-vhost.conf.tpl @@ -0,0 +1,16 @@ +{{before_vhost_configuration}} + + ServerAlias * + SSLEngine on + SSLCertificateFile "{{APACHE_CONF_DIR}}/bitnami/certs/server.crt" + SSLCertificateKeyFile "{{APACHE_CONF_DIR}}/bitnami/certs/server.key" + DocumentRoot {{document_root}} + + Options -Indexes +FollowSymLinks -MultiViews + AllowOverride {{allow_override}} + {{acl_configuration}} + {{extra_directory_configuration}} + + {{additional_configuration}} + {{htaccess_include}} + diff --git a/bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/apache/bitnami-templates/app-prefix.conf.tpl b/bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/apache/bitnami-templates/app-prefix.conf.tpl new file mode 100644 index 000000000000..fc0f6c218196 --- /dev/null +++ b/bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/apache/bitnami-templates/app-prefix.conf.tpl @@ -0,0 +1,9 @@ +{{prefix_conf}} + + Options -Indexes +FollowSymLinks -MultiViews + AllowOverride {{allow_override}} + {{acl_configuration}} + {{extra_directory_configuration}} + +{{additional_configuration}} +{{htaccess_include}} diff --git a/bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/apache/bitnami-templates/bitnami-ssl.conf.tpl b/bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/apache/bitnami-templates/bitnami-ssl.conf.tpl new file mode 100644 index 000000000000..b43486531519 --- /dev/null +++ b/bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/apache/bitnami-templates/bitnami-ssl.conf.tpl @@ -0,0 +1,30 @@ +# Default SSL Virtual Host configuration. + + + LoadModule ssl_module modules/mod_ssl.so + + +Listen 443 +SSLProtocol all -SSLv2 -SSLv3 +SSLHonorCipherOrder on +SSLCipherSuite "EECDH+ECDSA+AESGCM EECDH+aRSA+AESGCM EECDH+ECDSA+SHA384 EECDH+ECDSA+SHA256 EECDH+aRSA+SHA384 EECDH+aRSA+SHA256 EECDH !aNULL !eNULL !LOW !3DES !MD5 !EXP !PSK !SRP !DSS !EDH !RC4" +SSLPassPhraseDialog builtin +SSLSessionCache "shmcb:{{APACHE_LOGS_DIR}}/ssl_scache(512000)" +SSLSessionCacheTimeout 300 + + + DocumentRoot "{{APACHE_BASE_DIR}}/htdocs" + SSLEngine on + SSLCertificateFile "{{APACHE_CONF_DIR}}/bitnami/certs/server.crt" + SSLCertificateKeyFile "{{APACHE_CONF_DIR}}/bitnami/certs/server.key" + + + Options Indexes FollowSymLinks + AllowOverride All + Require all granted + + + # Error Documents + ErrorDocument 503 /503.html + + diff --git a/bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/apache/bitnami-templates/bitnami.conf.tpl b/bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/apache/bitnami-templates/bitnami.conf.tpl new file mode 100644 index 000000000000..53ae1742e8af --- /dev/null +++ b/bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/apache/bitnami-templates/bitnami.conf.tpl @@ -0,0 +1,19 @@ +# Default Virtual Host configuration. + +# Let Apache know we're behind a SSL reverse proxy +SetEnvIf X-Forwarded-Proto https HTTPS=on + + + DocumentRoot "{{APACHE_BASE_DIR}}/htdocs" + + Options Indexes FollowSymLinks + AllowOverride All + Require all granted + + + # Error Documents + ErrorDocument 503 /503.html + + + +Include "{{APACHE_CONF_DIR}}/bitnami/bitnami-ssl.conf" diff --git a/bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/apache/entrypoint.sh b/bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/apache/entrypoint.sh new file mode 100755 index 000000000000..3d0e4ce6a903 --- /dev/null +++ b/bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/apache/entrypoint.sh @@ -0,0 +1,27 @@ +#!/bin/bash + +# shellcheck disable=SC1091 + +set -o errexit +set -o nounset +set -o pipefail +#set -o xtrace + +# Load libraries +. /opt/bitnami/scripts/libapache.sh +. /opt/bitnami/scripts/libbitnami.sh +. /opt/bitnami/scripts/liblog.sh + +# Load Apache environment +. /opt/bitnami/scripts/apache-env.sh + +print_welcome_page + +if [[ "$*" == *"/opt/bitnami/scripts/apache/run.sh"* ]]; then + info "** Starting Apache setup **" + /opt/bitnami/scripts/apache/setup.sh + info "** Apache setup finished! **" +fi + +echo "" +exec "$@" diff --git a/bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/apache/postunpack.sh b/bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/apache/postunpack.sh new file mode 100755 index 000000000000..9c59856a6351 --- /dev/null +++ b/bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/apache/postunpack.sh @@ -0,0 +1,115 @@ +#!/bin/bash + +# shellcheck disable=SC1091 + +set -o errexit +set -o nounset +set -o pipefail +# set -o xtrace # Uncomment this line for debugging purpose + +# Load libraries +. /opt/bitnami/scripts/libapache.sh +. /opt/bitnami/scripts/libfs.sh +. /opt/bitnami/scripts/liblog.sh + +######################## +# Sets up the default Bitnami configuration +# Globals: +# APACHE_* +# Arguments: +# None +# Returns: +# None +######################### +apache_setup_bitnami_config() { + local template_dir="${BITNAMI_ROOT_DIR}/scripts/apache/bitnami-templates" + + # Enable Apache modules + local -a modules_to_enable=( + "deflate_module" + "negotiation_module" + "proxy[^\s]*_module" + "rewrite_module" + "slotmem_shm_module" + "socache_shmcb_module" + "ssl_module" + "status_module" + "version_module" + ) + for module in "${modules_to_enable[@]}"; do + apache_enable_module "$module" + done + + # Disable Apache modules + local -a modules_to_disable=( + "http2_module" + "proxy_hcheck_module" + ) + for module in "${modules_to_disable[@]}"; do + apache_disable_module "$module" + done + + # Bitnami customizations + render-template "${template_dir}/bitnami.conf.tpl" > "${APACHE_CONF_DIR}/bitnami/bitnami.conf" + render-template "${template_dir}/bitnami-ssl.conf.tpl" > "${APACHE_CONF_DIR}/bitnami/bitnami-ssl.conf" + + # Add new configuration only once, to avoid a second postunpack run breaking Apache + local apache_conf_add + apache_conf_add="$(cat <>"$APACHE_CONF_FILE" < + RequestHeader unset Proxy + +EOF + fi +} + +# Load Apache environment +. /opt/bitnami/scripts/apache-env.sh + +apache_setup_bitnami_config + +# Ensure non-root user has write permissions on a set of directories +for dir in "$APACHE_TMP_DIR" "$APACHE_CONF_DIR" "$APACHE_LOGS_DIR" "$APACHE_VHOSTS_DIR" "$APACHE_HTACCESS_DIR" "$APACHE_HTDOCS_DIR" "$APACHE_MOD_PAGESPEED_CACHE_DIR"; do + ensure_dir_exists "$dir" + chmod -R g+rwX "$dir" +done + +# Create 'apache2' symlink pointing to the 'apache' directory, for compatibility with Bitnami Docs guides +ln -sf apache "${BITNAMI_ROOT_DIR}/apache2" + +ln -sf "/dev/stdout" "${APACHE_LOGS_DIR}/access_log" +ln -sf "/dev/stderr" "${APACHE_LOGS_DIR}/error_log" diff --git a/bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/apache/reload.sh b/bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/apache/reload.sh new file mode 100755 index 000000000000..3bf21a282611 --- /dev/null +++ b/bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/apache/reload.sh @@ -0,0 +1,18 @@ +#!/bin/bash + +# shellcheck disable=SC1091 + +set -o errexit +set -o nounset +set -o pipefail +# set -o xtrace # Uncomment this line for debugging purpose + +# Load libraries +. /opt/bitnami/scripts/libapache.sh +. /opt/bitnami/scripts/liblog.sh + +# Load Apache environment +. /opt/bitnami/scripts/apache-env.sh + +info "** Reloading Apache configuration **" +exec "${APACHE_BIN_DIR}/apachectl" -k graceful diff --git a/bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/apache/restart.sh b/bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/apache/restart.sh new file mode 100755 index 000000000000..8993aaa58d8e --- /dev/null +++ b/bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/apache/restart.sh @@ -0,0 +1,17 @@ +#!/bin/bash + +# shellcheck disable=SC1091 + +set -o errexit +set -o nounset +set -o pipefail +# set -o xtrace # Uncomment this line for debugging purposes + +# Load libraries +. /opt/bitnami/scripts/libapache.sh + +# Load Apache environment variables +. /opt/bitnami/scripts/apache-env.sh + +/opt/bitnami/scripts/apache/stop.sh +/opt/bitnami/scripts/apache/start.sh diff --git a/bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/apache/run.sh b/bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/apache/run.sh new file mode 100755 index 000000000000..1ab422dd4c31 --- /dev/null +++ b/bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/apache/run.sh @@ -0,0 +1,18 @@ +#!/bin/bash + +# shellcheck disable=SC1091 + +set -o errexit +set -o nounset +set -o pipefail +# set -o xtrace # Uncomment this line for debugging purpose + +# Load libraries +. /opt/bitnami/scripts/libapache.sh +. /opt/bitnami/scripts/liblog.sh + +# Load Apache environment +. /opt/bitnami/scripts/apache-env.sh + +info "** Starting Apache **" +exec "${APACHE_BIN_DIR}/httpd" -f "$APACHE_CONF_FILE" -D "FOREGROUND" diff --git a/bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/apache/setup.sh b/bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/apache/setup.sh new file mode 100755 index 000000000000..45cd178a4b7a --- /dev/null +++ b/bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/apache/setup.sh @@ -0,0 +1,26 @@ +#!/bin/bash + +# shellcheck disable=SC1091 + +set -o errexit +set -o nounset +set -o pipefail +# set -o xtrace # Uncomment this line for debugging purpose + +# Load libraries +. /opt/bitnami/scripts/libapache.sh + +# Load Apache environment +. /opt/bitnami/scripts/apache-env.sh + +# Ensure Apache environment variables are valid +apache_validate + +# Ensure Apache daemon user exists when running as 'root' +am_i_root && ensure_user_exists "$APACHE_DAEMON_USER" "$APACHE_DAEMON_GROUP" + +# Ensure Apache is initialized +apache_initialize + +# Fix logging issue when running as root +! am_i_root || chmod o+w "$(readlink /dev/stdout)" "$(readlink /dev/stderr)" diff --git a/bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/apache/start.sh b/bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/apache/start.sh new file mode 100755 index 000000000000..8ea04e19f09e --- /dev/null +++ b/bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/apache/start.sh @@ -0,0 +1,32 @@ +#!/bin/bash + +# shellcheck disable=SC1091 + +set -o errexit +set -o nounset +set -o pipefail +# set -o xtrace # Uncomment this line for debugging purposes + +# Load libraries +. /opt/bitnami/scripts/libapache.sh +. /opt/bitnami/scripts/libos.sh +. /opt/bitnami/scripts/liblog.sh + +# Load Apache environment variables +. /opt/bitnami/scripts/apache-env.sh + +error_code=0 + +if is_apache_not_running; then + "${APACHE_BIN_DIR}/httpd" -f "$APACHE_CONF_FILE" + if ! retry_while "is_apache_running"; then + error "apache did not start" + error_code=1 + else + info "apache started" + fi +else + info "apache is already running" +fi + +exit "${error_code}" diff --git a/bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/apache/status.sh b/bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/apache/status.sh new file mode 100755 index 000000000000..c6f434dd4407 --- /dev/null +++ b/bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/apache/status.sh @@ -0,0 +1,21 @@ +#!/bin/bash + +# shellcheck disable=SC1091 + +set -o errexit +set -o nounset +set -o pipefail +# set -o xtrace # Uncomment this line for debugging purposes + +# Load libraries +. /opt/bitnami/scripts/libapache.sh +. /opt/bitnami/scripts/liblog.sh + +# Load Apache environment variables +. /opt/bitnami/scripts/apache-env.sh + +if is_apache_running; then + info "apache is already running" +else + info "apache is not running" +fi diff --git a/bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/apache/stop.sh b/bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/apache/stop.sh new file mode 100755 index 000000000000..920a075d8b92 --- /dev/null +++ b/bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/apache/stop.sh @@ -0,0 +1,32 @@ +#!/bin/bash + +# shellcheck disable=SC1091 + +set -o errexit +set -o nounset +set -o pipefail +# set -o xtrace # Uncomment this line for debugging purposes + +# Load libraries +. /opt/bitnami/scripts/libapache.sh +. /opt/bitnami/scripts/libos.sh +. /opt/bitnami/scripts/liblog.sh + +# Load Apache environment variables +. /opt/bitnami/scripts/apache-env.sh + +error_code=0 + +if is_apache_running; then + apache_stop + if ! retry_while "is_apache_not_running"; then + error "apache could not be stopped" + error_code=1 + else + info "apache stopped" + fi +else + info "apache is not running" +fi + +exit "${error_code}" diff --git a/bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/dokuwiki-env.sh b/bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/dokuwiki-env.sh new file mode 100644 index 000000000000..3d773aa17525 --- /dev/null +++ b/bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/dokuwiki-env.sh @@ -0,0 +1,57 @@ +#!/bin/bash +# +# Environment configuration for dokuwiki + +# The values for all environment variables will be set in the below order of precedence +# 1. Custom environment variables defined below after Bitnami defaults +# 2. Constants defined in this file (environment variables with no default), i.e. BITNAMI_ROOT_DIR +# 3. Environment variables overridden via external files using *_FILE variables (see below) +# 4. Environment variables set externally (i.e. current Bash context/Dockerfile/userdata) + +export BITNAMI_ROOT_DIR="/opt/bitnami" +export BITNAMI_VOLUME_DIR="/bitnami" + +# Logging configuration +export MODULE="${MODULE:-dokuwiki}" +export BITNAMI_DEBUG="${BITNAMI_DEBUG:-false}" + +# By setting an environment variable matching *_FILE to a file path, the prefixed environment +# variable will be overridden with the value specified in that file +dokuwiki_env_vars=( + DOKUWIKI_DATA_TO_PERSIST + DOKUWIKI_USERNAME + DOKUWIKI_USERNAME + DOKUWIKI_FULL_NAME + DOKUWIKI_EMAIL + DOKUWIKI_PASSWORD + DOKUWIKI_WIKI_NAME + +) +for env_var in "${dokuwiki_env_vars[@]}"; do + file_env_var="${env_var}_FILE" + if [[ -n "${!file_env_var:-}" ]]; then + export "${env_var}=$(< "${!file_env_var}")" + unset "${file_env_var}" + fi +done +unset dokuwiki_env_vars + +# Paths +export DOKUWIKI_BASE_DIR="${BITNAMI_ROOT_DIR}/dokuwiki" + +# DokuWiki persistence configuration +export DOKUWIKI_VOLUME_DIR="${BITNAMI_VOLUME_DIR}/dokuwiki" +export DOKUWIKI_DATA_TO_PERSIST="${DOKUWIKI_DATA_TO_PERSIST:-data conf lib/plugins lib/tpl lib/images/smileys/local lib/images/interwiki}" + +# DokuWiki configuration +export DOKUWIKI_USERNAME="${DOKUWIKI_USERNAME:-user}" +export DOKUWIKI_USERNAME="${DOKUWIKI_USERNAME:-superuser}" +export DOKUWIKI_FULL_NAME="${DOKUWIKI_FULL_NAME:-Full Name}" +export DOKUWIKI_EMAIL="${DOKUWIKI_EMAIL:-user@example.com}" +export DOKUWIKI_PASSWORD="${DOKUWIKI_PASSWORD:-bitnami1}" +export DOKUWIKI_WIKI_NAME="${DOKUWIKI_WIKI_NAME:-Bitnami DokuWiki}" + +# PHP configuration +export PHP_DEFAULT_MEMORY_LIMIT="256M" # only used at build time + +# Custom environment variables may be defined below diff --git a/bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/dokuwiki/entrypoint.sh b/bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/dokuwiki/entrypoint.sh new file mode 100755 index 000000000000..458d08f4538b --- /dev/null +++ b/bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/dokuwiki/entrypoint.sh @@ -0,0 +1,32 @@ +#!/bin/bash + +# shellcheck disable=SC1091 + +set -o errexit +set -o nounset +set -o pipefail +# set -o xtrace # Uncomment this line for debugging purpose + +# Load DokuWiki environment +. /opt/bitnami/scripts/dokuwiki-env.sh + +# Load web server environment and functions (after DokuWiki environment file so MODULE is not set to a wrong value) +. /opt/bitnami/scripts/libwebserver.sh + +# Load libraries +. /opt/bitnami/scripts/libbitnami.sh +. /opt/bitnami/scripts/liblog.sh + +print_welcome_page + +if [[ "$1" = "/opt/bitnami/scripts/$(web_server_type)/run.sh" || "$1" = "/opt/bitnami/scripts/nginx-php-fpm/run.sh" ]]; then + info "** Starting DokuWiki setup **" + /opt/bitnami/scripts/"$(web_server_type)"/setup.sh + /opt/bitnami/scripts/php/setup.sh + /opt/bitnami/scripts/dokuwiki/setup.sh + /post-init.sh + info "** DokuWiki setup finished! **" +fi + +echo "" +exec "$@" diff --git a/bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/dokuwiki/postunpack.sh b/bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/dokuwiki/postunpack.sh new file mode 100755 index 000000000000..21c1634e5736 --- /dev/null +++ b/bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/dokuwiki/postunpack.sh @@ -0,0 +1,42 @@ +#!/bin/bash + +# shellcheck disable=SC1091 + +set -o errexit +set -o nounset +set -o pipefail +# set -o xtrace # Uncomment this line for debugging purpose + +# Load DokuWiki environment +. /opt/bitnami/scripts/dokuwiki-env.sh + +# Load PHP environment for 'php_conf_set' (after 'dokuwiki-env.sh' so that MODULE is not set to a wrong value) +. /opt/bitnami/scripts/php-env.sh + +# Load web server environment and functions (after DokuWiki environment file so MODULE is not set to a wrong value) +. /opt/bitnami/scripts/libwebserver.sh + +# Load libraries +. /opt/bitnami/scripts/libdokuwiki.sh +. /opt/bitnami/scripts/libfile.sh +. /opt/bitnami/scripts/libfs.sh +. /opt/bitnami/scripts/liblog.sh +. /opt/bitnami/scripts/libphp.sh + +# Ensure the DokuWiki base directory exists and has proper permissions +info "Configuring file permissions for DokuWiki" +ensure_user_exists "$WEB_SERVER_DAEMON_USER" "$WEB_SERVER_DAEMON_GROUP" +for dir in "$DOKUWIKI_BASE_DIR" "$DOKUWIKI_VOLUME_DIR" "${DOKUWIKI_BASE_DIR}/lib/images/smileys/local" "${DOKUWIKI_BASE_DIR}/uploads"; do + ensure_dir_exists "$dir" + # Use daemon:root ownership for compatibility when running as a non-root user + configure_permissions_ownership "$dir" -d "775" -f "664" -u "$WEB_SERVER_DAEMON_USER" -g "root" +done + +# Configure memory limit for PHP +info "Configuring default PHP options for DokuWiki" +php_conf_set memory_limit "$PHP_DEFAULT_MEMORY_LIMIT" + +# Enable default web server configuration for DokuWiki +info "Creating default web server configuration for DokuWiki" +web_server_validate +ensure_web_server_app_configuration_exists "dokuwiki" --type php diff --git a/bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/dokuwiki/setup.sh b/bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/dokuwiki/setup.sh new file mode 100755 index 000000000000..1c6fb9579342 --- /dev/null +++ b/bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/dokuwiki/setup.sh @@ -0,0 +1,26 @@ +#!/bin/bash + +# shellcheck disable=SC1091 + +set -o errexit +set -o nounset +set -o pipefail +# set -o xtrace # Uncomment this line for debugging purpose + +# Load DokuWiki environment +. /opt/bitnami/scripts/dokuwiki-env.sh + +# Load environment for web server configuration (after DokuWiki environment file so MODULE is not set to a wrong value) +. /opt/bitnami/scripts/libwebserver.sh + +# Load libraries +. /opt/bitnami/scripts/libdokuwiki.sh + +# Ensure DokuWiki environment variables are valid +dokuwiki_validate + +# Update web server configuration with runtime environment (needs to happen before the initialization) +web_server_update_app_configuration "dokuwiki" + +# Ensure DokuWiki is initialized +dokuwiki_initialize diff --git a/bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/libapache.sh b/bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/libapache.sh new file mode 100644 index 000000000000..ff262cb594a7 --- /dev/null +++ b/bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/libapache.sh @@ -0,0 +1,687 @@ +#!/bin/bash +# +# Bitnami Apache library + +# shellcheck disable=SC1091 + +# Load Generic Libraries +. /opt/bitnami/scripts/libfs.sh +. /opt/bitnami/scripts/libfile.sh +. /opt/bitnami/scripts/liblog.sh +. /opt/bitnami/scripts/libos.sh +. /opt/bitnami/scripts/libvalidations.sh +. /opt/bitnami/scripts/libservice.sh + +######################## +# Validate settings in APACHE_* env vars +# Globals: +# APACHE_* +# Arguments: +# None +# Returns: +# None +######################### +apache_validate() { + debug "Validating settings in APACHE_* environment variables" + local error_code=0 + + # Auxiliary functions + print_validation_error() { + error "$1" + error_code=1 + } + + check_allowed_port() { + local port_var="${1:?missing port variable}" + local -a validate_port_args=() + ! am_i_root && validate_port_args+=("-unprivileged") + validate_port_args+=("${!port_var}") + if ! err=$(validate_port "${validate_port_args[@]}"); then + print_validation_error "An invalid port was specified in the environment variable ${port_var}: ${err}." + fi + } + + [[ -w "$APACHE_CONF_FILE" ]] || warn "The Apache configuration file '${APACHE_CONF_FILE}' is not writable. Configurations based on environment variables will not be applied." + + if [[ -n "$APACHE_HTTP_PORT_NUMBER" ]] && [[ -n "$APACHE_HTTPS_PORT_NUMBER" ]]; then + if [[ "$APACHE_HTTP_PORT_NUMBER" -eq "$APACHE_HTTPS_PORT_NUMBER" ]]; then + print_validation_error "APACHE_HTTP_PORT_NUMBER and APACHE_HTTPS_PORT_NUMBER are bound to the same port!" + fi + fi + + [[ -n "$APACHE_HTTP_PORT_NUMBER" ]] && check_allowed_port APACHE_HTTP_PORT_NUMBER + [[ -n "$APACHE_HTTPS_PORT_NUMBER" ]] && check_allowed_port APACHE_HTTPS_PORT_NUMBER + + [[ "$error_code" -eq 0 ]] || exit "$error_code" +} + +######################## +# Configure Apache's HTTP port +# Globals: +# APACHE_CONF_FILE, APACHE_CONF_DIR +# Arguments: +# None +# Returns: +# None +######################### +apache_configure_http_port() { + local -r port=${1:?missing port} + local -r listen_exp="s|^\s*Listen\s+([^:]*:)?[0-9]+\s*$|Listen ${port}|" + local -r server_name_exp="s|^\s*#?\s*ServerName\s+([^:\s]+)(:[0-9]+)?$|ServerName \1:${port}|" + local -r vhost_exp="s|VirtualHost\s+([^:>]+)(:[0-9]+)|VirtualHost \1:${port}|" + local apache_configuration + + if [[ -w "$APACHE_CONF_FILE" ]]; then + debug "Configuring port ${port} on file ${APACHE_CONF_FILE}" + apache_configuration="$(sed -E -e "$listen_exp" -e "$server_name_exp" "$APACHE_CONF_FILE")" + echo "$apache_configuration" > "$APACHE_CONF_FILE" + fi + + if [[ -w "${APACHE_CONF_DIR}/bitnami/bitnami.conf" ]]; then + debug "Configuring port ${port} on file ${APACHE_CONF_DIR}/bitnami/bitnami.conf" + apache_configuration="$(sed -E "$vhost_exp" "${APACHE_CONF_DIR}/bitnami/bitnami.conf")" + echo "$apache_configuration" > "${APACHE_CONF_DIR}/bitnami/bitnami.conf" + fi + + if [[ -w "${APACHE_VHOSTS_DIR}/00_status-vhost.conf" ]]; then + debug "Configuring port ${port} on file ${APACHE_VHOSTS_DIR}/00_status-vhost.conf" + apache_configuration="$(sed -E "$vhost_exp" "${APACHE_VHOSTS_DIR}/00_status-vhost.conf")" + echo "$apache_configuration" > "${APACHE_VHOSTS_DIR}/00_status-vhost.conf" + fi +} + +######################## +# Configure Apache's HTTPS port +# Globals: +# APACHE_CONF_DIR +# Arguments: +# None +# Returns: +# None +######################### +apache_configure_https_port() { + local -r port=${1:?missing port} + local -r listen_exp="s|^\s*Listen\s+([^:]*:)?[0-9]+\s*$|Listen ${port}|" + local -r vhost_exp="s|VirtualHost\s+([^:>]+)(:[0-9]+)|VirtualHost \1:${port}|" + local apache_configuration + + if [[ -w "${APACHE_CONF_DIR}/bitnami/bitnami-ssl.conf" ]]; then + debug "Configuring port ${port} on file ${APACHE_CONF_DIR}/bitnami/bitnami-ssl.conf" + apache_configuration="$(sed -E -e "$listen_exp" -e "$vhost_exp" "${APACHE_CONF_DIR}/bitnami/bitnami-ssl.conf")" + echo "$apache_configuration" > "${APACHE_CONF_DIR}/bitnami/bitnami-ssl.conf" + fi +} + +######################## +# Ensure Apache is initialized +# Globals: +# APACHE_* +# Arguments: +# None +# Returns: +# None +######################### +apache_initialize() { + # Copy vhosts files + if ! is_dir_empty "/vhosts"; then + info "Found mounted virtual hosts in '/vhosts'. Copying them to '${APACHE_BASE_DIR}/conf/vhosts'" + cp -Lr "/vhosts/." "${APACHE_VHOSTS_DIR}" + fi + + # Mount certificate files + if ! is_dir_empty "${APACHE_BASE_DIR}/certs"; then + warn "The directory '${APACHE_BASE_DIR}/certs' was externally mounted. This is a legacy configuration and will be deprecated soon. Please mount certificate files at '/certs' instead. Find an example at: https://github.com/bitnami/bitnami-docker-apache#using-custom-ssl-certificates" + warn "Restoring certificates at '${APACHE_BASE_DIR}/certs' to '${APACHE_CONF_DIR}/bitnami/certs'" + rm -rf "${APACHE_CONF_DIR}/bitnami/certs" + ln -sf "${APACHE_BASE_DIR}/certs" "${APACHE_CONF_DIR}/bitnami/certs" + elif ! is_dir_empty "/certs"; then + info "Mounting certificates files from '/certs'" + rm -rf "${APACHE_CONF_DIR}/bitnami/certs" + ln -sf "/certs" "${APACHE_CONF_DIR}/bitnami/certs" + fi + + # Mount application files + if ! is_dir_empty "/app"; then + info "Mounting application files from '/app'" + rm -rf "$APACHE_HTDOCS_DIR" + ln -sf "/app" "$APACHE_HTDOCS_DIR" + fi + + # Port configuration + [[ -n "$APACHE_HTTP_PORT_NUMBER" ]] && info "Configuring the HTTP port" && apache_configure_http_port "$APACHE_HTTP_PORT_NUMBER" + [[ -n "$APACHE_HTTPS_PORT_NUMBER" ]] && info "Configuring the HTTPS port" && apache_configure_https_port "$APACHE_HTTPS_PORT_NUMBER" + + # Restore persisted configuration files (deprecated) + if ! is_dir_empty "/bitnami/apache/conf"; then + warn "The directory '/bitnami/apache/conf' was externally mounted. This is a legacy configuration and will be deprecated soon. Please mount certificate files at '${APACHE_CONF_DIR}' instead. Find an example at: https://github.com/bitnami/bitnami-docker-apache#full-configuration" + warn "Restoring configuration at '/bitnami/apache/conf' to '${APACHE_CONF_DIR}'" + rm -rf "$APACHE_CONF_DIR" + ln -sf "/bitnami/apache/conf" "$APACHE_CONF_DIR" + fi +} + +######################## +# Enable a module in the Apache configuration file +# Globals: +# APACHE_CONF_FILE +# Arguments: +# $1 - Module to enable +# $2 - Path to module .so file (optional if already defined in httpd.conf) +# Returns: +# None +######################### +apache_enable_module() { + local -r name="${1:?missing name}" + local -r file="${2:-}" + local -r regex="[#\s]*(LoadModule\s+${name}\s+.*)$" + local apache_configuration + + if [[ -w "$APACHE_CONF_FILE" ]]; then + debug "Enabling module '${name}'" + if grep -q -E "$regex" "$APACHE_CONF_FILE"; then + # Uncomment line if the module was already defined + replace_in_file "$APACHE_CONF_FILE" "$regex" "\1" + elif [[ -n "$file" ]]; then + # Add right after the last LoadModule, so all Apache modules are organized in the same section of the file + append_file_after_last_match "$APACHE_CONF_FILE" "^[#\s]*LoadModule" "LoadModule ${name} ${file}" + else + error "Module ${name} was not defined in ${APACHE_CONF_FILE}. Please specify the 'file' parameter for 'apache_enable_module'." + fi + fi +} + +######################## +# Disable a module in the Apache configuration file +# Globals: +# APACHE_CONF_FILE +# Arguments: +# $1 - Module to disable +# Returns: +# None +######################### +apache_disable_module() { + local -r name="${1:?missing name}" + local -r file="${2:-}" + local -r regex="[#\s]*(LoadModule\s+${name}\s+.*)$" + local apache_configuration + + if [[ -w "$APACHE_CONF_FILE" ]]; then + debug "Disabling module '${name}'" + replace_in_file "$APACHE_CONF_FILE" "$regex" "#\1" + fi +} + +######################## +# Stop Apache +# Globals: +# APACHE_* +# Arguments: +# None +# Returns: +# None +######################### +apache_stop() { + is_apache_not_running && return + stop_service_using_pid "$APACHE_PID_FILE" +} + +######################## +# Check if Apache is running +# Globals: +# APACHE_PID_FILE +# Arguments: +# None +# Returns: +# Whether Apache is running +######################## +is_apache_running() { + local pid + pid="$(get_pid_from_file "$APACHE_PID_FILE")" + if [[ -n "$pid" ]]; then + is_service_running "$pid" + else + false + fi +} + +######################## +# Check if Apache is running +# Globals: +# APACHE_PID_FILE +# Arguments: +# None +# Returns: +# Whether Apache is not running +######################## +is_apache_not_running() { + ! is_apache_running +} + +######################## +# Ensure configuration gets added to the main Apache configuration file +# Globals: +# APACHE_* +# Arguments: +# $1 - configuration string +# $2 - pattern to use for checking if the configuration already exists (default: $1) +# Returns: +# None +######################## +ensure_apache_configuration_exists() { + local -r conf="${1:?conf missing}" + local -r pattern="${2:-"$conf"}" + # Enable configuration by appending to httpd.conf + if ! grep -E -q "$pattern" "$APACHE_CONF_FILE"; then + if is_file_writable "$APACHE_CONF_FILE"; then + cat >> "$APACHE_CONF_FILE" <<< "$conf" + else + error "Could not add the following configuration to '${APACHE_CONF_FILE}:" + error "" + error "$(indent "$conf" 4)" + error "" + error "Include the configuration manually and try again." + return 1 + fi + fi +} + +######################## +# Collect all the .htaccess files from /opt/bitnami/$name and write the result in the 'htaccess' directory +# Globals: +# APACHE_* +# Arguments: +# $1 - App name +# $2 - Overwrite the original .htaccess with the explanation text (defaults to 'yes') +# Flags: +# --document-root - Path to document root directory +# Returns: +# None +######################## +apache_replace_htaccess_files() { + local -r app="${1:?missing app}" + local -r result_file="${APACHE_HTACCESS_DIR}/${app}-htaccess.conf" + # Default options + local document_root="${BITNAMI_ROOT_DIR}/${app}" + local overwrite="yes" + local -a htaccess_files + local htaccess_dir + local htaccess_contents + # Validate arguments + shift + while [[ "$#" -gt 0 ]]; do + case "$1" in + --document-root) + shift + document_root="$1" + ;; + --overwrite) + shift + overwrite="$1" + ;; + *) + echo "Invalid command line flag ${1}" >&2 + return 1 + ;; + esac + shift + done + # Locate all .htaccess files inside the document root + read -r -a htaccess_files <<< "$(find "$document_root" -name .htaccess -print0 | xargs -0)" + [[ "${#htaccess_files[@]}" = 0 ]] && return + for htaccess_file in "${htaccess_files[@]}"; do + htaccess_dir="$(dirname "$htaccess_file")" + htaccess_contents="$(indent "$(< "$htaccess_file")" 2)" + # Skip if it was already included to the resulting htaccess file + if grep -q "^" <<< "$htaccess_contents"; then + continue + fi + # Add to the htaccess file + cat >> "$result_file" < +${htaccess_contents} + +EOF + # Overwrite the original .htaccess with the explanation text + if is_boolean_yes "$overwrite"; then + echo "# This configuration has been moved to the ${result_file} config file for performance and security reasons" > "$htaccess_file" + fi + done +} + +######################## +# Ensure an Apache application configuration exists (in virtual host format) +# Globals: +# APACHE_* +# Arguments: +# $1 - App name +# Flags: +# --hosts - Hosts to enable +# --type - Application type, which has an effect on what configuration template will be used, allowed values: php, (empty) +# --allow-remote-connections - Whether to allow remote connections or to require local connections +# --disabled - Whether to render the file with a .disabled prefix +# --enable-https - Enable app configuration on HTTPS port +# --http-port - HTTP port number +# --https-port - HTTPS port number +# --move-htaccess - Move .htaccess files to a common place so they can be loaded during Apache startup +# --additional-configuration - Additional vhost configuration (no default) +# --before-vhost-configuration - Configuration to add before the directive (no default) +# --allow-override - Whether to allow .htaccess files (only allowed when --move-htaccess is set to 'no') +# --document-root - Path to document root directory +# --extra-directory-configuration - Extra configuration for the document root directory +# Returns: +# true if the configuration was enabled, false otherwise +######################## +ensure_apache_app_configuration_exists() { + local -r app="${1:?missing app}" + # Default options + local -a hosts=("127.0.0.1" "_default_") + local type="" + local allow_remote_connections="yes" + local disabled="no" + local enable_https="yes" + local http_port="${APACHE_HTTP_PORT_NUMBER:-"$APACHE_DEFAULT_HTTP_PORT_NUMBER"}" + local https_port="${APACHE_HTTPS_PORT_NUMBER:-"$APACHE_DEFAULT_HTTPS_PORT_NUMBER"}" + local move_htaccess="yes" + local var_name + # Template variables defaults + export additional_configuration="" + export before_vhost_configuration="" + export allow_override="All" + export document_root="${BITNAMI_ROOT_DIR}/${app}" + export extra_directory_configuration="" + # Validate arguments + shift + while [[ "$#" -gt 0 ]]; do + case "$1" in + --hosts) + shift + read -r -a hosts <<< "$1" + ;; + --type \ + | --allow-remote-connections \ + | --disabled \ + | --enable-https \ + | --http-port \ + | --https-port \ + | --move-htaccess \ + | --additional-configuration \ + | --before-vhost-configuration \ + | --allow-override \ + | --document-root \ + | --extra-directory-configuration \ + ) + var_name="$(echo "$1" | sed -e "s/^--//" -e "s/-/_/g")" + shift + export "${var_name}"="$1" + ;; + *) + echo "Invalid command line flag $1" >&2 + return 1 + ;; + esac + shift + done + # Construct host string in the format of "host1:port1[ host2:port2[ ...]]" + export http_listen_addresses="" + export https_listen_addresses="" + for host in "${hosts[@]}"; do + http_listen="${host}:${http_port}" + https_listen="${host}:${https_port}" + [[ -z "${http_listen_addresses:-}" ]] && http_listen_addresses="$http_listen" || http_listen_addresses="${http_listen_addresses} ${http_listen}" + [[ -z "${https_listen_addresses:-}" ]] && https_listen_addresses="$https_listen" || https_listen_addresses="${https_listen_addresses} ${https_listen}" + done + # App .htaccess support + export htaccess_include + is_boolean_yes "$move_htaccess" && apache_replace_htaccess_files "$app" --document-root "$document_root" + if [[ -f "${APACHE_HTACCESS_DIR}/${app}-htaccess.conf" ]]; then + allow_override="None" + htaccess_include="Include \"${APACHE_HTACCESS_DIR}/${app}-htaccess.conf\"" + else + allow_override="$allow_override" + htaccess_include="" + fi + # ACL configuration + export acl_configuration + if is_boolean_yes "$allow_remote_connections"; then + acl_configuration="Require all granted" + else + acl_configuration="$(cat < "$http_vhost" + elif [[ ! -f "$http_vhost" ]]; then + error "Could not create virtual host for ${app} at '${http_vhost}'. Check permissions and ownership for parent directories." + return 1 + else + warn "The ${app} virtual host file '${http_vhost}' is not writable. Configurations based on environment variables will not be applied for this file." + fi + if is_boolean_yes "$enable_https"; then + if is_file_writable "$https_vhost"; then + # Create file with root group write privileges, so it can be modified in non-root containers + [[ ! -f "$https_vhost" ]] && touch "$https_vhost" && chmod g+rw "$https_vhost" + render-template "${template_dir}/${template_name}-https-vhost.conf.tpl" | sed '/^\s*$/d' > "$https_vhost" + elif [[ ! -f "$https_vhost" ]]; then + error "Could not create virtual host for ${app} at '${https_vhost}'. Check permissions and ownership for parent directories." + return 1 + else + warn "The ${app} virtual host file '${https_vhost}' is not writable. Configurations based on environment variables will not be applied for this file." + fi + fi +} + +######################## +# Ensure an Apache application configuration does not exist anymore (in virtual hosts format) +# Globals: +# * +# Arguments: +# $1 - App name +# Returns: +# true if the configuration was disabled, false otherwise +######################## +ensure_apache_app_configuration_not_exists() { + local -r app="${1:?missing app}" + local -r http_vhost="${APACHE_VHOSTS_DIR}/${app}-vhost.conf" + local -r https_vhost="${APACHE_VHOSTS_DIR}/${app}-https-vhost.conf" + # Note that 'rm -f' will not fail if the files don't exist + # However if we lack permissions to remove the file, it will result in a non-zero exit code, as expected by this function + rm -f "$http_vhost" "$https_vhost" +} + +######################## +# Ensure Apache loads the configuration for an application in a URL prefix +# Globals: +# APACHE_* +# Arguments: +# $1 - App name +# Flags: +# --type - Application type, which has an effect on what configuration template will be used, allowed values: php, (empty) +# --allow-remote-connections - Whether to allow remote connections or to require local connections +# --move-htaccess - Move .htaccess files to a common place so they can be loaded during Apache startup +# --prefix - URL prefix from where it will be accessible (i.e. /myapp) +# --additional-configuration - Additional vhost configuration (no default) +# --allow-override - Whether to allow .htaccess files (only allowed when --move-htaccess is set to 'no') +# --document-root - Path to document root directory +# --extra-directory-configuration - Extra configuration for the document root directory +# Returns: +# true if the configuration was enabled, false otherwise +######################## +ensure_apache_prefix_configuration_exists() { + local -r app="${1:?missing app}" + # Default options + local type="" + local allow_remote_connections="yes" + local move_htaccess="yes" + local prefix="/${app}" + local var_name + # Template variables defaults + export additional_configuration="" + export allow_override="All" + export document_root="${BITNAMI_ROOT_DIR}/${app}" + export extra_directory_configuration="" + # Validate arguments + shift + while [[ "$#" -gt 0 ]]; do + case "$1" in + --type \ + | --allow-remote-connections \ + | --move-htaccess \ + | --prefix \ + | --additional-configuration \ + | --allow-override \ + | --document-root \ + | --extra-directory-configuration \ + ) + var_name="$(echo "$1" | sed -e "s/^--//" -e "s/-/_/g")" + shift + declare "${var_name}"="$1" + ;; + *) + echo "Invalid command line flag $1" >&2 + return 1 + ;; + esac + shift + done + # App .htaccess support + export htaccess_include + is_boolean_yes "$move_htaccess" && apache_replace_htaccess_files "$app" --document-root "$document_root" + if [[ -f "${APACHE_HTACCESS_DIR}/${app}-htaccess.conf" ]]; then + allow_override="None" + htaccess_include="Include \"${APACHE_HTACCESS_DIR}/${app}-htaccess.conf\"" + else + allow_override="$allow_override" + htaccess_include="" + fi + # ACL configuration + export acl_configuration + if is_boolean_yes "$allow_remote_connections"; then + acl_configuration="Require all granted" + else + acl_configuration="$(cat < "$prefix_file" + ensure_apache_configuration_exists "Include \"$prefix_file\"" + elif [[ ! -f "$prefix_file" ]]; then + error "Could not create web server configuration file for ${app} at '${prefix_file}'. Check permissions and ownership for parent directories." + return 1 + else + warn "The ${app} web server configuration file '${prefix_file}' is not writable. Configurations based on environment variables will not be applied for this file." + fi +} + +######################## +# Ensure Apache application configuration is updated with the runtime configuration (i.e. ports) +# Globals: +# * +# Arguments: +# $1 - App name +# Flags: +# --hosts - Hosts to enable +# --enable-https - Update HTTPS app configuration +# --http-port - HTTP port number +# --https-port - HTTPS port number +# Returns: +# true if the configuration was updated, false otherwise +######################## +apache_update_app_configuration() { + local -r app="${1:?missing app}" + # Default options + local -a hosts=("127.0.0.1" "_default_") + local enable_https="yes" + local http_port="${APACHE_HTTP_PORT_NUMBER:-"$APACHE_DEFAULT_HTTP_PORT_NUMBER"}" + local https_port="${APACHE_HTTPS_PORT_NUMBER:-"$APACHE_DEFAULT_HTTPS_PORT_NUMBER"}" + # Validate arguments + shift + while [[ "$#" -gt 0 ]]; do + case "$1" in + --hosts) + shift + read -r -a hosts <<< "$1" + ;; + + # Common flags + --enable-https \ + | --http-port \ + | --https-port \ + ) + args+=("$1" "$2") + shift + ;; + + *) + echo "Invalid command line flag $1" >&2 + return 1 + ;; + esac + shift + done + # Construct host string in the format of "host1:port1[ host2:port2[ ...]]" + export http_listen_addresses="" + export https_listen_addresses="" + for host in "${hosts[@]}"; do + http_listen="${host}:${http_port}" + https_listen="${host}:${https_port}" + [[ -z "${http_listen_addresses:-}" ]] && http_listen_addresses="$http_listen" || http_listen_addresses="${http_listen_addresses} ${http_listen}" + [[ -z "${https_listen_addresses:-}" ]] && https_listen_addresses="$https_listen" || https_listen_addresses="${https_listen_addresses} ${https_listen}" + done + # Update configuration + local -r http_vhost="${APACHE_VHOSTS_DIR}/${app}-vhost.conf" + local -r https_vhost="${APACHE_VHOSTS_DIR}/${app}-https-vhost.conf" + if is_file_writable "$http_vhost"; then + replace_in_file "$http_vhost" "^$" "" + else + warn "The ${app} virtual host file '${http_vhost}' is not writable. Configurations based on environment variables will not be applied for this file." + fi + if is_boolean_yes "$enable_https"; then + if is_file_writable "$https_vhost"; then + replace_in_file "$https_vhost" "^$" "" + else + warn "The ${app} virtual host file '${https_vhost}' is not writable. Configurations based on environment variables will not be applied for this file." + fi + fi +} diff --git a/bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/libdokuwiki.sh b/bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/libdokuwiki.sh new file mode 100644 index 000000000000..9ad8414b8727 --- /dev/null +++ b/bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/libdokuwiki.sh @@ -0,0 +1,118 @@ +#!/bin/bash +# +# Bitnami DokuWiki library + +# shellcheck disable=SC1091 + +# Load DokuWiki environment +. /opt/bitnami/scripts/dokuwiki-env.sh + +# Load web server environment and functions +. /opt/bitnami/scripts/libwebserver.sh + +# Load generic libraries +. /opt/bitnami/scripts/libphp.sh +. /opt/bitnami/scripts/libfs.sh +. /opt/bitnami/scripts/libos.sh +. /opt/bitnami/scripts/libvalidations.sh +. /opt/bitnami/scripts/libpersistence.sh + +######################## +# Validate settings in DOKUWIKI_* env vars +# Globals: +# DOKUWIKI_* +# Arguments: +# None +# Returns: +# 0 if the validation succeeded, 1 otherwise +######################### +dokuwiki_validate() { + debug "Validating settings in DOKUWIKI_* environment variables..." + local error_code=0 + + # Auxiliary functions + print_validation_error() { + error "$1" + error_code=1 + } + + # Check that the web server is properly set up + web_server_validate || print_validation_error "Web server validation failed" + + return "$error_code" +} + +######################## +# Ensure DokuWiki is initialized +# Globals: +# DOKUWIKI_* +# Arguments: +# None +# Returns: +# None +######################### +dokuwiki_initialize() { + # Check if dokuwiki has already been initialized and persisted in a previous run + local -r app_name="dokuwiki" + if ! is_app_initialized "$app_name"; then + # Ensure the DokuWikiWiki base directory exists and has proper permissions + info "Configuring file permissions for DokuWiki" + ensure_dir_exists "$DOKUWIKI_VOLUME_DIR" + # Use daemon:root ownership for compatibility when running as a non-root user + am_i_root && configure_permissions_ownership "$DOKUWIKI_VOLUME_DIR" -d "775" -f "664" -u "$WEB_SERVER_DAEMON_USER" -g "root" + + if ! is_boolean_yes "${DOKUWIKI_SKIP_BOOTSTRAP:-}"; then + web_server_start + dokuwiki_pass_wizard + web_server_stop + fi + + info "Persisting DokuWiki installation" + persist_app "$app_name" "$DOKUWIKI_DATA_TO_PERSIST" + else + info "Restoring persisted DokuWiki installation" + restore_persisted_app "$app_name" "$DOKUWIKI_DATA_TO_PERSIST" + fi + + # Avoid exit code of previous commands to affect the result of this function + true +} + +######################## +# Pass Dokiwiki wizzard +# Globals: +# DOKUWIKI_* +# Arguments: +# None +# Returns: +# None +######################### +dokuwiki_pass_wizard() { + local -r port="${APACHE_HTTP_PORT_NUMBER:-"$APACHE_DEFAULT_HTTP_PORT_NUMBER"}" + local wizard_url curl_output + local -a curl_opts curl_data_opts + wizard_url="http://127.0.0.1:${port}/install.php" + curl_opts=("--location" "--silent") + curl_data_opts=( + "--data-urlencode" "l=en" + "--data-urlencode" "d[acl]=on" + "--data-urlencode" "d[policy]=0" + "--data-urlencode" "d[allowreg]=on" + "--data-urlencode" "d[license]=cc-by-sa" + "--data-urlencode" "d[pop]=on" + "--data-urlencode" "submit=" + "--data-urlencode" "d[title]=${DOKUWIKI_WIKI_NAME}" + "--data-urlencode" "d[superuser]=${DOKUWIKI_USERNAME}" + "--data-urlencode" "d[fullname]=${DOKUWIKI_FULL_NAME}" + "--data-urlencode" "d[email]=${DOKUWIKI_EMAIL}" + "--data-urlencode" "d[password]=${DOKUWIKI_PASSWORD}" + "--data-urlencode" "d[confirm]=${DOKUWIKI_PASSWORD}" + ) + curl "${curl_opts[@]}" "${curl_data_opts[@]}" "${wizard_url}" + # Check it has been configured + curl_output=$(curl "${wizard_url}") + if [[ "$curl_output" != *"already exists"* ]]; then + error "An error occurred while installing DokuWiki" + return 1 + fi +} diff --git a/bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/libphp.sh b/bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/libphp.sh new file mode 100644 index 000000000000..92ca554d4013 --- /dev/null +++ b/bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/libphp.sh @@ -0,0 +1,129 @@ +#!/bin/bash +# +# Bitnami PHP library + +# shellcheck disable=SC1091 + +# Load Generic Libraries +. /opt/bitnami/scripts/libfs.sh +. /opt/bitnami/scripts/libfile.sh +. /opt/bitnami/scripts/libservice.sh +. /opt/bitnami/scripts/libvalidations.sh + +######################## +# Add or modify an entry in the main PHP configuration file (php.ini) +# Globals: +# PHP_CONF_FILE +# Arguments: +# $1 - Key +# $2 - Value +# $3 - File to modify (default: $PHP_CONF_FILE) +# Returns: +# None +######################### +php_conf_set() { + local -r key="${1:?key missing}" + local -r value="${2:?value missing}" + local -r file="${3:-"$PHP_CONF_FILE"}" + local pattern="^[;\s]*${key}\s*=.*$" + if [[ "$key" = "extension" || "$key" = "zend_extension" ]]; then + # The "extension" property works a bit different for PHP, as there is one per module to be included, meaning it is additive unlike other configurations + # Because of that, we first check if the extension was defined in the file to replace the proper entry + pattern="^[;\s]*${key}\s*=\s*[\"]?${value}(\.so)?[\"]?\s*$" + fi + local -r entry="${key} = ${value}" + if is_file_writable "$file"; then + # Not using the ini-file tool since it does not play well with php.ini + if grep -q -E "$pattern" "$file"; then + replace_in_file "$file" "$pattern" "$entry" + else + cat >> "$file" <<< "$entry" + fi + else + warn "The PHP configuration file '${file}' is not writable. The '${key}' option will not be configured." + fi +} + +######################## +# Ensure PHP is initialized +# Globals: +# PHP_* +# Arguments: +# None +# Returns: +# None +######################### +php_initialize() { + # Configure PHP options based on the runtime environment + info "Configuring PHP options" + ! is_empty_value "$PHP_UPLOAD_MAX_FILESIZE" && info "Setting PHP upload_max_filesize option" && php_conf_set upload_max_filesize "$PHP_UPLOAD_MAX_FILESIZE" + ! is_empty_value "$PHP_POST_MAX_SIZE" && info "Setting PHP post_max_size option" && php_conf_set post_max_size "$PHP_POST_MAX_SIZE" + ! is_empty_value "$PHP_MEMORY_LIMIT" && info "Setting PHP memory_limit option" && php_conf_set memory_limit "$PHP_MEMORY_LIMIT" + + # PHP-FPM configuration + ! is_empty_value "$PHP_FPM_LISTEN_ADDRESS" && info "Setting PHP-FPM listen option" && php_conf_set "listen" "$PHP_FPM_LISTEN_ADDRESS" "${PHP_CONF_DIR}/php-fpm.d/www.conf" + + # Avoid exit code of previous commands to affect the result of this function + true +} + +######################## +# Convert a yes/no value to a PHP boolean +# Globals: +# None +# Arguments: +# $1 - yes/no value +# Returns: +# None +######################### +php_convert_to_boolean() { + local -r value="${1:?missing value}" + is_boolean_yes "$value" && echo "true" || echo "false" +} + +######################## +# Stop PHP-FPM +# Globals: +# PHP_FPM_PID_FILE +# Arguments: +# $1 - Signal (default: SIGTERM) +# Returns: +# None +######################### +php_fpm_stop() { + local -r signal="${1:-}" + is_php_fpm_not_running && return + stop_service_using_pid "$PHP_FPM_PID_FILE" "$signal" +} + +######################## +# Check if PHP-FPM is running +# Globals: +# PHP_FPM_PID_FILE +# Arguments: +# None +# Returns: +# true if PHP-FPM is running, false otherwise +######################## +is_php_fpm_running() { + local pid + pid="$(get_pid_from_file "$PHP_FPM_PID_FILE")" + if [[ -n "$pid" ]]; then + is_service_running "$pid" + else + false + fi +} + +######################## +# Check if PHP-FPM is running +# Globals: +# PHP_FPM_PID_FILE +# Arguments: +# None +# Returns: +# true PHP-FPM is not running, false otherwise +######################## +is_php_fpm_not_running() { + ! is_php_fpm_running +} diff --git a/bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/php-env.sh b/bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/php-env.sh new file mode 100644 index 000000000000..60633c6ac219 --- /dev/null +++ b/bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/php-env.sh @@ -0,0 +1,67 @@ +#!/bin/bash +# +# Environment configuration for php + +# The values for all environment variables will be set in the below order of precedence +# 1. Custom environment variables defined below after Bitnami defaults +# 2. Constants defined in this file (environment variables with no default), i.e. BITNAMI_ROOT_DIR +# 3. Environment variables overridden via external files using *_FILE variables (see below) +# 4. Environment variables set externally (i.e. current Bash context/Dockerfile/userdata) + +export BITNAMI_ROOT_DIR="/opt/bitnami" +export BITNAMI_VOLUME_DIR="/bitnami" + +# Logging configuration +export MODULE="${MODULE:-php}" +export BITNAMI_DEBUG="${BITNAMI_DEBUG:-false}" + +# By setting an environment variable matching *_FILE to a file path, the prefixed environment +# variable will be overridden with the value specified in that file +php_env_vars=( + PHP_FPM_LISTEN_ADDRESS + PHP_UPLOAD_MAX_FILESIZE + PHP_POST_MAX_SIZE + PHP_MEMORY_LIMIT + +) +for env_var in "${php_env_vars[@]}"; do + file_env_var="${env_var}_FILE" + if [[ -n "${!file_env_var:-}" ]]; then + export "${env_var}=$(< "${!file_env_var}")" + unset "${file_env_var}" + fi +done +unset php_env_vars + +# Paths +export PHP_BASE_DIR="${BITNAMI_ROOT_DIR}/php" +export PHP_BIN_DIR="${PHP_BASE_DIR}/bin" +export PHP_CONF_DIR="${PHP_BASE_DIR}/etc" +export PHP_TMP_DIR="${PHP_BASE_DIR}/var/run" +export PHP_CONF_FILE="${PHP_CONF_DIR}/php.ini" + +# PHP default build-time configuration +export PHP_DEFAULT_OPCACHE_INTERNED_STRINGS_BUFFER="16" # only used at build time +export PHP_DEFAULT_OPCACHE_MEMORY_CONSUMPTION="192" # only used at build time +export PHP_DEFAULT_OPCACHE_FILE_CACHE="${PHP_TMP_DIR}/opcache_file" # only used at build time + +# PHP-FPM configuration +export PHP_FPM_SBIN_DIR="${PHP_BASE_DIR}/sbin" +export PHP_FPM_LOGS_DIR="${PHP_BASE_DIR}/logs" +export PHP_FPM_LOG_FILE="${PHP_FPM_LOGS_DIR}/php-fpm.log" +export PHP_FPM_CONF_FILE="${PHP_CONF_DIR}/php-fpm.conf" +export PHP_FPM_PID_FILE="${PHP_TMP_DIR}/php-fpm.pid" +export PHP_FPM_DEFAULT_LISTEN_ADDRESS="${PHP_TMP_DIR}/www.sock" # only used at build time +export PHP_FPM_LISTEN_ADDRESS="${PHP_FPM_LISTEN_ADDRESS:-}" +export PATH="${PHP_FPM_SBIN_DIR}:${PHP_BIN_DIR}:${BITNAMI_ROOT_DIR}/common/bin:${PATH}" + +# System users (when running with a privileged user) +export PHP_FPM_DAEMON_USER="daemon" +export PHP_FPM_DAEMON_GROUP="daemon" + +# PHP configuration +export PHP_UPLOAD_MAX_FILESIZE="${PHP_UPLOAD_MAX_FILESIZE:-}" +export PHP_POST_MAX_SIZE="${PHP_POST_MAX_SIZE:-}" +export PHP_MEMORY_LIMIT="${PHP_MEMORY_LIMIT:-}" + +# Custom environment variables may be defined below diff --git a/bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/php/postunpack.sh b/bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/php/postunpack.sh new file mode 100755 index 000000000000..966cc1403a52 --- /dev/null +++ b/bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/php/postunpack.sh @@ -0,0 +1,34 @@ +#!/bin/bash + +# shellcheck disable=SC1091 + +set -o errexit +set -o nounset +set -o pipefail +# set -o xtrace # Uncomment this line for debugging purposes + +# Load libraries +. /opt/bitnami/scripts/libphp.sh +. /opt/bitnami/scripts/libfs.sh + +# Load PHP-FPM environment variables +. /opt/bitnami/scripts/php-env.sh + +# PHP OPcache optimizations +php_conf_set "opcache.interned_strings_buffer" "$PHP_DEFAULT_OPCACHE_INTERNED_STRINGS_BUFFER" +php_conf_set "opcache.memory_consumption" "$PHP_DEFAULT_OPCACHE_MEMORY_CONSUMPTION" +php_conf_set "opcache.file_cache" "$PHP_DEFAULT_OPCACHE_FILE_CACHE" + +# PHP-FPM configuration +php_conf_set "listen" "$PHP_FPM_DEFAULT_LISTEN_ADDRESS" "${PHP_CONF_DIR}/php-fpm.d/www.conf" + +# Ensure directories used by PHP-FPM exist and have proper ownership and permissions +for dir in "$PHP_CONF_DIR" "$PHP_TMP_DIR" "$PHP_FPM_LOGS_DIR"; do + ensure_dir_exists "$dir" + chmod -R g+rwX "$dir" +done + +info "Disabling PHP-FPM daemon user/group configuration" +echo "" > "${PHP_CONF_DIR}/common.conf" + +ln -sf "/dev/stdout" "${PHP_FPM_LOG_FILE}" diff --git a/bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/php/run.sh b/bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/php/run.sh new file mode 100755 index 000000000000..d74d672196d4 --- /dev/null +++ b/bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/php/run.sh @@ -0,0 +1,19 @@ +#!/bin/bash + +# shellcheck disable=SC1091 + +set -o errexit +set -o nounset +set -o pipefail +# set -o xtrace # Uncomment this line for debugging purposes + +# Load libraries +. /opt/bitnami/scripts/libphp.sh +. /opt/bitnami/scripts/liblog.sh + +# Load PHP-FPM environment variables +. /opt/bitnami/scripts/php-env.sh + +info "** Starting PHP-FPM **" +declare -a args=("--pid" "$PHP_FPM_PID_FILE" "--fpm-config" "$PHP_FPM_CONF_FILE" "-c" "$PHP_CONF_DIR" "-F") +exec "${PHP_FPM_SBIN_DIR}/php-fpm" "${args[@]}" diff --git a/bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/php/setup.sh b/bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/php/setup.sh new file mode 100755 index 000000000000..f456918e6d56 --- /dev/null +++ b/bitnami/dokuwiki/0/debian-10/rootfs/opt/bitnami/scripts/php/setup.sh @@ -0,0 +1,28 @@ +#!/bin/bash + +# shellcheck disable=SC1091 + +set -o errexit +set -o nounset +set -o pipefail +# set -o xtrace # Uncomment this line for debugging purposes + +# Load libraries +. /opt/bitnami/scripts/libphp.sh +. /opt/bitnami/scripts/libfs.sh +. /opt/bitnami/scripts/libos.sh + +# Load PHP-FPM environment variables +. /opt/bitnami/scripts/php-env.sh + +# Ensure PHP-FPM daemon user exists and required folder belongs to this user when running as 'root' +if am_i_root; then + ensure_user_exists "$PHP_FPM_DAEMON_USER" "$PHP_FPM_DAEMON_GROUP" + ensure_dir_exists "$PHP_TMP_DIR" + chown -R "${PHP_FPM_DAEMON_USER}:${PHP_FPM_DAEMON_GROUP}" "$PHP_TMP_DIR" +fi + +php_initialize + +# Fix logging issue when running as root +! am_i_root || chmod o+w "$(readlink /dev/stdout)" "$(readlink /dev/stderr)" diff --git a/bitnami/dokuwiki/README.md b/bitnami/dokuwiki/README.md index 7d3c6b465f71..e31a14e39563 100644 --- a/bitnami/dokuwiki/README.md +++ b/bitnami/dokuwiki/README.md @@ -1,194 +1,250 @@ +# Bitnami Docker Image for DokuWiki -# What is DokuWiki? +## What is DokuWiki? > DokuWiki is a simple to use and highly versatile Open Source wiki software that doesn't require a database. It is loved by users for its clean and readable syntax. The ease of maintenance, backup and integration makes it an administrator's favorite -https://www.dokuwiki.org/ +[https://www.dokuwiki.org/](https://www.dokuwiki.org/) -# TL;DR; - -## Docker Compose +## TL;DR; ```console $ curl -sSL https://raw.githubusercontent.com/bitnami/bitnami-docker-dokuwiki/master/docker-compose.yml > docker-compose.yml $ docker-compose up -d ``` -# Why use Bitnami Images? +## Why use Bitnami Images? * Bitnami closely tracks upstream source changes and promptly publishes new versions of this image using our automated systems. * With Bitnami images the latest bug fixes and features are available as soon as possible. * Bitnami containers, virtual machines and cloud images use the same components and configuration approach - making it easy to switch between formats based on your project needs. * All our images are based on [minideb](https://github.com/bitnami/minideb) a minimalist Debian based container image which gives you a small base container image and the familiarity of a leading linux distribution. -* All Bitnami images available in Docker Hub are signed with [Docker Content Trust (DTC)](https://docs.docker.com/engine/security/trust/content_trust/). You can use `DOCKER_CONTENT_TRUST=1` to verify the integrity of the images. +* All Bitnami images available in Docker Hub are signed with [Docker Content Trust (DCT)](https://docs.docker.com/engine/security/trust/content_trust/). You can use `DOCKER_CONTENT_TRUST=1` to verify the integrity of the images. * Bitnami container images are released daily with the latest distribution packages available. - > This [CVE scan report](https://quay.io/repository/bitnami/dokuwiki?tab=tags) contains a security report with all open CVEs. To get the list of actionable security issues, find the "latest" tag, click the vulnerability report link under the corresponding "Security scan" field and then select the "Only show fixable" filter on the next page. -# How to deploy DokuWiki in Kubernetes? +## Why use a non-root container? -Deploying Bitnami applications as Helm Charts is the easiest way to get started with our applications on Kubernetes. Read more about the installation in the [Bitnami DokuWiki Chart GitHub repository](https://github.com/bitnami/charts/tree/master/bitnami/dokuwiki). +Non-root container images add an extra layer of security and are generally recommended for production environments. However, because they run as a non-root user, privileged tasks are typically off-limits. Learn more about non-root containers [in our docs](https://docs.bitnami.com/tutorials/work-with-non-root-containers/). -Bitnami containers can be used with [Kubeapps](https://kubeapps.com/) for deployment and management of Helm Charts in clusters. - -# Supported tags and respective `Dockerfile` links +## Supported tags and respective `Dockerfile` links Learn more about the Bitnami tagging policy and the difference between rolling tags and immutable tags [in our documentation page](https://docs.bitnami.com/tutorials/understand-rolling-tags-containers/). -* [`0-debian-10`, `0.20180422.202005011246-debian-10-r67`, `0`, `0.20180422.202005011246`, `latest` (0/debian-10/Dockerfile)](https://github.com/bitnami/bitnami-docker-dokuwiki/blob/0.20180422.202005011246-debian-10-r67/0/debian-10/Dockerfile) +* [`0-debian-10`, `0.20180422.202005011246-debian-10-r68`, `0`, `0.20180422.202005011246`, `latest` (0/debian-10/Dockerfile)](https://github.com/bitnami/bitnami-docker-dokuwiki/blob/0.20180422.202005011246-debian-10-r68/0/debian-10/Dockerfile) Subscribe to project updates by watching the [bitnami/dokuwiki GitHub repo](https://github.com/bitnami/bitnami-docker-dokuwiki). +## Get this image -# Prerequisites - -To run this application you need Docker Engine 1.10.0. Docker Compose is recomended with a version 1.6.0 or later. - -# How to use this image - -### Run the application using Docker Compose - -The main folder of this repository contains a functional [`docker-compose.yml`](https://github.com/bitnami/bitnami-docker-dokuwiki/blob/master/docker-compose.yml) file. Run the application using it as shown below: - -```console -$ curl -sSL https://raw.githubusercontent.com/bitnami/bitnami-docker-dokuwiki/master/docker-compose.yml > docker-compose.yml -$ docker-compose up -d -``` - -### Run the application manually - -If you want to run the application manually instead of using docker-compose, these are the basic steps you need to run: - -1. Create a new network for the application : - - ```console - $ docker network create dokuwiki-tier - ``` - -2. Run the Dokuwiki container: - - ```console - $ docker run -d \ - -p 80:80 -p 443:443 --name dokuwiki --net dokuwiki-tier \ - bitnami/dokuwiki:latest - ``` - -Then you can access your application at http://your-ip/ - -## Persisting your application - -If you remove the container all your data and configurations will be lost, and the next time you run the image the database will be reinitialized. To avoid this loss of data, you should mount a volume that will persist even after the container is removed. - -For persistence you should mount a volume at the `/bitnami` path. The above examples define a docker volume namely `dokuwiki_data`. The DokuWiki application state will persist as long as this volume is not removed. - -To avoid inadvertent removal of this volume you can [mount host directories as data volumes](https://docs.docker.com/engine/tutorials/dockervolumes/). Alternatively you can make use of volume plugins to host the volume data. - -### Mount persistent folders in the host using docker-compose - -This requires a minor change to the [`docker-compose.yml`](https://github.com/bitnami/bitnami-docker-dokuwiki/blob/master/docker-compose.yml) file present in this repository: - -```yaml -dokuwiki: - ... - volumes: - - '/path/to/dokuwiki-persistence:/bitnami' - ... -``` - -### Mount persistent folders manually - -In this case you need to specify the directories to mount on the run command. The process is the same than the one previously shown: - -1. If you haven't done this before, create a new network for the application : - - ```console - $ docker network create dokuwiki-tier - ``` - -2. Run the Dokuwiki container: - - ```console - $ docker run -d -p 80:80 -p 443:443 --name dokuwiki \ - --net dokuwiki-tier \ - --volume /path/to/dokuwiki-persistence:/bitnami \ - bitnami/dokuwiki:latest - ``` - -# Upgrade this application - -Bitnami provides up-to-date versions of Dokuwiki, including security patches, soon after they are made upstream. We recommend that you follow these steps to upgrade your container. We will cover here the upgrade of the Dokuwiki container. - -1. Get the updated images: +The recommended way to get the Bitnami DokuWiki Docker Image is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/dokuwiki). ```console $ docker pull bitnami/dokuwiki:latest ``` -2. Stop your container - - * For docker-compose: `$ docker-compose stop dokuwiki` - * For manual execution: `$ docker stop dokuwiki` - -3. Take a snapshot of the application state +To use a specific version, you can pull a versioned tag. You can view the [list of available versions](https://hub.docker.com/r/bitnami/dokuwiki/tags/) in the Docker Hub Registry. ```console -$ rsync -a /path/to/dokuwiki-persistence /path/to/dokuwiki-persistence.bkp.$(date +%Y%m%d-%H.%M.%S) +$ docker pull bitnami/dokuwiki:[TAG] ``` -You can use this snapshot to restore the application state should the upgrade fail. +If you wish, you can also build the image yourself. -4. Remove the stopped container +```console +$ docker build -t bitnami/dokuwiki:latest 'https://github.com/bitnami/bitnami-docker-dokuwiki.git#master:0/debian-10' +``` - * For docker-compose: `$ docker-compose rm -v dokuwiki` - * For manual execution: `$ docker rm -v dokuwiki` +## Persisting your application -5. Run the new image +If you remove the container all your data will be lost, and the next time you run the image the database will be reinitialized. To avoid this loss of data, you should mount a volume that will persist even after the container is removed. - * For docker-compose: `$ docker-compose up dokuwiki` - * For manual execution ([mount](#mount-persistent-folders-manually) the directories if needed): `docker run --name dokuwiki bitnami/dokuwiki:latest` +For persistence you should mount a directory at the `/bitnami/dokuwiki` path. If the mounted directory is empty, it will be initialized on the first run. Additionally you should mount a volume for persistence of the data](https://github.com/bitnami/bitnami-docker-#persisting-your-database). -# Configuration +The above examples define the Docker volumes named dokuwiki_data. The DokuWiki application state will persist as long as volumes are not removed. + +To avoid inadvertent removal of volumes, you can mount host directories as data volumes. Alternatively you can make use of volume plugins to host the volume data. + +### Mount host directories as data volumes with Docker Compose + +This requires a minor change to the [`docker-compose.yml`](https://github.com/bitnami/bitnami-docker-dokuwiki/blob/master/docker-compose.yml) file present in this repository: + +```diff + dokuwiki: + ... + volumes: +- - 'dokuwiki_data:/bitnami/dokuwiki' ++ - /path/to/dokuwiki-persistence:/bitnami/dokuwiki + ... +-volumes: +- dokuwiki_data: +- driver: local +``` + +> NOTE: As this is a non-root container, the mounted files and directories must have the proper permissions for the UID `1001`. + +### Mount host directories as data volumes using the Docker command line + +#### Step 1: Create a network (if it does not exist) + +```console +$ docker network create dokuwiki-network +``` + +#### Step 2. Create the DokuWiki the container with host volumes + +```console +$ docker volume create --name dokuwiki_data +$ docker run -d --name dokuwiki \ + -p 8080:8080 -p 8443:8443 \ + --env ALLOW_EMPTY_PASSWORD=yes \ + --network dokuwiki-network \ + --volume /path/to/dokuwiki-persistence:/bitnami/dokuwiki \ + bitnami/dokuwiki:latest +``` + +## Configuration ## Environment variables When you start the DokuWiki image, you can adjust the configuration of the instance by passing one or more environment variables either on the docker-compose file or on the `docker run` command line. If you want to add a new environment variable: - * Modify the [`docker-compose.yml`](https://github.com/bitnami/bitnami-docker-dokuwiki/blob/master/docker-compose.yml) file present in this repository: + * For docker-compose add the variable name and value under the application section in the [`docker-compose.yml`](https://github.com/bitnami/bitnami-docker-dokuwiki/blob/master/docker-compose.yml) file present in this repository: - ```yaml - dokuwiki: - ... - environment: - - DOKUWIKI_PASSWORD=my_password - ... - ``` +```yaml +dokuwiki: + ... + environment: + - DOKUWIKI_PASSWORD=my_password + ... +``` - * For manual execution add a `-e` option with each variable and value: + * For manual execution add a `--env` option with each variable and value: ```console - $ docker run -d -p 80:80 -p 443:443 --name dokuwiki \ - -e DOKUWIKI_PASSWORD=my_password \ - --net dokuwiki-tier \ - --volume /path/to/dokuwiki-persistence:/bitnami/dokuwiki \ + $ docker run -d --name dokuwiki -p 80:8080 -p 443:8443 \ + --env DOKUWIKI_PASSWORD=my_password \ + --network dokuwiki-tier \ + --volume /path/to/dokuwiki-persistence:/bitnami \ bitnami/dokuwiki:latest ``` -Available variables: +Available environment variables: + +##### User and Site configuration - `DOKUWIKI_USERNAME`: Dokuwiki application SuperUser name. Default: **superuser** - `DOKUWIKI_FULL_NAME`: Dokuwiki SuperUser Full Name. Default: **Full Name** - `DOKUWIKI_PASSWORD`: Dokuwiki application password. Default: **bitnami1** - `DOKUWIKI_EMAIL`: Dokuwiki application email. Default: **user@example.com** - `DOKUWIKI_WIKI_NAME`: Dokuwiki wiki name. Default: **Bitnami DokuWiki** - - `PHP_MEMORY_LIMIT`: Memory limit for PHP. Default: **256M** -# Customize this image +##### PHP configuration -The Bitnami Dokuwiki Docker image is designed to be extended so it can be used as the base image for your custom web applications. +- `PHP_MEMORY_LIMIT`: Memory limit for PHP. Default: **256M** -## Extend this image +## Logging + +The Bitnami DokuWiki Docker image sends the container logs to `stdout`. To view the logs: + +```console +$ docker logs dokuwiki +``` + +Or using Docker Compose: + +```console +$ docker-compose logs dokuwiki +``` + +You can configure the containers [logging driver](https://docs.docker.com/engine/admin/logging/overview/) using the `--log-driver` option if you wish to consume the container logs differently. In the default configuration docker uses the `json-file` driver. + +## Maintenance + +### Backing up your container + +To backup your data, configuration and logs, follow these simple steps: + +#### Step 1: Stop the currently running container + +```console +$ docker stop dokuwiki +``` + +Or using Docker Compose: + +```console +$ docker-compose stop dokuwiki +``` + +#### Step 2: Run the backup command + +We need to mount two volumes in a container we will use to create the backup: a directory on your host to store the backup in, and the volumes from the container we just stopped so we can access the data. + +```console +$ docker run --rm -v /path/to/dokuwiki-backups:/backups --volumes-from dokuwiki busybox \ + cp -a /bitnami/dokuwiki /backups/latest +``` + +### Restoring a backup + +Restoring a backup is as simple as mounting the backup as volumes in the containers. + +For the DokuWiki container: + +```diff + $ docker run -d --name \ + ... +- --volume /path/to/-persistence:/bitnami/ \ ++ --volume /path/to/-backups/latest:/bitnami/ \ + bitnami/:latest +``` + +### Upgrade this image + +Bitnami provides up-to-date versions of DokuWiki, including security patches, soon after they are made upstream. We recommend that you follow these steps to upgrade your container. We will cover here the upgrade of the DokuWiki container. + +#### Step 1: Get the updated image + +```console +$ docker pull bitnami/dokuwiki:latest +``` + +#### Step 2: Stop the running container + +Stop the currently running container using the command + +```console +$ docker-compose stop dokuwiki +``` + +#### Step 3: Take a snapshot of the application state + +Follow the steps in [Backing up your container](#backing-up-your-container) to take a snapshot of the current application state. + +#### Step 4: Remove the currently running container + +Remove the currently running container by executing the following command: + +```console +docker-compose rm -v dokuwiki +``` + +#### Step 5: Run the new image + +Update the image tag in `docker-compose.yml` and re-create your container with the new image: + +```console +$ docker-compose up -d +``` + +## Customize this image + +The Bitnami DokuWiki Docker image is designed to be extended so it can be used as the base image for your custom web applications. + +### Extend this image Before extending this image, please note there are certain configuration settings you can modify using the original image: @@ -216,79 +272,85 @@ FROM bitnami/dokuwiki LABEL maintainer "Bitnami " ## Install 'vim' +USER 0 # Required to perform privileged actions RUN install_packages vim +USER 1001 # Revert to the original non-root user ## Enable mod_ratelimit module RUN sed -i -r 's/#LoadModule ratelimit_module/LoadModule ratelimit_module/' /opt/bitnami/apache/conf/httpd.conf ## Modify the ports used by Apache by default # It is also possible to change these environment variables at runtime -ENV APACHE_HTTP_PORT_NUMBER=8181 +ENV APACHE_HTTP_PORT_NUMBER=8181 ENV APACHE_HTTPS_PORT_NUMBER=8143 EXPOSE 8181 8143 ``` -Based on the extended image, you can use a Docker Compose file like the one below to add other features: +Based on the extended image, you can update the [`docker-compose.yml`](https://github.com/bitnami/bitnami-docker-dokuwiki/blob/master/docker-compose.yml) file present in this repository to add other features: -```yaml -version: '2' -services: - dokuwiki: - build: . - ports: - - '80:8181' - - '443:8143' - volumes: - - 'dokuwiki_data:/bitnami' -volumes: - dokuwiki_data: - driver: local +```diff + dokuwiki: +- image: bitnami/dokuwiki:latest ++ build: . + ports: +- - '80:8080' +- - '443:8443' ++ - '80:8181' ++ - '443:8143' + environment: ++ - PHP_MEMORY_LIMIT=512m + ... ``` - -# Notable Changes -## 0.20180422.201901061035-debian-9-r114 and 0.20180422.201901061035-ol-7-r128 +## Notable Changes + +### 0.20180422.202005011246-debian-10-r68 + +- The size of the container image has been decreased. +- The configuration logic is now based on Bash scripts in the *rootfs/* folder. + +### 0.20180422.201901061035-debian-9-r114 and 0.20180422.201901061035-ol-7-r128 - This image has been adapted so it's easier to customize. See the [Customize this image](#customize-this-image) section for more information. - The Apache configuration volume (`/bitnami/apache`) has been deprecated, and support for this feature will be dropped in the near future. Until then, the container will enable the Apache configuration from that volume if it exists. By default, and if the configuration volume does not exist, the configuration files will be regenerated each time the container is created. Users wanting to apply custom Apache configuration files are advised to mount a volume for the configuration at `/opt/bitnami/apache/conf`, or mount specific configuration files individually. - The PHP configuration volume (`/bitnami/php`) has been deprecated, and support for this feature will be dropped in the near future. Until then, the container will enable the PHP configuration from that volume if it exists. By default, and if the configuration volume does not exist, the configuration files will be regenerated each time the container is created. Users wanting to apply custom PHP configuration files are advised to mount a volume for the configuration at `/opt/bitnami/php/conf`, or mount specific configuration files individually. - Enabling custom Apache certificates by placing them at `/opt/bitnami/apache/certs` has been deprecated, and support for this functionality will be dropped in the near future. Users wanting to enable custom certificates are advised to mount their certificate files on top of the preconfigured ones at `/certs`. -## 0.20170219.201708232029-r3 +### 0.20170219.201708232029-r3 - Custom smileys, available in `lib/images/smileys/local`, are now persisted. - Address issue [#40](https://github.com/bitnami/bitnami-docker-dokuwiki/issues/40). - In order to upgrade your image from previous versions, see the workaround provided on issue [#42](https://github.com/bitnami/bitnami-docker-dokuwiki/issues/42). -## 0.20180422.201805030840-r5 +### 0.20180422.201805030840-r5 - Custom InterWiki shortcut icons, available in `lib/images/interwiki/`, are now persisted. - Address issue [#40](https://github.com/bitnami/bitnami-docker-dokuwiki/issues/40). - In order to upgrade your image from previous versions, see the workaround provided on issue [#42](https://github.com/bitnami/bitnami-docker-dokuwiki/issues/42). -# Contributing +## Contributing We'd love for you to contribute to this container. You can request new features by creating an [issue](https://github.com/bitnami/bitnami-docker-dokuwiki/issues), or submit a [pull request](https://github.com/bitnami/bitnami-docker-dokuwiki/pulls) with your contribution. -# Issues +## Issues -If you encountered a problem running this container, you can file an [issue](https://github.com/bitnami/bitnami-docker-dokuwiki/issues/new). For us to provide better support, be sure to include the following information in your issue: +If you encountered a problem running this container, you can file an [issue](https://github.com/bitnami/bitnami-docker-dokuwiki/issues). For us to provide better support, be sure to include the following information in your issue: - Host OS and version -- Docker version (`$ docker version`) -- Output of `$ docker info` -- Version of this container (`$ echo $BITNAMI_APP_VERSION` inside the container) +- Docker version (`docker version`) +- Output of `docker info` +- Version of this container - The command you used to run the container, and any relevant output you saw (masking any sensitive information) -# License +## License -Copyright 2016-2020 Bitnami +Copyright (c) 2020 Bitnami Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at - + http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, diff --git a/bitnami/dokuwiki/docker-compose.yml b/bitnami/dokuwiki/docker-compose.yml index e7ee2b517ff9..16f8853b5531 100644 --- a/bitnami/dokuwiki/docker-compose.yml +++ b/bitnami/dokuwiki/docker-compose.yml @@ -3,10 +3,10 @@ services: dokuwiki: image: 'docker.io/bitnami/dokuwiki:0-debian-10' ports: - - '80:80' - - '443:443' + - '80:8080' + - '443:8443' volumes: - - 'dokuwiki_data:/bitnami' + - 'dokuwiki_data:/bitnami/dokuwiki' volumes: dokuwiki_data: driver: local