mirror of
https://github.com/bitnami/containers.git
synced 2026-02-16 10:27:16 +08:00
3.7.1-6046-debian-10-r0 release
This commit is contained in:
@@ -1,24 +1,29 @@
|
||||
FROM docker.io/bitnami/minideb:buster
|
||||
LABEL maintainer "Bitnami <containers@bitnami.com>"
|
||||
|
||||
ENV PATH="/opt/bitnami/java/bin:/opt/bitnami/tomcat/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 fontconfig fonts-dejavu-extra gzip libaudit1 libc6 libcap-ng0 libgcc1 libicu63 libjemalloc2 liblzma5 libncurses6 libpam0g libssl1.1 libstdc++6 libtinfo6 libxml2 procps sudo tar zlib1g
|
||||
RUN /build/bitnami-user.sh
|
||||
RUN /build/install-nami.sh
|
||||
RUN bitnami-pkg install java-11.0.12-0 --checksum 14c1274e93b1135d4d1b82ad7985fc2fa7f5d0689b6da18e0c94da37407cd4ea
|
||||
RUN bitnami-pkg unpack tomcat-9.0.52-0 --checksum 3f07c11421321e7801af26b2e8977133317af2c885566e1ea94288bba2425477
|
||||
RUN bitnami-pkg unpack mysql-client-10.3.31-0 --checksum 92b99c64a3ffe10fd94ef9ecd94d2dd65a172404c726093eb50b3b293523559d
|
||||
RUN bitnami-pkg install tini-0.19.0-1 --checksum 9b1f1c095944bac88a62c1b63f3bff1bb123aa7ccd371c908c0e5b41cec2528d
|
||||
RUN bitnami-pkg unpack reportserver-3.7.0-6044-1 --checksum 2fee0935348a9a26425cc666ead61b7cae8ac7f1e68944a3c355a1ad5f8251ba
|
||||
RUN bitnami-pkg install gosu-1.13.0-0 --checksum fd7257c2736164d02832dbf72e2c1ed9d875bf3e32f0988520796bc503330129
|
||||
RUN install_packages acl ca-certificates curl fontconfig fonts-dejavu-extra gzip libaudit1 libc6 libcap-ng0 libgcc1 libicu63 libjemalloc2 liblzma5 libncurses6 libpam0g libssl1.1 libstdc++6 libtinfo6 libxml2 procps tar xmlstarlet zlib1g
|
||||
RUN . /opt/bitnami/scripts/libcomponent.sh && component_unpack "java" "11.0.12-0" --checksum 14c1274e93b1135d4d1b82ad7985fc2fa7f5d0689b6da18e0c94da37407cd4ea
|
||||
RUN . /opt/bitnami/scripts/libcomponent.sh && component_unpack "tomcat" "9.0.52-1" --checksum 68712f08805abefe3067cd796a2992156ba07313b3fcefe580eb45d1aa808260
|
||||
RUN . /opt/bitnami/scripts/libcomponent.sh && component_unpack "mysql-client" "10.3.31-0" --checksum 92b99c64a3ffe10fd94ef9ecd94d2dd65a172404c726093eb50b3b293523559d
|
||||
RUN . /opt/bitnami/scripts/libcomponent.sh && component_unpack "reportserver" "3.7.1-6046-0" --checksum 880bf1ae14f7ccfc3635d3920ff66830e787e1290ca909b909a0b5613a473d8b
|
||||
RUN . /opt/bitnami/scripts/libcomponent.sh && component_unpack "render-template" "1.0.0-3" --checksum 8179ad1371c9a7d897fe3b1bf53bbe763f94edafef19acad2498dd48b3674efe
|
||||
RUN . /opt/bitnami/scripts/libcomponent.sh && component_unpack "gosu" "1.14.0-0" --checksum 3e6fc37ca073b10a73a804d39c2f0c028947a1a596382a4f8ebe43dfbaa3a25e
|
||||
RUN chmod g+rwX /opt/bitnami
|
||||
|
||||
COPY rootfs /
|
||||
RUN /opt/bitnami/scripts/mysql-client/postunpack.sh
|
||||
RUN /opt/bitnami/scripts/reportserver/postunpack.sh
|
||||
RUN /opt/bitnami/scripts/tomcat/postunpack.sh
|
||||
ENV ALLOW_EMPTY_PASSWORD="no" \
|
||||
BITNAMI_APP_NAME="reportserver" \
|
||||
BITNAMI_IMAGE_VERSION="3.7.0-6044-debian-10-r51" \
|
||||
BITNAMI_IMAGE_VERSION="3.7.1-6046-debian-10-r0" \
|
||||
MARIADB_HOST="mariadb" \
|
||||
MARIADB_PORT_NUMBER="3306" \
|
||||
MARIADB_ROOT_PASSWORD="" \
|
||||
@@ -29,28 +34,11 @@ ENV ALLOW_EMPTY_PASSWORD="no" \
|
||||
MYSQL_CLIENT_CREATE_DATABASE_USER="" \
|
||||
MYSQL_CLIENT_ENABLE_SSL="no" \
|
||||
MYSQL_CLIENT_SSL_CA_FILE="" \
|
||||
OS_ARCH="amd64" \
|
||||
OS_FLAVOUR="debian-10" \
|
||||
OS_NAME="linux" \
|
||||
REPORTSERVER_CRYPTPASSPHRASE="" \
|
||||
REPORTSERVER_CRYPTSALT="" \
|
||||
REPORTSERVER_DATABASE_NAME="bitnami_reportserver" \
|
||||
REPORTSERVER_DATABASE_PASSWORD="" \
|
||||
REPORTSERVER_DATABASE_USER="bn_reportserver" \
|
||||
REPORTSERVER_EMAIL="user@example.com" \
|
||||
REPORTSERVER_INSTALLDEMODATA="" \
|
||||
REPORTSERVER_JAVA_OPTS="-Djava.awt.headless=true -Xmx4g -XX:+UseConcMarkSweepGC -XX:MaxPermSize=512M -Dfile.encoding=UTF8" \
|
||||
REPORTSERVER_PASSWORD="bitnami" \
|
||||
REPORTSERVER_USERNAME="user" \
|
||||
SMTP_HOST="" \
|
||||
SMTP_PASSWORD="" \
|
||||
SMTP_PORT="" \
|
||||
SMTP_SSL_ENABLE="false" \
|
||||
SMTP_TLS_ENABLE="false" \
|
||||
SMTP_TLS_REQUIRED="false" \
|
||||
SMTP_USER=""
|
||||
PATH="/opt/bitnami/java/bin:/opt/bitnami/tomcat/bin:/opt/bitnami/mysql/bin:/opt/bitnami/common/bin:$PATH" \
|
||||
TOMCAT_START_RETRIES="60"
|
||||
|
||||
EXPOSE 8080 8443
|
||||
EXPOSE 8009 8080 8443
|
||||
|
||||
ENTRYPOINT [ "/app-entrypoint.sh" ]
|
||||
CMD [ "nami", "start", "--foreground", "tomcat" ]
|
||||
USER 1001
|
||||
ENTRYPOINT [ "/opt/bitnami/scripts/reportserver/entrypoint.sh" ]
|
||||
CMD [ "/opt/bitnami/scripts/tomcat/run.sh" ]
|
||||
|
||||
@@ -1,27 +1,27 @@
|
||||
version: '2'
|
||||
|
||||
services:
|
||||
mariadb:
|
||||
image: docker.io/bitnami/mariadb:10.3
|
||||
image: docker.io/bitnami/mariadb:10.4
|
||||
volumes:
|
||||
- 'mariadb_data:/bitnami/mariadb'
|
||||
environment:
|
||||
- ALLOW_EMPTY_PASSWORD=yes
|
||||
- MARIADB_USER=bn_reportserver
|
||||
- MARIADB_DATABASE=bitnami_reportserver
|
||||
- ALLOW_EMPTY_PASSWORD=yes
|
||||
volumes:
|
||||
- 'mariadb_data:/bitnami'
|
||||
reportserver:
|
||||
image: docker.io/bitnami/reportserver:3
|
||||
environment:
|
||||
- MARIADB_HOST=mariadb
|
||||
- MARIADB_PORT_NUMBER=3306
|
||||
- REPORTSERVER_DATABASE_USER=bn_reportserver
|
||||
- REPORTSERVER_DATABASE_NAME=bitnami_reportserver
|
||||
- ALLOW_EMPTY_PASSWORD=yes
|
||||
ports:
|
||||
- '80:8080'
|
||||
- '443:8443'
|
||||
depends_on:
|
||||
- mariadb
|
||||
environment:
|
||||
# ALLOW_EMPTY_PASSWORD is recommended only for development.
|
||||
- ALLOW_EMPTY_PASSWORD=yes
|
||||
- REPORTSERVER_DATABASE_HOST=mariadb
|
||||
- REPORTSERVER_DATABASE_PORT_NUMBER=3306
|
||||
- REPORTSERVER_DATABASE_USER=bn_reportserver
|
||||
- REPORTSERVER_DATABASE_NAME=bitnami_reportserver
|
||||
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
|
||||
@@ -1,10 +1,10 @@
|
||||
{
|
||||
"gosu": {
|
||||
"arch": "amd64",
|
||||
"digest": "fd7257c2736164d02832dbf72e2c1ed9d875bf3e32f0988520796bc503330129",
|
||||
"digest": "3e6fc37ca073b10a73a804d39c2f0c028947a1a596382a4f8ebe43dfbaa3a25e",
|
||||
"distro": "debian-10",
|
||||
"type": "NAMI",
|
||||
"version": "1.13.0-0"
|
||||
"version": "1.14.0-0"
|
||||
},
|
||||
"java": {
|
||||
"arch": "amd64",
|
||||
@@ -20,25 +20,25 @@
|
||||
"type": "NAMI",
|
||||
"version": "10.3.31-0"
|
||||
},
|
||||
"render-template": {
|
||||
"arch": "amd64",
|
||||
"digest": "8179ad1371c9a7d897fe3b1bf53bbe763f94edafef19acad2498dd48b3674efe",
|
||||
"distro": "debian-10",
|
||||
"type": "NAMI",
|
||||
"version": "1.0.0-3"
|
||||
},
|
||||
"reportserver": {
|
||||
"arch": "amd64",
|
||||
"digest": "2fee0935348a9a26425cc666ead61b7cae8ac7f1e68944a3c355a1ad5f8251ba",
|
||||
"digest": "880bf1ae14f7ccfc3635d3920ff66830e787e1290ca909b909a0b5613a473d8b",
|
||||
"distro": "debian-10",
|
||||
"type": "NAMI",
|
||||
"version": "3.7.0-6044-1"
|
||||
},
|
||||
"tini": {
|
||||
"arch": "amd64",
|
||||
"digest": "9b1f1c095944bac88a62c1b63f3bff1bb123aa7ccd371c908c0e5b41cec2528d",
|
||||
"distro": "debian-10",
|
||||
"type": "NAMI",
|
||||
"version": "0.19.0-1"
|
||||
"version": "3.7.1-6046-0"
|
||||
},
|
||||
"tomcat": {
|
||||
"arch": "amd64",
|
||||
"digest": "3f07c11421321e7801af26b2e8977133317af2c885566e1ea94288bba2425477",
|
||||
"digest": "68712f08805abefe3067cd796a2992156ba07313b3fcefe580eb45d1aa808260",
|
||||
"distro": "debian-10",
|
||||
"type": "NAMI",
|
||||
"version": "9.0.52-0"
|
||||
"version": "9.0.52-1"
|
||||
}
|
||||
}
|
||||
@@ -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,139 @@
|
||||
#!/bin/bash
|
||||
#
|
||||
# Library for managing files
|
||||
|
||||
# shellcheck disable=SC1091
|
||||
|
||||
# Load Generic Libraries
|
||||
. /opt/bitnami/scripts/libos.sh
|
||||
|
||||
# Functions
|
||||
|
||||
########################
|
||||
# Replace a regex-matching string 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
|
||||
local -r 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"
|
||||
}
|
||||
|
||||
########################
|
||||
# Replace a regex-matching multiline string in a file
|
||||
# Arguments:
|
||||
# $1 - filename
|
||||
# $2 - match regex
|
||||
# $3 - substitute regex
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
replace_in_file_multiline() {
|
||||
local filename="${1:?filename is required}"
|
||||
local match_regex="${2:?match regex is required}"
|
||||
local substitute_regex="${3:?substitute regex is required}"
|
||||
|
||||
local result
|
||||
local -r del=$'\001' # Use a non-printable character as a 'sed' delimiter to avoid issues
|
||||
result="$(perl -pe "BEGIN{undef $/;} s${del}${match_regex}${del}${substitute_regex}${del}sg" "$filename")"
|
||||
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"
|
||||
}
|
||||
|
||||
########################
|
||||
# Wait until certain entry is present in a log file
|
||||
# Arguments:
|
||||
# $1 - entry to look for
|
||||
# $2 - log file
|
||||
# $3 - max retries. Default: 12
|
||||
# $4 - sleep between retries (in seconds). Default: 5
|
||||
# Returns:
|
||||
# Boolean
|
||||
#########################
|
||||
wait_for_log_entry() {
|
||||
local -r entry="${1:-missing entry}"
|
||||
local -r log_file="${2:-missing log file}"
|
||||
local -r retries="${3:-12}"
|
||||
local -r interval_time="${4:-5}"
|
||||
local attempt=0
|
||||
|
||||
check_log_file_for_entry() {
|
||||
if ! grep -qE "$entry" "$log_file"; then
|
||||
debug "Entry \"${entry}\" still not present in ${log_file} (attempt $((++attempt))/${retries})"
|
||||
return 1
|
||||
fi
|
||||
}
|
||||
debug "Checking that ${log_file} log file contains entry \"${entry}\""
|
||||
if retry_while check_log_file_for_entry "$retries" "$interval_time"; then
|
||||
debug "Found entry \"${entry}\" in ${log_file}"
|
||||
true
|
||||
else
|
||||
error "Could not find entry \"${entry}\" in ${log_file} after ${retries} retries"
|
||||
debug_execute cat "$log_file"
|
||||
return 1
|
||||
fi
|
||||
}
|
||||
@@ -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,364 @@
|
||||
#!/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}'
|
||||
}
|
||||
|
||||
########################
|
||||
# Create sha1 hash from a string
|
||||
# Arguments:
|
||||
# $1 - string
|
||||
# $2 - algorithm - 1 (default), 224, 256, 384, 512
|
||||
# Returns:
|
||||
# sha1 hash - string
|
||||
#########################
|
||||
generate_sha_hash() {
|
||||
local -r str="${1:?missing input string}"
|
||||
local -r algorithm="${2:-1}"
|
||||
echo -n "$str" | "sha${algorithm}sum" | 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[@]}" -le 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[@]}" -le 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,264 @@
|
||||
#!/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 a boolean 1/0 value
|
||||
# Arguments:
|
||||
# $1 - Value to check
|
||||
# Returns:
|
||||
# Boolean
|
||||
#########################
|
||||
is_1_0_value() {
|
||||
local -r bool="${1:-}"
|
||||
if [[ "$bool" =~ ^[10]$ ]]; 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,431 @@
|
||||
#!/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-proxy-address - Address where to proxy requests
|
||||
# --apache-proxy-configuration - Extra configuration for the proxy
|
||||
# --apache-proxy-http-configuration - Extra configuration for the proxy HTTP vhost
|
||||
# --apache-proxy-https-configuration - Extra configuration for the proxy HTTPS vhost
|
||||
# --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-proxy-configuration \
|
||||
| --apache-proxy-http-configuration \
|
||||
| --apache-proxy-https-configuration \
|
||||
| --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,13 +0,0 @@
|
||||
#!/bin/bash -e
|
||||
|
||||
. /opt/bitnami/base/functions
|
||||
. /opt/bitnami/base/helpers
|
||||
|
||||
print_welcome_page
|
||||
|
||||
if [[ "$1" == "nami" && "$2" == "start" ]] || [[ "$1" == "/init.sh" ]]; then
|
||||
nami_initialize tomcat mysql-client reportserver
|
||||
info "Starting gosu... "
|
||||
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}}"
|
||||
}
|
||||
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,311 @@
|
||||
#!/bin/bash
|
||||
#
|
||||
# Bitnami ReportServer library
|
||||
|
||||
# shellcheck disable=SC1091
|
||||
|
||||
# Load generic libraries
|
||||
. /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/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 REPORTSERVER_* env vars
|
||||
# Globals:
|
||||
# REPORTSERVER_*
|
||||
# Arguments:
|
||||
# None
|
||||
# Returns:
|
||||
# 0 if the validation succeeded, 1 otherwise
|
||||
#########################
|
||||
reportserver_validate() {
|
||||
debug "Validating settings in REPORTSERVER_* 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_valid_port() {
|
||||
local port_var="${1:?missing port variable}"
|
||||
local err
|
||||
if ! err="$(validate_port "${!port_var}")"; then
|
||||
print_validation_error "An invalid port was specified in the environment variable ${port_var}: ${err}."
|
||||
fi
|
||||
}
|
||||
|
||||
# Validate user inputs
|
||||
! is_empty_value "REPORTSERVER_INSTALL_DEMO_DATA" && check_yes_no_value "REPORTSERVER_INSTALL_DEMO_DATA"
|
||||
|
||||
# Validate user data
|
||||
check_empty_value "REPORTSERVER_USERNAME"
|
||||
check_empty_value "REPORTSERVER_PASSWORD"
|
||||
check_empty_value "REPORTSERVER_EMAIL"
|
||||
check_empty_value "REPORTSERVER_FIRST_NAME"
|
||||
check_empty_value "REPORTSERVER_LAST_NAME"
|
||||
|
||||
# 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 "REPORTSERVER_DATABASE_PASSWORD" "REPORTSERVER_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 "$REPORTSERVER_SMTP_HOST"; then
|
||||
for empty_env_var in "REPORTSERVER_SMTP_USER" "REPORTSERVER_SMTP_PASSWORD"; do
|
||||
is_empty_value "${!empty_env_var}" && warn "The ${empty_env_var} environment variable is empty or not set."
|
||||
done
|
||||
is_empty_value "$REPORTSERVER_SMTP_PORT_NUMBER" && print_validation_error "The REPORTSERVER_SMTP_PORT_NUMBER environment variable is empty or not set."
|
||||
! is_empty_value "$REPORTSERVER_SMTP_PORT_NUMBER" && check_valid_port "REPORTSERVER_SMTP_PORT_NUMBER"
|
||||
fi
|
||||
|
||||
return "$error_code"
|
||||
}
|
||||
|
||||
########################
|
||||
# Ensure ReportServer is initialized
|
||||
# Globals:
|
||||
# REPORTSERVER_*
|
||||
# Arguments:
|
||||
# None
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
reportserver_initialize() {
|
||||
local -a mysql_remote_execute_args=("$REPORTSERVER_DATABASE_HOST" "$REPORTSERVER_DATABASE_PORT_NUMBER" "$REPORTSERVER_DATABASE_NAME" "$REPORTSERVER_DATABASE_USER" "$REPORTSERVER_DATABASE_PASSWORD")
|
||||
local -r rsinit_properties="${REPORTSERVER_CONF_DIR}/rsinit.properties"
|
||||
local -r persistence_properties="${REPORTSERVER_CONF_DIR}/persistence.properties"
|
||||
info "Trying to connect to the database server"
|
||||
reportserver_wait_for_mysql_connection "${mysql_remote_execute_args[@]}"
|
||||
|
||||
# ReportServer uses all persistence in the database. So, in order to detect if we are using a persisted installation, we check
|
||||
# if there is content in the database (the databases start with RS_, as it can be seen in the schema files in the ddl/ folder)
|
||||
local -r num_tables=$(echo "SHOW TABLES" | mysql_remote_execute_print_output "${mysql_remote_execute_args[@]}" | grep -c "RS_")
|
||||
|
||||
# ReportServer database configuration
|
||||
# Source: https://reportserver.net/en/guides/config/chapters/configfile-persistenceproperties/
|
||||
info "Configuring ReportServer database"
|
||||
cat <<EOF >>"$persistence_properties"
|
||||
hibernate.connection.username=${REPORTSERVER_DATABASE_USER}
|
||||
hibernate.connection.password=${REPORTSERVER_DATABASE_PASSWORD}
|
||||
hibernate.dialect=net.datenwerke.rs.utils.hibernate.MySQL5Dialect
|
||||
hibernate.connection.driver_class=com.mysql.jdbc.Driver
|
||||
hibernate.connection.url=jdbc:mysql://${REPORTSERVER_DATABASE_HOST}:${REPORTSERVER_DATABASE_PORT_NUMBER}/${REPORTSERVER_DATABASE_NAME}
|
||||
EOF
|
||||
|
||||
if [[ "$num_tables" == "0" ]]; then
|
||||
# Deploy database schema. We only need to do it at first installation as the rs.Environmental validator class will automatically update the schemas on upgrades
|
||||
# Source: https://reportserver.net/en/tutorials/installation-best-practice/#database
|
||||
info "Deploying ReportServer from scratch"
|
||||
info "Creating database schema..."
|
||||
local -r schema_file_path=$(realpath "${REPORTSERVER_BASE_DIR}/ddl/reportserver-RS"*"-schema-MySQL5_CREATE.sql")
|
||||
echo "SOURCE $schema_file_path" | mysql_remote_execute "${mysql_remote_execute_args[@]}"
|
||||
# Mimicking the first boot parameter generation from the wizard, the rsinit.properties
|
||||
# is used at first boot and can be seen in the src/net/datenwerke/rs/installation/InitConfigTask.java file
|
||||
# inside the ReportServer source code
|
||||
# Source: https://github.com/infofabrik/reportserver/blob/main/src/net/datenwerke/rs/installation/InitConfigTask.java
|
||||
info "Configuring first boot parameters"
|
||||
|
||||
if is_boolean_yes "$REPORTSERVER_INSTALL_DEMO_DATA"; then
|
||||
debug "Enabling demo data"
|
||||
cat <<EOF >>"$rsinit_properties"
|
||||
democontent.install=true
|
||||
EOF
|
||||
fi
|
||||
|
||||
info "Configuring user"
|
||||
cat <<EOF >>"$rsinit_properties"
|
||||
usermanager.root.username=${REPORTSERVER_USERNAME}
|
||||
usermanager.root.firstname=${REPORTSERVER_FIRST_NAME}
|
||||
usermanager.root.lastname=${REPORTSERVER_LAST_NAME}
|
||||
usermanager.root.email=${REPORTSERVER_EMAIL}
|
||||
usermanager.root.password=${REPORTSERVER_PASSWORD}
|
||||
EOF
|
||||
|
||||
if ! is_empty_value "$REPORTSERVER_SMTP_HOST"; then
|
||||
info "Configuring SMTP"
|
||||
cat <<EOF >>"$rsinit_properties"
|
||||
cfg.mail.mail_cf.smtp.host=${REPORTSERVER_SMTP_HOST}
|
||||
cfg.mail.mail_cf.smtp.port=${REPORTSERVER_SMTP_PORT_NUMBER}
|
||||
cfg.mail.mail_cf.smtp.username=${REPORTSERVER_SMTP_USER}
|
||||
cfg.mail.mail_cf.smtp.password=${REPORTSERVER_SMTP_PASSWORD}
|
||||
EOF
|
||||
case "$REPORTSERVER_SMTP_PROTOCOL" in
|
||||
ssl)
|
||||
cat <<EOF >>"$rsinit_properties"
|
||||
cfg.mail.mail_cf.smtp.ssl=true
|
||||
EOF
|
||||
;;
|
||||
tls)
|
||||
cat <<EOF >>"$rsinit_properties"
|
||||
cfg.mail.mail_cf.smtp.tls.enable=true
|
||||
cfg.mail.mail_cf.smtp.tls.require=true
|
||||
EOF
|
||||
;;
|
||||
esac
|
||||
fi
|
||||
|
||||
# Start Tomcat in background to populate the database
|
||||
tomcat_start_bg
|
||||
|
||||
info "Waiting for database to be populated"
|
||||
reportserver_wait_for_data "${mysql_remote_execute_args[@]}"
|
||||
|
||||
tomcat_stop
|
||||
else
|
||||
info "Found persisted installation. Skipping initial bootstrap"
|
||||
fi
|
||||
|
||||
if ! grep -q 'response.sendRedirect' "${BITNAMI_ROOT_DIR}/tomcat/webapps/ROOT/index.jsp"; then
|
||||
# Make Tomcat redirect to /reportserver
|
||||
replace_in_file "${BITNAMI_ROOT_DIR}/tomcat/webapps/ROOT/index.jsp" '<%\s*$' '<%\nresponse.sendRedirect("/reportserver");'
|
||||
fi
|
||||
# Avoid exit code of previous commands to affect the result of this function
|
||||
true
|
||||
}
|
||||
|
||||
########################
|
||||
# Add or modify an entry in the ReportServer configuration file
|
||||
# Globals:
|
||||
# REPORTSERVER_*
|
||||
# Arguments:
|
||||
# $1 - Variable name
|
||||
# $2 - Value to assign to the variable
|
||||
# $3 - Whether the value is a literal, or if instead it should be quoted (default: no)
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
reportserver_conf_set() {
|
||||
local -r key="${1:?key missing}"
|
||||
local -r value="${2:?value missing}"
|
||||
local -r file="${3:-${REPORTSERVER_CONF_FILE}}"
|
||||
debug "Setting ${key} to '${value}' in ReportServer configuration"
|
||||
# Sanitize key (sed does not support fixed string substitutions)
|
||||
local sanitized_pattern
|
||||
sanitized_pattern="^\s*(//\s*)?$(sed 's/[]\[^$.*/]/\\&/g' <<<"$key")\s*=.*"
|
||||
local entry="${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 ReportServer configuration file includes all supported keys, but because of its format,
|
||||
# we cannot append contents to the end. We can assume this should never happen.
|
||||
warn "Could not set the ReportServer '${key}' configuration. Check that the file has not been modified externally."
|
||||
fi
|
||||
}
|
||||
|
||||
########################
|
||||
# Get an entry from the ReportServer configuration file
|
||||
# Globals:
|
||||
# REPORTSERVER_*
|
||||
# Arguments:
|
||||
# $1 - Variable name
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
reportserver_conf_get() {
|
||||
local -r key="${1:?key missing}"
|
||||
local -r file="${2:-${REPORTSERVER_CONF_FILE}}"
|
||||
debug "Getting ${key} from ReportServer configuration"
|
||||
# Sanitize key (sed does not support fixed string substitutions)
|
||||
local sanitized_pattern
|
||||
sanitized_pattern="^\s*(//\s*)?$(sed 's/[]\[^$.*/]/\\&/g' <<<"$key")\s*=(.*)"
|
||||
#sanitized_pattern="^\s*(//\s*)?$(sed 's/[]\[^$.*/]/\\&/g' <<< "$key")\s*=([^;]+);"
|
||||
grep -E "$sanitized_pattern" "$file" | sed -E "s|${sanitized_pattern}|\2|" | tr -d "\"' "
|
||||
}
|
||||
|
||||
########################
|
||||
# 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
|
||||
#########################
|
||||
reportserver_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
|
||||
}
|
||||
|
||||
########################
|
||||
# Wait until the database is populated
|
||||
# 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
|
||||
#########################
|
||||
reportserver_wait_for_data() {
|
||||
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:-}"
|
||||
# We check that one of the tables has content. The schema is available in the
|
||||
# ddl/ folder inside the ReportServer installation
|
||||
check_mysql_data() {
|
||||
echo "SELECT email FROM RS_USER WHERE super_user=1" | mysql_remote_execute_print_output "$db_host" "$db_port" "$db_name" "$db_user" "$db_pass"
|
||||
}
|
||||
|
||||
if ! retry_while "check_mysql_data"; then
|
||||
error "Data initialization failed"
|
||||
return 1
|
||||
fi
|
||||
}
|
||||
@@ -0,0 +1,288 @@
|
||||
#!/bin/bash
|
||||
#
|
||||
# Bitnami Tomcat library
|
||||
|
||||
# shellcheck disable=SC1091
|
||||
|
||||
# Load Generic Libraries
|
||||
. /opt/bitnami/scripts/libfile.sh
|
||||
. /opt/bitnami/scripts/liblog.sh
|
||||
. /opt/bitnami/scripts/libos.sh
|
||||
. /opt/bitnami/scripts/libservice.sh
|
||||
. /opt/bitnami/scripts/libvalidations.sh
|
||||
|
||||
########################
|
||||
# Validate settings in MYSQL_*/MARIADB_* environment variables
|
||||
# Globals:
|
||||
# DB_*
|
||||
# Arguments:
|
||||
# None
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
tomcat_validate() {
|
||||
debug "Validating settings in TOMCAT_* env vars..."
|
||||
local error_code=0
|
||||
|
||||
# Auxiliary functions
|
||||
print_validation_error() {
|
||||
error "$1"
|
||||
error_code=1
|
||||
}
|
||||
check_yes_no_value() {
|
||||
if ! is_yes_no_value "${!1}" && ! is_true_false_value "${!1}" && ! is_1_0_value "${!1}"; then
|
||||
print_validation_error "The allowed values for ${1} are: yes no"
|
||||
fi
|
||||
}
|
||||
check_conflicting_ports() {
|
||||
local -r total="$#"
|
||||
for i in $(seq 1 "$((total - 1))"); do
|
||||
for j in $(seq "$((i + 1))" "$total"); do
|
||||
var_i="${!i}"
|
||||
var_j="${!j}"
|
||||
if [[ -n "${!var_i:-}" ]] && [[ -n "${!var_j:-}" ]] && [[ "${!var_i:-}" = "${!var_j:-}" ]]; then
|
||||
print_validation_error "${var_i} and ${var_j} are bound to the same port"
|
||||
fi
|
||||
done
|
||||
done
|
||||
}
|
||||
check_allowed_port() {
|
||||
local validate_port_args="-unprivileged"
|
||||
|
||||
if ! err=$(validate_port "${validate_port_args[@]}" "${!1}"); then
|
||||
print_validation_error "An invalid port was specified in the environment variable $1: $err"
|
||||
fi
|
||||
}
|
||||
|
||||
check_yes_no_value TOMCAT_ALLOW_REMOTE_MANAGEMENT
|
||||
check_yes_no_value TOMCAT_ENABLE_AUTH
|
||||
check_yes_no_value TOMCAT_ENABLE_AJP
|
||||
|
||||
check_allowed_port TOMCAT_HTTP_PORT_NUMBER
|
||||
check_allowed_port TOMCAT_AJP_PORT_NUMBER
|
||||
check_allowed_port TOMCAT_SHUTDOWN_PORT_NUMBER
|
||||
|
||||
check_conflicting_ports TOMCAT_HTTP_PORT_NUMBER TOMCAT_AJP_PORT_NUMBER TOMCAT_SHUTDOWN_PORT_NUMBER
|
||||
|
||||
# Validate credentials
|
||||
if is_boolean_yes "$TOMCAT_ENABLE_AUTH"; then
|
||||
if is_boolean_yes "${ALLOW_EMPTY_PASSWORD:-no}"; 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
|
||||
is_empty_value "$TOMCAT_PASSWORD" && print_validation_error "The TOMCAT_PASSWORD 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."
|
||||
fi
|
||||
fi
|
||||
|
||||
return "$error_code"
|
||||
}
|
||||
|
||||
########################
|
||||
# Ensure that a Tomcat user exists
|
||||
# Globals:
|
||||
# TOMCAT_*
|
||||
# Arguments:
|
||||
# $1 - Username
|
||||
# $2 - Password
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
tomcat_ensure_user_exists() {
|
||||
local username="${1:?username is missing}"
|
||||
local password="${2:-}"
|
||||
|
||||
# This command will create a new user in tomcat-users.xml (inside <tomcat-users>) - How it works:
|
||||
# 0. Assign the XML namespace 'x' (required because it uses a non-standard namespace)
|
||||
# 1. Remove any existing <user> entry for $USERNAME
|
||||
# 2. Create a new subnode in <tomcat-users>
|
||||
# 3. Store that element in a variable so it can be accessed later
|
||||
# 4. Set the "username", "password" and "roles" attributes with their values
|
||||
# shellcheck disable=SC2016
|
||||
xmlstarlet ed -S --inplace -N x="http://tomcat.apache.org/xml" \
|
||||
-d '//x:user[@username="manager"]' \
|
||||
--subnode '//x:tomcat-users' --type elem --name 'user' \
|
||||
--var new_node '$prev' \
|
||||
--insert '$new_node' --type attr --name 'username' --value "$username" \
|
||||
--insert '$new_node' --type attr --name 'password' --value "$password" \
|
||||
--insert '$new_node' --type attr --name 'roles' --value "manager-gui,admin-gui" \
|
||||
"$TOMCAT_USERS_CONF_FILE"
|
||||
}
|
||||
|
||||
########################
|
||||
# Ensure that the Tomcat AJP connector is enabled
|
||||
# Globals:
|
||||
# TOMCAT_*
|
||||
# Arguments:
|
||||
# $1 - Tomcat AJP connector port number
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
tomcat_enable_ajp() {
|
||||
local ajp_port="${1:?missing ajp port}"
|
||||
# We want to locate the AJP connector right after the related comment, hence the substitution and not using xmlstarlet
|
||||
# Unfortunately the AJP connector is inside a multi-line comment, so the simplest approach is to add a new line in the proper location
|
||||
local ajp_protocol="AJP/1.3"
|
||||
local ajp_selector="//Connector[@protocol=\"${ajp_protocol}\"]"
|
||||
if is_empty_value "$(xmlstarlet sel --template --value-of "${ajp_selector}/@port" "$TOMCAT_CONF_FILE")"; then
|
||||
# Ensure that it is only added once
|
||||
local ajp_connector="<Connector protocol=\"${ajp_protocol}\" address=\"localhost\" secretRequired=\"false\" port=\"${ajp_port}\" redirectPort=\"8443\"/>"
|
||||
replace_in_file "$TOMCAT_CONF_FILE" "^(\s*)(<!-- Define an AJP .* -->)$" "\1\2\n\1${ajp_connector}"
|
||||
else
|
||||
# If it was already added, update the port number
|
||||
xmlstarlet ed -S --inplace --update "${ajp_selector}/@port" --value "$ajp_port" "$TOMCAT_CONF_FILE"
|
||||
fi
|
||||
}
|
||||
|
||||
########################
|
||||
# Ensure Tomcat is initialized
|
||||
# Globals:
|
||||
# TOMCAT_*
|
||||
# Arguments:
|
||||
# None
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
tomcat_initialize() {
|
||||
if ! is_empty_value "$TOMCAT_EXTRA_JAVA_OPTS"; then
|
||||
cat >>"${TOMCAT_BIN_DIR}/setenv.sh" <<EOF
|
||||
|
||||
# Additional configuration
|
||||
export JAVA_OPTS="\${JAVA_OPTS} ${TOMCAT_EXTRA_JAVA_OPTS}"
|
||||
EOF
|
||||
fi
|
||||
|
||||
# server.xml docs: https://tomcat.apache.org/tomcat-9.0-doc/config/server.html
|
||||
info "Configuring port numbers"
|
||||
xmlstarlet ed -S --inplace --update '//Server/@port' --value "$TOMCAT_SHUTDOWN_PORT_NUMBER" "$TOMCAT_CONF_FILE"
|
||||
xmlstarlet ed -S --inplace --update '//Connector[@protocol="HTTP/1.1"]/@port' --value "$TOMCAT_HTTP_PORT_NUMBER" "$TOMCAT_CONF_FILE"
|
||||
|
||||
if is_boolean_yes "$TOMCAT_ENABLE_AJP"; then
|
||||
info "Enabling AJP"
|
||||
tomcat_enable_ajp "$TOMCAT_AJP_PORT_NUMBER"
|
||||
fi
|
||||
|
||||
if is_boolean_yes "$TOMCAT_ENABLE_AUTH"; then
|
||||
info "Creating Tomcat user"
|
||||
tomcat_ensure_user_exists "$TOMCAT_USERNAME" "$TOMCAT_PASSWORD"
|
||||
fi
|
||||
|
||||
# Fix to make upgrades from old images work
|
||||
# Before, we were persisting 'data' dir instead of 'webapps', causing errors when restoring persisted data
|
||||
if ! is_dir_empty "$TOMCAT_WEBAPPS_DIR" || ! is_dir_empty "${TOMCAT_VOLUME_DIR}/data"; then
|
||||
info "Persisted webapps detected"
|
||||
if [[ ! -e "$TOMCAT_WEBAPPS_DIR" && -e "${TOMCAT_VOLUME_DIR}/data" ]]; then
|
||||
warn "Detected legacy configuration directory path ${TOMCAT_VOLUME_DIR}/conf in volume"
|
||||
warn "Creating ${TOMCAT_BASE_DIR}/webapps symlink pointing to ${TOMCAT_VOLUME_DIR}/data"
|
||||
ln -sf "${TOMCAT_VOLUME_DIR}/data" "${TOMCAT_BASE_DIR}/webapps"
|
||||
fi
|
||||
else
|
||||
info "Ensuring Tomcat directories exist"
|
||||
ensure_dir_exists "$TOMCAT_WEBAPPS_DIR"
|
||||
# Use tomcat:root ownership for compatibility when running as a non-root user
|
||||
am_i_root && configure_permissions_ownership "$TOMCAT_WEBAPPS_DIR" -d "775" -f "664" -u "$TOMCAT_DAEMON_USER" -g "root"
|
||||
|
||||
info "Deploying Tomcat from scratch"
|
||||
cp -rp "$TOMCAT_BASE_DIR"/webapps_default/* "$TOMCAT_WEBAPPS_DIR"
|
||||
|
||||
# Access control is configured in the application's context.xml with a Valve element
|
||||
# context.xml docs: https://tomcat.apache.org/tomcat-9.0-doc/config/context.html
|
||||
# Valve docs for Access Control: https://tomcat.apache.org/tomcat-9.0-doc/config/valve.html#Access_Control
|
||||
if is_boolean_yes "$TOMCAT_ALLOW_REMOTE_MANAGEMENT"; then
|
||||
info "Enabling remote connections for manager and host-manager applications"
|
||||
for application in manager host-manager; do
|
||||
[[ -f "${TOMCAT_WEBAPPS_DIR}/${application}/META-INF/context.xml" ]] || continue
|
||||
xmlstarlet ed -S --inplace --update '//Valve/@allow' --value '\d+\.\d+\.\d+\.\d+' "${TOMCAT_WEBAPPS_DIR}/${application}/META-INF/context.xml"
|
||||
done
|
||||
fi
|
||||
fi
|
||||
}
|
||||
|
||||
########################
|
||||
# Start Tomcat in background
|
||||
# Globals:
|
||||
# TOMCAT_*
|
||||
# Arguments:
|
||||
# None
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
tomcat_start_bg() {
|
||||
is_tomcat_running && return
|
||||
|
||||
info "Starting Tomcat in background"
|
||||
local start_error=0
|
||||
if am_i_root; then
|
||||
debug_execute gosu "$TOMCAT_DAEMON_USER" "${TOMCAT_BIN_DIR}/startup.sh" || start_error="$?"
|
||||
else
|
||||
debug_execute "${TOMCAT_BIN_DIR}/startup.sh" || start_error="$?"
|
||||
fi
|
||||
|
||||
if [[ "$start_error" -ne 0 ]]; then
|
||||
error "Tomcat failed to start with exit code ${start_error}"
|
||||
return "$start_error"
|
||||
fi
|
||||
wait_for_log_entry "Catalina.start Server startup" "$TOMCAT_LOG_FILE" "$TOMCAT_START_RETRIES" 10
|
||||
}
|
||||
|
||||
########################
|
||||
# Stop Tomcat daemon
|
||||
# Globals:
|
||||
# TOMCAT_*
|
||||
# Arguments:
|
||||
# None
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
tomcat_stop() {
|
||||
is_tomcat_not_running && return
|
||||
|
||||
info "Stopping Tomcat"
|
||||
local stop_error=0
|
||||
# 'shutdown.sh stop n -force' - Stop Catalina, wait up to n seconds and then use kill -KILL if still running
|
||||
# The default timeout is 5 seconds, and some apps require even more, so give double the amount of time
|
||||
# In addition, force the shutdown if it did not stop in time to ensure that the shutdown (almost) never fails
|
||||
local tomcat_shutdown_timeout=10
|
||||
if am_i_root; then
|
||||
debug_execute gosu "$TOMCAT_DAEMON_USER" "${TOMCAT_BIN_DIR}/shutdown.sh" "$tomcat_shutdown_timeout" -force || stop_error="$?"
|
||||
else
|
||||
debug_execute "${TOMCAT_BIN_DIR}/shutdown.sh" "$tomcat_shutdown_timeout" -force || stop_error="$?"
|
||||
fi
|
||||
|
||||
if [[ "$stop_error" -ne 0 ]]; then
|
||||
error "Tomcat failed to stop with exit code ${stop_error}"
|
||||
return "$stop_error"
|
||||
fi
|
||||
|
||||
retry_while "is_tomcat_not_running"
|
||||
}
|
||||
|
||||
########################
|
||||
# Check if Tomcat is running
|
||||
# Globals:
|
||||
# TOMCAT_*
|
||||
# Arguments:
|
||||
# None
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
is_tomcat_running() {
|
||||
local pid
|
||||
pid="$(get_pid_from_file "${TOMCAT_PID_FILE}")"
|
||||
if [[ -n "${pid}" ]]; then
|
||||
is_service_running "${pid}"
|
||||
else
|
||||
false
|
||||
fi
|
||||
}
|
||||
|
||||
########################
|
||||
# Check if Tomcat is not running
|
||||
# Globals:
|
||||
# TOMCAT_*
|
||||
# Arguments:
|
||||
# None
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
is_tomcat_not_running() {
|
||||
! is_tomcat_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
|
||||
@@ -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,116 @@
|
||||
#!/bin/bash
|
||||
#
|
||||
# Environment configuration for reportserver
|
||||
|
||||
# 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:-reportserver}"
|
||||
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
|
||||
reportserver_env_vars=(
|
||||
REPORTSERVER_INSTALL_DEMO_DATA
|
||||
REPORTSERVER_USERNAME
|
||||
REPORTSERVER_PASSWORD
|
||||
REPORTSERVER_EMAIL
|
||||
REPORTSERVER_FIRST_NAME
|
||||
REPORTSERVER_LAST_NAME
|
||||
REPORTSERVER_SMTP_HOST
|
||||
REPORTSERVER_SMTP_PORT_NUMBER
|
||||
REPORTSERVER_SMTP_USER
|
||||
REPORTSERVER_SMTP_PASSWORD
|
||||
REPORTSERVER_SMTP_PROTOCOL
|
||||
REPORTSERVER_DATABASE_HOST
|
||||
REPORTSERVER_DATABASE_PORT_NUMBER
|
||||
REPORTSERVER_DATABASE_NAME
|
||||
REPORTSERVER_DATABASE_USER
|
||||
REPORTSERVER_DATABASE_PASSWORD
|
||||
TOMCAT_EXTRA_JAVA_OPTS
|
||||
REPORTSERVER_INSTALLDEMODATA
|
||||
SMTP_HOST
|
||||
SMTP_PORT
|
||||
REPORTSERVER_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 "${reportserver_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 reportserver_env_vars
|
||||
|
||||
# Paths
|
||||
export REPORTSERVER_BASE_DIR="${BITNAMI_ROOT_DIR}/reportserver"
|
||||
export REPORTSERVER_CONF_DIR="${REPORTSERVER_BASE_DIR}/WEB-INF/classes"
|
||||
export REPORTSERVER_CONF_FILE="${REPORTSERVER_CONF_DIR}/reportserver.properties"
|
||||
|
||||
# System users (when running with a privileged user)
|
||||
export REPORTSERVER_DAEMON_USER="tomcat"
|
||||
export REPORTSERVER_DAEMON_GROUP="tomcat"
|
||||
|
||||
# ReportServer configuration
|
||||
REPORTSERVER_INSTALL_DEMO_DATA="${REPORTSERVER_INSTALL_DEMO_DATA:-"${REPORTSERVER_INSTALLDEMODATA:-}"}"
|
||||
export REPORTSERVER_INSTALL_DEMO_DATA="${REPORTSERVER_INSTALL_DEMO_DATA:-no}" # only used during the first initialization
|
||||
|
||||
# ReportServer credentials
|
||||
export REPORTSERVER_USERNAME="${REPORTSERVER_USERNAME:-user}" # only used during the first initialization
|
||||
export REPORTSERVER_PASSWORD="${REPORTSERVER_PASSWORD:-bitnami}" # only used during the first initialization
|
||||
export REPORTSERVER_EMAIL="${REPORTSERVER_EMAIL:-user@example.com}" # only used during the first initialization
|
||||
export REPORTSERVER_FIRST_NAME="${REPORTSERVER_FIRST_NAME:-FirstName}" # only used during the first initialization
|
||||
export REPORTSERVER_LAST_NAME="${REPORTSERVER_LAST_NAME:-LastName}" # only used during the first initialization
|
||||
|
||||
# ReportServer SMTP credentials
|
||||
REPORTSERVER_SMTP_HOST="${REPORTSERVER_SMTP_HOST:-"${SMTP_HOST:-}"}"
|
||||
export REPORTSERVER_SMTP_HOST="${REPORTSERVER_SMTP_HOST:-}"
|
||||
REPORTSERVER_SMTP_PORT_NUMBER="${REPORTSERVER_SMTP_PORT_NUMBER:-"${SMTP_PORT:-}"}"
|
||||
REPORTSERVER_SMTP_PORT_NUMBER="${REPORTSERVER_SMTP_PORT_NUMBER:-"${REPORTSERVER_SMTP_PORT:-}"}"
|
||||
export REPORTSERVER_SMTP_PORT_NUMBER="${REPORTSERVER_SMTP_PORT_NUMBER:-}"
|
||||
REPORTSERVER_SMTP_USER="${REPORTSERVER_SMTP_USER:-"${SMTP_USER:-}"}"
|
||||
export REPORTSERVER_SMTP_USER="${REPORTSERVER_SMTP_USER:-}"
|
||||
REPORTSERVER_SMTP_PASSWORD="${REPORTSERVER_SMTP_PASSWORD:-"${SMTP_PASSWORD:-}"}"
|
||||
export REPORTSERVER_SMTP_PASSWORD="${REPORTSERVER_SMTP_PASSWORD:-}"
|
||||
REPORTSERVER_SMTP_PROTOCOL="${REPORTSERVER_SMTP_PROTOCOL:-"${SMTP_PROTOCOL:-}"}"
|
||||
export REPORTSERVER_SMTP_PROTOCOL="${REPORTSERVER_SMTP_PROTOCOL:-tls}"
|
||||
|
||||
# Database configuration
|
||||
export REPORTSERVER_DEFAULT_DATABASE_HOST="mariadb" # only used at build time
|
||||
REPORTSERVER_DATABASE_HOST="${REPORTSERVER_DATABASE_HOST:-"${MARIADB_HOST:-}"}"
|
||||
export REPORTSERVER_DATABASE_HOST="${REPORTSERVER_DATABASE_HOST:-$REPORTSERVER_DEFAULT_DATABASE_HOST}" # only used during the first initialization
|
||||
REPORTSERVER_DATABASE_PORT_NUMBER="${REPORTSERVER_DATABASE_PORT_NUMBER:-"${MARIADB_PORT_NUMBER:-}"}"
|
||||
export REPORTSERVER_DATABASE_PORT_NUMBER="${REPORTSERVER_DATABASE_PORT_NUMBER:-3306}" # only used during the first initialization
|
||||
REPORTSERVER_DATABASE_NAME="${REPORTSERVER_DATABASE_NAME:-"${MARIADB_DATABASE_NAME:-}"}"
|
||||
export REPORTSERVER_DATABASE_NAME="${REPORTSERVER_DATABASE_NAME:-bitnami_reportserver}" # only used during the first initialization
|
||||
REPORTSERVER_DATABASE_USER="${REPORTSERVER_DATABASE_USER:-"${MARIADB_DATABASE_USER:-}"}"
|
||||
export REPORTSERVER_DATABASE_USER="${REPORTSERVER_DATABASE_USER:-bn_reportserver}" # only used during the first initialization
|
||||
REPORTSERVER_DATABASE_PASSWORD="${REPORTSERVER_DATABASE_PASSWORD:-"${MARIADB_DATABASE_PASSWORD:-}"}"
|
||||
export REPORTSERVER_DATABASE_PASSWORD="${REPORTSERVER_DATABASE_PASSWORD:-}" # only used during the first initialization
|
||||
|
||||
# Tomcat extra options
|
||||
export TOMCAT_EXTRA_JAVA_OPTS="${TOMCAT_EXTRA_JAVA_OPTS:-$TOMCAT_EXTRA_JAVA_OPTS -Drs.configdir=${REPORTSERVER_CONF_DIR}}"
|
||||
|
||||
# Custom environment variables may be defined below
|
||||
@@ -0,0 +1,29 @@
|
||||
#!/bin/bash
|
||||
|
||||
# shellcheck disable=SC1091
|
||||
|
||||
set -o errexit
|
||||
set -o nounset
|
||||
set -o pipefail
|
||||
# set -o xtrace # Uncomment this line for debugging purpose
|
||||
|
||||
# Load ReportServer environment
|
||||
. /opt/bitnami/scripts/tomcat-env.sh
|
||||
. /opt/bitnami/scripts/reportserver-env.sh
|
||||
|
||||
# Load libraries
|
||||
. /opt/bitnami/scripts/libbitnami.sh
|
||||
. /opt/bitnami/scripts/liblog.sh
|
||||
|
||||
print_welcome_page
|
||||
|
||||
if [[ "$1" = "/opt/bitnami/scripts/tomcat/run.sh" ]]; then
|
||||
/opt/bitnami/scripts/mysql-client/setup.sh
|
||||
/opt/bitnami/scripts/tomcat/setup.sh
|
||||
/opt/bitnami/scripts/reportserver/setup.sh
|
||||
/post-init.sh
|
||||
info "** ReportServer setup finished! **"
|
||||
fi
|
||||
|
||||
echo ""
|
||||
exec "$@"
|
||||
@@ -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 purpose
|
||||
|
||||
# Load ReportServer environment
|
||||
. /opt/bitnami/scripts/tomcat-env.sh
|
||||
. /opt/bitnami/scripts/reportserver-env.sh
|
||||
|
||||
# Load libraries
|
||||
. /opt/bitnami/scripts/libtomcat.sh
|
||||
. /opt/bitnami/scripts/libreportserver.sh
|
||||
. /opt/bitnami/scripts/libfile.sh
|
||||
. /opt/bitnami/scripts/libfs.sh
|
||||
. /opt/bitnami/scripts/liblog.sh
|
||||
|
||||
# Symlink for ReportServer Enterprise
|
||||
if [[ -d "${BITNAMI_ROOT_DIR}/reportserverenterprise" ]]; then
|
||||
ln -s "${BITNAMI_ROOT_DIR}/reportserverenterprise" "$REPORTSERVER_BASE_DIR"
|
||||
fi
|
||||
|
||||
# Ensure the required config files exist
|
||||
touch "${REPORTSERVER_CONF_DIR}"/{persistence,reportserver,rsinit}.properties
|
||||
|
||||
# Ensure the ReportServer base directory exists and has proper permissions
|
||||
info "Configuring file permissions for ReportServer"
|
||||
ensure_user_exists "$REPORTSERVER_DAEMON_USER" --group "$REPORTSERVER_DAEMON_GROUP" --system
|
||||
ensure_dir_exists "$REPORTSERVER_BASE_DIR"
|
||||
# Use tomcat:root ownership for compatibility when running as a non-root user
|
||||
configure_permissions_ownership "$REPORTSERVER_BASE_DIR" -d "775" -f "664" -u "$REPORTSERVER_DAEMON_USER" -g "root"
|
||||
|
||||
# Clean webapps and add the reportserver one
|
||||
rm "${BITNAMI_ROOT_DIR}/tomcat/webapps/"{manager,docs,examples,host-manager} -r
|
||||
ln -s "$REPORTSERVER_BASE_DIR" "${BITNAMI_ROOT_DIR}/tomcat/webapps/reportserver"
|
||||
@@ -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 ReportServer environment
|
||||
. /opt/bitnami/scripts/tomcat-env.sh
|
||||
. /opt/bitnami/scripts/reportserver-env.sh
|
||||
|
||||
# Load MySQL Client environment for 'mysql_remote_execute' (after 'reportserver-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/libtomcat.sh
|
||||
. /opt/bitnami/scripts/libreportserver.sh
|
||||
|
||||
# Ensure ReportServer environment variables are valid
|
||||
reportserver_validate
|
||||
|
||||
# Ensure ReportServer is initialized
|
||||
reportserver_initialize
|
||||
@@ -0,0 +1,88 @@
|
||||
#!/bin/bash
|
||||
#
|
||||
# Environment configuration for tomcat
|
||||
|
||||
# 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:-tomcat}"
|
||||
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
|
||||
tomcat_env_vars=(
|
||||
TOMCAT_SHUTDOWN_PORT_NUMBER
|
||||
TOMCAT_HTTP_PORT_NUMBER
|
||||
TOMCAT_AJP_PORT_NUMBER
|
||||
TOMCAT_USERNAME
|
||||
TOMCAT_PASSWORD
|
||||
TOMCAT_ALLOW_REMOTE_MANAGEMENT
|
||||
TOMCAT_ENABLE_AUTH
|
||||
TOMCAT_ENABLE_AJP
|
||||
TOMCAT_START_RETRIES
|
||||
TOMCAT_EXTRA_JAVA_OPTS
|
||||
JAVA_OPTS
|
||||
)
|
||||
for env_var in "${tomcat_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 tomcat_env_vars
|
||||
|
||||
# Paths
|
||||
export TOMCAT_BASE_DIR="${BITNAMI_ROOT_DIR}/tomcat"
|
||||
export TOMCAT_VOLUME_DIR="/bitnami/tomcat"
|
||||
export TOMCAT_BIN_DIR="${TOMCAT_BASE_DIR}/bin"
|
||||
export TOMCAT_LIB_DIR="${TOMCAT_BASE_DIR}/lib"
|
||||
export TOMCAT_WORK_DIR="${TOMCAT_BASE_DIR}/work"
|
||||
export TOMCAT_WEBAPPS_DIR="${TOMCAT_VOLUME_DIR}/webapps"
|
||||
export TOMCAT_CONF_DIR="${TOMCAT_BASE_DIR}/conf"
|
||||
export TOMCAT_CONF_FILE="${TOMCAT_CONF_DIR}/server.xml"
|
||||
export TOMCAT_USERS_CONF_FILE="${TOMCAT_CONF_DIR}/tomcat-users.xml"
|
||||
export TOMCAT_LOGS_DIR="${TOMCAT_BASE_DIR}/logs"
|
||||
export TOMCAT_TMP_DIR="${TOMCAT_BASE_DIR}/temp"
|
||||
export TOMCAT_LOG_FILE="${TOMCAT_LOGS_DIR}/catalina.out"
|
||||
export TOMCAT_PID_FILE="${TOMCAT_TMP_DIR}/catalina.pid"
|
||||
export TOMCAT_HOME="$TOMCAT_BASE_DIR"
|
||||
|
||||
# System users (when running with a privileged user)
|
||||
export TOMCAT_DAEMON_USER="tomcat"
|
||||
export TOMCAT_DAEMON_GROUP="tomcat"
|
||||
|
||||
# Tomcat configuration
|
||||
export TOMCAT_SHUTDOWN_PORT_NUMBER="${TOMCAT_SHUTDOWN_PORT_NUMBER:-8005}"
|
||||
export TOMCAT_HTTP_PORT_NUMBER="${TOMCAT_HTTP_PORT_NUMBER:-8080}"
|
||||
export TOMCAT_AJP_PORT_NUMBER="${TOMCAT_AJP_PORT_NUMBER:-8009}"
|
||||
export TOMCAT_USERNAME="${TOMCAT_USERNAME:-manager}"
|
||||
export TOMCAT_PASSWORD="${TOMCAT_PASSWORD:-}"
|
||||
export TOMCAT_ALLOW_REMOTE_MANAGEMENT="${TOMCAT_ALLOW_REMOTE_MANAGEMENT:-no}"
|
||||
export TOMCAT_ENABLE_AUTH="${TOMCAT_ENABLE_AUTH:-yes}"
|
||||
export TOMCAT_ENABLE_AJP="${TOMCAT_ENABLE_AJP:-no}"
|
||||
export TOMCAT_START_RETRIES="${TOMCAT_START_RETRIES:-12}"
|
||||
export TOMCAT_EXTRA_JAVA_OPTS="${TOMCAT_EXTRA_JAVA_OPTS:-}"
|
||||
|
||||
# Default JVM configuration
|
||||
export JAVA_HOME="${BITNAMI_ROOT_DIR}/java"
|
||||
export JAVA_OPTS="${JAVA_OPTS:--Djava.awt.headless=true -XX:+UseG1GC -Dfile.encoding=UTF-8 -Duser.home=${TOMCAT_HOME}}"
|
||||
|
||||
# Other parameters
|
||||
export PATH="${TOMCAT_BASE_DIR}/bin:${JAVA_HOME}/bin:${BITNAMI_ROOT_DIR}/common/bin:${PATH}"
|
||||
|
||||
# Custom environment variables may be defined below
|
||||
@@ -0,0 +1,8 @@
|
||||
#!/bin/bash
|
||||
|
||||
export JAVA_HOME="{{JAVA_HOME}}"
|
||||
export JAVA_OPTS="{{JAVA_OPTS}}"
|
||||
export CATALINA_PID="{{TOMCAT_PID_FILE}}"
|
||||
|
||||
# Load Tomcat Native library
|
||||
export LD_LIBRARY_PATH="{{TOMCAT_LIB_DIR}}:${LD_LIBRARY_PATH:+:$LD_LIBRARY_PATH}"
|
||||
@@ -0,0 +1,27 @@
|
||||
#!/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/libtomcat.sh
|
||||
. /opt/bitnami/scripts/libbitnami.sh
|
||||
. /opt/bitnami/scripts/liblog.sh
|
||||
|
||||
# Load Tomcat environment variables
|
||||
. /opt/bitnami/scripts/tomcat-env.sh
|
||||
|
||||
print_welcome_page
|
||||
|
||||
if [[ "$*" = *"/opt/bitnami/scripts/tomcat/run.sh"* ]]; then
|
||||
info "** Starting tomcat setup **"
|
||||
/opt/bitnami/scripts/tomcat/setup.sh
|
||||
info "** tomcat setup finished! **"
|
||||
fi
|
||||
|
||||
echo ""
|
||||
exec "$@"
|
||||
@@ -0,0 +1,49 @@
|
||||
#!/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/libtomcat.sh
|
||||
. /opt/bitnami/scripts/libfs.sh
|
||||
|
||||
# Load Tomcat environment variables
|
||||
. /opt/bitnami/scripts/tomcat-env.sh
|
||||
|
||||
# Ensure 'tomcat' user exists when running as 'root'
|
||||
ensure_user_exists "$TOMCAT_DAEMON_USER" --group "$TOMCAT_DAEMON_GROUP" --system
|
||||
# By default, the upstream Tomcat tarball includes very specific permissions on its files
|
||||
# For simplicity purposes, since Bitnami Tomcat is considered a development environment, we reset to OS defaults
|
||||
configure_permissions_ownership "$TOMCAT_BASE_DIR" -d "755" -f "644"
|
||||
chmod a+x "$TOMCAT_BIN_DIR"/*.sh
|
||||
# Make TOMCAT_HOME writable (non-recursively, for security reasons) both for root and non-root approaches
|
||||
chown "$TOMCAT_DAEMON_USER" "$TOMCAT_HOME"
|
||||
chmod g+rwX "$TOMCAT_HOME"
|
||||
# Make TOMCAT_LIB_DIR writable (non-recursively, for security reasons) for non-root approach, some apps may copy files there
|
||||
chmod g+rwX "$TOMCAT_LIB_DIR"
|
||||
# Make required folders writable by the Tomcat web server user
|
||||
for dir in "$TOMCAT_TMP_DIR" "$TOMCAT_LOGS_DIR" "$TOMCAT_CONF_DIR" "$TOMCAT_WORK_DIR" "$TOMCAT_WEBAPPS_DIR" "${TOMCAT_BASE_DIR}/webapps"; do
|
||||
ensure_dir_exists "$dir"
|
||||
# Use tomcat:root ownership for compatibility when running as a non-root user
|
||||
configure_permissions_ownership "$dir" -d "775" -f "664" -u "$TOMCAT_DAEMON_USER" -g "root"
|
||||
done
|
||||
|
||||
# Allow enabling custom Tomcat webapps
|
||||
mv "${TOMCAT_BASE_DIR}/webapps" "${TOMCAT_BASE_DIR}/webapps_default"
|
||||
ln -sf "$TOMCAT_WEBAPPS_DIR" "${TOMCAT_BASE_DIR}/webapps"
|
||||
|
||||
# Create a setenv.sh script
|
||||
# For more info, refer to section '(3.4) Using the "setenv" script' from https://tomcat.apache.org/tomcat-9.0-doc/RUNNING.txt
|
||||
declare template_dir="${BITNAMI_ROOT_DIR}/scripts/tomcat/bitnami-templates"
|
||||
render-template "${template_dir}/setenv.sh.tpl" > "${TOMCAT_BIN_DIR}/setenv.sh"
|
||||
chmod g+rwX "${TOMCAT_BIN_DIR}/setenv.sh"
|
||||
|
||||
# Create 'apache-tomcat' symlink pointing to the 'tomcat' directory, for compatibility with Bitnami Docs guides
|
||||
ln -sf tomcat "${BITNAMI_ROOT_DIR}/apache-tomcat"
|
||||
|
||||
# Users can mount their webapps at /app
|
||||
ln -sf "$TOMCAT_WEBAPPS_DIR" /app
|
||||
@@ -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/libtomcat.sh
|
||||
|
||||
# Load Tomcat environment variables
|
||||
. /opt/bitnami/scripts/tomcat-env.sh
|
||||
|
||||
/opt/bitnami/scripts/tomcat/stop.sh
|
||||
/opt/bitnami/scripts/tomcat/start.sh
|
||||
24
bitnami/reportserver/3/debian-10/rootfs/opt/bitnami/scripts/tomcat/run.sh
Executable file
24
bitnami/reportserver/3/debian-10/rootfs/opt/bitnami/scripts/tomcat/run.sh
Executable file
@@ -0,0 +1,24 @@
|
||||
#!/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/libtomcat.sh
|
||||
. /opt/bitnami/scripts/liblog.sh
|
||||
|
||||
# Load Tomcat environment variables
|
||||
. /opt/bitnami/scripts/tomcat-env.sh
|
||||
|
||||
info "** Starting Tomcat **"
|
||||
|
||||
if am_i_root; then
|
||||
exec gosu "$TOMCAT_DAEMON_USER" "${TOMCAT_BIN_DIR}/catalina.sh" run "$@"
|
||||
else
|
||||
exec "${TOMCAT_BIN_DIR}/catalina.sh" run "$@"
|
||||
fi
|
||||
|
||||
22
bitnami/reportserver/3/debian-10/rootfs/opt/bitnami/scripts/tomcat/setup.sh
Executable file
22
bitnami/reportserver/3/debian-10/rootfs/opt/bitnami/scripts/tomcat/setup.sh
Executable file
@@ -0,0 +1,22 @@
|
||||
#!/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/libtomcat.sh
|
||||
. /opt/bitnami/scripts/libfs.sh
|
||||
. /opt/bitnami/scripts/libos.sh
|
||||
|
||||
# Load Tomcat environment variables
|
||||
. /opt/bitnami/scripts/tomcat-env.sh
|
||||
|
||||
# Ensure Tomcat environment variables are valid
|
||||
tomcat_validate
|
||||
|
||||
# Ensure tomcat is initialized
|
||||
tomcat_initialize
|
||||
36
bitnami/reportserver/3/debian-10/rootfs/opt/bitnami/scripts/tomcat/start.sh
Executable file
36
bitnami/reportserver/3/debian-10/rootfs/opt/bitnami/scripts/tomcat/start.sh
Executable file
@@ -0,0 +1,36 @@
|
||||
#!/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/libos.sh
|
||||
. /opt/bitnami/scripts/libtomcat.sh
|
||||
|
||||
# Load Tomcat environment variables
|
||||
. /opt/bitnami/scripts/tomcat-env.sh
|
||||
|
||||
error_code=0
|
||||
start_error=0
|
||||
|
||||
if is_tomcat_not_running; then
|
||||
if am_i_root; then
|
||||
gosu "$TOMCAT_DAEMON_USER" "${TOMCAT_BIN_DIR}/startup.sh" || start_error="$?"
|
||||
else
|
||||
"${TOMCAT_BIN_DIR}/startup.sh" || start_error="$?"
|
||||
fi
|
||||
if [[ "$start_error" -ne 0 ]] || ! retry_while "is_tomcat_running"; then
|
||||
error "tomcat did not start"
|
||||
error_code=1
|
||||
else
|
||||
info "tomcat started"
|
||||
fi
|
||||
else
|
||||
info "tomcat is already running"
|
||||
fi
|
||||
|
||||
exit "$error_code"
|
||||
20
bitnami/reportserver/3/debian-10/rootfs/opt/bitnami/scripts/tomcat/status.sh
Executable file
20
bitnami/reportserver/3/debian-10/rootfs/opt/bitnami/scripts/tomcat/status.sh
Executable file
@@ -0,0 +1,20 @@
|
||||
#!/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/libtomcat.sh
|
||||
|
||||
# Load Tomcat environment variables
|
||||
. /opt/bitnami/scripts/tomcat-env.sh
|
||||
|
||||
if is_tomcat_running; then
|
||||
info "tomcat is already running"
|
||||
else
|
||||
info "tomcat is not running"
|
||||
fi
|
||||
32
bitnami/reportserver/3/debian-10/rootfs/opt/bitnami/scripts/tomcat/stop.sh
Executable file
32
bitnami/reportserver/3/debian-10/rootfs/opt/bitnami/scripts/tomcat/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/libos.sh
|
||||
. /opt/bitnami/scripts/libtomcat.sh
|
||||
|
||||
# Load Tomcat environment variables
|
||||
. /opt/bitnami/scripts/tomcat-env.sh
|
||||
|
||||
error_code=0
|
||||
stop_error=0
|
||||
|
||||
if is_tomcat_running; then
|
||||
BITNAMI_QUIET=1 tomcat_stop || stop_error="$?"
|
||||
if [[ "$stop_error" -ne 0 ]] || ! retry_while "is_tomcat_not_running"; then
|
||||
error "tomcat could not be stopped"
|
||||
error_code=1
|
||||
else
|
||||
info "tomcat stopped"
|
||||
fi
|
||||
else
|
||||
info "tomcat is not running"
|
||||
fi
|
||||
|
||||
exit "$error_code"
|
||||
36
bitnami/reportserver/3/debian-10/rootfs/post-init.d/shell.sh
Executable file
36
bitnami/reportserver/3/debian-10/rootfs/post-init.d/shell.sh
Executable file
@@ -0,0 +1,36 @@
|
||||
#!/bin/bash
|
||||
#
|
||||
# Executes custom Bash init scripts
|
||||
|
||||
# shellcheck disable=SC1090,SC1091
|
||||
|
||||
set -o errexit
|
||||
set -o nounset
|
||||
set -o pipefail
|
||||
# set -o xtrace # Uncomment this line for debugging purposes
|
||||
|
||||
# Load libraries with logging functions
|
||||
if [[ -f /opt/bitnami/base/functions ]]; then
|
||||
. /opt/bitnami/base/functions
|
||||
else
|
||||
. /opt/bitnami/scripts/liblog.sh
|
||||
fi
|
||||
|
||||
# Loop through all input files passed via stdin
|
||||
read -r -a custom_init_scripts <<< "$@"
|
||||
failure=0
|
||||
if [[ "${#custom_init_scripts[@]}" -gt 0 ]]; then
|
||||
for custom_init_script in "${custom_init_scripts[@]}"; do
|
||||
[[ "$custom_init_script" != *".sh" ]] && continue
|
||||
if [[ -x "$custom_init_script" ]]; then
|
||||
info "Executing ${custom_init_script}"
|
||||
"$custom_init_script" || failure="1"
|
||||
else
|
||||
info "Sourcing ${custom_init_script} as it is not executable by the current user, any error may cause initialization to fail"
|
||||
. "$custom_init_script"
|
||||
fi
|
||||
[[ "$failure" -ne 0 ]] && error "Failed to execute ${custom_init_script}"
|
||||
done
|
||||
fi
|
||||
|
||||
exit "$failure"
|
||||
46
bitnami/reportserver/3/debian-10/rootfs/post-init.d/sql-mysql.sh
Executable file
46
bitnami/reportserver/3/debian-10/rootfs/post-init.d/sql-mysql.sh
Executable file
@@ -0,0 +1,46 @@
|
||||
#!/bin/bash
|
||||
#
|
||||
# Executes custom MySQL (.sql or .sql.gz) init scripts
|
||||
|
||||
# shellcheck disable=SC1091
|
||||
|
||||
set -o errexit
|
||||
set -o nounset
|
||||
set -o pipefail
|
||||
# set -o xtrace # Uncomment this line for debugging purposes
|
||||
|
||||
# Load libraries with logging functions
|
||||
if [[ -f /opt/bitnami/base/functions ]]; then
|
||||
. /opt/bitnami/base/functions
|
||||
else
|
||||
. /opt/bitnami/scripts/liblog.sh
|
||||
fi
|
||||
|
||||
mysql_execute() {
|
||||
local -r sql_file="${1:?missing file}"
|
||||
local failure=0
|
||||
mysql_cmd=("mysql" "-h" "$MARIADB_HOST" "-P" "$MARIADB_PORT_NUMBER" "-u" "$MARIADB_ROOT_USER")
|
||||
if [[ "${ALLOW_EMPTY_PASSWORD:-no}" != "yes" ]]; then
|
||||
mysql_cmd+=("-p${MARIADB_ROOT_PASSWORD}")
|
||||
fi
|
||||
if [[ "$sql_file" == *".sql" ]]; then
|
||||
"${mysql_cmd[@]}" < "$sql_file" || failure=$?
|
||||
elif [[ "$sql_file" == *".sql.gz" ]]; then
|
||||
gunzip -c "$sql_file" | "${mysql_cmd[@]}" || failure=$?
|
||||
fi
|
||||
return "$failure"
|
||||
}
|
||||
|
||||
# Loop through all input files passed via stdin
|
||||
read -r -a custom_init_scripts <<< "$@"
|
||||
failure=0
|
||||
if [[ "${#custom_init_scripts[@]}" -gt 0 ]]; then
|
||||
for custom_init_script in "${custom_init_scripts[@]}"; do
|
||||
[[ ! "$custom_init_script" =~ ^.*(\.sql|\.sql\.gz)$ ]] && continue
|
||||
info "Executing ${custom_init_script}"
|
||||
mysql_execute "$custom_init_script" || failure=1
|
||||
[[ "$failure" -ne 0 ]] && error "Failed to execute ${custom_init_script}"
|
||||
done
|
||||
fi
|
||||
|
||||
exit "$failure"
|
||||
23
bitnami/reportserver/3/debian-10/rootfs/post-init.sh
Executable file
23
bitnami/reportserver/3/debian-10/rootfs/post-init.sh
Executable file
@@ -0,0 +1,23 @@
|
||||
#!/bin/bash
|
||||
|
||||
# shellcheck disable=SC1091
|
||||
|
||||
set -o errexit
|
||||
set -o nounset
|
||||
set -o pipefail
|
||||
# set -o xtrace # Uncomment this line for debugging purposes
|
||||
|
||||
# Only execute init scripts once
|
||||
if [[ ! -f "/bitnami/reportserver/.user_scripts_initialized" && -d "/docker-entrypoint-init.d" ]]; then
|
||||
read -r -a init_scripts <<< "$(find "/docker-entrypoint-init.d" -type f -print0 | sort -z | xargs -0)"
|
||||
if [[ "${#init_scripts[@]}" -gt 0 ]] && [[ ! -f "/bitnami/reportserver/.user_scripts_initialized" ]]; then
|
||||
mkdir -p "/bitnami/reportserver"
|
||||
for init_script in "${init_scripts[@]}"; do
|
||||
for init_script_type_handler in /post-init.d/*.sh; do
|
||||
"$init_script_type_handler" "$init_script"
|
||||
done
|
||||
done
|
||||
fi
|
||||
|
||||
touch "/bitnami/reportserver/.user_scripts_initialized"
|
||||
fi
|
||||
@@ -1,21 +0,0 @@
|
||||
{
|
||||
"cryptPassphrase": "{{$global.env.REPORTSERVER_CRYPTPASSPHRASE}}",
|
||||
"cryptSalt": "{{$global.env.REPORTSERVER_CRYPTSALT}}",
|
||||
"databaseName": "{{$global.env.REPORTSERVER_DATABASE_NAME}}",
|
||||
"databasePassword": "{{$global.env.REPORTSERVER_DATABASE_PASSWORD}}",
|
||||
"databaseServerHost": "{{$global.env.MARIADB_HOST}}",
|
||||
"databaseServerPort": "{{$global.env.MARIADB_PORT_NUMBER}}",
|
||||
"databaseUser": "{{$global.env.REPORTSERVER_DATABASE_USER}}",
|
||||
"email": "{{$global.env.REPORTSERVER_EMAIL}}",
|
||||
"installDemoData": "{{$global.env.REPORTSERVER_INSTALLDEMODATA}}",
|
||||
"javaOpts": "{{$global.env.REPORTSERVER_JAVA_OPTS}}",
|
||||
"password": "{{$global.env.REPORTSERVER_PASSWORD}}",
|
||||
"smtpHost": "{{$global.env.SMTP_HOST}}",
|
||||
"smtpPassword": "{{$global.env.SMTP_PASSWORD}}",
|
||||
"smtpPort": "{{$global.env.SMTP_PORT}}",
|
||||
"smtpSSLEnable": "{{$global.env.SMTP_SSL_ENABLE}}",
|
||||
"smtpTLSEnable": "{{$global.env.SMTP_TLS_ENABLE}}",
|
||||
"smtpTLSRequired": "{{$global.env.SMTP_TLS_REQUIRED}}",
|
||||
"smtpUser": "{{$global.env.SMTP_USER}}",
|
||||
"username": "{{$global.env.REPORTSERVER_USERNAME}}"
|
||||
}
|
||||
@@ -1,286 +1,438 @@
|
||||
# What is ReportServer Community ?
|
||||
# Bitnami Docker Image for ReportServer Community
|
||||
|
||||
## What is ReportServer Community?
|
||||
|
||||
> ReportServer is an open source business intelligence (OSBI) platform with powerful reporting and analysis tools. It provides a unified interface to reporting engines from different providers, making it easy for managers to collate, analyze and take action on data from multiple business touchpoints. With support for Jasper, Birt, Mondrian and Excel as well as a powerful ad-hoc reporting component ReportServer is the ideal tool for business decision makers, analysts and consultants.
|
||||
|
||||
https://reportserver.net/en/#secondsection
|
||||
|
||||
# TL;DR
|
||||
|
||||
## Docker Compose
|
||||
## TL;DR
|
||||
|
||||
```console
|
||||
$ curl -sSL https://raw.githubusercontent.com/bitnami/bitnami-docker-reportserver-community/master/docker-compose.yml > docker-compose.yml
|
||||
$ curl -sSL https://raw.githubusercontent.com/bitnami/bitnami-docker-reportserver/master/docker-compose.yml > docker-compose.yml
|
||||
$ docker-compose up -d
|
||||
```
|
||||
|
||||
You can find the default credentials and available configuration options in the [Environment Variables](#environment-variables) section.
|
||||
**Warning**: This quick setup is only intended for development environments. You are encouraged to change the insecure default credentials and check out the available configuration options in the [Environment Variables](#environment-variables) section for a more secure deployment.
|
||||
|
||||
# Why use Bitnami Images?
|
||||
## Why use Bitnami Images?
|
||||
|
||||
* Bitnami closely tracks upstream source changes and promptly publishes new versions of this image using our automated systems.
|
||||
* With Bitnami images the latest bug fixes and features are available as soon as possible.
|
||||
* Bitnami containers, virtual machines and cloud images use the same components and configuration approach - making it easy to switch between formats based on your project needs.
|
||||
* All our images are based on [minideb](https://github.com/bitnami/minideb) a minimalist Debian based container image which gives you a small base container image and the familiarity of a leading Linux distribution.
|
||||
* All Bitnami images available in Docker Hub are signed with [Docker Content Trust (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.
|
||||
- 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/reportserver?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.
|
||||
|
||||
> This [CVE scan report](https://quay.io/repository/bitnami/reportserver-community?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.
|
||||
## Why use a non-root container?
|
||||
|
||||
# Supported tags and respective `Dockerfile` links
|
||||
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/).
|
||||
|
||||
## 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/).
|
||||
|
||||
|
||||
* [`3`, `3-debian-10`, `3.7.0-6044`, `3.7.0-6044-debian-10-r51`, `latest` (3/debian-10/Dockerfile)](https://github.com/bitnami/bitnami-docker-reportserver-community/blob/3.7.0-6044-debian-10-r51/3/debian-10/Dockerfile)
|
||||
- [`3`, `3-debian-10`, `3.7.1-6046`, `3.7.1-6046-debian-10-r0`, `latest` (3/debian-10/Dockerfile)](https://github.com/bitnami/bitnami-docker-reportserver/blob/3.7.1-6046-debian-10-r0/3/debian-10/Dockerfile)
|
||||
|
||||
Subscribe to project updates by watching the [bitnami/reportserver-community GitHub repo](https://github.com/bitnami/bitnami-docker-reportserver-community).
|
||||
Subscribe to project updates by watching the [bitnami/reportserver GitHub repo](https://github.com/bitnami/bitnami-docker-reportserver).
|
||||
|
||||
## Get this image
|
||||
|
||||
# Prerequisites
|
||||
|
||||
To run this application you need Docker Engine 1.10.0. Docker Compose is recomended with a version 1.6.0 or later.
|
||||
|
||||
# How to use this image
|
||||
|
||||
## Run the application using Docker Compose
|
||||
|
||||
The main folder of this repository contains a functional [`docker-compose.yml`](https://github.com/bitnami/bitnami-docker-reportserver-community/blob/master/docker-compose.yml) file. Run the application using it as shown below:
|
||||
The recommended way to get the Bitnami ReportServer Community Docker Image is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/reportserver).
|
||||
|
||||
```console
|
||||
$ curl -sSL https://raw.githubusercontent.com/bitnami/bitnami-docker-reportserver-community/master/docker-compose.yml > docker-compose.yml
|
||||
$ docker pull bitnami/reportserver: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/reportserver/tags/) in the Docker Hub Registry.
|
||||
|
||||
```console
|
||||
$ docker pull bitnami/reportserver:[TAG]
|
||||
```
|
||||
|
||||
If you wish, you can also build the image yourself.
|
||||
|
||||
```console
|
||||
$ docker build -t bitnami/reportserver:latest 'https://github.com/bitnami/bitnami-docker-reportserver.git#master:3/debian-10'
|
||||
```
|
||||
|
||||
## How to use this image
|
||||
|
||||
ReportServer Community 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-reportserver/blob/master/docker-compose.yml) file. Run the application using it as shown below:
|
||||
|
||||
```console
|
||||
$ curl -sSL https://raw.githubusercontent.com/bitnami/bitnami-docker-reportserver/master/docker-compose.yml > docker-compose.yml
|
||||
$ docker-compose up -d
|
||||
```
|
||||
|
||||
Then you can access your application at http://your-ip/. Enter bitnami default username and password `user/ bitnami`
|
||||
### Using the Docker Command Line
|
||||
|
||||
## Run the application manually
|
||||
If you want to run the application manually instead of using `docker-compose`, these are the basic steps you need to run:
|
||||
|
||||
If you want to run the application manually instead of using docker-compose, these are the basic steps you need to run:
|
||||
#### Step 1: Create a network
|
||||
|
||||
1. Create a new network for the application:
|
||||
```console
|
||||
$ docker network create reportserver-network
|
||||
```
|
||||
|
||||
```console
|
||||
$ docker network create reportserver-tier
|
||||
```
|
||||
#### Step 2: Create a volume for MariaDB persistence and create a MariaDB container
|
||||
|
||||
2. Create a volume for MariaDB persistence and create a MariaDB container
|
||||
```console
|
||||
$ docker volume create --name mariadb_data
|
||||
$ docker run -d --name mariadb \
|
||||
--env ALLOW_EMPTY_PASSWORD=yes \
|
||||
--env MARIADB_USER=bn_reportserver \
|
||||
--env MARIADB_PASSWORD=bitnami \
|
||||
--env MARIADB_DATABASE=bitnami_reportserver \
|
||||
--network reportserver-network \
|
||||
--volume mariadb_data:/bitnami/mariadb \
|
||||
bitnami/mariadb:latest
|
||||
```
|
||||
|
||||
```console
|
||||
$ docker volume create --name mariadb_data
|
||||
$ docker run -d --name mariadb \
|
||||
-e ALLOW_EMPTY_PASSWORD=yes \
|
||||
-e MARIADB_USER=bn_reportserver \
|
||||
-e MARIADB_DATABASE=bitnami_reportserver \
|
||||
--net reportserver-tier \
|
||||
--volume mariadb_data:/bitnami \
|
||||
bitnami/mariadb:latest
|
||||
```
|
||||
#### Step 3: Create volumes for ReportServer Community persistence and launch the container
|
||||
|
||||
3. Launch the container
|
||||
```console
|
||||
$ docker volume create --name reportserver_data
|
||||
$ docker run -d --name reportserver \
|
||||
-p 8080:8080 -p 8443:8443 \
|
||||
--env ALLOW_EMPTY_PASSWORD=yes \
|
||||
--env REPORTSERVER_DATABASE_USER=bn_reportserver \
|
||||
--env REPORTSERVER_DATABASE_PASSWORD=bitnami \
|
||||
--env REPORTSERVER_DATABASE_NAME=bitnami_reportserver \
|
||||
--network reportserver-network \
|
||||
--volume reportserver_data:/bitnami/reportserver \
|
||||
bitnami/reportserver:latest
|
||||
```
|
||||
|
||||
```console
|
||||
$ docker volume create --name reportserver_data
|
||||
$ docker run -d --name reportserver-community -p 80:8080 \
|
||||
-e ALLOW_EMPTY_PASSWORD=yes \
|
||||
-e REPORTSERVER_DATABASE_USER=bn_reportserver \
|
||||
-e REPORTSERVER_DATABASE_NAME=bitnami_reportserver \
|
||||
--net reporserver-tier \
|
||||
bitnami/reportserver-community:latest
|
||||
```
|
||||
|
||||
Then you can access your application at http://your-ip/. Enter bitnami default username and password:
|
||||
`user/ bitnami`
|
||||
|
||||
>**Note!** If you are using **Docker for Windows** (regardless of running the application using Docker compose or manually) you must check the Docker virtual machine IP executing this command:
|
||||
|
||||
`docker-machine ip`
|
||||
|
||||
This IP address allowing you to access to your application.
|
||||
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.
|
||||
|
||||
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/reportserver` 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`. The Reportserver Community state will persist as long as database is persisted.
|
||||
The above examples define the Docker volumes named `mariadb_data` and `reportserver_data`. The ReportServer Community 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
|
||||
|
||||
### Mount persistent folders manually
|
||||
This requires a minor change to the [`docker-compose.yml`](https://github.com/bitnami/bitnami-docker-reportserver/blob/master/docker-compose.yml) file present in this repository:
|
||||
|
||||
In this case you need to specify the directories to mount on the run command. The process is the same than the one previously shown:
|
||||
```diff
|
||||
mariadb:
|
||||
...
|
||||
volumes:
|
||||
- - 'mariadb_data:/bitnami/mariadb'
|
||||
+ - /path/to/mariadb-persistence:/bitnami/mariadb
|
||||
...
|
||||
reportserver:
|
||||
...
|
||||
volumes:
|
||||
- - 'reportserver_data:/bitnami/reportserver'
|
||||
+ - /path/to/reportserver-persistence:/bitnami/reportserver
|
||||
...
|
||||
-volumes:
|
||||
- mariadb_data:
|
||||
- driver: local
|
||||
- reportserver_data:
|
||||
- driver: local
|
||||
```
|
||||
|
||||
1. Create a network (if it does not exist):
|
||||
> NOTE: As this is a non-root container, the mounted files and directories must have the proper permissions for the UID `1001`.
|
||||
|
||||
```console
|
||||
$ docker network create reportserver-tier
|
||||
```
|
||||
### Mount host directories as data volumes using the Docker command line
|
||||
|
||||
2. Create a MariaDB container with host volume:
|
||||
#### Step 1: Create a network (if it does not exist)
|
||||
|
||||
```console
|
||||
$ docker run -d --name mariadb \
|
||||
-e ALLOW_EMPTY_PASSWORD=yes \
|
||||
-e MARIADB_USER=bn_reportserver \
|
||||
-e MARIADB_DATABASE=bitnami_reportserver \
|
||||
--net reportserver-tier \
|
||||
--volume /path/to/mariadb-persistence:/bitnami \
|
||||
bitnami/mariadb:latest
|
||||
```
|
||||
```console
|
||||
$ docker network create reportserver-network
|
||||
```
|
||||
|
||||
3. Create the Reportserver Community container:
|
||||
#### Step 2. Create a MariaDB container with host volume
|
||||
|
||||
```console
|
||||
$ docker run -d --name reportserver-community -p 80:8080 \
|
||||
-e ALLOW_EMPTY_PASSWORD=yes \
|
||||
-e REPORTSERVER_DATABASE_USER=bn_reportserver \
|
||||
-e REPORTSERVER_DATABASE_NAME=bitnami_reportserver \
|
||||
--net reportserver-tier \
|
||||
bitnami/reportserver-community:latest
|
||||
```
|
||||
```console
|
||||
$ docker run -d --name mariadb \
|
||||
--env ALLOW_EMPTY_PASSWORD=yes \
|
||||
--env MARIADB_USER=bn_reportserver \
|
||||
--env MARIADB_PASSWORD=bitnami \
|
||||
--env MARIADB_DATABASE=bitnami_reportserver \
|
||||
--network reportserver-network \
|
||||
--volume /path/to/mariadb-persistence:/bitnami/mariadb \
|
||||
bitnami/mariadb:latest
|
||||
```
|
||||
|
||||
# Upgrade this application
|
||||
#### Step 3. Create the ReportServer Community container with host volumes
|
||||
|
||||
Bitnami provides up-to-date versions of Reportserver Community, 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 Reportserver Community container.
|
||||
```console
|
||||
$ docker run -d --name reportserver \
|
||||
-p 8080:8080 -p 8443:8443 \
|
||||
--env ALLOW_EMPTY_PASSWORD=yes \
|
||||
--env REPORTSERVER_DATABASE_USER=bn_reportserver \
|
||||
--env REPORTSERVER_DATABASE_PASSWORD=bitnami \
|
||||
--env REPORTSERVER_DATABASE_NAME=bitnami_reportserver \
|
||||
--network reportserver-network \
|
||||
--volume /path/to/reportserver-persistence:/bitnami/reportserver \
|
||||
bitnami/reportserver:latest
|
||||
```
|
||||
|
||||
1. Get the updated images:
|
||||
## Configuration
|
||||
|
||||
```console
|
||||
$ docker pull bitnami/reportserver-community:latest
|
||||
```
|
||||
### Environment variables
|
||||
|
||||
2. Stop your container
|
||||
When you start the ReportServer Community 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:
|
||||
|
||||
* For docker-compose: `$ docker-compose stop reportserver-community`
|
||||
* For manual execution: `$ docker stop reportserver-community`
|
||||
- For docker-compose add the variable name and value under the application section in the [`docker-compose.yml`](https://github.com/bitnami/bitnami-docker-reportserver/blob/master/docker-compose.yml) file present in this repository:
|
||||
|
||||
3. [snapshot the MariaDB data](https://github.com/bitnami/bitnami-docker-mariadb#step-2-stop-and-backup-the-currently-running-container)
|
||||
```yaml
|
||||
reportserver:
|
||||
...
|
||||
environment:
|
||||
- REPORTSERVER_PASSWORD=my_password
|
||||
...
|
||||
```
|
||||
|
||||
You can use these snapshots to restore the application state should the upgrade fail.
|
||||
- For manual execution add a `--env` option with each variable and value:
|
||||
|
||||
4. Remove the currently running container
|
||||
```console
|
||||
$ docker run -d --name reportserver -p 80:8080 -p 443:8443 \
|
||||
--env REPORTSERVER_PASSWORD=my_password \
|
||||
--network reportserver-tier \
|
||||
--volume /path/to/reportserver-persistence:/bitnami \
|
||||
bitnami/reportserver:latest
|
||||
```
|
||||
|
||||
* For docker-compose: `$ docker-compose rm -v reportserver-community`
|
||||
* For manual execution: `$ docker rm -v reportserver-community`
|
||||
|
||||
5. Run the new image
|
||||
|
||||
* For docker-compose: `$ docker-compose up reportserver-community`
|
||||
* For manual execution ([mount](#mount-persistent-folders-manually) the directories if needed): `docker run --name reportserver bitnami/reportserver-community:latest`
|
||||
|
||||
# Configuration
|
||||
|
||||
## Environment variables
|
||||
|
||||
When you start the reportserver-community 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.
|
||||
Available environment variables:
|
||||
|
||||
##### User and Site configuration
|
||||
|
||||
- `REPORTSERVER_USERNAME`: Reportserver admin username. Default: **user**
|
||||
- `REPORTSERVER_PASSWORD`: Reportserver admin password. Default: **bitnami**
|
||||
- `REPORTSERVER_EMAIL`: Reportserver admin email. Default: **user@example.com**
|
||||
- `REPORTSERVER_USERNAME`: ReportServer Community application username. Default: **user**
|
||||
- `REPORTSERVER_PASSWORD`: ReportServer Community application password. Default: **bitnami**
|
||||
- `REPORTSERVER_EMAIL`: ReportServer Community application email. Default: **user@example.com**
|
||||
- `REPORTSERVER_FIRST_NAME`: ReportServer Community first name. Default: **FirstName**
|
||||
- `REPORTSERVER_LAST_NAME`: ReportServer Community last name. Default: **LastName**
|
||||
|
||||
##### Use an existing database
|
||||
##### Database connection configuration
|
||||
|
||||
- `MARIADB_HOST`: Hostname for MariaDB server. Default: **mariadb**
|
||||
- `MARIADB_PORT_NUMBER`: Port used by MariaDB server. Default: **3306**
|
||||
- `REPORTSERVER_DATABASE_NAME`: Database name that Reportserver will use to connect with the database. Default: **bitnami_reportserver**
|
||||
- `REPORTSERVER_DATABASE_USER`: Database user that Reportserver will use to connect with the database. Default: **bn_reportserver**
|
||||
- `REPORTSERVER_DATABASE_PASSWORD`: Database password that Reportserver will use to connect with the database. No defaults.
|
||||
- `REPORTSERVER_DATABASE_HOST`: Hostname for the MariaDB or MySQL server. Default: **mariadb**
|
||||
- `REPORTSERVER_DATABASE_PORT_NUMBER`: Port used by the MariaDB or MySQL server. Default: **3306**
|
||||
- `REPORTSERVER_DATABASE_NAME`: Database name that ReportServer Community will use to connect with the database. Default: **bitnami_reportserver**
|
||||
- `REPORTSERVER_DATABASE_USER`: Database user that ReportServer Community will use to connect with the database. Default: **bn_reportserver**
|
||||
- `REPORTSERVER_DATABASE_PASSWORD`: Database password that ReportServer Community will use to connect with the database. No default.
|
||||
- `ALLOW_EMPTY_PASSWORD`: It can be used to allow blank passwords. Default: **no**
|
||||
|
||||
##### Create a database for Reportserver using mysql-client
|
||||
##### Create a database for ReportServer Community 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_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_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 default.
|
||||
- `MYSQL_CLIENT_CREATE_DATABASE_NAME`: New database to be created by the mysql client module. No default.
|
||||
- `MYSQL_CLIENT_CREATE_DATABASE_USER`: New database user to be created by the mysql client module. No default.
|
||||
- `MYSQL_CLIENT_CREATE_DATABASE_PASSWORD`: Database password for the `MYSQL_CLIENT_CREATE_DATABASE_USER` user. No default.
|
||||
- `MYSQL_CLIENT_CREATE_DATABASE_CHARACTER_SET`: Character set to use for the new database. No default.
|
||||
- `MYSQL_CLIENT_CREATE_DATABASE_COLLATE`: Database collation to use for the new database. No default.
|
||||
- `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 default.
|
||||
- `ALLOW_EMPTY_PASSWORD`: It can be used to allow blank passwords. Default: **no**
|
||||
|
||||
##### Modify JAVA_OPTS for the application
|
||||
##### SMTP Configuration
|
||||
|
||||
- `REPORTSERVER_JAVA_OPTS`: Java additional options. Default: `-Djava.awt.headless=true -Xmx4g -XX:+UseConcMarkSweepGC -XX:MaxPermSize=512M -Dfile.encoding=UTF8`
|
||||
To configure ReportServer Community to send email using SMTP you can set the following environment variables:
|
||||
|
||||
If you want to add a new environment variable:
|
||||
- `REPORTSERVER_SMTP_HOST`: SMTP host.
|
||||
- `REPORTSERVER_SMTP_PORT`: SMTP port.
|
||||
- `REPORTSERVER_SMTP_USER`: SMTP account user.
|
||||
- `REPORTSERVER_SMTP_PASSWORD`: SMTP account password.
|
||||
- `REPORTSERVER_SMTP_PROTOCOL`: If specified, SMTP protocol to use. Allowed values: *tls*, *ssl*. No default.
|
||||
|
||||
* For Docker Compose, add the variable name and value under the application section:
|
||||
#### Examples
|
||||
|
||||
```yaml
|
||||
reportserver-community:
|
||||
environment:
|
||||
- REPORTSERVER_PASSWORD=my_password
|
||||
```
|
||||
##### SMTP configuration using a Gmail account
|
||||
|
||||
* For manual execution add a `-e` option with each variable and value:
|
||||
This would be an example of SMTP configuration using a Gmail account:
|
||||
|
||||
```console
|
||||
$ docker run -d -e REPORTSERVER_PASSWORD=my_password -p 80:8080 --name reportserver -v --network=reportserver-tier bitnami/reportserver-community
|
||||
```
|
||||
### Install demo data
|
||||
- Modify the [`docker-compose.yml`](https://github.com/bitnami/bitnami-docker-reportserver/blob/master/docker-compose.yml) file present in this repository:
|
||||
|
||||
Reportserver brings in demo data that can be autmatically loaded setting the following environment variable:
|
||||
```yaml
|
||||
reportserver:
|
||||
...
|
||||
environment:
|
||||
- REPORTSERVER_DATABASE_USER=bn_reportserver
|
||||
- REPORTSERVER_DATABASE_NAME=bitnami_reportserver
|
||||
- ALLOW_EMPTY_PASSWORD=yes
|
||||
- REPORTSERVER_SMTP_HOST=smtp.gmail.com
|
||||
- REPORTSERVER_SMTP_PORT=587
|
||||
- REPORTSERVER_SMTP_USER=your_email@gmail.com
|
||||
- REPORTSERVER_SMTP_PASSWORD=your_password
|
||||
...
|
||||
```
|
||||
|
||||
- REPORTSERVER_INSTALLDEMODATA=yes
|
||||
- For manual execution:
|
||||
|
||||
### Setting a passphrase and salt
|
||||
```console
|
||||
$ docker run -d --name reportserver -p 80:8080 -p 443:8443 \
|
||||
--env REPORTSERVER_DATABASE_USER=bn_reportserver \
|
||||
--env REPORTSERVER_DATABASE_NAME=bitnami_reportserver \
|
||||
--env REPORTSERVER_SMTP_HOST=smtp.gmail.com \
|
||||
--env REPORTSERVER_SMTP_PORT=587 \
|
||||
--env REPORTSERVER_SMTP_USER=your_email@gmail.com \
|
||||
--env REPORTSERVER_SMTP_PASSWORD=your_password \
|
||||
--network reportserver-tier \
|
||||
--volume /path/to/reportserver-persistence:/bitnami \
|
||||
bitnami/reportserver:latest
|
||||
```
|
||||
|
||||
If set, this passphrase and salt are used to generate the passwords of the Reportserver users in the database. If not, they are ramdonly generated.
|
||||
##### Connect ReportServer Community container to an existing database
|
||||
|
||||
- REPORTSERVER_CRYPTPASSPHRASE="my_passphrase"
|
||||
- REPORTSERVER_CRYPTSALT="my_salt" # Maximum 8 characters
|
||||
The Bitnami ReportServer Community container supports connecting the ReportServer Community application to an external database. This would be an example of using an external database for ReportServer Community.
|
||||
|
||||
### SMTP Configuration
|
||||
- Modify the [`docker-compose.yml`](https://github.com/bitnami/bitnami-docker-reportserver/blob/master/docker-compose.yml) file present in this repository:
|
||||
|
||||
To configure Reportserver Community to send email using SMTP you can set the following environment variables:
|
||||
```diff
|
||||
reportserver:
|
||||
...
|
||||
environment:
|
||||
- - REPORTSERVER_DATABASE_HOST=mariadb
|
||||
+ - REPORTSERVER_DATABASE_HOST=mariadb_host
|
||||
- REPORTSERVER_DATABASE_PORT_NUMBER=3306
|
||||
- REPORTSERVER_DATABASE_NAME=reportserver_db
|
||||
- REPORTSERVER_DATABASE_USER=reportserver_user
|
||||
- - ALLOW_EMPTY_PASSWORD=yes
|
||||
+ - REPORTSERVER_DATABASE_PASSWORD=reportserver_password
|
||||
...
|
||||
```
|
||||
|
||||
- `SMTP_HOST`: SMTP host.
|
||||
- `SMTP_PORT`: SMTP port.
|
||||
- `SMTP_EMAIL`: SMTP email.
|
||||
- `SMTP_USER`: SMTP account user.
|
||||
- `SMTP_PASSWORD`: SMTP account password.
|
||||
- `SMTP_SSL_ENABLE`: Enable SSL for SMTP.
|
||||
- `SMTP_TLS_ENABLE`: Enable TLS for SMTP.
|
||||
- `SMTP_TLS_REQUIRED`: TLS is required for SMTP.
|
||||
- For manual execution:
|
||||
|
||||
This would be an example of SMTP configuration using a GMail account:
|
||||
```console
|
||||
$ docker run -d --name reportserver\
|
||||
-p 8080:8080 -p 8443:8443 \
|
||||
--network reportserver-network \
|
||||
--env REPORTSERVER_DATABASE_HOST=mariadb_host \
|
||||
--env REPORTSERVER_DATABASE_PORT_NUMBER=3306 \
|
||||
--env REPORTSERVER_DATABASE_NAME=reportserver_db \
|
||||
--env REPORTSERVER_DATABASE_USER=reportserver_user \
|
||||
--env REPORTSERVER_DATABASE_PASSWORD=reportserver_password \
|
||||
--volume reportserver_data:/bitnami/reportserver \
|
||||
bitnami/reportserver:latest
|
||||
```
|
||||
|
||||
* Modify the [`docker-compose.yml`](https://github.com/bitnami/bitnami-docker-reportserver-community/blob/master/docker-compose.yml) file present in this repository:
|
||||
In case the database already contains data from a previous ReportServer Community installation, you need to set the variable `REPORTSERVER_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 `REPORTSERVER_SKIP_BOOTSTRAP` to `yes`, values for environment variables such as `REPORTSERVER_USERNAME`, `REPORTSERVER_PASSWORD` or `REPORTSERVER_EMAIL` will be ignored.
|
||||
|
||||
## Logging
|
||||
|
||||
```yaml
|
||||
reportserver-community:
|
||||
environment:
|
||||
- MARIADB_HOST=mariadb
|
||||
- MARIADB_PORT_NUMBER=3306
|
||||
- REPORTSERVER_DATABASE_USER=bn_reportserver
|
||||
- REPORTSERVER_DATABASE_NAME=bitnami_reportserver
|
||||
- SMTP_HOST=smtp.gmail.com
|
||||
- SMTP_PORT=587
|
||||
- SMTP_EMAIL=your_email@gmail.com
|
||||
- SMTP_USER=your_email@gmail.com
|
||||
- SMTP_PASSWORD=your_password
|
||||
```
|
||||
|
||||
* For manual execution:
|
||||
The Bitnami ReportServer Community Docker image sends the container logs to `stdout`. To view the logs:
|
||||
|
||||
```console
|
||||
$ docker run -d -p 80:8080 --name reportserver-community --net=reportserver-tier \
|
||||
-e MARIADB_HOST=mariadb \
|
||||
-e MARIADB_PORT_NUMBER=3306 \
|
||||
-e ALLOW_EMPTY_PASSWORD=yes \
|
||||
-e REPORTSERVER_DATABASE_USER=bn_reportserver \
|
||||
-e REPORTSERVER_DATABASE_NAME=bitnami_reportserver \
|
||||
-e SMTP_HOST=smtp.gmail.com \
|
||||
-e SMTP_PORT=587 \
|
||||
-e SMTP_USER=your_email@gmail.com \
|
||||
-e SMTP_PASSWORD=your_password \
|
||||
bitnami/reportserver-community
|
||||
$ docker logs reportserver
|
||||
```
|
||||
|
||||
Or using Docker Compose:
|
||||
|
||||
```console
|
||||
$ docker-compose logs reportserver
|
||||
```
|
||||
|
||||
You can configure the containers [logging driver](https://docs.docker.com/engine/admin/logging/overview/) using the `--log-driver` option if you wish to consume the container logs differently. In the default configuration docker uses the `json-file` driver.
|
||||
|
||||
## Maintenance
|
||||
|
||||
### Backing up your container
|
||||
|
||||
To backup your data, configuration and logs, follow these simple steps:
|
||||
|
||||
#### Step 1: Stop the currently running container
|
||||
|
||||
```console
|
||||
$ docker stop reportserver
|
||||
```
|
||||
|
||||
Or using Docker Compose:
|
||||
|
||||
```console
|
||||
$ docker-compose stop reportserver
|
||||
```
|
||||
|
||||
#### 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/reportserver-backups:/backups --volumes-from reportserver busybox \
|
||||
cp -a /bitnami/reportserver /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 ReportServer Community container:
|
||||
|
||||
```diff
|
||||
$ docker run -d --name reportserver \
|
||||
...
|
||||
- --volume /path/to/reportserver-persistence:/bitnami/reportserver \
|
||||
+ --volume /path/to/reportserver-backups/latest:/bitnami/reportserver \
|
||||
bitnami/reportserver:latest
|
||||
```
|
||||
|
||||
### Upgrade this image
|
||||
|
||||
Bitnami provides up-to-date versions of MariaDB and ReportServer Community, 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 ReportServer Community container. For the MariaDB upgrade see: https://github.com/bitnami/bitnami-docker-mariadb/blob/master/README.md#upgrade-this-image
|
||||
|
||||
The `bitnami/reportserver: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/reportserver:latest`. However it is recommended to use [tagged versions](https://hub.docker.com/r/bitnami/reportserver/tags/).
|
||||
|
||||
#### Step 1: Get the updated image
|
||||
|
||||
```console
|
||||
$ docker pull bitnami/reportserver:latest
|
||||
```
|
||||
|
||||
#### Step 2: Stop the running container
|
||||
|
||||
Stop the currently running container using the command
|
||||
|
||||
```console
|
||||
$ docker-compose stop reportserver
|
||||
```
|
||||
|
||||
#### 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 reportserver
|
||||
```
|
||||
|
||||
#### 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
|
||||
```
|
||||
|
||||
# Learn more about ReportServer Community
|
||||
@@ -291,29 +443,41 @@ Developers can also access the [API documentation](https://reportserver.net/api/
|
||||
|
||||
More information is available from the [ReportServer website](https://reportserver.net/en/).
|
||||
|
||||
# Notable Changes
|
||||
## Notable Changes
|
||||
|
||||
## 3.1.2-6022-debian-10-r23
|
||||
### 3.7.0-6044-debian-10-r52
|
||||
|
||||
- The size of the container image has been reduced.
|
||||
- The configuration logic is now based on Bash scripts in the *rootfs/* folder.
|
||||
|
||||
|
||||
### 3.1.2-6022-debian-10-r23
|
||||
|
||||
- Java distribution has been migrated from AdoptOpenJDK to OpenJDK Liberica. As part of VMware, we have an agreement with Bell Software to distribute the Liberica distribution of OpenJDK. That way, we can provide support & the latest versions and security releases for Java.
|
||||
|
||||
# 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-reportserver-community/issues), or submit a [pull request](https://github.com/bitnami/bitnami-docker-reportserver-community/pulls) with your contribution.
|
||||
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-reportserver/issues), or submit a [pull request](https://github.com/bitnami/bitnami-docker-reportserver/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-reportserver-community/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-reportserver/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)
|
||||
- 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
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
|
||||
@@ -1,27 +1,27 @@
|
||||
version: '2'
|
||||
|
||||
services:
|
||||
mariadb:
|
||||
image: docker.io/bitnami/mariadb:10.3
|
||||
image: docker.io/bitnami/mariadb:10.4
|
||||
volumes:
|
||||
- 'mariadb_data:/bitnami/mariadb'
|
||||
environment:
|
||||
- ALLOW_EMPTY_PASSWORD=yes
|
||||
- MARIADB_USER=bn_reportserver
|
||||
- MARIADB_DATABASE=bitnami_reportserver
|
||||
- ALLOW_EMPTY_PASSWORD=yes
|
||||
volumes:
|
||||
- 'mariadb_data:/bitnami'
|
||||
reportserver:
|
||||
image: docker.io/bitnami/reportserver:3
|
||||
environment:
|
||||
- MARIADB_HOST=mariadb
|
||||
- MARIADB_PORT_NUMBER=3306
|
||||
- REPORTSERVER_DATABASE_USER=bn_reportserver
|
||||
- REPORTSERVER_DATABASE_NAME=bitnami_reportserver
|
||||
- ALLOW_EMPTY_PASSWORD=yes
|
||||
ports:
|
||||
- '80:8080'
|
||||
- '443:8443'
|
||||
depends_on:
|
||||
- mariadb
|
||||
environment:
|
||||
# ALLOW_EMPTY_PASSWORD is recommended only for development.
|
||||
- ALLOW_EMPTY_PASSWORD=yes
|
||||
- REPORTSERVER_DATABASE_HOST=mariadb
|
||||
- REPORTSERVER_DATABASE_PORT_NUMBER=3306
|
||||
- REPORTSERVER_DATABASE_USER=bn_reportserver
|
||||
- REPORTSERVER_DATABASE_NAME=bitnami_reportserver
|
||||
volumes:
|
||||
mariadb_data:
|
||||
driver: local
|
||||
|
||||
Reference in New Issue
Block a user