mirror of
https://github.com/bitnami/containers.git
synced 2026-02-19 14:08:07 +08:00
4.4.0-debian-10-r16 release
This commit is contained in:
Bitnami Bot
@@ -1,30 +1,35 @@
|
||||
FROM docker.io/bitnami/minideb:buster
|
||||
LABEL maintainer "Bitnami <containers@bitnami.com>"
|
||||
|
||||
ENV PATH="/opt/bitnami/php/bin:/opt/bitnami/php/sbin:/opt/bitnami/apache/bin:/opt/bitnami/mysql/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 libargon2-1 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 libjemalloc2 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 libsodium23 libsqlite3-0 libssh2-1 libssl1.1 libstdc++6 libsybdb5 libtasn1-6 libtidy5deb1 libtinfo6 libunistring2 libuuid1 libwebp6 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.28-0 --checksum 029ca7c2678b4ccfb07db3b4ad18724070e0f49528ad17b42bbcf6b20620e574
|
||||
RUN bitnami-pkg unpack apache-2.4.46-7 --checksum cfb1835e471967ec5a6df8c622bdd907be03fb5b57b4f86f68eb7b73fe0f6be3
|
||||
RUN bitnami-pkg unpack mysql-client-10.3.29-0 --checksum 5bf8f1ed022c8ad75a4db5b8b72ae54ce427bff628d7e4025c5b5e67b876708d
|
||||
RUN bitnami-pkg install libphp-7.3.28-0 --checksum 70777f4c71ed24d033410bb3eaf4475d12aec111b971d7a3ed3f6935db72ed51
|
||||
RUN bitnami-pkg install tini-0.19.0-1 --checksum 9b1f1c095944bac88a62c1b63f3bff1bb123aa7ccd371c908c0e5b41cec2528d
|
||||
RUN bitnami-pkg unpack osclass-4.4.0-0 --checksum ef7ad7da4f3b18f34e8bb427518c209bb88c481ca2fb6ca68c1e6324b8a9a44e
|
||||
RUN bitnami-pkg install gosu-1.12.0-2 --checksum 4d858ac600c38af8de454c27b7f65c0074ec3069880cb16d259a6e40a46bbc50
|
||||
RUN ln -sf /dev/stdout /opt/bitnami/apache/logs/access_log && \
|
||||
ln -sf /dev/stderr /opt/bitnami/apache/logs/error_log
|
||||
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 libjemalloc2 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 libonig5 libp11-kit0 libpam0g libpcre3 libpng16-16 libpq5 libpsl5 libreadline7 librtmp1 libsasl2-2 libsodium23 libsqlite3-0 libssh2-1 libssl1.1 libstdc++6 libsybdb5 libtasn1-6 libtidy5deb1 libtinfo6 libunistring2 libuuid1 libwebp6 libx11-6 libxau6 libxcb1 libxdmcp6 libxext6 libxml2 libxslt1.1 libzip4 procps tar zlib1g
|
||||
RUN . /opt/bitnami/scripts/libcomponent.sh && component_unpack "php" "7.4.19-1" --checksum bbd1264e15d8eb1f3418ce0da010afff4fe3e3c539419d4c2acf00bc56655616
|
||||
RUN . /opt/bitnami/scripts/libcomponent.sh && component_unpack "apache" "2.4.46-7" --checksum cfb1835e471967ec5a6df8c622bdd907be03fb5b57b4f86f68eb7b73fe0f6be3
|
||||
RUN . /opt/bitnami/scripts/libcomponent.sh && component_unpack "mysql-client" "10.3.29-0" --checksum 5bf8f1ed022c8ad75a4db5b8b72ae54ce427bff628d7e4025c5b5e67b876708d
|
||||
RUN . /opt/bitnami/scripts/libcomponent.sh && component_unpack "libphp" "7.4.19-0" --checksum 285daf7986284f628aa0278ebdff8d9bb8d5c97527a8582f254aaf300d4215ca
|
||||
RUN . /opt/bitnami/scripts/libcomponent.sh && component_unpack "render-template" "1.0.0-3" --checksum 8179ad1371c9a7d897fe3b1bf53bbe763f94edafef19acad2498dd48b3674efe
|
||||
RUN . /opt/bitnami/scripts/libcomponent.sh && component_unpack "osclass" "4.4.0-0" --checksum ef7ad7da4f3b18f34e8bb427518c209bb88c481ca2fb6ca68c1e6324b8a9a44e
|
||||
RUN . /opt/bitnami/scripts/libcomponent.sh && component_unpack "gosu" "1.12.0-2" --checksum 4d858ac600c38af8de454c27b7f65c0074ec3069880cb16d259a6e40a46bbc50
|
||||
RUN chmod g+rwX /opt/bitnami
|
||||
|
||||
COPY rootfs /
|
||||
RUN /opt/bitnami/scripts/mysql-client/postunpack.sh
|
||||
RUN /opt/bitnami/scripts/apache/postunpack.sh
|
||||
RUN /opt/bitnami/scripts/php/postunpack.sh
|
||||
RUN /opt/bitnami/scripts/apache-modphp/postunpack.sh
|
||||
RUN /opt/bitnami/scripts/osclass/postunpack.sh
|
||||
ENV ALLOW_EMPTY_PASSWORD="no" \
|
||||
APACHE_ENABLE_CUSTOM_PORTS="no" \
|
||||
APACHE_HTTPS_PORT_NUMBER="443" \
|
||||
APACHE_HTTP_PORT_NUMBER="80" \
|
||||
APACHE_HTTPS_PORT_NUMBER="" \
|
||||
APACHE_HTTP_PORT_NUMBER="" \
|
||||
BITNAMI_APP_NAME="osclass" \
|
||||
BITNAMI_IMAGE_VERSION="4.4.0-debian-10-r15" \
|
||||
BITNAMI_IMAGE_VERSION="4.4.0-debian-10-r16" \
|
||||
MARIADB_HOST="mariadb" \
|
||||
MARIADB_PORT_NUMBER="3306" \
|
||||
MARIADB_ROOT_PASSWORD="" \
|
||||
@@ -35,25 +40,10 @@ ENV ALLOW_EMPTY_PASSWORD="no" \
|
||||
MYSQL_CLIENT_CREATE_DATABASE_USER="" \
|
||||
MYSQL_CLIENT_ENABLE_SSL="no" \
|
||||
MYSQL_CLIENT_SSL_CA_FILE="" \
|
||||
OSCLASS_DATABASE_NAME="bitnami_osclass" \
|
||||
OSCLASS_DATABASE_PASSWORD="" \
|
||||
OSCLASS_DATABASE_USER="bn_osclass" \
|
||||
OSCLASS_EMAIL="user@example.com" \
|
||||
OSCLASS_HOST="127.0.0.1" \
|
||||
OSCLASS_PASSWORD="bitnami1" \
|
||||
OSCLASS_USERNAME="user" \
|
||||
OSCLASS_WEB_TITLE="Sample Web Page" \
|
||||
OS_ARCH="amd64" \
|
||||
OS_FLAVOUR="debian-10" \
|
||||
OS_NAME="linux" \
|
||||
PHP_MEMORY_LIMIT="256M" \
|
||||
SMTP_HOST="" \
|
||||
SMTP_PASSWORD="" \
|
||||
SMTP_PORT="" \
|
||||
SMTP_PROTOCOL="" \
|
||||
SMTP_USER=""
|
||||
PATH="/opt/bitnami/php/bin:/opt/bitnami/php/sbin:/opt/bitnami/apache/bin:/opt/bitnami/mysql/bin:/opt/bitnami/common/bin:$PATH"
|
||||
|
||||
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/osclass/entrypoint.sh" ]
|
||||
CMD [ "/opt/bitnami/scripts/apache/run.sh" ]
|
||||
|
||||
@@ -2,28 +2,27 @@ version: '2'
|
||||
services:
|
||||
mariadb:
|
||||
image: docker.io/bitnami/mariadb:10.3
|
||||
volumes:
|
||||
- 'mariadb_data:/bitnami/mariadb'
|
||||
environment:
|
||||
- ALLOW_EMPTY_PASSWORD=yes
|
||||
- MARIADB_USER=bn_osclass
|
||||
- MARIADB_DATABASE=bitnami_osclass
|
||||
- ALLOW_EMPTY_PASSWORD=yes
|
||||
volumes:
|
||||
- 'mariadb_data:/bitnami'
|
||||
osclass:
|
||||
image: docker.io/bitnami/osclass:4
|
||||
environment:
|
||||
- MARIADB_HOST=mariadb
|
||||
- MARIADB_PORT_NUMBER=3306
|
||||
- OSCLASS_HOST=localhost
|
||||
- OSCLASS_DATABASE_USER=bn_osclass
|
||||
- OSCLASS_DATABASE_NAME=bitnami_osclass
|
||||
- ALLOW_EMPTY_PASSWORD=yes
|
||||
ports:
|
||||
- '80:80'
|
||||
- '443:443'
|
||||
- '80:8080'
|
||||
- '443:8443'
|
||||
volumes:
|
||||
- 'osclass_data:/bitnami/osclass'
|
||||
depends_on:
|
||||
- mariadb
|
||||
volumes:
|
||||
- 'osclass_data:/bitnami'
|
||||
environment:
|
||||
- ALLOW_EMPTY_PASSWORD=yes
|
||||
- OSCLASS_DATABASE_HOST=mariadb
|
||||
- OSCLASS_DATABASE_PORT_NUMBER=3306
|
||||
- OSCLASS_DATABASE_USER=bn_osclass
|
||||
- OSCLASS_DATABASE_NAME=bitnami_osclass
|
||||
volumes:
|
||||
mariadb_data:
|
||||
driver: local
|
||||
|
||||
@@ -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
|
||||
@@ -1,7 +0,0 @@
|
||||
#!/bin/bash
|
||||
|
||||
curl --silent -L https://nami-prod.s3.amazonaws.com/tools/nami/releases/nami-2.0.1-0-linux-x64.tar.gz > /tmp/nami-linux-x64.tar.gz
|
||||
echo "05e6e1e86cbb419cd80f832650ad06d97bcabca2c3a9e953e81b2674a29cc94e /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.1-0.txt
|
||||
@@ -15,10 +15,10 @@
|
||||
},
|
||||
"libphp": {
|
||||
"arch": "amd64",
|
||||
"digest": "70777f4c71ed24d033410bb3eaf4475d12aec111b971d7a3ed3f6935db72ed51",
|
||||
"digest": "285daf7986284f628aa0278ebdff8d9bb8d5c97527a8582f254aaf300d4215ca",
|
||||
"distro": "debian-10",
|
||||
"type": "NAMI",
|
||||
"version": "7.3.28-0"
|
||||
"version": "7.4.19-0"
|
||||
},
|
||||
"mysql-client": {
|
||||
"arch": "amd64",
|
||||
@@ -36,16 +36,16 @@
|
||||
},
|
||||
"php": {
|
||||
"arch": "amd64",
|
||||
"digest": "029ca7c2678b4ccfb07db3b4ad18724070e0f49528ad17b42bbcf6b20620e574",
|
||||
"digest": "bbd1264e15d8eb1f3418ce0da010afff4fe3e3c539419d4c2acf00bc56655616",
|
||||
"distro": "debian-10",
|
||||
"type": "NAMI",
|
||||
"version": "7.3.28-0"
|
||||
"version": "7.4.19-1"
|
||||
},
|
||||
"tini": {
|
||||
"render-template": {
|
||||
"arch": "amd64",
|
||||
"digest": "9b1f1c095944bac88a62c1b63f3bff1bb123aa7ccd371c908c0e5b41cec2528d",
|
||||
"digest": "8179ad1371c9a7d897fe3b1bf53bbe763f94edafef19acad2498dd48b3674efe",
|
||||
"distro": "debian-10",
|
||||
"type": "NAMI",
|
||||
"version": "0.19.0-1"
|
||||
"version": "1.0.0-3"
|
||||
}
|
||||
}
|
||||
@@ -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 ""
|
||||
}
|
||||
@@ -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 overridden 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
|
||||
}
|
||||
@@ -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 ""
|
||||
}
|
||||
|
||||
@@ -0,0 +1,65 @@
|
||||
#!/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"
|
||||
}
|
||||
@@ -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"
|
||||
}
|
||||
@@ -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 || exit
|
||||
realpath -q --no-symlinks --relative-base="$base" "$path" | sed -e 's|^/$|.|' -e 's|^/||'
|
||||
popd >/dev/null || exit
|
||||
}
|
||||
|
||||
########################
|
||||
# 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
|
||||
}
|
||||
@@ -0,0 +1,16 @@
|
||||
#!/bin/bash
|
||||
#
|
||||
# Library to use for scripts expected to be used as Kubernetes lifecycle hooks
|
||||
|
||||
# shellcheck disable=SC1091
|
||||
|
||||
# Load generic libraries
|
||||
. /opt/bitnami/scripts/liblog.sh
|
||||
. /opt/bitnami/scripts/libos.sh
|
||||
|
||||
# Override functions that log to stdout/stderr of the current process, so they print to process 1
|
||||
for function_to_override in stderr_print debug_execute; do
|
||||
# Output is sent to output of process 1 and thus end up in the container log
|
||||
# The hook output in general isn't saved
|
||||
eval "$(declare -f "$function_to_override") >/proc/1/fd/1 2>/proc/1/fd/2"
|
||||
done
|
||||
@@ -0,0 +1,112 @@
|
||||
#!/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
|
||||
# shellcheck disable=SC2001
|
||||
# Complex regex, see https://github.com/koalaman/shellcheck/wiki/SC2001#exceptions
|
||||
echo "$string" | sed "s/^/${indent_unit}/"
|
||||
}
|
||||
@@ -0,0 +1,142 @@
|
||||
#!/bin/bash
|
||||
#
|
||||
# Library for network functions
|
||||
|
||||
# shellcheck disable=SC1091
|
||||
|
||||
# Load Generic Libraries
|
||||
. /opt/bitnami/scripts/liblog.sh
|
||||
|
||||
# Functions
|
||||
|
||||
########################
|
||||
# Resolve IP address for a host/domain (i.e. DNS lookup)
|
||||
# Arguments:
|
||||
# $1 - Hostname to resolve
|
||||
# $2 - IP address version (v4, v6), leave empty for resolving to any version
|
||||
# Returns:
|
||||
# IP
|
||||
#########################
|
||||
dns_lookup() {
|
||||
local host="${1:?host is missing}"
|
||||
local ip_version="${2:-}"
|
||||
getent "ahosts${ip_version}" "$host" | awk '/STREAM/ {print $1 }' | head -n 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}]}"
|
||||
}
|
||||
@@ -0,0 +1,350 @@
|
||||
#!/bin/bash
|
||||
#
|
||||
# Library for operating system actions
|
||||
|
||||
# shellcheck disable=SC1091
|
||||
|
||||
# Load Generic Libraries
|
||||
. /opt/bitnami/scripts/liblog.sh
|
||||
. /opt/bitnami/scripts/libfs.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
|
||||
# Flags:
|
||||
# -s|--system - Whether to create new user as system user (uid <= 999)
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
ensure_group_exists() {
|
||||
local group="${1:?group is missing}"
|
||||
local is_system_user=false
|
||||
|
||||
# Validate arguments
|
||||
shift 1
|
||||
while [ "$#" -gt 0 ]; do
|
||||
case "$1" in
|
||||
-s|--system)
|
||||
is_system_user=true
|
||||
;;
|
||||
*)
|
||||
echo "Invalid command line flag $1" >&2
|
||||
return 1
|
||||
;;
|
||||
esac
|
||||
shift
|
||||
done
|
||||
|
||||
if ! group_exists "$group"; then
|
||||
local -a args=("$group")
|
||||
$is_system_user && args+=("--system")
|
||||
groupadd "${args[@]}" >/dev/null 2>&1
|
||||
fi
|
||||
}
|
||||
|
||||
########################
|
||||
# Create an user in the system if it does not exist already
|
||||
# Arguments:
|
||||
# $1 - user
|
||||
# Flags:
|
||||
# -g|--group - the group the new user should belong to
|
||||
# -h|--home - the home directory for the new user
|
||||
# -s|--system - whether to create new user as system user (uid <= 999)
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
ensure_user_exists() {
|
||||
local user="${1:?user is missing}"
|
||||
local group=""
|
||||
local home=""
|
||||
local is_system_user=false
|
||||
|
||||
# Validate arguments
|
||||
shift 1
|
||||
while [ "$#" -gt 0 ]; do
|
||||
case "$1" in
|
||||
-g|--group)
|
||||
shift
|
||||
group="${1:?missing group}"
|
||||
;;
|
||||
-h|--home)
|
||||
shift
|
||||
home="${1:?missing home directory}"
|
||||
;;
|
||||
-s|--system)
|
||||
is_system_user=true
|
||||
;;
|
||||
*)
|
||||
echo "Invalid command line flag $1" >&2
|
||||
return 1
|
||||
;;
|
||||
esac
|
||||
shift
|
||||
done
|
||||
|
||||
if ! user_exists "$user"; then
|
||||
local -a user_args=("-N" "$user")
|
||||
$is_system_user && user_args+=("--system")
|
||||
useradd "${user_args[@]}" >/dev/null 2>&1
|
||||
fi
|
||||
|
||||
if [[ -n "$group" ]]; then
|
||||
local -a group_args=("$group")
|
||||
$is_system_user && group_args+=("--system")
|
||||
ensure_group_exists "${group_args[@]}"
|
||||
usermod -g "$group" "$user" >/dev/null 2>&1
|
||||
fi
|
||||
|
||||
if [[ -n "$home" ]]; then
|
||||
mkdir -p "$home"
|
||||
usermod -d "$home" "$user" >/dev/null 2>&1
|
||||
configure_permissions_ownership "$home" -d "775" -f "664" -u "$user" -g "$group"
|
||||
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"
|
||||
}
|
||||
|
||||
########################
|
||||
# Create md5 hash from a string
|
||||
# Arguments:
|
||||
# $1 - string
|
||||
# Returns:
|
||||
# md5 hash - string
|
||||
#########################
|
||||
generate_md5_hash() {
|
||||
local -r str="${1:?missing input string}"
|
||||
echo -n "$str" | md5sum | awk '{print $1}'
|
||||
}
|
||||
@@ -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 <<< "$(tr ',;:' ' ' <<< "$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 || exit
|
||||
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 || exit
|
||||
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 || exit
|
||||
done
|
||||
popd >/dev/null || exit
|
||||
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 <<< "$(tr ',;:' ' ' <<< "$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
|
||||
}
|
||||
@@ -0,0 +1,235 @@
|
||||
#!/bin/bash
|
||||
#
|
||||
# Library for managing services
|
||||
|
||||
# shellcheck disable=SC1091
|
||||
|
||||
# Load Generic Libraries
|
||||
. /opt/bitnami/scripts/libvalidations.sh
|
||||
. /opt/bitnami/scripts/liblog.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="* * * * *"
|
||||
local clean="true"
|
||||
|
||||
local clean="true"
|
||||
|
||||
# Parse optional CLI flags
|
||||
shift 2
|
||||
while [[ "$#" -gt 0 ]]; do
|
||||
case "$1" in
|
||||
--run-as)
|
||||
shift
|
||||
run_as="$1"
|
||||
;;
|
||||
--schedule)
|
||||
shift
|
||||
schedule="$1"
|
||||
;;
|
||||
--no-clean)
|
||||
clean="false"
|
||||
;;
|
||||
*)
|
||||
echo "Invalid command line flag ${1}" >&2
|
||||
return 1
|
||||
;;
|
||||
esac
|
||||
shift
|
||||
done
|
||||
|
||||
mkdir -p /etc/cron.d
|
||||
if "$clean"; then
|
||||
echo "${schedule} ${run_as} ${cmd}" > /etc/cron.d/"$service_name"
|
||||
else
|
||||
echo "${schedule} ${run_as} ${cmd}" >> /etc/cron.d/"$service_name"
|
||||
fi
|
||||
}
|
||||
|
||||
########################
|
||||
# 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:-}" <<EOF
|
||||
check process ${service_name}
|
||||
with pidfile "${pid_file}"
|
||||
start program = "${start_command}" with timeout 90 seconds
|
||||
stop program = "${stop_command}" with timeout 90 seconds
|
||||
EOF
|
||||
}
|
||||
|
||||
########################
|
||||
# Generate a logrotate configuration file
|
||||
# Arguments:
|
||||
# $1 - Service name
|
||||
# $2 - Log files pattern
|
||||
# Flags:
|
||||
# --period - Period
|
||||
# --rotations - Number of rotations to store
|
||||
# --extra - Extra options (Optional)
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
generate_logrotate_conf() {
|
||||
local service_name="${1:?service name is missing}"
|
||||
local log_path="${2:?log path is missing}"
|
||||
local period="weekly"
|
||||
local rotations="150"
|
||||
local extra=""
|
||||
local logrotate_conf_dir="/etc/logrotate.d"
|
||||
local var_name
|
||||
# Parse optional CLI flags
|
||||
shift 2
|
||||
while [[ "$#" -gt 0 ]]; do
|
||||
case "$1" in
|
||||
--period|--rotations|--extra)
|
||||
var_name="$(echo "$1" | sed -e "s/^--//" -e "s/-/_/g")"
|
||||
shift
|
||||
declare "$var_name"="${1:?"$var_name" is missing}"
|
||||
;;
|
||||
*)
|
||||
echo "Invalid command line flag ${1}" >&2
|
||||
return 1
|
||||
;;
|
||||
esac
|
||||
shift
|
||||
done
|
||||
|
||||
mkdir -p "$logrotate_conf_dir"
|
||||
cat <<EOF | sed '/^\s*$/d' >"${logrotate_conf_dir}/${service_name}"
|
||||
${log_path} {
|
||||
${period}
|
||||
rotate ${rotations}
|
||||
dateext
|
||||
compress
|
||||
copytruncate
|
||||
missingok
|
||||
$(indent "$extra" 2)
|
||||
}
|
||||
EOF
|
||||
}
|
||||
@@ -0,0 +1,248 @@
|
||||
#!/bin/bash
|
||||
#
|
||||
# Validation functions library
|
||||
|
||||
# shellcheck disable=SC1091
|
||||
|
||||
# Load Generic Libraries
|
||||
. /opt/bitnami/scripts/liblog.sh
|
||||
|
||||
# Functions
|
||||
|
||||
########################
|
||||
# Check if the provided argument is an integer
|
||||
# Arguments:
|
||||
# $1 - Value to check
|
||||
# Returns:
|
||||
# Boolean
|
||||
#########################
|
||||
is_int() {
|
||||
local -r int="${1:?missing value}"
|
||||
if [[ "$int" =~ ^-?[0-9]+ ]]; then
|
||||
true
|
||||
else
|
||||
false
|
||||
fi
|
||||
}
|
||||
|
||||
########################
|
||||
# Check if the provided argument is a positive integer
|
||||
# Arguments:
|
||||
# $1 - Value to check
|
||||
# Returns:
|
||||
# Boolean
|
||||
#########################
|
||||
is_positive_int() {
|
||||
local -r int="${1:?missing value}"
|
||||
if is_int "$int" && (( "${int}" >= 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
|
||||
}
|
||||
@@ -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
|
||||
}
|
||||
@@ -0,0 +1,424 @@
|
||||
#!/bin/bash
|
||||
#
|
||||
# Bitnami web server handler library
|
||||
|
||||
# shellcheck disable=SC1090,SC1091
|
||||
|
||||
# Load generic libraries
|
||||
. /opt/bitnami/scripts/liblog.sh
|
||||
|
||||
########################
|
||||
# Execute a command (or list of commands) with the web server environment and library loaded
|
||||
# Globals:
|
||||
# *
|
||||
# Arguments:
|
||||
# None
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
web_server_execute() {
|
||||
local -r web_server="${1:?missing web server}"
|
||||
shift
|
||||
# Run program in sub-shell to avoid web server environment getting loaded when not necessary
|
||||
(
|
||||
. "/opt/bitnami/scripts/lib${web_server}.sh"
|
||||
. "/opt/bitnami/scripts/${web_server}-env.sh"
|
||||
"$@"
|
||||
)
|
||||
}
|
||||
|
||||
########################
|
||||
# Prints the list of enabled web servers
|
||||
# Globals:
|
||||
# None
|
||||
# Arguments:
|
||||
# None
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
web_server_list() {
|
||||
local -r -a supported_web_servers=(apache nginx)
|
||||
local -a existing_web_servers=()
|
||||
for web_server in "${supported_web_servers[@]}"; do
|
||||
[[ -f "/opt/bitnami/scripts/${web_server}-env.sh" ]] && existing_web_servers+=("$web_server")
|
||||
done
|
||||
echo "${existing_web_servers[@]:-}"
|
||||
}
|
||||
|
||||
########################
|
||||
# Prints the currently-enabled web server type (only one, in order of preference)
|
||||
# Globals:
|
||||
# None
|
||||
# Arguments:
|
||||
# None
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
web_server_type() {
|
||||
local -a web_servers
|
||||
read -r -a web_servers <<< "$(web_server_list)"
|
||||
echo "${web_servers[0]:-}"
|
||||
}
|
||||
|
||||
########################
|
||||
# Validate that a supported web server is configured
|
||||
# Globals:
|
||||
# None
|
||||
# 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 ! web_server_execute "$(web_server_type)" 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() {
|
||||
info "Starting $(web_server_type) in background"
|
||||
"${BITNAMI_ROOT_DIR}/scripts/$(web_server_type)/start.sh"
|
||||
}
|
||||
|
||||
########################
|
||||
# Stop web server
|
||||
# Globals:
|
||||
# *
|
||||
# Arguments:
|
||||
# None
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
web_server_stop() {
|
||||
info "Stopping $(web_server_type)"
|
||||
"${BITNAMI_ROOT_DIR}/scripts/$(web_server_type)/stop.sh"
|
||||
}
|
||||
|
||||
########################
|
||||
# Restart web server
|
||||
# Globals:
|
||||
# *
|
||||
# Arguments:
|
||||
# None
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
web_server_restart() {
|
||||
info "Restarting $(web_server_type)"
|
||||
"${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 <VirtualHost> 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)
|
||||
# --nginx-external-configuration - Configuration external to server block (no default)
|
||||
# Returns:
|
||||
# true if the configuration was enabled, false otherwise
|
||||
########################
|
||||
ensure_web_server_app_configuration_exists() {
|
||||
local app="${1:?missing app}"
|
||||
shift
|
||||
local -a apache_args nginx_args web_servers args_var
|
||||
apache_args=("$app")
|
||||
nginx_args=("$app")
|
||||
# Validate arguments
|
||||
while [[ "$#" -gt 0 ]]; do
|
||||
case "$1" in
|
||||
# Common flags
|
||||
--hosts \
|
||||
| --type \
|
||||
| --allow-remote-connections \
|
||||
| --disabled \
|
||||
| --enable-https \
|
||||
| --http-port \
|
||||
| --https-port \
|
||||
| --document-root \
|
||||
)
|
||||
apache_args+=("$1" "${2:?missing value}")
|
||||
nginx_args+=("$1" "${2:?missing value}")
|
||||
shift
|
||||
;;
|
||||
|
||||
# Specific Apache flags
|
||||
--apache-additional-configuration \
|
||||
| --apache-before-vhost-configuration \
|
||||
| --apache-allow-override \
|
||||
| --apache-extra-directory-configuration \
|
||||
| --apache-proxy-address \
|
||||
| --apache-move-htaccess \
|
||||
)
|
||||
apache_args+=("${1//apache-/}" "${2:?missing value}")
|
||||
shift
|
||||
;;
|
||||
|
||||
# Specific NGINX flags
|
||||
--nginx-additional-configuration \
|
||||
| --nginx-external-configuration)
|
||||
nginx_args+=("${1//nginx-/}" "${2:?missing value}")
|
||||
shift
|
||||
;;
|
||||
|
||||
*)
|
||||
echo "Invalid command line flag $1" >&2
|
||||
return 1
|
||||
;;
|
||||
esac
|
||||
shift
|
||||
done
|
||||
read -r -a web_servers <<< "$(web_server_list)"
|
||||
for web_server in "${web_servers[@]}"; do
|
||||
args_var="${web_server}_args[@]"
|
||||
web_server_execute "$web_server" "ensure_${web_server}_app_configuration_exists" "${!args_var}"
|
||||
done
|
||||
}
|
||||
|
||||
########################
|
||||
# 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}"
|
||||
local -a web_servers
|
||||
read -r -a web_servers <<< "$(web_server_list)"
|
||||
for web_server in "${web_servers[@]}"; do
|
||||
web_server_execute "$web_server" "ensure_${web_server}_app_configuration_not_exists" "$app"
|
||||
done
|
||||
}
|
||||
|
||||
########################
|
||||
# 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}"
|
||||
shift
|
||||
local -a apache_args nginx_args web_servers args_var
|
||||
apache_args=("$app")
|
||||
nginx_args=("$app")
|
||||
# Validate arguments
|
||||
while [[ "$#" -gt 0 ]]; do
|
||||
case "$1" in
|
||||
# Common flags
|
||||
--allow-remote-connections \
|
||||
| --document-root \
|
||||
| --prefix \
|
||||
| --type \
|
||||
)
|
||||
apache_args+=("$1" "${2:?missing value}")
|
||||
nginx_args+=("$1" "${2:?missing value}")
|
||||
shift
|
||||
;;
|
||||
|
||||
# Specific Apache flags
|
||||
--apache-additional-configuration \
|
||||
| --apache-allow-override \
|
||||
| --apache-extra-directory-configuration \
|
||||
| --apache-move-htaccess \
|
||||
)
|
||||
apache_args+=("${1//apache-/}" "$2")
|
||||
shift
|
||||
;;
|
||||
|
||||
# Specific NGINX flags
|
||||
--nginx-additional-configuration)
|
||||
nginx_args+=("${1//nginx-/}" "$2")
|
||||
shift
|
||||
;;
|
||||
|
||||
*)
|
||||
echo "Invalid command line flag $1" >&2
|
||||
return 1
|
||||
;;
|
||||
esac
|
||||
shift
|
||||
done
|
||||
read -r -a web_servers <<< "$(web_server_list)"
|
||||
for web_server in "${web_servers[@]}"; do
|
||||
args_var="${web_server}_args[@]"
|
||||
web_server_execute "$web_server" "ensure_${web_server}_prefix_configuration_exists" "${!args_var}"
|
||||
done
|
||||
}
|
||||
|
||||
########################
|
||||
# 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}"
|
||||
shift
|
||||
local -a args web_servers
|
||||
args=("$app")
|
||||
# Validate arguments
|
||||
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
|
||||
read -r -a web_servers <<< "$(web_server_list)"
|
||||
for web_server in "${web_servers[@]}"; do
|
||||
web_server_execute "$web_server" "${web_server}_update_app_configuration" "${args[@]}"
|
||||
done
|
||||
}
|
||||
|
||||
########################
|
||||
# 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
|
||||
}
|
||||
@@ -1,222 +0,0 @@
|
||||
#!/bin/bash -e
|
||||
. /opt/bitnami/base/functions
|
||||
|
||||
print_usage() {
|
||||
log "Usage: bitnami-pkg <COMMAND> <PACKAGE>-<VERSION> [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
|
||||
;;
|
||||
ubuntu-*)
|
||||
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
|
||||
|
||||
if [[ $PACKAGE =~ git-.* ]]; then
|
||||
# Due to a nami unpack issue, git binaries are copied instead of using hard symlinks.
|
||||
# This workaround overwrites these binaries with the original ones, preserving links
|
||||
# and saving ~500 MB
|
||||
info "Patching ${PACKAGE}"
|
||||
cp -a --force "${INSTALL_ROOT}/${PACKAGE}/files/git/." "/opt/bitnami/git"
|
||||
fi
|
||||
|
||||
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
|
||||
@@ -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
|
||||
@@ -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}}"
|
||||
}
|
||||
@@ -1,16 +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
|
||||
. /osclass-init.sh
|
||||
nami_initialize php apache mysql-client osclass
|
||||
info "Starting gosu... "
|
||||
. /post-init.sh
|
||||
fi
|
||||
|
||||
exec tini -- "$@"
|
||||
@@ -1,13 +0,0 @@
|
||||
{
|
||||
"allowEmptyPassword": "{{$global.env.ALLOW_EMPTY_PASSWORD}}",
|
||||
"createDatabaseName": "{{$global.env.MYSQL_CLIENT_CREATE_DATABASE_NAME}}",
|
||||
"createDatabasePassword": "{{$global.env.MYSQL_CLIENT_CREATE_DATABASE_PASSWORD}}",
|
||||
"createDatabasePrivileges": "{{$global.env.MYSQL_CLIENT_CREATE_DATABASE_PRIVILEGES}}",
|
||||
"createDatabaseUser": "{{$global.env.MYSQL_CLIENT_CREATE_DATABASE_USER}}",
|
||||
"host": "{{$global.env.MARIADB_HOST}}",
|
||||
"port": "{{$global.env.MARIADB_PORT_NUMBER}}",
|
||||
"rootPassword": "{{$global.env.MARIADB_ROOT_PASSWORD}}",
|
||||
"rootUser": "{{$global.env.MARIADB_ROOT_USER}}",
|
||||
"sslCAFile": "{{$global.env.MYSQL_CLIENT_SSL_CA_FILE}}",
|
||||
"sslEnable": "{{$global.env.MYSQL_CLIENT_ENABLE_SSL}}"
|
||||
}
|
||||
@@ -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-----
|
||||
@@ -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-----
|
||||
@@ -0,0 +1,5 @@
|
||||
<IfModule mod_deflate.c>
|
||||
AddOutputFilterByType DEFLATE text/html text/plain text/xml text/css
|
||||
AddOutputFilterByType DEFLATE application/x-javascript application/javascript application/ecmascript
|
||||
AddOutputFilterByType DEFLATE application/rss+xml
|
||||
</IfModule>
|
||||
@@ -0,0 +1,7 @@
|
||||
<VirtualHost 127.0.0.1:80>
|
||||
ServerName status.localhost
|
||||
<Location /server-status>
|
||||
Require local
|
||||
SetHandler server-status
|
||||
</Location>
|
||||
</VirtualHost>
|
||||
@@ -0,0 +1,76 @@
|
||||
#!/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)
|
||||
|
||||
# Load logging library
|
||||
. /opt/bitnami/scripts/liblog.sh
|
||||
|
||||
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
|
||||
APACHE_HTTP_PORT
|
||||
APACHE_HTTPS_PORT
|
||||
)
|
||||
for env_var in "${apache_env_vars[@]}"; do
|
||||
file_env_var="${env_var}_FILE"
|
||||
if [[ -n "${!file_env_var:-}" ]]; then
|
||||
if [[ -r "${!file_env_var:-}" ]]; then
|
||||
export "${env_var}=$(< "${!file_env_var}")"
|
||||
unset "${file_env_var}"
|
||||
else
|
||||
warn "Skipping export of '${env_var}'. '${!file_env_var:-}' is not readable."
|
||||
fi
|
||||
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"
|
||||
export WEB_SERVER_DEFAULT_HTTP_PORT_NUMBER="$APACHE_DEFAULT_HTTP_PORT_NUMBER" # only used at build time
|
||||
export APACHE_DEFAULT_HTTPS_PORT_NUMBER="8443"
|
||||
export WEB_SERVER_DEFAULT_HTTPS_PORT_NUMBER="$APACHE_DEFAULT_HTTPS_PORT_NUMBER" # only used at build time
|
||||
APACHE_HTTP_PORT_NUMBER="${APACHE_HTTP_PORT_NUMBER:-"${APACHE_HTTP_PORT:-}"}"
|
||||
export APACHE_HTTP_PORT_NUMBER="${APACHE_HTTP_PORT_NUMBER:-}"
|
||||
export WEB_SERVER_HTTP_PORT_NUMBER="$APACHE_HTTP_PORT_NUMBER"
|
||||
APACHE_HTTPS_PORT_NUMBER="${APACHE_HTTPS_PORT_NUMBER:-"${APACHE_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
|
||||
@@ -0,0 +1,37 @@
|
||||
#!/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/libversion.sh
|
||||
. /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"
|
||||
php_version="$("${PHP_BIN_DIR}/php" -v | grep ^PHP | cut -d' ' -f2))"
|
||||
php_major_version="$(get_sematic_version "$php_version" 1)"
|
||||
if [[ "$php_major_version" -eq "8" ]]; then
|
||||
apache_enable_module "php_module" "modules/libphp.so"
|
||||
else
|
||||
apache_enable_module "php${php_major_version}_module" "modules/libphp${php_major_version}.so"
|
||||
fi
|
||||
|
||||
# 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" <<EOF
|
||||
AddType application/x-httpd-php .php
|
||||
DirectoryIndex index.html index.htm index.php
|
||||
EOF
|
||||
ensure_apache_configuration_exists "Include \"${apache_php_conf_file}\""
|
||||
@@ -0,0 +1,5 @@
|
||||
{{before_vhost_configuration}}
|
||||
<VirtualHost {{http_listen_addresses}}>
|
||||
ServerAlias *
|
||||
{{additional_configuration}}
|
||||
</VirtualHost>
|
||||
@@ -0,0 +1,8 @@
|
||||
{{before_vhost_configuration}}
|
||||
<VirtualHost {{https_listen_addresses}}>
|
||||
ServerAlias *
|
||||
SSLEngine on
|
||||
SSLCertificateFile "{{APACHE_CONF_DIR}}/bitnami/certs/server.crt"
|
||||
SSLCertificateKeyFile "{{APACHE_CONF_DIR}}/bitnami/certs/server.key"
|
||||
{{additional_configuration}}
|
||||
</VirtualHost>
|
||||
@@ -0,0 +1 @@
|
||||
{{additional_configuration}}
|
||||
@@ -0,0 +1,13 @@
|
||||
{{before_vhost_configuration}}
|
||||
<VirtualHost {{http_listen_addresses}}>
|
||||
ServerAlias *
|
||||
DocumentRoot {{document_root}}
|
||||
<Directory "{{document_root}}">
|
||||
Options -Indexes +FollowSymLinks -MultiViews
|
||||
AllowOverride {{allow_override}}
|
||||
{{acl_configuration}}
|
||||
{{extra_directory_configuration}}
|
||||
</Directory>
|
||||
{{additional_configuration}}
|
||||
{{htaccess_include}}
|
||||
</VirtualHost>
|
||||
@@ -0,0 +1,16 @@
|
||||
{{before_vhost_configuration}}
|
||||
<VirtualHost {{https_listen_addresses}}>
|
||||
ServerAlias *
|
||||
SSLEngine on
|
||||
SSLCertificateFile "{{APACHE_CONF_DIR}}/bitnami/certs/server.crt"
|
||||
SSLCertificateKeyFile "{{APACHE_CONF_DIR}}/bitnami/certs/server.key"
|
||||
DocumentRoot {{document_root}}
|
||||
<Directory "{{document_root}}">
|
||||
Options -Indexes +FollowSymLinks -MultiViews
|
||||
AllowOverride {{allow_override}}
|
||||
{{acl_configuration}}
|
||||
{{extra_directory_configuration}}
|
||||
</Directory>
|
||||
{{additional_configuration}}
|
||||
{{htaccess_include}}
|
||||
</VirtualHost>
|
||||
@@ -0,0 +1,9 @@
|
||||
{{prefix_conf}}
|
||||
<Directory "{{document_root}}">
|
||||
Options -Indexes +FollowSymLinks -MultiViews
|
||||
AllowOverride {{allow_override}}
|
||||
{{acl_configuration}}
|
||||
{{extra_directory_configuration}}
|
||||
</Directory>
|
||||
{{additional_configuration}}
|
||||
{{htaccess_include}}
|
||||
@@ -0,0 +1,6 @@
|
||||
<VirtualHost {{http_listen_addresses}}>
|
||||
ServerAlias *
|
||||
ProxyPass / {{proxy_address}}
|
||||
ProxyPassReverse / {{proxy_address}}
|
||||
{{additional_configuration}}
|
||||
</VirtualHost>
|
||||
@@ -0,0 +1,8 @@
|
||||
<VirtualHost {{https_listen_addresses}}>
|
||||
ServerAlias *
|
||||
SSLCertificateFile "{{APACHE_CONF_DIR}}/bitnami/certs/server.crt"
|
||||
SSLCertificateKeyFile "{{APACHE_CONF_DIR}}/bitnami/certs/server.key"
|
||||
ProxyPass / {{proxy_address}}
|
||||
ProxyPassReverse / {{proxy_address}}
|
||||
{{additional_configuration}}
|
||||
</VirtualHost>
|
||||
@@ -0,0 +1,10 @@
|
||||
{{prefix_conf}}
|
||||
<Directory "{{document_root}}">
|
||||
Options -Indexes +FollowSymLinks -MultiViews
|
||||
AllowOverride {{allow_override}}
|
||||
{{acl_configuration}}
|
||||
ProxyPass / {{proxy_address}}
|
||||
ProxyPassReverse / {{proxy_address}}
|
||||
{{extra_directory_configuration}}
|
||||
</Directory>
|
||||
{{additional_configuration}}
|
||||
@@ -0,0 +1,14 @@
|
||||
{{before_vhost_configuration}}
|
||||
PassengerPreStart http://localhost:{{APACHE_DEFAULT_HTTP_PORT_NUMBER}}/
|
||||
<VirtualHost {{http_listen_addresses}}>
|
||||
ServerAlias *
|
||||
DocumentRoot {{document_root}}
|
||||
<Directory "{{document_root}}">
|
||||
Options -Indexes +FollowSymLinks -MultiViews
|
||||
AllowOverride {{allow_override}}
|
||||
{{acl_configuration}}
|
||||
PassengerEnabled on
|
||||
{{extra_directory_configuration}}
|
||||
</Directory>
|
||||
{{additional_configuration}}
|
||||
</VirtualHost>
|
||||
@@ -0,0 +1,17 @@
|
||||
{{before_vhost_configuration}}
|
||||
PassengerPreStart https://localhost:{{APACHE_DEFAULT_HTTPS_PORT_NUMBER}}/
|
||||
<VirtualHost {{https_listen_addresses}}>
|
||||
ServerAlias *
|
||||
SSLEngine on
|
||||
SSLCertificateFile "{{APACHE_CONF_DIR}}/bitnami/certs/server.crt"
|
||||
SSLCertificateKeyFile "{{APACHE_CONF_DIR}}/bitnami/certs/server.key"
|
||||
DocumentRoot {{document_root}}
|
||||
<Directory "{{document_root}}">
|
||||
Options -Indexes +FollowSymLinks -MultiViews
|
||||
AllowOverride {{allow_override}}
|
||||
{{acl_configuration}}
|
||||
PassengerEnabled on
|
||||
{{extra_directory_configuration}}
|
||||
</Directory>
|
||||
{{additional_configuration}}
|
||||
</VirtualHost>
|
||||
@@ -0,0 +1,9 @@
|
||||
{{prefix_conf}}
|
||||
<Directory "{{document_root}}">
|
||||
Options -Indexes +FollowSymLinks -MultiViews
|
||||
AllowOverride {{allow_override}}
|
||||
{{acl_configuration}}
|
||||
PassengerEnabled on
|
||||
{{extra_directory_configuration}}
|
||||
</Directory>
|
||||
{{additional_configuration}}
|
||||
@@ -0,0 +1,29 @@
|
||||
# Default SSL Virtual Host configuration.
|
||||
|
||||
<IfModule !ssl_module>
|
||||
LoadModule ssl_module modules/mod_ssl.so
|
||||
</IfModule>
|
||||
|
||||
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
|
||||
|
||||
<VirtualHost _default_:443>
|
||||
DocumentRoot "{{APACHE_BASE_DIR}}/htdocs"
|
||||
SSLEngine on
|
||||
SSLCertificateFile "{{APACHE_CONF_DIR}}/bitnami/certs/server.crt"
|
||||
SSLCertificateKeyFile "{{APACHE_CONF_DIR}}/bitnami/certs/server.key"
|
||||
|
||||
<Directory "{{APACHE_BASE_DIR}}/htdocs">
|
||||
Options Indexes FollowSymLinks
|
||||
AllowOverride All
|
||||
Require all granted
|
||||
</Directory>
|
||||
|
||||
# Error Documents
|
||||
ErrorDocument 503 /503.html
|
||||
</VirtualHost>
|
||||
@@ -0,0 +1,18 @@
|
||||
# Default Virtual Host configuration.
|
||||
|
||||
# Let Apache know we're behind a SSL reverse proxy
|
||||
SetEnvIf X-Forwarded-Proto https HTTPS=on
|
||||
|
||||
<VirtualHost _default_:80>
|
||||
DocumentRoot "{{APACHE_BASE_DIR}}/htdocs"
|
||||
<Directory "{{APACHE_BASE_DIR}}/htdocs">
|
||||
Options Indexes FollowSymLinks
|
||||
AllowOverride All
|
||||
Require all granted
|
||||
</Directory>
|
||||
|
||||
# Error Documents
|
||||
ErrorDocument 503 /503.html
|
||||
</VirtualHost>
|
||||
|
||||
Include "{{APACHE_CONF_DIR}}/bitnami/bitnami-ssl.conf"
|
||||
27
bitnami/osclass/4/debian-10/rootfs/opt/bitnami/scripts/apache/entrypoint.sh
Executable file
27
bitnami/osclass/4/debian-10/rootfs/opt/bitnami/scripts/apache/entrypoint.sh
Executable file
@@ -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 "$@"
|
||||
115
bitnami/osclass/4/debian-10/rootfs/opt/bitnami/scripts/apache/postunpack.sh
Executable file
115
bitnami/osclass/4/debian-10/rootfs/opt/bitnami/scripts/apache/postunpack.sh
Executable file
@@ -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 <<EOF
|
||||
Include "${APACHE_CONF_DIR}/extra/httpd-default.conf"
|
||||
PidFile "${APACHE_PID_FILE}"
|
||||
TraceEnable Off
|
||||
Include "${APACHE_CONF_DIR}/deflate.conf"
|
||||
IncludeOptional "${APACHE_VHOSTS_DIR}/*.conf"
|
||||
Include "${APACHE_CONF_DIR}/bitnami/bitnami.conf"
|
||||
EOF
|
||||
)"
|
||||
ensure_apache_configuration_exists "$apache_conf_add" "${APACHE_CONF_DIR}/bitnami/bitnami.conf"
|
||||
|
||||
# Configure the default ports since the container is non root by default
|
||||
apache_configure_http_port "$APACHE_DEFAULT_HTTP_PORT_NUMBER"
|
||||
apache_configure_https_port "$APACHE_DEFAULT_HTTPS_PORT_NUMBER"
|
||||
|
||||
# Patch the HTTPoxy vulnerability - see: https://docs.bitnami.com/general/security/security-2016-07-18/
|
||||
apache_patch_httpoxy_vulnerability
|
||||
|
||||
# Remove unnecessary directories that come with the tarball
|
||||
rm -rf "${BITNAMI_ROOT_DIR}/certs" "${BITNAMI_ROOT_DIR}/conf"
|
||||
}
|
||||
|
||||
########################
|
||||
# Patches the HTTPoxy vulnerability - see: https://docs.bitnami.com/general/security/security-2016-07-18/
|
||||
# Globals:
|
||||
# APACHE_CONF_FILE
|
||||
# Arguments:
|
||||
# None
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
apache_patch_httpoxy_vulnerability() {
|
||||
# Apache HTTPD includes the HTTPoxy fix since 2016, so we only add it if not present
|
||||
if ! grep -q "RequestHeader unset Proxy" "$APACHE_CONF_FILE"; then
|
||||
cat >>"$APACHE_CONF_FILE" <<EOF
|
||||
<IfModule mod_headers.c>
|
||||
RequestHeader unset Proxy
|
||||
</IfModule>
|
||||
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"
|
||||
18
bitnami/osclass/4/debian-10/rootfs/opt/bitnami/scripts/apache/reload.sh
Executable file
18
bitnami/osclass/4/debian-10/rootfs/opt/bitnami/scripts/apache/reload.sh
Executable file
@@ -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
|
||||
17
bitnami/osclass/4/debian-10/rootfs/opt/bitnami/scripts/apache/restart.sh
Executable file
17
bitnami/osclass/4/debian-10/rootfs/opt/bitnami/scripts/apache/restart.sh
Executable file
@@ -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
|
||||
18
bitnami/osclass/4/debian-10/rootfs/opt/bitnami/scripts/apache/run.sh
Executable file
18
bitnami/osclass/4/debian-10/rootfs/opt/bitnami/scripts/apache/run.sh
Executable file
@@ -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"
|
||||
60
bitnami/osclass/4/debian-10/rootfs/opt/bitnami/scripts/apache/setup.sh
Executable file
60
bitnami/osclass/4/debian-10/rootfs/opt/bitnami/scripts/apache/setup.sh
Executable file
@@ -0,0 +1,60 @@
|
||||
#!/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" --group "$APACHE_DAEMON_GROUP"
|
||||
|
||||
# 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
|
||||
|
||||
# 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
|
||||
|
||||
# Update ports in 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"
|
||||
|
||||
# Fix logging issue when running as root
|
||||
! am_i_root || chmod o+w "$(readlink /dev/stdout)" "$(readlink /dev/stderr)"
|
||||
32
bitnami/osclass/4/debian-10/rootfs/opt/bitnami/scripts/apache/start.sh
Executable file
32
bitnami/osclass/4/debian-10/rootfs/opt/bitnami/scripts/apache/start.sh
Executable file
@@ -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"
|
||||
21
bitnami/osclass/4/debian-10/rootfs/opt/bitnami/scripts/apache/status.sh
Executable file
21
bitnami/osclass/4/debian-10/rootfs/opt/bitnami/scripts/apache/status.sh
Executable file
@@ -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
|
||||
32
bitnami/osclass/4/debian-10/rootfs/opt/bitnami/scripts/apache/stop.sh
Executable file
32
bitnami/osclass/4/debian-10/rootfs/opt/bitnami/scripts/apache/stop.sh
Executable file
@@ -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
|
||||
BITNAMI_QUIET=1 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"
|
||||
@@ -0,0 +1,671 @@
|
||||
#!/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
|
||||
}
|
||||
|
||||
########################
|
||||
# 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
|
||||
if is_file_writable "$result_file"; then
|
||||
# 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
|
||||
# Create file with root group write privileges, so it can be modified in non-root containers
|
||||
[[ ! -f "$result_file" ]] && touch "$result_file" && chmod g+rw "$result_file"
|
||||
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 "^<Directory \"$htaccess_dir\">" <<< "$htaccess_contents"; then
|
||||
continue
|
||||
fi
|
||||
# Add to the htaccess file
|
||||
cat >> "$result_file" <<EOF
|
||||
<Directory "${htaccess_dir}">
|
||||
${htaccess_contents}
|
||||
</Directory>
|
||||
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
|
||||
elif [[ ! -f "$result_file" ]]; then
|
||||
error "Could not create htaccess for ${app} at '${result_file}'. Check permissions and ownership for parent directories."
|
||||
return 1
|
||||
else
|
||||
warn "The ${app} htaccess file '${result_file}' is not writable. Configurations based on environment variables will not be applied for this file."
|
||||
return
|
||||
fi
|
||||
}
|
||||
|
||||
########################
|
||||
# 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 <VirtualHost> 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=""
|
||||
export proxy_address=""
|
||||
# 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 \
|
||||
| --proxy-address \
|
||||
)
|
||||
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 <<EOF
|
||||
Require local
|
||||
ErrorDocument 403 "For security reasons, this URL is only accessible using localhost (127.0.0.1) as the hostname."
|
||||
# AuthType Basic
|
||||
# AuthName ${app}
|
||||
# AuthUserFile "${APACHE_BASE_DIR}/users"
|
||||
# Require valid-user
|
||||
EOF
|
||||
)"
|
||||
fi
|
||||
# Indent configurations
|
||||
additional_configuration="$(indent $'\n'"$additional_configuration" 2)"
|
||||
htaccess_include="$(indent $'\n'"$htaccess_include" 2)"
|
||||
extra_directory_configuration="$(indent $'\n'"$extra_directory_configuration" 4)"
|
||||
# Render templates
|
||||
# We remove lines that are empty or contain only newspaces with 'sed', so the resulting file looks better
|
||||
local template_name="app"
|
||||
[[ -n "$type" && "$type" != "php" ]] && template_name="app-${type}"
|
||||
local -r template_dir="${BITNAMI_ROOT_DIR}/scripts/apache/bitnami-templates"
|
||||
local vhost_suffix=""
|
||||
is_boolean_yes "$disabled" && vhost_suffix=".disabled"
|
||||
local -r http_vhost="${APACHE_VHOSTS_DIR}/${app}-vhost.conf${vhost_suffix}"
|
||||
local -r https_vhost="${APACHE_VHOSTS_DIR}/${app}-https-vhost.conf${vhost_suffix}"
|
||||
if is_file_writable "$http_vhost"; then
|
||||
# Create file with root group write privileges, so it can be modified in non-root containers
|
||||
[[ ! -f "$http_vhost" ]] && touch "$http_vhost" && chmod g+rw "$http_vhost"
|
||||
render-template "${template_dir}/${template_name}-http-vhost.conf.tpl" | sed '/^\s*$/d' > "$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 <<EOF
|
||||
Require local
|
||||
ErrorDocument 403 "For security reasons, this URL is only accessible using localhost (127.0.0.1) as the hostname."
|
||||
# AuthType Basic
|
||||
# AuthName ${app}
|
||||
# AuthUserFile "${APACHE_BASE_DIR}/users"
|
||||
# Require valid-user
|
||||
EOF
|
||||
)"
|
||||
fi
|
||||
# Prefix configuration
|
||||
export prefix_conf="Alias ${prefix} \"${document_root}\""
|
||||
# Indent configurations
|
||||
acl_configuration="$(indent $'\n'"$acl_configuration" 2)"
|
||||
extra_directory_configuration="$(indent $'\n'"$extra_directory_configuration" 2)"
|
||||
# Render templates
|
||||
# We remove lines that are empty or contain only newspaces with 'sed', so the resulting file looks better
|
||||
local template_name="app"
|
||||
[[ -n "$type" && "$type" != "php" ]] && template_name="app-${type}"
|
||||
local -r template_dir="${BITNAMI_ROOT_DIR}/scripts/apache/bitnami-templates"
|
||||
local -r prefix_file="${APACHE_CONF_DIR}/bitnami/${app}.conf"
|
||||
if is_file_writable "$prefix_file"; then
|
||||
# Create file with root group write privileges, so it can be modified in non-root containers
|
||||
[[ ! -f "$prefix_file" ]] && touch "$prefix_file" && chmod g+rw "$prefix_file"
|
||||
render-template "${template_dir}/${template_name}-prefix.conf.tpl" | sed '/^\s*$/d' > "$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" "^<VirtualHost\s.*>$" "<VirtualHost ${http_listen_addresses}>"
|
||||
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" "^<VirtualHost\s.*>$" "<VirtualHost ${https_listen_addresses}>"
|
||||
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
|
||||
}
|
||||
|
||||
########################
|
||||
# Create a password file for basic authentication and restrict its permissions
|
||||
# Globals:
|
||||
# *
|
||||
# Arguments:
|
||||
# $1 - file
|
||||
# $2 - username
|
||||
# $3 - password
|
||||
# Returns:
|
||||
# true if the configuration was updated, false otherwise
|
||||
########################
|
||||
apache_create_password_file() {
|
||||
local -r file="${1:?missing file}"
|
||||
local -r username="${2:?missing username}"
|
||||
local -r password="${3:?missing password}"
|
||||
|
||||
"${APACHE_BIN_DIR}/htpasswd" -bc "$file" "$username" "$password"
|
||||
am_i_root && configure_permissions_ownership "$file" --file-mode "600" --user "$APACHE_DAEMON_USER" --group "$APACHE_DAEMON_GROUP"
|
||||
}
|
||||
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,400 @@
|
||||
#!/bin/bash
|
||||
#
|
||||
# Bitnami Osclass library
|
||||
|
||||
# shellcheck disable=SC1091
|
||||
|
||||
# Load generic libraries
|
||||
. /opt/bitnami/scripts/libphp.sh
|
||||
. /opt/bitnami/scripts/libfs.sh
|
||||
. /opt/bitnami/scripts/libos.sh
|
||||
. /opt/bitnami/scripts/libnet.sh
|
||||
. /opt/bitnami/scripts/libvalidations.sh
|
||||
. /opt/bitnami/scripts/libpersistence.sh
|
||||
. /opt/bitnami/scripts/libwebserver.sh
|
||||
. /opt/bitnami/scripts/libservice.sh
|
||||
|
||||
# Load database library
|
||||
if [[ -f /opt/bitnami/scripts/libmysqlclient.sh ]]; then
|
||||
. /opt/bitnami/scripts/libmysqlclient.sh
|
||||
elif [[ -f /opt/bitnami/scripts/libmysql.sh ]]; then
|
||||
. /opt/bitnami/scripts/libmysql.sh
|
||||
elif [[ -f /opt/bitnami/scripts/libmariadb.sh ]]; then
|
||||
. /opt/bitnami/scripts/libmariadb.sh
|
||||
fi
|
||||
|
||||
########################
|
||||
# Validate settings in OSCLASS_* env vars
|
||||
# Globals:
|
||||
# OSCLASS_*
|
||||
# Arguments:
|
||||
# None
|
||||
# Returns:
|
||||
# 0 if the validation succeeded, 1 otherwise
|
||||
#########################
|
||||
osclass_validate() {
|
||||
debug "Validating settings in OSCLASS_* environment variables..."
|
||||
local error_code=0
|
||||
|
||||
# Auxiliary functions
|
||||
print_validation_error() {
|
||||
error "$1"
|
||||
error_code=1
|
||||
}
|
||||
check_empty_value() {
|
||||
if is_empty_value "${!1}"; then
|
||||
print_validation_error "${1} must be set"
|
||||
fi
|
||||
}
|
||||
check_yes_no_value() {
|
||||
if ! is_yes_no_value "${!1}" && ! is_true_false_value "${!1}"; then
|
||||
print_validation_error "The allowed values for ${1} are: yes no"
|
||||
fi
|
||||
}
|
||||
check_multi_value() {
|
||||
if [[ " ${2} " != *" ${!1} "* ]]; then
|
||||
print_validation_error "The allowed values for ${1} are: ${2}"
|
||||
fi
|
||||
}
|
||||
check_resolved_hostname() {
|
||||
if ! is_hostname_resolved "$1"; then
|
||||
warn "Hostname ${1} could not be resolved, this could lead to connection issues"
|
||||
fi
|
||||
}
|
||||
|
||||
check_empty_value "OSCLASS_WEB_TITLE"
|
||||
! is_empty_value "$OSCLASS_SKIP_BOOTSTRAP" && check_yes_no_value "OSCLASS_SKIP_BOOTSTRAP"
|
||||
! is_empty_value "$OSCLASS_DATABASE_HOST" && check_resolved_hostname "$OSCLASS_DATABASE_HOST"
|
||||
! is_empty_value "$OSCLASS_DATABASE_PORT_NUMBER" && validate_port "$OSCLASS_DATABASE_PORT_NUMBER"
|
||||
|
||||
# Validate credentials
|
||||
if is_boolean_yes "${ALLOW_EMPTY_PASSWORD:-}"; then
|
||||
warn "You set the environment variable ALLOW_EMPTY_PASSWORD=${ALLOW_EMPTY_PASSWORD:-}. For safety reasons, do not use this flag in a production environment."
|
||||
else
|
||||
for empty_env_var in "OSCLASS_DATABASE_PASSWORD" "OSCLASS_PASSWORD"; do
|
||||
is_empty_value "${!empty_env_var}" && print_validation_error "The ${empty_env_var} environment variable is empty or not set. Set the environment variable ALLOW_EMPTY_PASSWORD=yes to allow a blank password. This is only recommended for development environments."
|
||||
done
|
||||
fi
|
||||
|
||||
# Validate SMTP credentials
|
||||
if ! is_empty_value "$OSCLASS_SMTP_HOST"; then
|
||||
for empty_env_var in "OSCLASS_SMTP_USER" "OSCLASS_SMTP_PASSWORD" "OSCLASS_SMTP_PORT_NUMBER"; do
|
||||
is_empty_value "${!empty_env_var}" && print_validation_error "The ${empty_env_var} environment variable is empty or not set."
|
||||
done
|
||||
! is_empty_value "$OSCLASS_SMTP_PROTOCOL" && check_multi_value "OSCLASS_SMTP_PROTOCOL" "ssl tls"
|
||||
fi
|
||||
|
||||
# Check that the web server is properly set up
|
||||
web_server_validate || print_validation_error "Web server validation failed"
|
||||
|
||||
return "$error_code"
|
||||
}
|
||||
|
||||
########################
|
||||
# Ensure Osclass is initialized
|
||||
# Globals:
|
||||
# OSCLASS_*
|
||||
# Arguments:
|
||||
# None
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
osclass_initialize() {
|
||||
# Check if Osclass has already been initialized and persisted in a previous run
|
||||
local -r app_name="osclass"
|
||||
if ! is_app_initialized "$app_name"; then
|
||||
# Ensure Osclass persisted directories exist (i.e. when a volume has been mounted to /bitnami)
|
||||
info "Ensuring Osclass directories exist"
|
||||
ensure_dir_exists "$OSCLASS_VOLUME_DIR"
|
||||
# Use daemon:root ownership for compatibility when running as a non-root user
|
||||
am_i_root && configure_permissions_ownership "$OSCLASS_VOLUME_DIR" -d "775" -f "664" -u "$WEB_SERVER_DAEMON_USER" -g "root"
|
||||
info "Trying to connect to the database server"
|
||||
osclass_wait_for_mysql_connection "$OSCLASS_DATABASE_HOST" "$OSCLASS_DATABASE_PORT_NUMBER" "$OSCLASS_DATABASE_NAME" "$OSCLASS_DATABASE_USER" "$OSCLASS_DATABASE_PASSWORD"
|
||||
|
||||
if ! is_boolean_yes "$OSCLASS_SKIP_BOOTSTRAP"; then
|
||||
info "Installing Osclass"
|
||||
osclass_pass_wizard
|
||||
else
|
||||
# We copy the sample configuration file and modify it, as the installer will not generate it
|
||||
info "An already initialized Osclass database was provided, configuration will be skipped"
|
||||
cp "${OSCLASS_BASE_DIR}/config-sample.php" "$OSCLASS_CONF_FILE"
|
||||
if [[ "$OSCLASS_DATABASE_PORT_NUMBER" == "3306" ]]; then
|
||||
osclass_conf_set "DB_HOST" "$OSCLASS_DATABASE_HOST"
|
||||
else
|
||||
osclass_conf_set "DB_HOST" "${OSCLASS_DATABASE_HOST}:${OSCLASS_DATABASE_PORT_NUMBER}"
|
||||
fi
|
||||
osclass_conf_set "DB_USER" "$OSCLASS_DATABASE_USER"
|
||||
osclass_conf_set "DB_PASSWORD" "$OSCLASS_DATABASE_PASSWORD"
|
||||
osclass_conf_set "DB_NAME" "$OSCLASS_DATABASE_NAME"
|
||||
# In the sample configuration file the relative web url is set to "relhere", we need to change it
|
||||
osclass_conf_set "REL_WEB_URL" "/"
|
||||
osclass_pass_upgrade_wizard
|
||||
fi
|
||||
|
||||
# We maintain the OSCLASS_HOST variable for backwards compatibility. If the user does not set it
|
||||
# then the modify the WEB_PATH setting in config.php file to allow any host, both HTTP and HTTPS.
|
||||
if is_empty_value "$OSCLASS_HOST"; then
|
||||
# sed replacement notes:
|
||||
# - The ampersand ('&') is escaped due to sed replacing any non-escaped ampersand characters with the matched string
|
||||
# - For the replacement text to be multi-line, an \ needs to be specified to escape the newline character
|
||||
local -r conf_to_replace="if (empty(\$_SERVER['HTTP_HOST'])) {\\
|
||||
define('WEB_PATH', 'http://127.0.0.1:${WEB_SERVER_HTTP_PORT_NUMBER}/');\\
|
||||
} else if (isset(\$_SERVER['HTTPS']) \&\& \$_SERVER['HTTPS'] == 'on') {\\
|
||||
define('WEB_PATH','https://' . \$_SERVER['HTTP_HOST'] . '/');\\
|
||||
} else {\\
|
||||
define('WEB_PATH','http://' . \$_SERVER['HTTP_HOST'] . '/');\\
|
||||
}"
|
||||
replace_in_file "$OSCLASS_CONF_FILE" "define.*WEB_PATH.*" "$conf_to_replace"
|
||||
else
|
||||
osclass_conf_set "WEB_PATH" "$OSCLASS_HOST"
|
||||
fi
|
||||
|
||||
# SMTP configuration tweaking the System Settings via Database
|
||||
# Based on https://docs.osclasspoint.com/setting-up-a-mail-server
|
||||
if ! is_empty_value "$OSCLASS_SMTP_HOST"; then
|
||||
local -a mysql_execute_args=("$OSCLASS_DATABASE_HOST" "$OSCLASS_DATABASE_PORT_NUMBER" "$OSCLASS_DATABASE_NAME" "$OSCLASS_DATABASE_USER" "$OSCLASS_DATABASE_PASSWORD")
|
||||
info "Configuring SMTP"
|
||||
settings_to_update=(
|
||||
"mailserver_auth=1"
|
||||
"mailserver_pop=0"
|
||||
"mailserver_host=${OSCLASS_SMTP_HOST}"
|
||||
"mailserver_port=${OSCLASS_SMTP_PORT_NUMBER}"
|
||||
"mailserver_username=${OSCLASS_SMTP_USER}"
|
||||
"mailserver_mail_from=${OSCLASS_EMAIL}"
|
||||
"mailserver_password=${OSCLASS_SMTP_PASSWORD}"
|
||||
"mailserver_ssl=${OSCLASS_SMTP_PROTOCOL}"
|
||||
)
|
||||
|
||||
for setting in "${settings_to_update[@]}"; do
|
||||
# We split the key and value with the '=' delimiter via native Bash functionality to simplify the logic
|
||||
mysql_remote_execute "${mysql_execute_args[@]}" <<<"UPDATE oc_t_preference SET s_value='${setting#*=}' WHERE s_name='${setting%=*}';"
|
||||
done
|
||||
fi
|
||||
|
||||
info "Persisting Osclass installation"
|
||||
persist_app "$app_name" "$OSCLASS_DATA_TO_PERSIST"
|
||||
else
|
||||
info "Restoring persisted Osclass installation"
|
||||
restore_persisted_app "$app_name" "$OSCLASS_DATA_TO_PERSIST"
|
||||
info "Trying to connect to the database server"
|
||||
local db_host_port db_host db_port db_name db_user db_pass
|
||||
db_host_port="$(osclass_conf_get "DB_HOST")"
|
||||
db_host="${db_host_port%:*}"
|
||||
if [[ "$db_host_port" =~ :[0-9]+$ ]]; then
|
||||
# Use '##' to extract only the part after the last colon, to avoid any possible issues with IPv6 addresses
|
||||
db_port="${db_host_port##*:}"
|
||||
else
|
||||
db_port="$OSCLASS_DATABASE_PORT_NUMBER"
|
||||
fi
|
||||
db_name="$(osclass_conf_get "DB_NAME")"
|
||||
db_user="$(osclass_conf_get "DB_USER")"
|
||||
db_pass="$(osclass_conf_get "DB_PASSWORD")"
|
||||
osclass_wait_for_mysql_connection "$db_host" "$db_port" "$db_name" "$db_user" "$db_pass"
|
||||
osclass_pass_upgrade_wizard
|
||||
fi
|
||||
|
||||
# Avoid exit code of previous commands to affect the result of this function
|
||||
true
|
||||
}
|
||||
|
||||
########################
|
||||
# Add or modify an entry in the Osclass configuration file (config.inc.php)
|
||||
# Globals:
|
||||
# OSCLASS_*
|
||||
# Arguments:
|
||||
# $1 - PHP constant name
|
||||
# $2 - Value to assign to the PHP variable
|
||||
# $3 - Configuration file to modify
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
osclass_conf_set() {
|
||||
local -r key="${1:?key missing}"
|
||||
local -r value="${2:-}"
|
||||
local -r file="${3:-$OSCLASS_CONF_FILE}"
|
||||
debug "Setting ${key} to '${value}' in Osclass configuration file ${file}"
|
||||
# Sanitize key (sed does not support fixed string substitutions)
|
||||
local sanitized_pattern
|
||||
sanitized_pattern="^\s*(//\s*)?define\s*\(['\"]$(sed 's/[]\[^$.*/]/\\&/g' <<<"$key")['\"]\s*,.*"
|
||||
local -r entry="define('${key}', '$value');"
|
||||
# Check if the configuration exists in the file
|
||||
if grep -q -E "$sanitized_pattern" "$file"; then
|
||||
# It exists, so replace the line
|
||||
replace_in_file "$file" "$sanitized_pattern" "$entry"
|
||||
else
|
||||
# The Osclass configuration file includes all supported keys, but because of its format,
|
||||
# we cannot append contents to the end. We can assume thi
|
||||
warn "Could not set the Osclass '${key}' configuration. Check that the file has not been modified externally."
|
||||
fi
|
||||
}
|
||||
|
||||
########################
|
||||
# Get an entry from the Osclass configuration file (config.inc.php)
|
||||
# Globals:
|
||||
# OSCLASS_*
|
||||
# Arguments:
|
||||
# $1 - PHP constant name
|
||||
# $2 - Configuration file to read
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
osclass_conf_get() {
|
||||
local -r key="${1:?key missing}"
|
||||
local -r file="${2:-$OSCLASS_CONF_FILE}"
|
||||
debug "Getting ${key} from Osclass configuration"
|
||||
php -r "require ('${OSCLASS_CONF_FILE}'); print ${key};"
|
||||
}
|
||||
|
||||
########################
|
||||
# Wait until the database is accessible with the currently-known credentials
|
||||
# Globals:
|
||||
# *
|
||||
# Arguments:
|
||||
# $1 - database host
|
||||
# $2 - database port
|
||||
# $3 - database name
|
||||
# $4 - database username
|
||||
# $5 - database user password (optional)
|
||||
# Returns:
|
||||
# true if the database connection succeeded, false otherwise
|
||||
#########################
|
||||
osclass_wait_for_mysql_connection() {
|
||||
local -r db_host="${1:?missing database host}"
|
||||
local -r db_port="${2:?missing database port}"
|
||||
local -r db_name="${3:?missing database name}"
|
||||
local -r db_user="${4:?missing database user}"
|
||||
local -r db_pass="${5:-}"
|
||||
check_mysql_connection() {
|
||||
echo "SELECT 1" | mysql_remote_execute "$db_host" "$db_port" "$db_name" "$db_user" "$db_pass"
|
||||
}
|
||||
if ! retry_while "check_mysql_connection"; then
|
||||
error "Could not connect to the database"
|
||||
return 1
|
||||
fi
|
||||
}
|
||||
|
||||
########################
|
||||
# Pass Osclass wizard
|
||||
# Globals:
|
||||
# *
|
||||
# Arguments:
|
||||
# None
|
||||
# Returns:
|
||||
# true if the wizard succeeded, false otherwise
|
||||
#########################
|
||||
osclass_pass_wizard() {
|
||||
local -r port="${WEB_SERVER_HTTP_PORT_NUMBER:-"$WEB_SERVER_DEFAULT_HTTP_PORT_NUMBER"}"
|
||||
local wizard_url wizard_install_location_url cookie_file curl_output
|
||||
local -a curl_opts curl_data_opts
|
||||
wizard_url="http://127.0.0.1:${port}/oc-includes/osclass/install.php"
|
||||
wizard_install_location_url="http://127.0.0.1:${port}/oc-includes/osclass/install-location.php"
|
||||
cookie_file="/tmp/cookie$(generate_random_string -t alphanumeric -c 8)"
|
||||
curl_opts=("--location" "--silent" "--cookie" "$cookie_file" "--cookie-jar" "$cookie_file")
|
||||
# Ensure the web server is started
|
||||
web_server_start
|
||||
# Step 0: Get cookies
|
||||
debug_execute curl "${curl_opts[@]}" "$wizard_url" 2>/dev/null
|
||||
# Step 1: Requirements check
|
||||
curl_data_opts=(
|
||||
"--data-urlencode" "step=2"
|
||||
)
|
||||
curl_output="$(curl "${curl_opts[@]}" "${curl_data_opts[@]}" "${wizard_url}" 2>/dev/null)"
|
||||
debug_execute echo "$curl_output"
|
||||
# Step 2: Database settings
|
||||
curl_data_opts=(
|
||||
"--data-urlencode" "step=3"
|
||||
"--data-urlencode" "dbhost=${OSCLASS_DATABASE_HOST}"
|
||||
"--data-urlencode" "dbname=${OSCLASS_DATABASE_NAME}"
|
||||
"--data-urlencode" "username=${OSCLASS_DATABASE_USER}"
|
||||
"--data-urlencode" "password=${OSCLASS_DATABASE_PASSWORD}"
|
||||
"--data-urlencode" "tableprefix=oc_"
|
||||
"--data-urlencode" "submit=Next"
|
||||
)
|
||||
curl_output="$(curl "${curl_opts[@]}" "${curl_data_opts[@]}" "${wizard_url}" 2>/dev/null)"
|
||||
debug_execute echo "$curl_output"
|
||||
# Step 3: User settings
|
||||
curl_data_opts=(
|
||||
"--data-urlencode" "s_name=${OSCLASS_USERNAME}"
|
||||
"--data-urlencode" "s_passwd=${OSCLASS_PASSWORD}"
|
||||
"--data-urlencode" "webtitle=${OSCLASS_WEB_TITLE}"
|
||||
"--data-urlencode" "email=${OSCLASS_EMAIL}"
|
||||
"--data-urlencode" "skip-location-input=0"
|
||||
"--data-urlencode" "locationsql=US-United_States.sql"
|
||||
)
|
||||
curl_output="$(curl "${curl_opts[@]}" "${curl_data_opts[@]}" "${wizard_install_location_url}" 2>/dev/null)"
|
||||
debug_execute echo "$curl_output"
|
||||
# Step 4: Confirm user settings
|
||||
curl_data_opts=(
|
||||
"--data-urlencode" "step=4"
|
||||
"--data-urlencode" "password=${OSCLASS_PASSWORD}"
|
||||
)
|
||||
curl_output="$(curl "${curl_opts[@]}" "${curl_data_opts[@]}" "${wizard_url}" 2>/dev/null)"
|
||||
debug_execute echo "$curl_output"
|
||||
if [[ "$curl_output" != *"Congratulations"* ]]; then
|
||||
error "An error occurred while installing Osclass"
|
||||
return 1
|
||||
fi
|
||||
# Stop the web server afterwards
|
||||
web_server_stop
|
||||
}
|
||||
|
||||
########################
|
||||
# Pass Osclass upgrade wizard
|
||||
# Based on https://docs.osclasspoint.com/updating-osclass
|
||||
# Globals:
|
||||
# *
|
||||
# Arguments:
|
||||
# None
|
||||
# Returns:
|
||||
# true if the wizard succeeded, false otherwise
|
||||
#########################
|
||||
osclass_pass_upgrade_wizard() {
|
||||
local -r port="${WEB_SERVER_HTTP_PORT_NUMBER:-"$WEB_SERVER_DEFAULT_HTTP_PORT_NUMBER"}"
|
||||
local wizard_url wizard_install_location_url cookie_file curl_output octoken
|
||||
local -a curl_opts curl_data_opts
|
||||
info "Passing update wizard"
|
||||
# Update wizard url
|
||||
wizard_url="http://127.0.0.1:${port}/oc-admin/index.php"
|
||||
cookie_file="/tmp/cookie$(generate_random_string -t alphanumeric -c 8)"
|
||||
octoken_file="$(mktemp)"
|
||||
curl_opts=("--location" "--silent" "--cookie" "$cookie_file" "--cookie-jar" "$cookie_file")
|
||||
# Ensure the web server is started
|
||||
web_server_start
|
||||
# Step 0: Get cookies and oc-token
|
||||
curl "${curl_opts[@]}" "$wizard_url" 2>/dev/null >"$octoken_file"
|
||||
# Extract octoken from the HTML
|
||||
octoken="$(grep -o "octoken.*value=[\"'][^\"']*[\"']" "$octoken_file" | awk -F= '{print $2}' | sed "s/[\"']//g")"
|
||||
# Step 1: Login
|
||||
curl_data_opts=(
|
||||
"--data-urlencode" "octoken=${octoken}"
|
||||
"--data-urlencode" "page=login"
|
||||
"--data-urlencode" "action=login_post"
|
||||
"--data-urlencode" "user=${OSCLASS_USERNAME}"
|
||||
"--data-urlencode" "password=${OSCLASS_PASSWORD}"
|
||||
"--data-urlencode" "locale=en_US"
|
||||
"--data-urlencode" "submit="
|
||||
)
|
||||
curl_output="$(curl "${curl_opts[@]}" "${curl_data_opts[@]}" "${wizard_url}" 2>/dev/null)"
|
||||
debug_execute echo "$curl_output"
|
||||
# Step 2: Launch upgrade
|
||||
curl_data_opts=(
|
||||
"--data-urlencode" "octoken=${octoken}"
|
||||
"--data-urlencode" "page=upgrade"
|
||||
"--data-urlencode" "action=upgrade-funcs"
|
||||
)
|
||||
curl_output="$(curl "${curl_opts[@]}" "${curl_data_opts[@]}" "${wizard_url}" 2>/dev/null)"
|
||||
# Step 3: Check upgrade
|
||||
curl_data_opts=(
|
||||
"--data-urlencode" "octoken=${octoken}"
|
||||
"--data-urlencode" "page=tools"
|
||||
"--data-urlencode" "action=version"
|
||||
)
|
||||
curl_output="$(curl "${curl_opts[@]}" "${curl_data_opts[@]}" "${wizard_url}" 2>/dev/null)"
|
||||
debug_execute echo "$curl_output"
|
||||
if [[ "$curl_output" != *"Osclass has been updated successfully"* ]]; then
|
||||
error "An error occurred while installing Osclass"
|
||||
return 1
|
||||
fi
|
||||
# Stop the web server afterwards
|
||||
web_server_stop
|
||||
}
|
||||
256
bitnami/osclass/4/debian-10/rootfs/opt/bitnami/scripts/libphp.sh
Normal file
256
bitnami/osclass/4/debian-10/rootfs/opt/bitnami/scripts/libphp.sh
Normal file
@@ -0,0 +1,256 @@
|
||||
#!/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
|
||||
. /opt/bitnami/scripts/libwebserver.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="^[; ]*${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="^[; ]*${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"
|
||||
php_set_runtime_config "$PHP_CONF_FILE"
|
||||
|
||||
# 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
|
||||
}
|
||||
|
||||
########################
|
||||
# Set PHP runtime options, based on user-provided environment variables
|
||||
# Globals:
|
||||
# PHP_*
|
||||
# Arguments:
|
||||
# None
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
php_set_runtime_config() {
|
||||
local -r conf_file="${1:?missing conf file}"
|
||||
|
||||
! is_empty_value "$PHP_ENABLE_OPCACHE" && info "Setting PHP opcache.enable option" && php_conf_set opcache.enable "$PHP_ENABLE_OPCACHE" "$conf_file"
|
||||
! is_empty_value "$PHP_EXPOSE_PHP" && info "Setting PHP expose_php option" && php_conf_set expose_php "$PHP_EXPOSE_PHP" "$conf_file"
|
||||
! is_empty_value "$PHP_MAX_EXECUTION_TIME" && info "Setting PHP max_execution_time option" && php_conf_set max_execution_time "$PHP_MAX_EXECUTION_TIME" "$conf_file"
|
||||
! is_empty_value "$PHP_MAX_INPUT_TIME" && info "Setting PHP max_input_time option" && php_conf_set max_input_time "$PHP_MAX_INPUT_TIME" "$conf_file"
|
||||
! is_empty_value "$PHP_MAX_INPUT_VARS" && info "Setting PHP max_input_vars option" && php_conf_set max_input_vars "$PHP_MAX_INPUT_VARS" "$conf_file"
|
||||
! is_empty_value "$PHP_MEMORY_LIMIT" && info "Setting PHP memory_limit option" && php_conf_set memory_limit "$PHP_MEMORY_LIMIT" "$conf_file"
|
||||
! is_empty_value "$PHP_POST_MAX_SIZE" && info "Setting PHP post_max_size option" && php_conf_set post_max_size "$PHP_POST_MAX_SIZE" "$conf_file"
|
||||
! is_empty_value "$PHP_UPLOAD_MAX_FILESIZE" && info "Setting PHP upload_max_filesize option" && php_conf_set upload_max_filesize "$PHP_UPLOAD_MAX_FILESIZE" "$conf_file"
|
||||
|
||||
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"
|
||||
}
|
||||
|
||||
########################
|
||||
# Execute/run PHP code and print to stdout
|
||||
# Globals:
|
||||
# None
|
||||
# Stdin:
|
||||
# Code to execute
|
||||
# Arguments:
|
||||
# $1..$n - Input arguments to script
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
php_execute_print_output() {
|
||||
local php_cmd
|
||||
# Obtain the command specified via stdin
|
||||
php_cmd="$(</dev/stdin)"
|
||||
debug "Executing PHP code:\n${php_cmd}"
|
||||
php -- "$@" <<< "<?php ${php_cmd}"
|
||||
}
|
||||
|
||||
########################
|
||||
# Execute/run PHP code
|
||||
# Globals:
|
||||
# None
|
||||
# Stdin:
|
||||
# Code to execute
|
||||
# Arguments:
|
||||
# $1..$n - Input arguments to script
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
php_execute() {
|
||||
debug_execute php_execute_print_output "$@"
|
||||
}
|
||||
|
||||
########################
|
||||
# Execute/run PHP code and print to stdout
|
||||
# Globals:
|
||||
# None
|
||||
# Stdin:
|
||||
# Code to execute
|
||||
# Arguments:
|
||||
# $1..$n - Input arguments to script
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
php_execute_print_output() {
|
||||
local php_cmd
|
||||
# Obtain the command specified via stdin
|
||||
php_cmd="$(</dev/stdin)"
|
||||
debug "Executing PHP code:\n${php_cmd}"
|
||||
php -- "$@" <<< "<?php ${php_cmd}"
|
||||
}
|
||||
|
||||
########################
|
||||
# Execute/run PHP code
|
||||
# Globals:
|
||||
# None
|
||||
# Stdin:
|
||||
# Code to execute
|
||||
# Arguments:
|
||||
# $1..$n - Input arguments to script
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
php_execute() {
|
||||
debug_execute php_execute_print_output "$@"
|
||||
}
|
||||
|
||||
########################
|
||||
# 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"
|
||||
}
|
||||
|
||||
########################
|
||||
# Reload PHP-FPM configuration
|
||||
# Globals:
|
||||
# PHP_FPM_PID_FILE
|
||||
# Arguments:
|
||||
# None
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
php_fpm_reload() {
|
||||
php_fpm_stop "USR2"
|
||||
}
|
||||
|
||||
########################
|
||||
# Check if PHP-FPM is enabled for the current Bitnami installation
|
||||
# Globals:
|
||||
# None
|
||||
# Arguments:
|
||||
# None
|
||||
# Returns:
|
||||
# true if PHP-FPM is enabled, false otherwise
|
||||
########################
|
||||
is_php_fpm_enabled() {
|
||||
if [[ "$(web_server_type)" = "apache" ]]; then
|
||||
# If mod_php is enabled, then PHP-FPM is cannot be
|
||||
if apachectl -M | grep -q -E "php[0-9]?_module"; then
|
||||
false
|
||||
else
|
||||
true
|
||||
fi
|
||||
else
|
||||
# Assume PHP-FPM is enabled with any other configuration (i.e. NGINX)
|
||||
true
|
||||
fi
|
||||
}
|
||||
|
||||
########################
|
||||
# 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
|
||||
}
|
||||
@@ -0,0 +1,124 @@
|
||||
#!/bin/bash
|
||||
#
|
||||
# Environment configuration for mysql
|
||||
|
||||
# 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)
|
||||
|
||||
# Load logging library
|
||||
. /opt/bitnami/scripts/liblog.sh
|
||||
|
||||
export BITNAMI_ROOT_DIR="/opt/bitnami"
|
||||
export BITNAMI_VOLUME_DIR="/bitnami"
|
||||
|
||||
# Logging configuration
|
||||
export MODULE="${MODULE:-mysql}"
|
||||
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
|
||||
mysql_env_vars=(
|
||||
MYSQL_CLIENT_FLAVOR
|
||||
ALLOW_EMPTY_PASSWORD
|
||||
MYSQL_CLIENT_DATABASE_AUTHENTICATION_PLUGIN
|
||||
MYSQL_CLIENT_DATABASE_HOST
|
||||
MYSQL_CLIENT_DATABASE_PORT_NUMBER
|
||||
MYSQL_CLIENT_DATABASE_ROOT_USER
|
||||
MYSQL_CLIENT_DATABASE_ROOT_PASSWORD
|
||||
MYSQL_CLIENT_CREATE_DATABASE_NAME
|
||||
MYSQL_CLIENT_CREATE_DATABASE_USER
|
||||
MYSQL_CLIENT_CREATE_DATABASE_PASSWORD
|
||||
MYSQL_CLIENT_CREATE_DATABASE_CHARACTER_SET
|
||||
MYSQL_CLIENT_CREATE_DATABASE_COLLATE
|
||||
MYSQL_CLIENT_CREATE_DATABASE_PRIVILEGES
|
||||
MYSQL_CLIENT_ENABLE_SSL_WRAPPER
|
||||
MYSQL_CLIENT_ENABLE_SSL
|
||||
MYSQL_CLIENT_SSL_CA_FILE
|
||||
MYSQL_CLIENT_SSL_CERT_FILE
|
||||
MYSQL_CLIENT_SSL_KEY_FILE
|
||||
MYSQL_CLIENT_EXTRA_FLAGS
|
||||
MARIADB_AUTHENTICATION_PLUGIN
|
||||
MARIADB_HOST
|
||||
MARIADB_PORT_NUMBER
|
||||
MARIADB_ROOT_USER
|
||||
MARIADB_ROOT_PASSWORD
|
||||
)
|
||||
for env_var in "${mysql_env_vars[@]}"; do
|
||||
file_env_var="${env_var}_FILE"
|
||||
if [[ -n "${!file_env_var:-}" ]]; then
|
||||
if [[ -r "${!file_env_var:-}" ]]; then
|
||||
export "${env_var}=$(< "${!file_env_var}")"
|
||||
unset "${file_env_var}"
|
||||
else
|
||||
warn "Skipping export of '${env_var}'. '${!file_env_var:-}' is not readable."
|
||||
fi
|
||||
fi
|
||||
done
|
||||
unset mysql_env_vars
|
||||
export MYSQL_CLIENT_FLAVOR="${MYSQL_CLIENT_FLAVOR:-mariadb}"
|
||||
export DB_FLAVOR="$MYSQL_CLIENT_FLAVOR"
|
||||
|
||||
# Paths
|
||||
export DB_BASE_DIR="${BITNAMI_ROOT_DIR}/mysql"
|
||||
export DB_VOLUME_DIR="${BITNAMI_VOLUME_DIR}/mysql"
|
||||
export DB_DATA_DIR="${DB_VOLUME_DIR}/data"
|
||||
export DB_BIN_DIR="${DB_BASE_DIR}/bin"
|
||||
export DB_SBIN_DIR="${DB_BASE_DIR}/bin"
|
||||
export DB_CONF_DIR="${DB_BASE_DIR}/conf"
|
||||
export DB_LOGS_DIR="${DB_BASE_DIR}/logs"
|
||||
export DB_TMP_DIR="${DB_BASE_DIR}/tmp"
|
||||
export DB_CONF_FILE="${DB_CONF_DIR}/my.cnf"
|
||||
export DB_PID_FILE="${DB_TMP_DIR}/mysqld.pid"
|
||||
export DB_SOCKET_FILE="${DB_TMP_DIR}/mysql.sock"
|
||||
export PATH="${DB_SBIN_DIR}:${DB_BIN_DIR}:/opt/bitnami/common/bin:${PATH}"
|
||||
|
||||
# System users (when running with a privileged user)
|
||||
export DB_DAEMON_USER="mysql"
|
||||
export DB_DAEMON_GROUP="mysql"
|
||||
|
||||
# MySQL client configuration
|
||||
export ALLOW_EMPTY_PASSWORD="${ALLOW_EMPTY_PASSWORD:-no}"
|
||||
MYSQL_CLIENT_DATABASE_AUTHENTICATION_PLUGIN="${MYSQL_CLIENT_DATABASE_AUTHENTICATION_PLUGIN:-"${MARIADB_AUTHENTICATION_PLUGIN:-}"}"
|
||||
export MYSQL_CLIENT_DATABASE_AUTHENTICATION_PLUGIN="${MYSQL_CLIENT_DATABASE_AUTHENTICATION_PLUGIN:-}"
|
||||
export DB_AUTHENTICATION_PLUGIN="$MYSQL_CLIENT_DATABASE_AUTHENTICATION_PLUGIN"
|
||||
MYSQL_CLIENT_DATABASE_HOST="${MYSQL_CLIENT_DATABASE_HOST:-"${MARIADB_HOST:-}"}"
|
||||
export MYSQL_CLIENT_DATABASE_HOST="${MYSQL_CLIENT_DATABASE_HOST:-mariadb}"
|
||||
export DB_HOST="$MYSQL_CLIENT_DATABASE_HOST"
|
||||
MYSQL_CLIENT_DATABASE_PORT_NUMBER="${MYSQL_CLIENT_DATABASE_PORT_NUMBER:-"${MARIADB_PORT_NUMBER:-}"}"
|
||||
export MYSQL_CLIENT_DATABASE_PORT_NUMBER="${MYSQL_CLIENT_DATABASE_PORT_NUMBER:-3306}"
|
||||
export DB_PORT_NUMBER="$MYSQL_CLIENT_DATABASE_PORT_NUMBER"
|
||||
MYSQL_CLIENT_DATABASE_ROOT_USER="${MYSQL_CLIENT_DATABASE_ROOT_USER:-"${MARIADB_ROOT_USER:-}"}"
|
||||
export MYSQL_CLIENT_DATABASE_ROOT_USER="${MYSQL_CLIENT_DATABASE_ROOT_USER:-root}"
|
||||
export DB_ROOT_USER="$MYSQL_CLIENT_DATABASE_ROOT_USER" # only used during the first initialization
|
||||
MYSQL_CLIENT_DATABASE_ROOT_PASSWORD="${MYSQL_CLIENT_DATABASE_ROOT_PASSWORD:-"${MARIADB_ROOT_PASSWORD:-}"}"
|
||||
export MYSQL_CLIENT_DATABASE_ROOT_PASSWORD="${MYSQL_CLIENT_DATABASE_ROOT_PASSWORD:-}"
|
||||
export DB_ROOT_PASSWORD="$MYSQL_CLIENT_DATABASE_ROOT_PASSWORD" # only used during the first initialization
|
||||
export MYSQL_CLIENT_CREATE_DATABASE_NAME="${MYSQL_CLIENT_CREATE_DATABASE_NAME:-}"
|
||||
export DB_CREATE_DATABASE_NAME="$MYSQL_CLIENT_CREATE_DATABASE_NAME" # only used during the first initialization
|
||||
export MYSQL_CLIENT_CREATE_DATABASE_USER="${MYSQL_CLIENT_CREATE_DATABASE_USER:-}"
|
||||
export DB_CREATE_DATABASE_USER="$MYSQL_CLIENT_CREATE_DATABASE_USER"
|
||||
export MYSQL_CLIENT_CREATE_DATABASE_PASSWORD="${MYSQL_CLIENT_CREATE_DATABASE_PASSWORD:-}"
|
||||
export DB_CREATE_DATABASE_PASSWORD="$MYSQL_CLIENT_CREATE_DATABASE_PASSWORD"
|
||||
export MYSQL_CLIENT_CREATE_DATABASE_CHARACTER_SET="${MYSQL_CLIENT_CREATE_DATABASE_CHARACTER_SET:-}"
|
||||
export DB_CREATE_DATABASE_CHARACTER_SET="$MYSQL_CLIENT_CREATE_DATABASE_CHARACTER_SET"
|
||||
export MYSQL_CLIENT_CREATE_DATABASE_COLLATE="${MYSQL_CLIENT_CREATE_DATABASE_COLLATE:-}"
|
||||
export DB_CREATE_DATABASE_COLLATE="$MYSQL_CLIENT_CREATE_DATABASE_COLLATE"
|
||||
export MYSQL_CLIENT_CREATE_DATABASE_PRIVILEGES="${MYSQL_CLIENT_CREATE_DATABASE_PRIVILEGES:-}"
|
||||
export DB_CREATE_DATABASE_PRIVILEGES="$MYSQL_CLIENT_CREATE_DATABASE_PRIVILEGES"
|
||||
export MYSQL_CLIENT_ENABLE_SSL_WRAPPER="${MYSQL_CLIENT_ENABLE_SSL_WRAPPER:-no}"
|
||||
export DB_ENABLE_SSL_WRAPPER="$MYSQL_CLIENT_ENABLE_SSL_WRAPPER"
|
||||
export MYSQL_CLIENT_ENABLE_SSL="${MYSQL_CLIENT_ENABLE_SSL:-no}"
|
||||
export DB_ENABLE_SSL="$MYSQL_CLIENT_ENABLE_SSL"
|
||||
export MYSQL_CLIENT_SSL_CA_FILE="${MYSQL_CLIENT_SSL_CA_FILE:-}"
|
||||
export DB_SSL_CA_FILE="$MYSQL_CLIENT_SSL_CA_FILE"
|
||||
export MYSQL_CLIENT_SSL_CERT_FILE="${MYSQL_CLIENT_SSL_CERT_FILE:-}"
|
||||
export DB_SSL_CERT_FILE="$MYSQL_CLIENT_SSL_CERT_FILE"
|
||||
export MYSQL_CLIENT_SSL_KEY_FILE="${MYSQL_CLIENT_SSL_KEY_FILE:-}"
|
||||
export DB_SSL_KEY_FILE="$MYSQL_CLIENT_SSL_KEY_FILE"
|
||||
export MYSQL_CLIENT_EXTRA_FLAGS="${MYSQL_CLIENT_EXTRA_FLAGS:-no}"
|
||||
export DB_EXTRA_FLAGS="$MYSQL_CLIENT_EXTRA_FLAGS"
|
||||
|
||||
# Custom environment variables may be defined below
|
||||
@@ -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/libfs.sh
|
||||
|
||||
# Load MySQL Client environment variables
|
||||
. /opt/bitnami/scripts/mysql-client-env.sh
|
||||
|
||||
for dir in "$DB_BIN_DIR" "${DB_BASE_DIR}/.bin"; do
|
||||
ensure_dir_exists "$dir"
|
||||
chmod g+rwX "$dir"
|
||||
done
|
||||
19
bitnami/osclass/4/debian-10/rootfs/opt/bitnami/scripts/mysql-client/setup.sh
Executable file
19
bitnami/osclass/4/debian-10/rootfs/opt/bitnami/scripts/mysql-client/setup.sh
Executable file
@@ -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/libmysqlclient.sh
|
||||
|
||||
# Load MySQL Client environment variables
|
||||
. /opt/bitnami/scripts/mysql-client-env.sh
|
||||
|
||||
# Ensure MySQL Client environment variables settings are valid
|
||||
mysql_client_validate
|
||||
# Ensure MySQL Client is initialized
|
||||
mysql_client_initialize
|
||||
@@ -0,0 +1,113 @@
|
||||
#!/bin/bash
|
||||
#
|
||||
# Environment configuration for osclass
|
||||
|
||||
# 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)
|
||||
|
||||
# Load logging library
|
||||
. /opt/bitnami/scripts/liblog.sh
|
||||
|
||||
export BITNAMI_ROOT_DIR="/opt/bitnami"
|
||||
export BITNAMI_VOLUME_DIR="/bitnami"
|
||||
|
||||
# Logging configuration
|
||||
export MODULE="${MODULE:-osclass}"
|
||||
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
|
||||
osclass_env_vars=(
|
||||
OSCLASS_DATA_TO_PERSIST
|
||||
OSCLASS_HOST
|
||||
OSCLASS_SKIP_BOOTSTRAP
|
||||
OSCLASS_USERNAME
|
||||
OSCLASS_PASSWORD
|
||||
OSCLASS_EMAIL
|
||||
OSCLASS_WEB_TITLE
|
||||
OSCLASS_SMTP_HOST
|
||||
OSCLASS_SMTP_PORT_NUMBER
|
||||
OSCLASS_SMTP_USER
|
||||
OSCLASS_SMTP_PASSWORD
|
||||
OSCLASS_SMTP_PROTOCOL
|
||||
OSCLASS_DATABASE_HOST
|
||||
OSCLASS_DATABASE_PORT_NUMBER
|
||||
OSCLASS_DATABASE_NAME
|
||||
OSCLASS_DATABASE_USER
|
||||
OSCLASS_DATABASE_PASSWORD
|
||||
SMTP_HOST
|
||||
SMTP_PORT
|
||||
OSCLASS_SMTP_PORT
|
||||
SMTP_USER
|
||||
SMTP_PASSWORD
|
||||
SMTP_PROTOCOL
|
||||
MARIADB_HOST
|
||||
MARIADB_PORT_NUMBER
|
||||
MARIADB_DATABASE_NAME
|
||||
MARIADB_DATABASE_USER
|
||||
MARIADB_DATABASE_PASSWORD
|
||||
)
|
||||
for env_var in "${osclass_env_vars[@]}"; do
|
||||
file_env_var="${env_var}_FILE"
|
||||
if [[ -n "${!file_env_var:-}" ]]; then
|
||||
if [[ -r "${!file_env_var:-}" ]]; then
|
||||
export "${env_var}=$(< "${!file_env_var}")"
|
||||
unset "${file_env_var}"
|
||||
else
|
||||
warn "Skipping export of '${env_var}'. '${!file_env_var:-}' is not readable."
|
||||
fi
|
||||
fi
|
||||
done
|
||||
unset osclass_env_vars
|
||||
|
||||
# Paths
|
||||
export OSCLASS_BASE_DIR="${BITNAMI_ROOT_DIR}/osclass"
|
||||
export OSCLASS_CONF_FILE="${OSCLASS_BASE_DIR}/config.php"
|
||||
|
||||
# Osclass persistence configuration
|
||||
export OSCLASS_VOLUME_DIR="${BITNAMI_VOLUME_DIR}/osclass"
|
||||
export OSCLASS_DATA_TO_PERSIST="${OSCLASS_DATA_TO_PERSIST:-config.php oc-content/uploads oc-content/downloads oc-content/languages oc-content/plugins oc-content/themes}"
|
||||
|
||||
# Osclass configuration
|
||||
export OSCLASS_HOST="${OSCLASS_HOST:-}" # only used during the first initialization
|
||||
export OSCLASS_SKIP_BOOTSTRAP="${OSCLASS_SKIP_BOOTSTRAP:-}" # only used during the first initialization
|
||||
|
||||
# Osclass credentials
|
||||
export OSCLASS_USERNAME="${OSCLASS_USERNAME:-user}" # only used during the first initialization
|
||||
export OSCLASS_PASSWORD="${OSCLASS_PASSWORD:-bitnami}" # only used during the first initialization
|
||||
export OSCLASS_EMAIL="${OSCLASS_EMAIL:-user@example.com}" # only used during the first initialization
|
||||
export OSCLASS_WEB_TITLE="${OSCLASS_WEB_TITLE:-Sample Web Page}" # only used during the first initialization
|
||||
|
||||
# Osclass SMTP credentials
|
||||
OSCLASS_SMTP_HOST="${OSCLASS_SMTP_HOST:-"${SMTP_HOST:-}"}"
|
||||
export OSCLASS_SMTP_HOST="${OSCLASS_SMTP_HOST:-}" # only used during the first initialization
|
||||
OSCLASS_SMTP_PORT_NUMBER="${OSCLASS_SMTP_PORT_NUMBER:-"${SMTP_PORT:-}"}"
|
||||
OSCLASS_SMTP_PORT_NUMBER="${OSCLASS_SMTP_PORT_NUMBER:-"${OSCLASS_SMTP_PORT:-}"}"
|
||||
export OSCLASS_SMTP_PORT_NUMBER="${OSCLASS_SMTP_PORT_NUMBER:-}" # only used during the first initialization
|
||||
OSCLASS_SMTP_USER="${OSCLASS_SMTP_USER:-"${SMTP_USER:-}"}"
|
||||
export OSCLASS_SMTP_USER="${OSCLASS_SMTP_USER:-}" # only used during the first initialization
|
||||
OSCLASS_SMTP_PASSWORD="${OSCLASS_SMTP_PASSWORD:-"${SMTP_PASSWORD:-}"}"
|
||||
export OSCLASS_SMTP_PASSWORD="${OSCLASS_SMTP_PASSWORD:-}" # only used during the first initialization
|
||||
OSCLASS_SMTP_PROTOCOL="${OSCLASS_SMTP_PROTOCOL:-"${SMTP_PROTOCOL:-}"}"
|
||||
export OSCLASS_SMTP_PROTOCOL="${OSCLASS_SMTP_PROTOCOL:-}" # only used during the first initialization
|
||||
|
||||
# Database configuration
|
||||
export OSCLASS_DEFAULT_DATABASE_HOST="mariadb" # only used at build time
|
||||
OSCLASS_DATABASE_HOST="${OSCLASS_DATABASE_HOST:-"${MARIADB_HOST:-}"}"
|
||||
export OSCLASS_DATABASE_HOST="${OSCLASS_DATABASE_HOST:-$OSCLASS_DEFAULT_DATABASE_HOST}" # only used during the first initialization
|
||||
OSCLASS_DATABASE_PORT_NUMBER="${OSCLASS_DATABASE_PORT_NUMBER:-"${MARIADB_PORT_NUMBER:-}"}"
|
||||
export OSCLASS_DATABASE_PORT_NUMBER="${OSCLASS_DATABASE_PORT_NUMBER:-3306}" # only used during the first initialization
|
||||
OSCLASS_DATABASE_NAME="${OSCLASS_DATABASE_NAME:-"${MARIADB_DATABASE_NAME:-}"}"
|
||||
export OSCLASS_DATABASE_NAME="${OSCLASS_DATABASE_NAME:-bitnami_osclass}" # only used during the first initialization
|
||||
OSCLASS_DATABASE_USER="${OSCLASS_DATABASE_USER:-"${MARIADB_DATABASE_USER:-}"}"
|
||||
export OSCLASS_DATABASE_USER="${OSCLASS_DATABASE_USER:-bn_osclass}" # only used during the first initialization
|
||||
OSCLASS_DATABASE_PASSWORD="${OSCLASS_DATABASE_PASSWORD:-"${MARIADB_DATABASE_PASSWORD:-}"}"
|
||||
export OSCLASS_DATABASE_PASSWORD="${OSCLASS_DATABASE_PASSWORD:-}" # only used during the first initialization
|
||||
|
||||
# PHP configuration
|
||||
export PHP_DEFAULT_MEMORY_LIMIT="256M" # only used at build time
|
||||
|
||||
# Custom environment variables may be defined below
|
||||
31
bitnami/osclass/4/debian-10/rootfs/opt/bitnami/scripts/osclass/entrypoint.sh
Executable file
31
bitnami/osclass/4/debian-10/rootfs/opt/bitnami/scripts/osclass/entrypoint.sh
Executable file
@@ -0,0 +1,31 @@
|
||||
#!/bin/bash
|
||||
|
||||
# shellcheck disable=SC1091
|
||||
|
||||
set -o errexit
|
||||
set -o nounset
|
||||
set -o pipefail
|
||||
# set -o xtrace # Uncomment this line for debugging purpose
|
||||
|
||||
# Load Osclass environment
|
||||
. /opt/bitnami/scripts/osclass-env.sh
|
||||
|
||||
# Load libraries
|
||||
. /opt/bitnami/scripts/libbitnami.sh
|
||||
. /opt/bitnami/scripts/liblog.sh
|
||||
. /opt/bitnami/scripts/libwebserver.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 Osclass setup **"
|
||||
/opt/bitnami/scripts/"$(web_server_type)"/setup.sh
|
||||
/opt/bitnami/scripts/php/setup.sh
|
||||
/opt/bitnami/scripts/mysql-client/setup.sh
|
||||
/opt/bitnami/scripts/osclass/setup.sh
|
||||
/post-init.sh
|
||||
info "** Osclass setup finished! **"
|
||||
fi
|
||||
|
||||
echo ""
|
||||
exec "$@"
|
||||
48
bitnami/osclass/4/debian-10/rootfs/opt/bitnami/scripts/osclass/postunpack.sh
Executable file
48
bitnami/osclass/4/debian-10/rootfs/opt/bitnami/scripts/osclass/postunpack.sh
Executable file
@@ -0,0 +1,48 @@
|
||||
#!/bin/bash
|
||||
|
||||
# shellcheck disable=SC1090,SC1091
|
||||
|
||||
set -o errexit
|
||||
set -o nounset
|
||||
set -o pipefail
|
||||
# set -o xtrace # Uncomment this line for debugging purpose
|
||||
|
||||
# Load Osclass environment
|
||||
. /opt/bitnami/scripts/osclass-env.sh
|
||||
|
||||
# Load PHP environment for 'php_conf_set' (after 'osclass-env.sh' so that MODULE is not set to a wrong value)
|
||||
. /opt/bitnami/scripts/php-env.sh
|
||||
|
||||
# Load libraries
|
||||
. /opt/bitnami/scripts/libosclass.sh
|
||||
. /opt/bitnami/scripts/libfile.sh
|
||||
. /opt/bitnami/scripts/libfs.sh
|
||||
. /opt/bitnami/scripts/liblog.sh
|
||||
. /opt/bitnami/scripts/libphp.sh
|
||||
. /opt/bitnami/scripts/libwebserver.sh
|
||||
|
||||
# Load web server environment (after Osclass environment file so MODULE is not set to a wrong value)
|
||||
. "/opt/bitnami/scripts/$(web_server_type)-env.sh"
|
||||
|
||||
# Ensure the Osclass base directory exists and has proper permissions
|
||||
info "Configuring file permissions for Osclass"
|
||||
ensure_user_exists "$WEB_SERVER_DAEMON_USER" --group "$WEB_SERVER_DAEMON_GROUP"
|
||||
for dir in "$OSCLASS_BASE_DIR" "$OSCLASS_VOLUME_DIR"; do
|
||||
ensure_dir_exists "$dir"
|
||||
# Use daemon:root ownership for compatibility when running as a non-root user
|
||||
configure_permissions_ownership "$dir" -d "g+rwx" -f "g+rw" -u "$WEB_SERVER_DAEMON_USER" -g "root"
|
||||
done
|
||||
|
||||
# Enable default web server configuration for Osclass
|
||||
info "Creating default web server configuration for Osclass"
|
||||
web_server_validate
|
||||
ensure_web_server_app_configuration_exists "osclass" --type php --apache-additional-configuration '
|
||||
# Bypass mod_dir in order to allow 80->8080 redirections when not using a reverse proxy (example: docker-compose or Kubernetes)
|
||||
<LocationMatch "^/oc-admin$">
|
||||
DirectorySlash off
|
||||
</LocationMatch>
|
||||
|
||||
# Custom rewrite by Bitnami - bypass mod_dir in order to allow 80->8080 redirections when not using a reverse proxy (example: docker-compose or Kubernetes)
|
||||
RewriteEngine on
|
||||
RewriteRule "^/oc-admin$" "/oc-admin/index.php"
|
||||
'
|
||||
36
bitnami/osclass/4/debian-10/rootfs/opt/bitnami/scripts/osclass/setup.sh
Executable file
36
bitnami/osclass/4/debian-10/rootfs/opt/bitnami/scripts/osclass/setup.sh
Executable file
@@ -0,0 +1,36 @@
|
||||
#!/bin/bash
|
||||
|
||||
# shellcheck disable=SC1090,SC1091
|
||||
|
||||
set -o errexit
|
||||
set -o nounset
|
||||
set -o pipefail
|
||||
# set -o xtrace # Uncomment this line for debugging purpose
|
||||
|
||||
# Load Osclass environment
|
||||
. /opt/bitnami/scripts/osclass-env.sh
|
||||
|
||||
# Load MySQL Client environment for 'mysql_remote_execute' (after 'osclass-env.sh' so that MODULE is not set to a wrong value)
|
||||
if [[ -f /opt/bitnami/scripts/mysql-client-env.sh ]]; then
|
||||
. /opt/bitnami/scripts/mysql-client-env.sh
|
||||
elif [[ -f /opt/bitnami/scripts/mysql-env.sh ]]; then
|
||||
. /opt/bitnami/scripts/mysql-env.sh
|
||||
elif [[ -f /opt/bitnami/scripts/mariadb-env.sh ]]; then
|
||||
. /opt/bitnami/scripts/mariadb-env.sh
|
||||
fi
|
||||
|
||||
# Load libraries
|
||||
. /opt/bitnami/scripts/libosclass.sh
|
||||
. /opt/bitnami/scripts/libwebserver.sh
|
||||
|
||||
# Load web server environment (after Osclass environment file so MODULE is not set to a wrong value)
|
||||
. "/opt/bitnami/scripts/$(web_server_type)-env.sh"
|
||||
|
||||
# Ensure Osclass environment variables are valid
|
||||
osclass_validate
|
||||
|
||||
# Update web server configuration with runtime environment (needs to happen before the initialization)
|
||||
web_server_update_app_configuration "osclass"
|
||||
|
||||
# Ensure Osclass is initialized
|
||||
osclass_initialize
|
||||
@@ -0,0 +1,85 @@
|
||||
#!/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)
|
||||
|
||||
# Load logging library
|
||||
. /opt/bitnami/scripts/liblog.sh
|
||||
|
||||
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_ENABLE_OPCACHE
|
||||
PHP_EXPOSE_PHP
|
||||
PHP_MAX_EXECUTION_TIME
|
||||
PHP_MAX_INPUT_TIME
|
||||
PHP_MAX_INPUT_VARS
|
||||
PHP_MEMORY_LIMIT
|
||||
PHP_POST_MAX_SIZE
|
||||
PHP_UPLOAD_MAX_FILESIZE
|
||||
PHP_OPCACHE_ENABLED
|
||||
)
|
||||
for env_var in "${php_env_vars[@]}"; do
|
||||
file_env_var="${env_var}_FILE"
|
||||
if [[ -n "${!file_env_var:-}" ]]; then
|
||||
if [[ -r "${!file_env_var:-}" ]]; then
|
||||
export "${env_var}=$(< "${!file_env_var}")"
|
||||
unset "${file_env_var}"
|
||||
else
|
||||
warn "Skipping export of '${env_var}'. '${!file_env_var:-}' is not readable."
|
||||
fi
|
||||
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
|
||||
PHP_ENABLE_OPCACHE="${PHP_ENABLE_OPCACHE:-"${PHP_OPCACHE_ENABLED:-}"}"
|
||||
export PHP_ENABLE_OPCACHE="${PHP_ENABLE_OPCACHE:-}"
|
||||
export PHP_EXPOSE_PHP="${PHP_EXPOSE_PHP:-}"
|
||||
export PHP_MAX_EXECUTION_TIME="${PHP_MAX_EXECUTION_TIME:-}"
|
||||
export PHP_MAX_INPUT_TIME="${PHP_MAX_INPUT_TIME:-}"
|
||||
export PHP_MAX_INPUT_VARS="${PHP_MAX_INPUT_VARS:-}"
|
||||
export PHP_MEMORY_LIMIT="${PHP_MEMORY_LIMIT:-}"
|
||||
export PHP_POST_MAX_SIZE="${PHP_POST_MAX_SIZE:-}"
|
||||
export PHP_UPLOAD_MAX_FILESIZE="${PHP_UPLOAD_MAX_FILESIZE:-}"
|
||||
|
||||
# Custom environment variables may be defined below
|
||||
38
bitnami/osclass/4/debian-10/rootfs/opt/bitnami/scripts/php/postunpack.sh
Executable file
38
bitnami/osclass/4/debian-10/rootfs/opt/bitnami/scripts/php/postunpack.sh
Executable file
@@ -0,0 +1,38 @@
|
||||
#!/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"
|
||||
|
||||
# TMP dir configuration
|
||||
php_conf_set upload_tmp_dir "$PHP_TMP_DIR"
|
||||
|
||||
# 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"
|
||||
mv "${PHP_CONF_DIR}/common.conf" "${PHP_CONF_DIR}/common.conf.disabled"
|
||||
touch "${PHP_CONF_DIR}/common.conf"
|
||||
|
||||
ln -sf "/dev/stdout" "$PHP_FPM_LOG_FILE"
|
||||
35
bitnami/osclass/4/debian-10/rootfs/opt/bitnami/scripts/php/reload.sh
Executable file
35
bitnami/osclass/4/debian-10/rootfs/opt/bitnami/scripts/php/reload.sh
Executable file
@@ -0,0 +1,35 @@
|
||||
#!/bin/bash
|
||||
|
||||
# shellcheck disable=SC1090,SC1091
|
||||
|
||||
set -o errexit
|
||||
set -o nounset
|
||||
set -o pipefail
|
||||
# set -o xtrace # Uncomment this line for debugging purpose
|
||||
|
||||
# Load libraries
|
||||
. /opt/bitnami/scripts/libphp.sh
|
||||
. /opt/bitnami/scripts/liblog.sh
|
||||
. /opt/bitnami/scripts/libwebserver.sh
|
||||
|
||||
# Load PHP-FPM environment
|
||||
. /opt/bitnami/scripts/php-env.sh
|
||||
|
||||
# Load web server environment and functions
|
||||
. "/opt/bitnami/scripts/$(web_server_type)-env.sh"
|
||||
|
||||
error_code=0
|
||||
|
||||
if is_php_fpm_enabled; then
|
||||
if is_php_fpm_not_running; then
|
||||
error "php-fpm is not running"
|
||||
error_code=1
|
||||
else
|
||||
info "** Reloading PHP-FPM configuration **"
|
||||
php_fpm_reload
|
||||
fi
|
||||
else
|
||||
web_server_reload
|
||||
fi
|
||||
|
||||
exit "$error_code"
|
||||
17
bitnami/osclass/4/debian-10/rootfs/opt/bitnami/scripts/php/restart.sh
Executable file
17
bitnami/osclass/4/debian-10/rootfs/opt/bitnami/scripts/php/restart.sh
Executable file
@@ -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/libphp.sh
|
||||
|
||||
# Load PHP-FPM environment variables
|
||||
. /opt/bitnami/scripts/php-env.sh
|
||||
|
||||
/opt/bitnami/scripts/php/stop.sh
|
||||
/opt/bitnami/scripts/php/start.sh
|
||||
19
bitnami/osclass/4/debian-10/rootfs/opt/bitnami/scripts/php/run.sh
Executable file
19
bitnami/osclass/4/debian-10/rootfs/opt/bitnami/scripts/php/run.sh
Executable file
@@ -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[@]}"
|
||||
32
bitnami/osclass/4/debian-10/rootfs/opt/bitnami/scripts/php/setup.sh
Executable file
32
bitnami/osclass/4/debian-10/rootfs/opt/bitnami/scripts/php/setup.sh
Executable file
@@ -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/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" --group "$PHP_FPM_DAEMON_GROUP"
|
||||
ensure_dir_exists "$PHP_TMP_DIR"
|
||||
chown -R "${PHP_FPM_DAEMON_USER}:${PHP_FPM_DAEMON_GROUP}" "$PHP_TMP_DIR"
|
||||
# Enable daemon configuration
|
||||
if [[ ! -f "${PHP_CONF_DIR}/common.conf" ]]; then
|
||||
cp "${PHP_CONF_DIR}/common.conf.disabled" "${PHP_CONF_DIR}/common.conf"
|
||||
fi
|
||||
fi
|
||||
|
||||
php_initialize
|
||||
|
||||
# Fix logging issue when running as root
|
||||
! am_i_root || chmod o+w "$(readlink /dev/stdout)" "$(readlink /dev/stderr)"
|
||||
32
bitnami/osclass/4/debian-10/rootfs/opt/bitnami/scripts/php/start.sh
Executable file
32
bitnami/osclass/4/debian-10/rootfs/opt/bitnami/scripts/php/start.sh
Executable file
@@ -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/libphp.sh
|
||||
. /opt/bitnami/scripts/libos.sh
|
||||
. /opt/bitnami/scripts/liblog.sh
|
||||
|
||||
# Load PHP-FPM environment variables
|
||||
. /opt/bitnami/scripts/php-env.sh
|
||||
|
||||
error_code=0
|
||||
|
||||
if is_php_fpm_not_running; then
|
||||
nohup /opt/bitnami/scripts/php/run.sh >/dev/null 2>&1 &
|
||||
if ! retry_while "is_php_fpm_running"; then
|
||||
error "php-fpm did not start"
|
||||
error_code=1
|
||||
else
|
||||
info "php-fpm started"
|
||||
fi
|
||||
else
|
||||
info "php-fpm is already running"
|
||||
fi
|
||||
|
||||
exit "$error_code"
|
||||
21
bitnami/osclass/4/debian-10/rootfs/opt/bitnami/scripts/php/status.sh
Executable file
21
bitnami/osclass/4/debian-10/rootfs/opt/bitnami/scripts/php/status.sh
Executable file
@@ -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/libphp.sh
|
||||
. /opt/bitnami/scripts/liblog.sh
|
||||
|
||||
# Load PHP-FPM environment variables
|
||||
. /opt/bitnami/scripts/php-env.sh
|
||||
|
||||
if is_php_fpm_running; then
|
||||
info "php-fpm is already running"
|
||||
else
|
||||
info "php-fpm is not running"
|
||||
fi
|
||||
32
bitnami/osclass/4/debian-10/rootfs/opt/bitnami/scripts/php/stop.sh
Executable file
32
bitnami/osclass/4/debian-10/rootfs/opt/bitnami/scripts/php/stop.sh
Executable file
@@ -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/libphp.sh
|
||||
. /opt/bitnami/scripts/libos.sh
|
||||
. /opt/bitnami/scripts/liblog.sh
|
||||
|
||||
# Load PHP-FPM environment variables
|
||||
. /opt/bitnami/scripts/php-env.sh
|
||||
|
||||
error_code=0
|
||||
|
||||
if is_php_fpm_running; then
|
||||
BITNAMI_QUIET=1 php_fpm_stop
|
||||
if ! retry_while "is_php_fpm_not_running"; then
|
||||
error "php-fpm could not be stopped"
|
||||
error_code=1
|
||||
else
|
||||
info "php-fpm stopped"
|
||||
fi
|
||||
else
|
||||
info "php-fpm is not running"
|
||||
fi
|
||||
|
||||
exit "$error_code"
|
||||
@@ -1,31 +0,0 @@
|
||||
#!/bin/bash
|
||||
|
||||
##
|
||||
## @brief Helper function to show an error when a password is empty and exit
|
||||
## param $1 Input name
|
||||
##
|
||||
empty_password_error() {
|
||||
error "The $1 environment variable is empty or not set. Set the environment variable ALLOW_EMPTY_PASSWORD=yes to allow the container to be started with blank passwords. This is recommended only for development."
|
||||
exit 1
|
||||
}
|
||||
|
||||
##
|
||||
## @brief Helper function to show a warning when the ALLOW_EMPTY_PASSWORD flag is enabled
|
||||
##
|
||||
empty_password_enabled_warn() {
|
||||
warn "You set the environment variable ALLOW_EMPTY_PASSWORD=${ALLOW_EMPTY_PASSWORD}. For safety reasons, do not use this flag in a production environment."
|
||||
}
|
||||
|
||||
# Validate passwords
|
||||
if [[ "$ALLOW_EMPTY_PASSWORD" =~ ^(yes|Yes|YES)$ ]]; then
|
||||
empty_password_enabled_warn
|
||||
else
|
||||
# Database creation by MySQL client
|
||||
if [[ -n "$MYSQL_CLIENT_CREATE_DATABASE_USER" && -z "$MYSQL_CLIENT_CREATE_DATABASE_PASSWORD" ]]; then
|
||||
empty_password_error MYSQL_CLIENT_CREATE_DATABASE_PASSWORD
|
||||
fi
|
||||
# Osclass database
|
||||
if [[ -z "$OSCLASS_DATABASE_PASSWORD" ]]; then
|
||||
empty_password_error OSCLASS_DATABASE_PASSWORD
|
||||
fi
|
||||
fi
|
||||
@@ -1,18 +0,0 @@
|
||||
{
|
||||
"databaseName": "{{$global.env.OSCLASS_DATABASE_NAME}}",
|
||||
"databasePassword": "{{$global.env.OSCLASS_DATABASE_PASSWORD}}",
|
||||
"databaseServerHost": "{{$global.env.MARIADB_HOST}}",
|
||||
"databaseServerPort": "{{$global.env.MARIADB_PORT_NUMBER}}",
|
||||
"databaseUser": "{{$global.env.OSCLASS_DATABASE_USER}}",
|
||||
"email": "{{$global.env.OSCLASS_EMAIL}}",
|
||||
"host": "{{$global.env.OSCLASS_HOST}}",
|
||||
"password": "{{$global.env.OSCLASS_PASSWORD}}",
|
||||
"phpMemoryLimit": "{{$global.env.PHP_MEMORY_LIMIT}}",
|
||||
"smtpHost": "{{$global.env.SMTP_HOST}}",
|
||||
"smtpPassword": "{{$global.env.SMTP_PASSWORD}}",
|
||||
"smtpPort": "{{$global.env.SMTP_PORT}}",
|
||||
"smtpProtocol": "{{$global.env.SMTP_PROTOCOL}}",
|
||||
"smtpUser": "{{$global.env.SMTP_USER}}",
|
||||
"username": "{{$global.env.OSCLASS_USERNAME}}",
|
||||
"webTitle": "{{$global.env.OSCLASS_WEB_TITLE}}"
|
||||
}
|
||||
@@ -1,12 +1,12 @@
|
||||
# What is Osclass?
|
||||
# Bitnami Docker Image for Osclass
|
||||
|
||||
## What is Osclass?
|
||||
|
||||
> Osclass is a php script that allows you to quickly create and manage your own free classifieds site. Using this script, you can provide free advertising for items for sale, real estate, jobs, cars... Hundreds of free classified advertising sites are using Osclass. Visit our demo and post a free ad to see Osclass in action.
|
||||
|
||||
https://osclass.org/
|
||||
|
||||
# TL;DR
|
||||
|
||||
## Docker Compose
|
||||
## TL;DR
|
||||
|
||||
```console
|
||||
$ curl -sSL https://raw.githubusercontent.com/bitnami/bitnami-docker-osclass/master/docker-compose.yml > docker-compose.yml
|
||||
@@ -15,255 +15,222 @@ $ docker-compose up -d
|
||||
|
||||
You can find the default credentials and available configuration options in the [Environment Variables](#environment-variables) section.
|
||||
|
||||
# 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 (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.
|
||||
## 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 (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/osclass?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 Osclass in Kubernetes?
|
||||
## Why use a non-root container?
|
||||
|
||||
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/).
|
||||
|
||||
## How to deploy Osclass in Kubernetes?
|
||||
|
||||
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 Osclass Chart GitHub repository](https://github.com/bitnami/charts/tree/master/bitnami/osclass).
|
||||
|
||||
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/).
|
||||
|
||||
|
||||
* [`4`, `4-debian-10`, `4.4.0`, `4.4.0-debian-10-r15`, `latest` (4/debian-10/Dockerfile)](https://github.com/bitnami/bitnami-docker-osclass/blob/4.4.0-debian-10-r15/4/debian-10/Dockerfile)
|
||||
- [`4`, `4-debian-10`, `4.4.0`, `4.4.0-debian-10-r16`, `latest` (4/debian-10/Dockerfile)](https://github.com/bitnami/bitnami-docker-osclass/blob/4.4.0-debian-10-r16/4/debian-10/Dockerfile)
|
||||
|
||||
Subscribe to project updates by watching the [bitnami/osclass GitHub repo](https://github.com/bitnami/bitnami-docker-osclass).
|
||||
|
||||
# Prerequisites
|
||||
## Get this image
|
||||
|
||||
To run this application you need [Docker Engine](https://www.docker.com/products/docker-engine) >= `1.10.0`. [Docker Compose](https://www.docker.com/products/docker-compose) is recommended with a version `1.6.0` or later.
|
||||
|
||||
# How to use this image
|
||||
|
||||
Osclass requires access to a MySQL database or MariaDB database to store information. We'll use our very own [MariaDB image](https://www.github.com/bitnami/bitnami-docker-mariadb) for the database requirements.
|
||||
|
||||
## Using Docker Compose
|
||||
|
||||
The recommended way to run Osclass is using Docker Compose using the following `docker-compose.yml` template:
|
||||
|
||||
```yaml
|
||||
version: '2'
|
||||
|
||||
services:
|
||||
mariadb:
|
||||
image: 'bitnami/mariadb:latest'
|
||||
environment:
|
||||
- MARIADB_USER=bn_osclass
|
||||
- MARIADB_DATABASE=bitnami_osclass
|
||||
- ALLOW_EMPTY_PASSWORD=yes
|
||||
volumes:
|
||||
- mariadb_data:/bitnami
|
||||
osclass:
|
||||
image: bitnami/osclass:latest
|
||||
environment:
|
||||
- MARIADB_HOST=mariadb
|
||||
- MARIADB_PORT_NUMBER=3306
|
||||
- OSCLASS_DATABASE_USER=bn_osclass
|
||||
- OSCLASS_DATABASE_NAME=bitnami_osclass
|
||||
- ALLOW_EMPTY_PASSWORD=yes
|
||||
depends_on:
|
||||
- mariadb
|
||||
ports:
|
||||
- '80:80'
|
||||
- '443:443'
|
||||
volumes:
|
||||
- osclass_data:/bitnami
|
||||
volumes:
|
||||
mariadb_data:
|
||||
driver: local
|
||||
osclass_data:
|
||||
driver: local
|
||||
```
|
||||
|
||||
Launch the containers using:
|
||||
The recommended way to get the Bitnami Osclass Docker Image is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/osclass).
|
||||
|
||||
```console
|
||||
$ docker pull bitnami/osclass:latest
|
||||
```
|
||||
|
||||
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/osclass/tags/) in the Docker Hub Registry.
|
||||
|
||||
```console
|
||||
$ docker pull bitnami/osclass:[TAG]
|
||||
```
|
||||
|
||||
If you wish, you can also build the image yourself.
|
||||
|
||||
```console
|
||||
$ docker build -t bitnami/osclass:latest 'https://github.com/bitnami/bitnami-docker-osclass.git#master:4/debian-10'
|
||||
```
|
||||
|
||||
## How to use this image
|
||||
|
||||
Osclass requires access to a MySQL or MariaDB database to store information. We'll use the [Bitnami Docker Image for MariaDB](https://www.github.com/bitnami/bitnami-docker-mariadb) for the database requirements.
|
||||
|
||||
### Run the application using Docker Compose
|
||||
|
||||
The main folder of this repository contains a functional [`docker-compose.yml`](https://github.com/bitnami/bitnami-docker-osclass/blob/master/docker-compose.yml) file. Run the application using it as shown below:
|
||||
|
||||
```console
|
||||
$ curl -sSL https://raw.githubusercontent.com/bitnami/bitnami-docker-osclass/master/docker-compose.yml > docker-compose.yml
|
||||
$ docker-compose up -d
|
||||
```
|
||||
|
||||
## Using the Docker Command Line
|
||||
### Using the Docker Command Line
|
||||
|
||||
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 network
|
||||
#### Step 1: Create a network
|
||||
|
||||
```console
|
||||
$ docker network create osclass-tier
|
||||
```
|
||||
```console
|
||||
$ docker network create osclass-network
|
||||
```
|
||||
|
||||
2. Create a volume for MariaDB persistence and create a MariaDB container
|
||||
#### Step 2: Create a volume for MariaDB persistence and create a MariaDB container
|
||||
|
||||
```console
|
||||
$ docker volume create --name mariadb_data
|
||||
$ docker run -d --name mariadb \
|
||||
-e ALLOW_EMPTY_PASSWORD=yes \
|
||||
-e MARIADB_USER=bn_osclass \
|
||||
-e MARIADB_DATABASE=bitnami_osclass \
|
||||
--net osclass-tier \
|
||||
--volume mariadb_data:/bitnami \
|
||||
bitnami/mariadb:latest
|
||||
```
|
||||
```console
|
||||
$ docker volume create --name mariadb_data
|
||||
$ docker run -d --name mariadb \
|
||||
--env ALLOW_EMPTY_PASSWORD=yes \
|
||||
--env MARIADB_USER=bn_osclass \
|
||||
--env MARIADB_PASSWORD=bitnami \
|
||||
--env MARIADB_DATABASE=bitnami_osclass \
|
||||
--network osclass-network \
|
||||
--volume mariadb_data:/bitnami/mariadb \
|
||||
bitnami/mariadb:latest
|
||||
```
|
||||
|
||||
3. Create volumes for Osclass persistence and launch the container
|
||||
#### Step 3: Create volumes for Osclass persistence and launch the container
|
||||
|
||||
```console
|
||||
$ docker volume create --name osclass_data
|
||||
$ docker run -d --name osclass -p 80:80 -p 443:443 \
|
||||
-e ALLOW_EMPTY_PASSWORD=yes \
|
||||
-e OSCLASS_DATABASE_USER=bn_osclass \
|
||||
-e OSCLASS_DATABASE_NAME=bitnami_osclass \
|
||||
--net osclass-tier \
|
||||
--volume osclass_data:/bitnami \
|
||||
bitnami/osclass:latest
|
||||
```
|
||||
```console
|
||||
$ docker volume create --name osclass_data
|
||||
$ docker run -d --name osclass \
|
||||
-p 8080:8080 -p 8443:8443 \
|
||||
--env ALLOW_EMPTY_PASSWORD=yes \
|
||||
--env OSCLASS_DATABASE_USER=bn_osclass \
|
||||
--env OSCLASS_DATABASE_PASSWORD=bitnami \
|
||||
--env OSCLASS_DATABASE_NAME=bitnami_osclass \
|
||||
--network osclass-network \
|
||||
--volume osclass_data:/bitnami/osclass \
|
||||
bitnami/osclass:latest
|
||||
```
|
||||
|
||||
Access your application at [http://your-ip/](http://your-ip/)
|
||||
|
||||
> **NOTE**:
|
||||
>
|
||||
> To login to your Osclass Administration panel, go to [http://your-ip/oc-admin/](http://your-ip/oc-admin/).
|
||||
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.
|
||||
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 persistence you should mount a volume at the `/bitnami` path. Additionally you should mount a volume for [persistence of the MariaDB data](https://github.com/bitnami/bitnami-docker-mariadb#persisting-your-database).
|
||||
For persistence you should mount a directory at the `/bitnami/osclass` 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 MariaDB data](https://github.com/bitnami/bitnami-docker-mariadb#persisting-your-database).
|
||||
|
||||
The above examples define docker volumes namely `mariadb_data` and `osclass_data`. The Osclass application state will persist as long as these volumes are not removed.
|
||||
The above examples define the Docker volumes named `mariadb_data` and `osclass_data`. The Osclass application state will persist as long as volumes are not removed.
|
||||
|
||||
To avoid inadvertent removal of these volumes 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.
|
||||
To avoid inadvertent removal of volumes, 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 host directories as data volumes with Docker Compose
|
||||
|
||||
The following `docker-compose.yml` template demonstrates the use of host directories as data volumes.
|
||||
This requires a minor change to the [`docker-compose.yml`](https://github.com/bitnami/bitnami-docker-osclass/blob/master/docker-compose.yml) file present in this repository:
|
||||
|
||||
```yaml
|
||||
version: '2'
|
||||
|
||||
services:
|
||||
mariadb:
|
||||
image: 'bitnami/mariadb:latest'
|
||||
environment:
|
||||
- ALLOW_EMPTY_PASSWORD=yes
|
||||
- MARIADB_USER=bn_osclass
|
||||
- MARIADB_DATABASE=bitnami_osclass
|
||||
volumes:
|
||||
- /path/to/mariadb-persistence:/bitnami
|
||||
osclass:
|
||||
image: bitnami/osclass:latest
|
||||
environment:
|
||||
- OSCLASS_DATABASE_USER=bn_osclass
|
||||
- OSCLASS_DATABASE_NAME=bitnami_osclass
|
||||
- ALLOW_EMPTY_PASSWORD=yes
|
||||
depends_on:
|
||||
- mariadb
|
||||
ports:
|
||||
- '80:80'
|
||||
- '443:443'
|
||||
volumes:
|
||||
- /path/to/osclass-persistence:/bitnami
|
||||
```diff
|
||||
mariadb:
|
||||
...
|
||||
volumes:
|
||||
- - 'mariadb_data:/bitnami/mariadb'
|
||||
+ - /path/to/mariadb-persistence:/bitnami/mariadb
|
||||
...
|
||||
osclass:
|
||||
...
|
||||
volumes:
|
||||
- - 'osclass_data:/bitnami/osclass'
|
||||
+ - /path/to/osclass-persistence:/bitnami/osclass
|
||||
...
|
||||
-volumes:
|
||||
- mariadb_data:
|
||||
- driver: local
|
||||
- osclass_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
|
||||
|
||||
1. Create a network (if it does not exist)
|
||||
|
||||
```console
|
||||
$ docker network create osclass-tier
|
||||
```
|
||||
|
||||
2. Create a MariaDB container with host volume
|
||||
|
||||
```console
|
||||
$ docker run -d --name mariadb \
|
||||
-e ALLOW_EMPTY_PASSWORD=yes \
|
||||
-e MARIADB_USER=bn_osclass \
|
||||
-e MARIADB_DATABASE=bitnami_osclass \
|
||||
--net osclass-tier \
|
||||
--volume /path/to/mariadb-persistence:/bitnami \
|
||||
bitnami/mariadb:latest
|
||||
```
|
||||
|
||||
3. Create the Osclass container with host volumes
|
||||
|
||||
```console
|
||||
$ docker run -d --name osclass -p 80:80 -p 443:443 \
|
||||
-e ALLOW_EMPTY_PASSWORD=yes \
|
||||
-e OSCLASS_DATABASE_USER=bn_osclass \
|
||||
-e OSCLASS_DATABASE_NAME=bitnami_osclass \
|
||||
--net osclass-tier \
|
||||
--volume /path/to/osclass-persistence:/bitnami \
|
||||
bitnami/osclass:latest
|
||||
```
|
||||
|
||||
# Upgrading Osclass
|
||||
|
||||
Bitnami provides up-to-date versions of MariaDB and Osclass, 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 Osclass container. For the MariaDB upgrade see https://github.com/bitnami/bitnami-docker-mariadb/blob/master/README.md#upgrade-this-image
|
||||
|
||||
1. Get the updated images:
|
||||
|
||||
```console
|
||||
$ docker pull bitnami/osclass:latest
|
||||
```
|
||||
|
||||
2. Stop your container
|
||||
|
||||
* For docker-compose: `$ docker-compose stop osclass`
|
||||
* For manual execution: `$ docker stop osclass`
|
||||
|
||||
3. Take a snapshot of the application state
|
||||
#### Step 1: Create a network (if it does not exist)
|
||||
|
||||
```console
|
||||
$ rsync -a /path/to/osclass-persistence /path/to/osclass-persistence.bkp.$(date +%Y%m%d-%H.%M.%S)
|
||||
$ docker network create osclass-network
|
||||
```
|
||||
|
||||
Additionally, [snapshot the MariaDB data](https://github.com/bitnami/bitnami-docker-mariadb#step-2-stop-and-backup-the-currently-running-container)
|
||||
#### Step 2. Create a MariaDB container with host volume
|
||||
|
||||
You can use these snapshots to restore the application state should the upgrade fail.
|
||||
```console
|
||||
$ docker run -d --name mariadb \
|
||||
--env ALLOW_EMPTY_PASSWORD=yes \
|
||||
--env MARIADB_USER=bn_osclass \
|
||||
--env MARIADB_PASSWORD=bitnami \
|
||||
--env MARIADB_DATABASE=bitnami_osclass \
|
||||
--network osclass-network \
|
||||
--volume /path/to/mariadb-persistence:/bitnami/mariadb \
|
||||
bitnami/mariadb:latest
|
||||
```
|
||||
|
||||
4. Remove the stopped container
|
||||
#### Step 3. Create the Osclass container with host volumes
|
||||
|
||||
* For docker-compose: `$ docker-compose rm osclass`
|
||||
* For manual execution: `$ docker rm osclass`
|
||||
```console
|
||||
$ docker run -d --name osclass \
|
||||
-p 8080:8080 -p 8443:8443 \
|
||||
--env ALLOW_EMPTY_PASSWORD=yes \
|
||||
--env OSCLASS_DATABASE_USER=bn_osclass \
|
||||
--env OSCLASS_DATABASE_PASSWORD=bitnami \
|
||||
--env OSCLASS_DATABASE_NAME=bitnami_osclass \
|
||||
--network osclass-network \
|
||||
--volume /path/to/osclass-persistence:/bitnami/osclass \
|
||||
bitnami/osclass:latest
|
||||
```
|
||||
|
||||
5. Run the new image
|
||||
## Configuration
|
||||
|
||||
* For docker-compose: `$ docker-compose up osclass`
|
||||
* For manual execution ([mount](#mount-persistent-folders-manually) the directories if needed): `docker run --name osclass bitnami/osclass:latest`
|
||||
### Environment variables
|
||||
|
||||
# Configuration
|
||||
When you start the Osclass 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:
|
||||
|
||||
## Environment variables
|
||||
- For docker-compose add the variable name and value under the application section in the [`docker-compose.yml`](https://github.com/bitnami/bitnami-docker-osclass/blob/master/docker-compose.yml) file present in this repository:
|
||||
|
||||
The Osclass instance can be customized by specifying environment variables on the first run. The following environment values are provided to custom Osclass:
|
||||
```yaml
|
||||
osclass:
|
||||
...
|
||||
environment:
|
||||
- OSCLASS_PASSWORD=my_password
|
||||
...
|
||||
```
|
||||
|
||||
- For manual execution add a `--env` option with each variable and value:
|
||||
|
||||
```console
|
||||
$ docker run -d --name osclass -p 80:8080 -p 443:8443 \
|
||||
--env OSCLASS_PASSWORD=my_password \
|
||||
--network osclass-tier \
|
||||
--volume /path/to/osclass-persistence:/bitnami \
|
||||
bitnami/osclass:latest
|
||||
```
|
||||
|
||||
Available environment variables:
|
||||
|
||||
##### User and Site configuration
|
||||
|
||||
- `APACHE_HTTP_PORT_NUMBER`: Port used by Apache for HTTP. Default: **8080**
|
||||
- `APACHE_HTTPS_PORT_NUMBER`: Port used by Apache for HTTPS. Default: **8443**
|
||||
- `OSCLASS_USERNAME`: Osclass application username. Default: **user**
|
||||
- `OSCLASS_PASSWORD`: Osclass application password. Default: **bitnami1**
|
||||
- `OSCLASS_PASSWORD`: Osclass application password. Default: **bitnami**
|
||||
- `OSCLASS_EMAIL`: Osclass application email. Default: **user@example.com**
|
||||
- `OSCLASS_WEB_TITLE`: Osclass application title. Default: **Sample Web Page**
|
||||
- `OSCLASS_HOST`: Osclass application IP or domain. Default: **127.0.0.1**
|
||||
- `OSCLASS_PING_ENGINES`: Allow site to appear in search engines. Default: **1**
|
||||
- `OSCLASS_SAVE_STATS`: Automatically send usage statistics and crash reports to Osclass. Default: **1**
|
||||
- `OSCLASS_SKIP_BOOTSTRAP`: Whether to perform initial bootstrapping for the application. This is necessary in case you use a database that already has Osclass data. Default: **no**
|
||||
|
||||
##### Use an existing database
|
||||
|
||||
- `MARIADB_HOST`: Hostname for MariaDB server. Default: **mariadb**
|
||||
- `MARIADB_PORT_NUMBER`: Port used by MariaDB server. Default: **3306**
|
||||
##### Database connection configuration
|
||||
- `OSCLASS_DATABASE_HOST`: Hostname for the MariaDB or MySQL server. Default: **mariadb**
|
||||
- `OSCLASS_DATABASE_PORT_NUMBER`: Port used by the MariaDB or MySQL server. Default: **3306**
|
||||
- `OSCLASS_DATABASE_NAME`: Database name that Osclass will use to connect with the database. Default: **bitnami_osclass**
|
||||
- `OSCLASS_DATABASE_USER`: Database user that Osclass will use to connect with the database. Default: **bn_osclass**
|
||||
- `OSCLASS_DATABASE_PASSWORD`: Database password that Osclass will use to connect with the database. No defaults.
|
||||
@@ -271,127 +238,225 @@ The Osclass instance can be customized by specifying environment variables on th
|
||||
|
||||
##### Create a database for Osclass using mysql-client
|
||||
|
||||
- `MARIADB_HOST`: Hostname for MariaDB server. Default: **mariadb**
|
||||
- `MARIADB_PORT_NUMBER`: Port used by MariaDB server. Default: **3306**
|
||||
- `MARIADB_ROOT_USER`: Database admin user. Default: **root**
|
||||
- `MARIADB_ROOT_PASSWORD`: Database password for the `MARIADB_ROOT_USER` user. No defaults.
|
||||
- `MYSQL_CLIENT_DATABASE_HOST`: Hostname for the MariaDB or MySQL server. Default: **mariadb**
|
||||
- `MYSQL_CLIENT_DATABASE_PORT_NUMBER`: Port used by the MariaDB or MySQL server. Default: **3306**
|
||||
- `MYSQL_CLIENT_DATABASE_ROOT_USER`: Database admin user. Default: **root**
|
||||
- `MYSQL_CLIENT_DATABASE_ROOT_PASSWORD`: Database password for the database admin user. No defaults.
|
||||
- `MYSQL_CLIENT_CREATE_DATABASE_NAME`: New database to be created by the mysql client module. No defaults.
|
||||
- `MYSQL_CLIENT_CREATE_DATABASE_USER`: New database user to be created by the mysql client module. No defaults.
|
||||
- `MYSQL_CLIENT_CREATE_DATABASE_PASSWORD`: Database password for the `MYSQL_CLIENT_CREATE_DATABASE_USER` user. No defaults.
|
||||
- `MYSQL_CLIENT_CREATE_DATABASE_CHARACTER_SET`: Character set to use for the new database. No defaults.
|
||||
- `MYSQL_CLIENT_CREATE_DATABASE_COLLATE`: Database collation to use for the new database. No defaults.
|
||||
- `MYSQL_CLIENT_ENABLE_SSL`: Whether to enable SSL connections for the new database. Default: **no**
|
||||
- `MYSQL_CLIENT_SSL_CA_FILE`: Path to the SSL CA file for the new database. No defaults
|
||||
- `ALLOW_EMPTY_PASSWORD`: It can be used to allow blank passwords. Default: **no**
|
||||
|
||||
##### SMTP Configuration
|
||||
|
||||
To configure Osclass to send email using SMTP you can set the following environment variables:
|
||||
|
||||
- `OSCLASS_SMTP_HOST`: SMTP host.
|
||||
- `OSCLASS_SMTP_PORT`: SMTP port.
|
||||
- `OSCLASS_SMTP_USER`: SMTP account user.
|
||||
- `OSCLASS_SMTP_PASSWORD`: SMTP account password.
|
||||
|
||||
##### PHP configuration
|
||||
|
||||
- `PHP_ENABLE_OPCACHE`: Enable OPcache for PHP scripts. Default: **yes**
|
||||
- `PHP_EXPOSE_PHP`: Enables HTTP header with PHP version. No default.
|
||||
- `PHP_MAX_EXECUTION_TIME`: Maximum execution time for PHP scripts. No default.
|
||||
- `PHP_MAX_INPUT_TIME`: Maximum input time for PHP scripts. No default.
|
||||
- `PHP_MAX_INPUT_VARS`: Maximum amount of input variables for PHP scripts. No default.
|
||||
- `PHP_MEMORY_LIMIT`: Memory limit for PHP scripts. Default: **256M**
|
||||
- `PHP_POST_MAX_SIZE`: Maximum size for PHP POST requests. No default.
|
||||
- `PHP_UPLOAD_MAX_FILESIZE`: Maximum file size for PHP uploads. No default.
|
||||
|
||||
If you want to add a new environment variable:
|
||||
#### Examples
|
||||
|
||||
### Specifying Environment variables using Docker Compose
|
||||
##### SMTP configuration using a Gmail account
|
||||
|
||||
```yaml
|
||||
version: '2'
|
||||
This would be an example of SMTP configuration using a Gmail account:
|
||||
|
||||
services:
|
||||
mariadb:
|
||||
image: 'bitnami/mariadb:latest'
|
||||
environment:
|
||||
- MARIADB_USER=bn_osclass
|
||||
- MARIADB_DATABASE=bitnami_osclass
|
||||
- ALLOW_EMPTY_PASSWORD=yes
|
||||
volumes:
|
||||
- mariadb_data:/bitnami
|
||||
osclass:
|
||||
image: bitnami/osclass:latest
|
||||
depends_on:
|
||||
- mariadb
|
||||
ports:
|
||||
- '80:80'
|
||||
- '443:443'
|
||||
environment:
|
||||
- OSCLASS_PASSWORD=my_password
|
||||
- MARIADB_HOST=mariadb
|
||||
- MARIADB_PORT_NUMBER=3306
|
||||
- OSCLASS_DATABASE_USER=bn_osclass
|
||||
- OSCLASS_DATABASE_NAME=bitnami_osclass
|
||||
- ALLOW_EMPTY_PASSWORD=yes
|
||||
volumes:
|
||||
- osclass_data:/bitnami
|
||||
volumes:
|
||||
mariadb_data:
|
||||
driver: local
|
||||
osclass_data:
|
||||
driver: local
|
||||
```
|
||||
- Modify the [`docker-compose.yml`](https://github.com/bitnami/bitnami-docker-osclass/blob/master/docker-compose.yml) file present in this repository:
|
||||
|
||||
### Specifying Environment variables on the Docker command line
|
||||
```yaml
|
||||
osclass:
|
||||
...
|
||||
environment:
|
||||
- OSCLASS_DATABASE_USER=bn_osclass
|
||||
- OSCLASS_DATABASE_NAME=bitnami_osclass
|
||||
- ALLOW_EMPTY_PASSWORD=yes
|
||||
- OSCLASS_SMTP_HOST=smtp.gmail.com
|
||||
- OSCLASS_SMTP_PORT=587
|
||||
- OSCLASS_SMTP_USER=your_email@gmail.com
|
||||
- OSCLASS_SMTP_PASSWORD=your_password
|
||||
...
|
||||
```
|
||||
|
||||
- For manual execution:
|
||||
|
||||
```console
|
||||
$ docker run -d --name osclass -p 80:8080 -p 443:8443 \
|
||||
--env OSCLASS_DATABASE_USER=bn_osclass \
|
||||
--env OSCLASS_DATABASE_NAME=bitnami_osclass \
|
||||
--env OSCLASS_SMTP_HOST=smtp.gmail.com \
|
||||
--env OSCLASS_SMTP_PORT=587 \
|
||||
--env OSCLASS_SMTP_USER=your_email@gmail.com \
|
||||
--env OSCLASS_SMTP_PASSWORD=your_password \
|
||||
--network osclass-tier \
|
||||
--volume /path/to/osclass-persistence:/bitnami \
|
||||
bitnami/osclass:latest
|
||||
```
|
||||
|
||||
##### Connect Osclass container to an existing database
|
||||
|
||||
The Bitnami Osclass container supports connecting the Osclass application to an external database. This would be an example of using an external database for Osclass.
|
||||
|
||||
- Modify the [`docker-compose.yml`](https://github.com/bitnami/bitnami-docker-osclass/blob/master/docker-compose.yml) file present in this repository:
|
||||
|
||||
```diff
|
||||
osclass:
|
||||
...
|
||||
environment:
|
||||
- - OSCLASS_DATABASE_HOST=mariadb
|
||||
+ - OSCLASS_DATABASE_HOST=mariadb_host
|
||||
- OSCLASS_DATABASE_PORT_NUMBER=3306
|
||||
- OSCLASS_DATABASE_NAME=osclass_db
|
||||
- OSCLASS_DATABASE_USER=osclass_user
|
||||
- - ALLOW_EMPTY_PASSWORD=yes
|
||||
+ - OSCLASS_DATABASE_PASSWORD=osclass_password
|
||||
...
|
||||
```
|
||||
|
||||
- For manual execution:
|
||||
|
||||
```console
|
||||
$ docker run -d --name osclass\
|
||||
-p 8080:8080 -p 8443:8443 \
|
||||
--network osclass-network \
|
||||
--env OSCLASS_DATABASE_HOST=mariadb_host \
|
||||
--env OSCLASS_DATABASE_PORT_NUMBER=3306 \
|
||||
--env OSCLASS_DATABASE_NAME=osclass_db \
|
||||
--env OSCLASS_DATABASE_USER=osclass_user \
|
||||
--env OSCLASS_DATABASE_PASSWORD=osclass_password \
|
||||
--volume osclass_data:/bitnami/osclass \
|
||||
bitnami/osclass:latest
|
||||
```
|
||||
|
||||
In case the database already contains data from a previous Osclass installation, you need to set the variable `OSCLASS_SKIP_BOOTSTRAP` to `yes`. Otherwise, the container would execute the installation wizard and could modify the existing data in the database. Note that, when setting `OSCLASS_SKIP_BOOTSTRAP` to `yes`, values for environment variables such as `OSCLASS_USERNAME`, `OSCLASS_PASSWORD` or `OSCLASS_EMAIL` will be ignored.
|
||||
|
||||
## Logging
|
||||
|
||||
The Bitnami Osclass Docker image sends the container logs to `stdout`. To view the logs:
|
||||
|
||||
```console
|
||||
$ docker run -d --name osclass -p 80:80 -p 443:443 \
|
||||
--net osclass-tier \
|
||||
--env OSCLASS_PASSWORD=my_password \
|
||||
-e ALLOW_EMPTY_PASSWORD=yes \
|
||||
-e OSCLASS_DATABASE_USER=bn_osclass \
|
||||
-e OSCLASS_DATABASE_NAME=bitnami_osclass \
|
||||
-e OSCLASS_PASSWORD=my_password \
|
||||
--volume osclass_data:/bitnami \
|
||||
bitnami/osclass:latest
|
||||
$ docker logs osclass
|
||||
```
|
||||
|
||||
### SMTP Configuration
|
||||
Or using Docker Compose:
|
||||
|
||||
To configure Osclass to send email using SMTP you can set the following environment variables:
|
||||
- `SMTP_HOST`: Host for outgoing SMTP email.
|
||||
- `SMTP_PORT`: Port for outgoing SMTP email.
|
||||
- `SMTP_USER`: User of SMTP used for authentication (likely email).
|
||||
- `SMTP_PASSWORD`: Password for SMTP.
|
||||
- `SMTP_PROTOCOL`: Secure connection protocol to use for SMTP [tls, ssl, none].
|
||||
|
||||
This would be an example of SMTP configuration using a GMail account:
|
||||
|
||||
* docker-compose (application part):
|
||||
|
||||
```yaml
|
||||
osclass:
|
||||
image: bitnami/osclass:latest
|
||||
ports:
|
||||
- 80:80
|
||||
environment:
|
||||
- MARIADB_HOST=mariadb
|
||||
- MARIADB_PORT_NUMBER=3306
|
||||
- OSCLASS_DATABASE_USER=bn_osclass
|
||||
- OSCLASS_DATABASE_NAME=bitnami_osclass
|
||||
- SMTP_HOST=smtp.gmail.com
|
||||
- SMTP_PORT=587
|
||||
- SMTP_USER=your_email@gmail.com
|
||||
- SMTP_PASSWORD=your_password
|
||||
- SMTP_PROTOCOL=tls
|
||||
volumes:
|
||||
- osclass_data:/bitnami
|
||||
```console
|
||||
$ docker-compose logs osclass
|
||||
```
|
||||
|
||||
* For manual execution:
|
||||
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.
|
||||
|
||||
```console
|
||||
$ docker run -d --name osclass -p 80:80 -p 443:443 \
|
||||
--net osclass-tier \
|
||||
-e MARIADB_HOST=mariadb \
|
||||
-e MARIADB_PORT_NUMBER=3306 \
|
||||
-e OSCLASS_DATABASE_USER=bn_osclass \
|
||||
-e OSCLASS_DATABASE_NAME=bitnami_osclass \
|
||||
-e SMTP_HOST=smtp.gmail.com \
|
||||
-e SMTP_PORT=587 \
|
||||
-e SMTP_PROTOCOL=tls \
|
||||
-e SMTP_USER=your_email@gmail.com \
|
||||
-e SMTP_PASSWORD=your_password \
|
||||
--volume osclass_data:/bitnami \
|
||||
bitnami/osclass:latest
|
||||
```
|
||||
## Maintenance
|
||||
|
||||
# Customize this image
|
||||
### 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 osclass
|
||||
```
|
||||
|
||||
Or using Docker Compose:
|
||||
|
||||
```console
|
||||
$ docker-compose stop osclass
|
||||
```
|
||||
|
||||
#### 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/osclass-backups:/backups --volumes-from osclass busybox \
|
||||
cp -a /bitnami/osclass /backups/latest
|
||||
```
|
||||
|
||||
### Restoring a backup
|
||||
|
||||
Restoring a backup is as simple as mounting the backup as volumes in the containers.
|
||||
|
||||
For the MariaDB database container:
|
||||
|
||||
```diff
|
||||
$ docker run -d --name mariadb \
|
||||
...
|
||||
- --volume /path/to/mariadb-persistence:/bitnami/mariadb \
|
||||
+ --volume /path/to/mariadb-backups/latest:/bitnami/mariadb \
|
||||
bitnami/mariadb:latest
|
||||
```
|
||||
|
||||
For the Osclass container:
|
||||
|
||||
```diff
|
||||
$ docker run -d --name osclass \
|
||||
...
|
||||
- --volume /path/to/osclass-persistence:/bitnami/osclass \
|
||||
+ --volume /path/to/osclass-backups/latest:/bitnami/osclass \
|
||||
bitnami/osclass:latest
|
||||
```
|
||||
|
||||
### Upgrade this image
|
||||
|
||||
Bitnami provides up-to-date versions of MariaDB and Osclass, 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 Osclass container. For the MariaDB upgrade see: https://github.com/bitnami/bitnami-docker-mariadb/blob/master/README.md#upgrade-this-image
|
||||
|
||||
The `bitnami/osclass:latest` tag always points to the most recent release. To get the most recent release you can simple repull the `latest` tag from the Docker Hub with `docker pull bitnami/osclass:latest`. However it is recommended to use [tagged versions](https://hub.docker.com/r/bitnami/osclass/tags/).
|
||||
|
||||
#### Step 1: Get the updated image
|
||||
|
||||
```console
|
||||
$ docker pull bitnami/osclass:latest
|
||||
```
|
||||
|
||||
#### Step 2: Stop the running container
|
||||
|
||||
Stop the currently running container using the command
|
||||
|
||||
```console
|
||||
$ docker-compose stop osclass
|
||||
```
|
||||
|
||||
#### 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 osclass
|
||||
```
|
||||
|
||||
#### 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 Osclass Docker image is designed to be extended so it can be used as the base image for your custom web applications.
|
||||
|
||||
## Extend this image
|
||||
### Extend this image
|
||||
|
||||
Before extending this image, please note there are certain configuration settings you can modify using the original image:
|
||||
|
||||
@@ -418,8 +483,12 @@ Here is an example of extending the image with the following modifications:
|
||||
FROM bitnami/osclass
|
||||
LABEL maintainer "Bitnami <containers@bitnami.com>"
|
||||
|
||||
## Change user to perform privileged actions
|
||||
USER 0
|
||||
## Install 'vim'
|
||||
RUN install_packages vim
|
||||
## Revert to the original non-root user
|
||||
USER 1001
|
||||
|
||||
## Enable mod_ratelimit module
|
||||
RUN sed -i -r 's/#LoadModule ratelimit_module/LoadModule ratelimit_module/' /opt/bitnami/apache/conf/httpd.conf
|
||||
@@ -431,74 +500,74 @@ 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-osclass/blob/master/docker-compose.yml) file present in this repository to add other features:
|
||||
|
||||
```yaml
|
||||
version: '2'
|
||||
services:
|
||||
mariadb:
|
||||
image: 'bitnami/mariadb:10.3'
|
||||
environment:
|
||||
- MARIADB_USER=bn_osclass
|
||||
- MARIADB_DATABASE=bitnami_osclass
|
||||
- ALLOW_EMPTY_PASSWORD=yes
|
||||
volumes:
|
||||
- 'mariadb_data:/bitnami'
|
||||
osclass:
|
||||
build: .
|
||||
environment:
|
||||
- MARIADB_HOST=mariadb
|
||||
- MARIADB_PORT_NUMBER=3306
|
||||
- OSCLASS_HOST=localhost
|
||||
- OSCLASS_DATABASE_USER=bn_osclass
|
||||
- OSCLASS_DATABASE_NAME=bitnami_osclass
|
||||
- ALLOW_EMPTY_PASSWORD=yes
|
||||
ports:
|
||||
- '80:8181'
|
||||
- '443:8143'
|
||||
depends_on:
|
||||
- mariadb
|
||||
volumes:
|
||||
- 'osclass_data:/bitnami'
|
||||
volumes:
|
||||
mariadb_data:
|
||||
driver: local
|
||||
osclass_data:
|
||||
driver: local
|
||||
```diff
|
||||
osclass:
|
||||
- image: bitnami/osclass:latest
|
||||
+ build: .
|
||||
ports:
|
||||
- - '80:8080'
|
||||
- - '443:8443'
|
||||
+ - '80:8181'
|
||||
+ - '443:8143'
|
||||
environment:
|
||||
+ - PHP_MEMORY_LIMIT=512m
|
||||
...
|
||||
```
|
||||
## Notable changes
|
||||
|
||||
### 4.4.0-debian-10-r12
|
||||
|
||||
- The size of the container image has been decreased.
|
||||
- The configuration logic is now based on Bash scripts in the *rootfs/* folder.
|
||||
- The Osclass container image has been migrated to a "non-root" user approach. Previously the container ran as the `root` user and the Apache daemon was started as the `daemon` user. From now on, both the container and the Apache daemon run as user `1001`. You can revert this behavior by changing `USER 1001` to `USER root` in the Dockerfile, or `user: root` in `docker-compose.yml`. Consequences:
|
||||
- The HTTP/HTTPS ports exposed by the container are now `8080/8443` instead of `80/443`.
|
||||
- Backwards compatibility is not guaranteed when data is persisted using docker or docker-compose. We highly recommend migrating the Osclass site by exporting its content, and importing it on a new Osclass container. Follow the steps in [Backing up your container](#backing-up-your-container) and [Restoring a backup](#restoring-a-backup) to migrate the data between the old and new container.
|
||||
|
||||
To upgrade a previous Bitnami Osclass container image, which did not support non-root, the easiest way is to start the new image as a root user and updating the port numbers. Modify your docker-compose.yml file as follows:
|
||||
|
||||
```diff
|
||||
- ALLOW_EMPTY_PASSWORD=yes
|
||||
+ user: root
|
||||
ports:
|
||||
- - '80:80'
|
||||
- - '443:443'
|
||||
+ - '80:8080'
|
||||
+ - '443:8443'
|
||||
volumes:
|
||||
```
|
||||
|
||||
# Notable Changes
|
||||
|
||||
## 3.7.4-debian-9-r254 and 3.7.4-ol-7-r322
|
||||
### 3.7.4-debian-9-r254 and 3.7.4-ol-7-r322
|
||||
|
||||
- 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`.
|
||||
|
||||
# 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-osclass/issues), or submit a [pull request](https://github.com/bitnami/bitnami-docker-osclass/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-osclass/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-osclass/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_IMAGE_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-2021 Bitnami
|
||||
Copyright (c) 2021 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>
|
||||
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,
|
||||
|
||||
@@ -2,28 +2,27 @@ version: '2'
|
||||
services:
|
||||
mariadb:
|
||||
image: docker.io/bitnami/mariadb:10.3
|
||||
volumes:
|
||||
- 'mariadb_data:/bitnami/mariadb'
|
||||
environment:
|
||||
- ALLOW_EMPTY_PASSWORD=yes
|
||||
- MARIADB_USER=bn_osclass
|
||||
- MARIADB_DATABASE=bitnami_osclass
|
||||
- ALLOW_EMPTY_PASSWORD=yes
|
||||
volumes:
|
||||
- 'mariadb_data:/bitnami'
|
||||
osclass:
|
||||
image: docker.io/bitnami/osclass:4
|
||||
environment:
|
||||
- MARIADB_HOST=mariadb
|
||||
- MARIADB_PORT_NUMBER=3306
|
||||
- OSCLASS_HOST=localhost
|
||||
- OSCLASS_DATABASE_USER=bn_osclass
|
||||
- OSCLASS_DATABASE_NAME=bitnami_osclass
|
||||
- ALLOW_EMPTY_PASSWORD=yes
|
||||
ports:
|
||||
- '80:80'
|
||||
- '443:443'
|
||||
- '80:8080'
|
||||
- '443:8443'
|
||||
volumes:
|
||||
- 'osclass_data:/bitnami/osclass'
|
||||
depends_on:
|
||||
- mariadb
|
||||
volumes:
|
||||
- 'osclass_data:/bitnami'
|
||||
environment:
|
||||
- ALLOW_EMPTY_PASSWORD=yes
|
||||
- OSCLASS_DATABASE_HOST=mariadb
|
||||
- OSCLASS_DATABASE_PORT_NUMBER=3306
|
||||
- OSCLASS_DATABASE_USER=bn_osclass
|
||||
- OSCLASS_DATABASE_NAME=bitnami_osclass
|
||||
volumes:
|
||||
mariadb_data:
|
||||
driver: local
|
||||
|
||||
Reference in New Issue
Block a user