mirror of
https://github.com/bitnami/containers.git
synced 2026-03-15 14:58:17 +08:00
4.2.1-debian-10-r70 release
This commit is contained in:
@@ -1,46 +1,50 @@
|
|||||||
FROM docker.io/bitnami/minideb:buster
|
FROM docker.io/bitnami/minideb:buster
|
||||||
LABEL maintainer "Bitnami <containers@bitnami.com>"
|
LABEL maintainer "Bitnami <containers@bitnami.com>"
|
||||||
|
|
||||||
ENV PATH="/opt/bitnami/ruby/bin:/opt/bitnami/postgresql/bin:/opt/bitnami/mysql/bin:/opt/bitnami/git/bin:/opt/bitnami/common/bin:/opt/bitnami/nami/bin:$PATH"
|
ENV HOME="/" \
|
||||||
|
OS_ARCH="amd64" \
|
||||||
|
OS_FLAVOUR="debian-10" \
|
||||||
|
OS_NAME="linux"
|
||||||
|
|
||||||
COPY prebuildfs /
|
COPY prebuildfs /
|
||||||
# Install required system packages and dependencies
|
# Install required system packages and dependencies
|
||||||
RUN install_packages ca-certificates curl ghostscript gsfonts gzip imagemagick libaudit1 libbsd0 libc6 libcap-ng0 libcom-err2 libcurl4 libedit2 libffi6 libgcc1 libgcrypt20 libgmp-dev libgmp10 libgnutls30 libgpg-error0 libgssapi-krb5-2 libhogweed4 libicu63 libidn2-0 libjemalloc2 libk5crypto3 libkeyutils1 libkrb5-3 libkrb5support0 libldap-2.4-2 liblzma5 libmariadb3 libncurses6 libnettle6 libnghttp2-14 libp11-kit0 libpam0g libpq5 libpsl5 libreadline-dev libreadline7 librtmp1 libsasl2-2 libssh2-1 libssl-dev libssl1.1 libstdc++6 libtasn1-6 libtinfo6 libunistring2 libuuid1 libxml2 libxml2-dev libxslt1-dev libxslt1.1 procps sqlite3 sudo tar zlib1g zlib1g-dev
|
RUN install_packages acl ca-certificates curl ghostscript gzip imagemagick libaudit1 libbsd0 libc6 libcap-ng0 libcom-err2 libcurl4 libedit2 libffi6 libgcc1 libgcrypt20 libgmp-dev libgmp10 libgnutls30 libgpg-error0 libgssapi-krb5-2 libhogweed4 libicu63 libidn2-0 libjemalloc2 libk5crypto3 libkeyutils1 libkrb5-3 libkrb5support0 libldap-2.4-2 liblzma5 libmariadb3 libncurses6 libnettle6 libnghttp2-14 libp11-kit0 libpam0g libpq5 libpsl5 libreadline-dev libreadline7 librtmp1 libsasl2-2 libssh2-1 libssl-dev libssl1.1 libstdc++6 libtasn1-6 libtinfo6 libunistring2 libuuid1 libxml2 libxml2-dev libxslt1-dev libxslt1.1 procps sqlite3 tar zlib1g zlib1g-dev
|
||||||
RUN /build/bitnami-user.sh
|
RUN . /opt/bitnami/scripts/libcomponent.sh && component_unpack "yq" "3.4.1-0" --checksum c88c76a7b5214407821771e5fc340f0320d5ded19eada938629603a982b8b640
|
||||||
RUN /build/install-nami.sh
|
RUN . /opt/bitnami/scripts/libcomponent.sh && component_unpack "ruby" "2.6.8-1" --checksum aa85db57a30d79ac61743dffac4b1cbdc58b7736ffbffd873ed32248b07f9e51
|
||||||
RUN bitnami-pkg install ruby-2.6.8-1 --checksum aa85db57a30d79ac61743dffac4b1cbdc58b7736ffbffd873ed32248b07f9e51
|
RUN . /opt/bitnami/scripts/libcomponent.sh && component_unpack "postgresql-client" "11.12.0-0" --checksum 94395af20a0ee9e12aaab0d1a58bb42290145af8ab7f736c4bb7cc3f51bbf2b6
|
||||||
RUN bitnami-pkg install postgresql-client-11.12.0-0 --checksum 94395af20a0ee9e12aaab0d1a58bb42290145af8ab7f736c4bb7cc3f51bbf2b6
|
RUN . /opt/bitnami/scripts/libcomponent.sh && component_unpack "mysql-client" "10.4.20-0" --checksum 85d9e5d8f92e8aac0cdc8a17d09e1887fa1b11d5e5319a66093a4e933b73ac8c
|
||||||
RUN bitnami-pkg install mysql-client-10.3.30-0 --checksum 47107f86621bb184307e47bbb15244d076575f0e0f7d339f198ef312b6f3f285
|
RUN . /opt/bitnami/scripts/libcomponent.sh && component_unpack "git" "2.32.0-0" --checksum 3094f50c904e966bd6c6a2d6152cf41fd3a816d32395622a785ccbcda62b7c5f
|
||||||
RUN bitnami-pkg install git-2.32.0-0 --checksum 3094f50c904e966bd6c6a2d6152cf41fd3a816d32395622a785ccbcda62b7c5f
|
RUN . /opt/bitnami/scripts/libcomponent.sh && component_unpack "redmine" "4.2.1-2" --checksum 40a7b16798c36c4b393713f93759a5b946dea3ac91e8234da0d3e95b3a6dd534
|
||||||
RUN bitnami-pkg install tini-0.19.0-1 --checksum 9b1f1c095944bac88a62c1b63f3bff1bb123aa7ccd371c908c0e5b41cec2528d
|
RUN . /opt/bitnami/scripts/libcomponent.sh && component_unpack "gosu" "1.13.0-0" --checksum fd7257c2736164d02832dbf72e2c1ed9d875bf3e32f0988520796bc503330129
|
||||||
RUN bitnami-pkg unpack redmine-4.2.1-2 --checksum 40a7b16798c36c4b393713f93759a5b946dea3ac91e8234da0d3e95b3a6dd534
|
RUN chmod g+rwX /opt/bitnami
|
||||||
RUN bitnami-pkg install gosu-1.13.0-0 --checksum fd7257c2736164d02832dbf72e2c1ed9d875bf3e32f0988520796bc503330129
|
|
||||||
|
|
||||||
COPY rootfs /
|
COPY rootfs /
|
||||||
ENV BITNAMI_APP_NAME="redmine" \
|
RUN /opt/bitnami/scripts/mysql-client/postunpack.sh
|
||||||
BITNAMI_IMAGE_VERSION="4.2.1-debian-10-r69" \
|
RUN /opt/bitnami/scripts/redmine/postunpack.sh
|
||||||
OS_ARCH="amd64" \
|
ENV ALLOW_EMPTY_PASSWORD="no" \
|
||||||
OS_FLAVOUR="debian-10" \
|
BITNAMI_APP_NAME="redmine" \
|
||||||
OS_NAME="linux" \
|
BITNAMI_IMAGE_VERSION="4.2.1-debian-10-r70" \
|
||||||
REDMINE_DB_MYSQL="mariadb" \
|
MARIADB_HOST="mariadb" \
|
||||||
REDMINE_DB_NAME="bitnami_redmine" \
|
MARIADB_PORT_NUMBER="3306" \
|
||||||
REDMINE_DB_PASSWORD="" \
|
MARIADB_ROOT_PASSWORD="" \
|
||||||
REDMINE_DB_PORT_NUMBER="" \
|
MARIADB_ROOT_USER="root" \
|
||||||
REDMINE_DB_POSTGRES="" \
|
MYSQL_CLIENT_CREATE_DATABASE_NAME="" \
|
||||||
REDMINE_DB_USERNAME="bn_redmine" \
|
MYSQL_CLIENT_CREATE_DATABASE_PASSWORD="" \
|
||||||
REDMINE_EMAIL="user@example.com" \
|
MYSQL_CLIENT_CREATE_DATABASE_PRIVILEGES="ALL" \
|
||||||
REDMINE_LANGUAGE="en" \
|
MYSQL_CLIENT_CREATE_DATABASE_USER="" \
|
||||||
REDMINE_PASSWORD="bitnami1" \
|
MYSQL_CLIENT_ENABLE_SSL="no" \
|
||||||
REDMINE_USERNAME="user" \
|
MYSQL_CLIENT_SSL_CA_FILE="" \
|
||||||
SMTP_AUTHENTICATION="login" \
|
PATH="/opt/bitnami/common/bin:/opt/bitnami/ruby/bin:/opt/bitnami/postgresql/bin:/opt/bitnami/mysql/bin:/opt/bitnami/git/bin:$PATH" \
|
||||||
SMTP_DOMAIN="example.com" \
|
POSTGRESQL_CLIENT_CREATE_DATABASE_NAME="" \
|
||||||
SMTP_HOST="" \
|
POSTGRESQL_CLIENT_CREATE_DATABASE_PASSWORD="" \
|
||||||
SMTP_PASSWORD="" \
|
POSTGRESQL_CLIENT_CREATE_DATABASE_USERNAME="" \
|
||||||
SMTP_PORT="" \
|
POSTGRESQL_HOST="postgresql" \
|
||||||
SMTP_TLS="true" \
|
POSTGRESQL_PORT_NUMBER="5432" \
|
||||||
SMTP_USER=""
|
POSTGRESQL_ROOT_PASSWORD="" \
|
||||||
|
POSTGRESQL_ROOT_USER="postgres"
|
||||||
|
|
||||||
EXPOSE 3000
|
EXPOSE 3000
|
||||||
|
|
||||||
ENTRYPOINT [ "/app-entrypoint.sh" ]
|
USER root
|
||||||
CMD [ "/run.sh" ]
|
ENTRYPOINT [ "/opt/bitnami/scripts/redmine/entrypoint.sh" ]
|
||||||
|
CMD [ "/opt/bitnami/scripts/redmine/run.sh" ]
|
||||||
|
|||||||
@@ -1,24 +1,27 @@
|
|||||||
version: '2'
|
version: '2'
|
||||||
services:
|
services:
|
||||||
mariadb:
|
mariadb:
|
||||||
image: docker.io/bitnami/mariadb:10.3
|
image: docker.io/bitnami/mariadb:10.4
|
||||||
|
volumes:
|
||||||
|
- 'mariadb_data:/bitnami/mariadb'
|
||||||
environment:
|
environment:
|
||||||
- ALLOW_EMPTY_PASSWORD=yes
|
- ALLOW_EMPTY_PASSWORD=yes
|
||||||
- MARIADB_USER=bn_redmine
|
- MARIADB_USER=bn_redmine
|
||||||
- MARIADB_DATABASE=bitnami_redmine
|
- MARIADB_DATABASE=bitnami_redmine
|
||||||
volumes:
|
|
||||||
- 'mariadb_data:/bitnami'
|
|
||||||
redmine:
|
redmine:
|
||||||
image: docker.io/bitnami/redmine:4
|
image: docker.io/bitnami/redmine:4
|
||||||
environment:
|
|
||||||
- REDMINE_DB_USERNAME=bn_redmine
|
|
||||||
- REDMINE_DB_NAME=bitnami_redmine
|
|
||||||
ports:
|
ports:
|
||||||
- '80:3000'
|
- '80:3000'
|
||||||
volumes:
|
volumes:
|
||||||
- 'redmine_data:/bitnami'
|
- 'redmine_data:/bitnami/redmine'
|
||||||
depends_on:
|
depends_on:
|
||||||
- mariadb
|
- mariadb
|
||||||
|
environment:
|
||||||
|
- ALLOW_EMPTY_PASSWORD=yes
|
||||||
|
- REDMINE_DATABASE_HOST=mariadb
|
||||||
|
- REDMINE_DATABASE_PORT_NUMBER=3306
|
||||||
|
- REDMINE_DATABASE_USER=bn_redmine
|
||||||
|
- REDMINE_DATABASE_NAME=bitnami_redmine
|
||||||
volumes:
|
volumes:
|
||||||
mariadb_data:
|
mariadb_data:
|
||||||
driver: local
|
driver: local
|
||||||
|
|||||||
@@ -1,6 +0,0 @@
|
|||||||
#!/bin/bash
|
|
||||||
|
|
||||||
useradd -ms /bin/bash bitnami
|
|
||||||
mkdir -p /opt/bitnami
|
|
||||||
sed -i -e 's/\s*Defaults\s*secure_path\s*=/# Defaults secure_path=/' /etc/sudoers
|
|
||||||
echo 'bitnami ALL=NOPASSWD: ALL' >> /etc/sudoers
|
|
||||||
@@ -1,7 +0,0 @@
|
|||||||
#!/bin/bash
|
|
||||||
|
|
||||||
curl --silent -L https://nami-prod.s3.amazonaws.com/tools/nami/releases/nami-2.0.1-0-linux-x64.tar.gz > /tmp/nami-linux-x64.tar.gz
|
|
||||||
echo "05e6e1e86cbb419cd80f832650ad06d97bcabca2c3a9e953e81b2674a29cc94e /tmp/nami-linux-x64.tar.gz" | sha256sum --check
|
|
||||||
mkdir -p /opt/bitnami/nami /opt/bitnami/licenses
|
|
||||||
tar xzf /tmp/nami-linux-x64.tar.gz --strip 1 -C /opt/bitnami/nami && rm /tmp/nami-linux-x64.tar.gz
|
|
||||||
curl --silent -L https://raw.githubusercontent.com/bitnami/nami/master/COPYING > /opt/bitnami/licenses/nami-2.0.1-0.txt
|
|
||||||
@@ -15,10 +15,10 @@
|
|||||||
},
|
},
|
||||||
"mysql-client": {
|
"mysql-client": {
|
||||||
"arch": "amd64",
|
"arch": "amd64",
|
||||||
"digest": "47107f86621bb184307e47bbb15244d076575f0e0f7d339f198ef312b6f3f285",
|
"digest": "85d9e5d8f92e8aac0cdc8a17d09e1887fa1b11d5e5319a66093a4e933b73ac8c",
|
||||||
"distro": "debian-10",
|
"distro": "debian-10",
|
||||||
"type": "NAMI",
|
"type": "NAMI",
|
||||||
"version": "10.3.30-0"
|
"version": "10.4.20-0"
|
||||||
},
|
},
|
||||||
"postgresql-client": {
|
"postgresql-client": {
|
||||||
"arch": "amd64",
|
"arch": "amd64",
|
||||||
@@ -41,11 +41,11 @@
|
|||||||
"type": "NAMI",
|
"type": "NAMI",
|
||||||
"version": "2.6.8-1"
|
"version": "2.6.8-1"
|
||||||
},
|
},
|
||||||
"tini": {
|
"yq": {
|
||||||
"arch": "amd64",
|
"arch": "amd64",
|
||||||
"digest": "9b1f1c095944bac88a62c1b63f3bff1bb123aa7ccd371c908c0e5b41cec2528d",
|
"digest": "c88c76a7b5214407821771e5fc340f0320d5ded19eada938629603a982b8b640",
|
||||||
"distro": "debian-10",
|
"distro": "debian-10",
|
||||||
"type": "NAMI",
|
"type": "NAMI",
|
||||||
"version": "0.19.0-1"
|
"version": "3.4.1-0"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -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,119 @@
|
|||||||
|
#!/bin/bash
|
||||||
|
#
|
||||||
|
# Library for managing files
|
||||||
|
|
||||||
|
# shellcheck disable=SC1091
|
||||||
|
|
||||||
|
# Load Generic Libraries
|
||||||
|
. /opt/bitnami/scripts/libos.sh
|
||||||
|
|
||||||
|
# Functions
|
||||||
|
|
||||||
|
########################
|
||||||
|
# Replace a regex in a file
|
||||||
|
# Arguments:
|
||||||
|
# $1 - filename
|
||||||
|
# $2 - match regex
|
||||||
|
# $3 - substitute regex
|
||||||
|
# $4 - use POSIX regex. Default: true
|
||||||
|
# Returns:
|
||||||
|
# None
|
||||||
|
#########################
|
||||||
|
replace_in_file() {
|
||||||
|
local filename="${1:?filename is required}"
|
||||||
|
local match_regex="${2:?match regex is required}"
|
||||||
|
local substitute_regex="${3:?substitute regex is required}"
|
||||||
|
local posix_regex=${4:-true}
|
||||||
|
|
||||||
|
local result
|
||||||
|
|
||||||
|
# We should avoid using 'sed in-place' substitutions
|
||||||
|
# 1) They are not compatible with files mounted from ConfigMap(s)
|
||||||
|
# 2) We found incompatibility issues with Debian10 and "in-place" substitutions
|
||||||
|
del=$'\001' # Use a non-printable character as a 'sed' delimiter to avoid issues
|
||||||
|
if [[ $posix_regex = true ]]; then
|
||||||
|
result="$(sed -E "s${del}${match_regex}${del}${substitute_regex}${del}g" "$filename")"
|
||||||
|
else
|
||||||
|
result="$(sed "s${del}${match_regex}${del}${substitute_regex}${del}g" "$filename")"
|
||||||
|
fi
|
||||||
|
echo "$result" > "$filename"
|
||||||
|
}
|
||||||
|
|
||||||
|
########################
|
||||||
|
# Remove a line in a file based on a regex
|
||||||
|
# Arguments:
|
||||||
|
# $1 - filename
|
||||||
|
# $2 - match regex
|
||||||
|
# $3 - use POSIX regex. Default: true
|
||||||
|
# Returns:
|
||||||
|
# None
|
||||||
|
#########################
|
||||||
|
remove_in_file() {
|
||||||
|
local filename="${1:?filename is required}"
|
||||||
|
local match_regex="${2:?match regex is required}"
|
||||||
|
local posix_regex=${3:-true}
|
||||||
|
local result
|
||||||
|
|
||||||
|
# We should avoid using 'sed in-place' substitutions
|
||||||
|
# 1) They are not compatible with files mounted from ConfigMap(s)
|
||||||
|
# 2) We found incompatibility issues with Debian10 and "in-place" substitutions
|
||||||
|
if [[ $posix_regex = true ]]; then
|
||||||
|
result="$(sed -E "/$match_regex/d" "$filename")"
|
||||||
|
else
|
||||||
|
result="$(sed "/$match_regex/d" "$filename")"
|
||||||
|
fi
|
||||||
|
echo "$result" > "$filename"
|
||||||
|
}
|
||||||
|
|
||||||
|
########################
|
||||||
|
# Appends text after the last line matching a pattern
|
||||||
|
# Arguments:
|
||||||
|
# $1 - file
|
||||||
|
# $2 - match regex
|
||||||
|
# $3 - contents to add
|
||||||
|
# Returns:
|
||||||
|
# None
|
||||||
|
#########################
|
||||||
|
append_file_after_last_match() {
|
||||||
|
local file="${1:?missing file}"
|
||||||
|
local match_regex="${2:?missing pattern}"
|
||||||
|
local value="${3:?missing value}"
|
||||||
|
|
||||||
|
# We read the file in reverse, replace the first match (0,/pattern/s) and then reverse the results again
|
||||||
|
result="$(tac "$file" | sed -E "0,/($match_regex)/s||${value}\n\1|" | tac)"
|
||||||
|
echo "$result" > "$file"
|
||||||
|
}
|
||||||
|
|
||||||
|
########################
|
||||||
|
# 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,248 @@
|
|||||||
|
#!/bin/bash
|
||||||
|
#
|
||||||
|
# Validation functions library
|
||||||
|
|
||||||
|
# shellcheck disable=SC1091
|
||||||
|
|
||||||
|
# Load Generic Libraries
|
||||||
|
. /opt/bitnami/scripts/liblog.sh
|
||||||
|
|
||||||
|
# Functions
|
||||||
|
|
||||||
|
########################
|
||||||
|
# Check if the provided argument is an integer
|
||||||
|
# Arguments:
|
||||||
|
# $1 - Value to check
|
||||||
|
# Returns:
|
||||||
|
# Boolean
|
||||||
|
#########################
|
||||||
|
is_int() {
|
||||||
|
local -r int="${1:?missing value}"
|
||||||
|
if [[ "$int" =~ ^-?[0-9]+ ]]; then
|
||||||
|
true
|
||||||
|
else
|
||||||
|
false
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
########################
|
||||||
|
# Check if the provided argument is a positive integer
|
||||||
|
# Arguments:
|
||||||
|
# $1 - Value to check
|
||||||
|
# Returns:
|
||||||
|
# Boolean
|
||||||
|
#########################
|
||||||
|
is_positive_int() {
|
||||||
|
local -r int="${1:?missing value}"
|
||||||
|
if is_int "$int" && (( "${int}" >= 0 )); then
|
||||||
|
true
|
||||||
|
else
|
||||||
|
false
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
########################
|
||||||
|
# Check if the provided argument is a boolean or is the string 'yes/true'
|
||||||
|
# Arguments:
|
||||||
|
# $1 - Value to check
|
||||||
|
# Returns:
|
||||||
|
# Boolean
|
||||||
|
#########################
|
||||||
|
is_boolean_yes() {
|
||||||
|
local -r bool="${1:-}"
|
||||||
|
# comparison is performed without regard to the case of alphabetic characters
|
||||||
|
shopt -s nocasematch
|
||||||
|
if [[ "$bool" = 1 || "$bool" =~ ^(yes|true)$ ]]; then
|
||||||
|
true
|
||||||
|
else
|
||||||
|
false
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
########################
|
||||||
|
# Check if the provided argument is a boolean yes/no value
|
||||||
|
# Arguments:
|
||||||
|
# $1 - Value to check
|
||||||
|
# Returns:
|
||||||
|
# Boolean
|
||||||
|
#########################
|
||||||
|
is_yes_no_value() {
|
||||||
|
local -r bool="${1:-}"
|
||||||
|
if [[ "$bool" =~ ^(yes|no)$ ]]; then
|
||||||
|
true
|
||||||
|
else
|
||||||
|
false
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
########################
|
||||||
|
# Check if the provided argument is a boolean true/false value
|
||||||
|
# Arguments:
|
||||||
|
# $1 - Value to check
|
||||||
|
# Returns:
|
||||||
|
# Boolean
|
||||||
|
#########################
|
||||||
|
is_true_false_value() {
|
||||||
|
local -r bool="${1:-}"
|
||||||
|
if [[ "$bool" =~ ^(true|false)$ ]]; then
|
||||||
|
true
|
||||||
|
else
|
||||||
|
false
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
########################
|
||||||
|
# Check if the provided argument is an empty string or not defined
|
||||||
|
# Arguments:
|
||||||
|
# $1 - Value to check
|
||||||
|
# Returns:
|
||||||
|
# Boolean
|
||||||
|
#########################
|
||||||
|
is_empty_value() {
|
||||||
|
local -r val="${1:-}"
|
||||||
|
if [[ -z "$val" ]]; then
|
||||||
|
true
|
||||||
|
else
|
||||||
|
false
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
########################
|
||||||
|
# Validate if the provided argument is a valid port
|
||||||
|
# Arguments:
|
||||||
|
# $1 - Port to validate
|
||||||
|
# Returns:
|
||||||
|
# Boolean and error message
|
||||||
|
#########################
|
||||||
|
validate_port() {
|
||||||
|
local value
|
||||||
|
local unprivileged=0
|
||||||
|
|
||||||
|
# Parse flags
|
||||||
|
while [[ "$#" -gt 0 ]]; do
|
||||||
|
case "$1" in
|
||||||
|
-unprivileged)
|
||||||
|
unprivileged=1
|
||||||
|
;;
|
||||||
|
--)
|
||||||
|
shift
|
||||||
|
break
|
||||||
|
;;
|
||||||
|
-*)
|
||||||
|
stderr_print "unrecognized flag $1"
|
||||||
|
return 1
|
||||||
|
;;
|
||||||
|
*)
|
||||||
|
break
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
shift
|
||||||
|
done
|
||||||
|
|
||||||
|
if [[ "$#" -gt 1 ]]; then
|
||||||
|
echo "too many arguments provided"
|
||||||
|
return 2
|
||||||
|
elif [[ "$#" -eq 0 ]]; then
|
||||||
|
stderr_print "missing port argument"
|
||||||
|
return 1
|
||||||
|
else
|
||||||
|
value=$1
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [[ -z "$value" ]]; then
|
||||||
|
echo "the value is empty"
|
||||||
|
return 1
|
||||||
|
else
|
||||||
|
if ! is_int "$value"; then
|
||||||
|
echo "value is not an integer"
|
||||||
|
return 2
|
||||||
|
elif [[ "$value" -lt 0 ]]; then
|
||||||
|
echo "negative value provided"
|
||||||
|
return 2
|
||||||
|
elif [[ "$value" -gt 65535 ]]; then
|
||||||
|
echo "requested port is greater than 65535"
|
||||||
|
return 2
|
||||||
|
elif [[ "$unprivileged" = 1 && "$value" -lt 1024 ]]; then
|
||||||
|
echo "privileged port requested"
|
||||||
|
return 3
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
########################
|
||||||
|
# Validate if the provided argument is a valid IPv4 address
|
||||||
|
# Arguments:
|
||||||
|
# $1 - IP to validate
|
||||||
|
# Returns:
|
||||||
|
# Boolean
|
||||||
|
#########################
|
||||||
|
validate_ipv4() {
|
||||||
|
local ip="${1:?ip is missing}"
|
||||||
|
local stat=1
|
||||||
|
|
||||||
|
if [[ $ip =~ ^[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}$ ]]; then
|
||||||
|
read -r -a ip_array <<< "$(tr '.' ' ' <<< "$ip")"
|
||||||
|
[[ ${ip_array[0]} -le 255 && ${ip_array[1]} -le 255 \
|
||||||
|
&& ${ip_array[2]} -le 255 && ${ip_array[3]} -le 255 ]]
|
||||||
|
stat=$?
|
||||||
|
fi
|
||||||
|
return $stat
|
||||||
|
}
|
||||||
|
|
||||||
|
########################
|
||||||
|
# Validate a string format
|
||||||
|
# Arguments:
|
||||||
|
# $1 - String to validate
|
||||||
|
# Returns:
|
||||||
|
# Boolean
|
||||||
|
#########################
|
||||||
|
validate_string() {
|
||||||
|
local string
|
||||||
|
local min_length=-1
|
||||||
|
local max_length=-1
|
||||||
|
|
||||||
|
# Parse flags
|
||||||
|
while [ "$#" -gt 0 ]; do
|
||||||
|
case "$1" in
|
||||||
|
-min-length)
|
||||||
|
shift
|
||||||
|
min_length=${1:-}
|
||||||
|
;;
|
||||||
|
-max-length)
|
||||||
|
shift
|
||||||
|
max_length=${1:-}
|
||||||
|
;;
|
||||||
|
--)
|
||||||
|
shift
|
||||||
|
break
|
||||||
|
;;
|
||||||
|
-*)
|
||||||
|
stderr_print "unrecognized flag $1"
|
||||||
|
return 1
|
||||||
|
;;
|
||||||
|
*)
|
||||||
|
break
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
shift
|
||||||
|
done
|
||||||
|
|
||||||
|
if [ "$#" -gt 1 ]; then
|
||||||
|
stderr_print "too many arguments provided"
|
||||||
|
return 2
|
||||||
|
elif [ "$#" -eq 0 ]; then
|
||||||
|
stderr_print "missing string"
|
||||||
|
return 1
|
||||||
|
else
|
||||||
|
string=$1
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [[ "$min_length" -ge 0 ]] && [[ "${#string}" -lt "$min_length" ]]; then
|
||||||
|
echo "string length is less than $min_length"
|
||||||
|
return 1
|
||||||
|
fi
|
||||||
|
if [[ "$max_length" -ge 0 ]] && [[ "${#string}" -gt "$max_length" ]]; then
|
||||||
|
echo "string length is great than $max_length"
|
||||||
|
return 1
|
||||||
|
fi
|
||||||
|
}
|
||||||
@@ -0,0 +1,49 @@
|
|||||||
|
#!/bin/bash
|
||||||
|
#
|
||||||
|
# Library for managing versions strings
|
||||||
|
|
||||||
|
# shellcheck disable=SC1091
|
||||||
|
|
||||||
|
# Load Generic Libraries
|
||||||
|
. /opt/bitnami/scripts/liblog.sh
|
||||||
|
|
||||||
|
# Functions
|
||||||
|
########################
|
||||||
|
# Gets semantic version
|
||||||
|
# Arguments:
|
||||||
|
# $1 - version: string to extract major.minor.patch
|
||||||
|
# $2 - section: 1 to extract major, 2 to extract minor, 3 to extract patch
|
||||||
|
# Returns:
|
||||||
|
# array with the major, minor and release
|
||||||
|
#########################
|
||||||
|
get_sematic_version () {
|
||||||
|
local version="${1:?version is required}"
|
||||||
|
local section="${2:?section is required}"
|
||||||
|
local -a version_sections
|
||||||
|
|
||||||
|
#Regex to parse versions: x.y.z
|
||||||
|
local -r regex='([0-9]+)(\.([0-9]+)(\.([0-9]+))?)?'
|
||||||
|
|
||||||
|
if [[ "$version" =~ $regex ]]; then
|
||||||
|
local i=1
|
||||||
|
local j=1
|
||||||
|
local n=${#BASH_REMATCH[*]}
|
||||||
|
|
||||||
|
while [[ $i -lt $n ]]; do
|
||||||
|
if [[ -n "${BASH_REMATCH[$i]}" ]] && [[ "${BASH_REMATCH[$i]:0:1}" != '.' ]]; then
|
||||||
|
version_sections[$j]=${BASH_REMATCH[$i]}
|
||||||
|
((j++))
|
||||||
|
fi
|
||||||
|
((i++))
|
||||||
|
done
|
||||||
|
|
||||||
|
local number_regex='^[0-9]+$'
|
||||||
|
if [[ "$section" =~ $number_regex ]] && (( section > 0 )) && (( section <= 3 )); then
|
||||||
|
echo "${version_sections[$section]}"
|
||||||
|
return
|
||||||
|
else
|
||||||
|
stderr_print "Section allowed values are: 1, 2, and 3"
|
||||||
|
return 1
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
}
|
||||||
@@ -0,0 +1,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,14 +0,0 @@
|
|||||||
#!/bin/bash -e
|
|
||||||
|
|
||||||
. /opt/bitnami/base/functions
|
|
||||||
. /opt/bitnami/base/helpers
|
|
||||||
|
|
||||||
print_welcome_page
|
|
||||||
|
|
||||||
if [[ "$1" == "nami" && "$2" == "start" ]] || [[ "$1" == "/run.sh" ]]; then
|
|
||||||
. /init.sh
|
|
||||||
nami_initialize redmine
|
|
||||||
info "Starting gosu... "
|
|
||||||
fi
|
|
||||||
|
|
||||||
exec tini -- "$@"
|
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
#!/bin/bash
|
|
||||||
|
|
||||||
# Set default values depending on database variation
|
|
||||||
if [ -n "$REDMINE_DB_POSTGRES" ]; then
|
|
||||||
export REDMINE_DB_PORT_NUMBER=${REDMINE_DB_PORT_NUMBER:-5432}
|
|
||||||
export REDMINE_DB_USERNAME=${REDMINE_DB_USERNAME:-postgres}
|
|
||||||
elif [ -n "$REDMINE_DB_MYSQL" ]; then
|
|
||||||
export REDMINE_DB_PORT_NUMBER=${REDMINE_DB_PORT_NUMBER:-3306}
|
|
||||||
export REDMINE_DB_USERNAME=${REDMINE_DB_USERNAME:-root}
|
|
||||||
fi
|
|
||||||
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,389 @@
|
|||||||
|
#!/bin/bash
|
||||||
|
#
|
||||||
|
# Bitnami PostgreSQL Client library
|
||||||
|
|
||||||
|
# shellcheck disable=SC1091
|
||||||
|
|
||||||
|
# Load Generic Libraries
|
||||||
|
. /opt/bitnami/scripts/liblog.sh
|
||||||
|
. /opt/bitnami/scripts/libos.sh
|
||||||
|
. /opt/bitnami/scripts/libvalidations.sh
|
||||||
|
|
||||||
|
########################
|
||||||
|
# Validate settings in POSTGRESQL_CLIENT_* environment variables
|
||||||
|
# Globals:
|
||||||
|
# POSTGRESQL_CLIENT_*
|
||||||
|
# Arguments:
|
||||||
|
# None
|
||||||
|
# Returns:
|
||||||
|
# None
|
||||||
|
#########################
|
||||||
|
postgresql_client_validate() {
|
||||||
|
info "Validating settings in POSTGRESQL_CLIENT_* env vars"
|
||||||
|
local error_code=0
|
||||||
|
|
||||||
|
# Auxiliary functions
|
||||||
|
print_validation_error() {
|
||||||
|
error "$1"
|
||||||
|
error_code=1
|
||||||
|
}
|
||||||
|
|
||||||
|
empty_password_enabled_warn() {
|
||||||
|
warn "You set the environment variable ALLOW_EMPTY_PASSWORD=${ALLOW_EMPTY_PASSWORD}. For safety reasons, do not use this flag in a production environment."
|
||||||
|
}
|
||||||
|
empty_password_error() {
|
||||||
|
print_validation_error "The $1 environment variable is empty or not set. Set the environment variable ALLOW_EMPTY_PASSWORD=yes to allow the container to be started with blank passwords. This is recommended only for development."
|
||||||
|
}
|
||||||
|
|
||||||
|
# Only validate environment variables if any action needs to be performed
|
||||||
|
if [[ -n "$POSTGRESQL_CLIENT_CREATE_DATABASE_USERNAME" || -n "$POSTGRESQL_CLIENT_CREATE_DATABASE_NAME" ]]; then
|
||||||
|
if is_boolean_yes "$ALLOW_EMPTY_PASSWORD"; then
|
||||||
|
empty_password_enabled_warn
|
||||||
|
else
|
||||||
|
if [[ -z "$POSTGRESQL_CLIENT_POSTGRES_PASSWORD" ]]; then
|
||||||
|
empty_password_error "POSTGRESQL_CLIENT_POSTGRES_PASSWORD"
|
||||||
|
fi
|
||||||
|
if [[ -n "$POSTGRESQL_CLIENT_CREATE_DATABASE_USERNAME" ]] && [[ -z "$POSTGRESQL_CLIENT_CREATE_DATABASE_PASSWORD" ]]; then
|
||||||
|
empty_password_error "POSTGRESQL_CLIENT_CREATE_DATABASE_PASSWORD"
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
# When enabling extensions, the DB name must be provided
|
||||||
|
local -a extensions
|
||||||
|
read -r -a extensions <<< "$(tr ',;' ' ' <<< "$POSTGRESQL_CLIENT_CREATE_DATABASE_EXTENSIONS")"
|
||||||
|
if [[ -z "$POSTGRESQL_CLIENT_CREATE_DATABASE_NAME" && "${#extensions[@]}" -gt 0 ]]; then
|
||||||
|
print_validation_error "POSTGRESQL_CLIENT_CREATE_DATABASE_EXTENSIONS requires POSTGRESQL_CLIENT_CREATE_DATABASE_NAME to be set."
|
||||||
|
fi
|
||||||
|
return "$error_code"
|
||||||
|
}
|
||||||
|
|
||||||
|
########################
|
||||||
|
# Perform actions to a database
|
||||||
|
# Globals:
|
||||||
|
# POSTGRESQL_CLIENT_*
|
||||||
|
# Arguments:
|
||||||
|
# None
|
||||||
|
# Returns:
|
||||||
|
# None
|
||||||
|
#########################
|
||||||
|
postgresql_client_initialize() {
|
||||||
|
# Wait for the database to be accessible if any action needs to be performed
|
||||||
|
if [[ -n "$POSTGRESQL_CLIENT_CREATE_DATABASE_USERNAME" || -n "$POSTGRESQL_CLIENT_CREATE_DATABASE_NAME" ]]; then
|
||||||
|
info "Trying to connect to the database server"
|
||||||
|
check_postgresql_connection() {
|
||||||
|
echo "SELECT 1" | postgresql_remote_execute "$POSTGRESQL_CLIENT_DATABASE_HOST" "$POSTGRESQL_CLIENT_DATABASE_PORT_NUMBER" "" "$POSTGRESQL_CLIENT_POSTGRES_USER" "$POSTGRESQL_CLIENT_POSTGRES_PASSWORD"
|
||||||
|
}
|
||||||
|
if ! retry_while "check_postgresql_connection"; then
|
||||||
|
error "Could not connect to the database server"
|
||||||
|
return 1
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
# Ensure a database user exists in the server
|
||||||
|
if [[ -n "$POSTGRESQL_CLIENT_CREATE_DATABASE_USERNAME" ]]; then
|
||||||
|
info "Creating database user ${POSTGRESQL_CLIENT_CREATE_DATABASE_USERNAME}"
|
||||||
|
local -a args=("$POSTGRESQL_CLIENT_CREATE_DATABASE_USERNAME" "--host" "$POSTGRESQL_CLIENT_DATABASE_HOST" "--port" "$POSTGRESQL_CLIENT_DATABASE_PORT_NUMBER")
|
||||||
|
[[ -n "$POSTGRESQL_CLIENT_CREATE_DATABASE_PASSWORD" ]] && args+=("-p" "$POSTGRESQL_CLIENT_CREATE_DATABASE_PASSWORD")
|
||||||
|
postgresql_ensure_user_exists "${args[@]}"
|
||||||
|
fi
|
||||||
|
# Ensure a database exists in the server (and that the user has write privileges, if specified)
|
||||||
|
if [[ -n "$POSTGRESQL_CLIENT_CREATE_DATABASE_NAME" ]]; then
|
||||||
|
info "Creating database ${POSTGRESQL_CLIENT_CREATE_DATABASE_NAME}"
|
||||||
|
local -a createdb_args=("$POSTGRESQL_CLIENT_CREATE_DATABASE_NAME" "--host" "$POSTGRESQL_CLIENT_DATABASE_HOST" "--port" "$POSTGRESQL_CLIENT_DATABASE_PORT_NUMBER")
|
||||||
|
[[ -n "$POSTGRESQL_CLIENT_CREATE_DATABASE_USERNAME" ]] && createdb_args+=("-u" "$POSTGRESQL_CLIENT_CREATE_DATABASE_USERNAME")
|
||||||
|
postgresql_ensure_database_exists "${createdb_args[@]}"
|
||||||
|
# Ensure the list of extensions are enabled in the specified database
|
||||||
|
local -a extensions
|
||||||
|
read -r -a extensions <<< "$(tr ',;' ' ' <<< "$POSTGRESQL_CLIENT_CREATE_DATABASE_EXTENSIONS")"
|
||||||
|
if [[ "${#extensions[@]}" -gt 0 ]]; then
|
||||||
|
for extension_to_create in "${extensions[@]}"; do
|
||||||
|
echo "CREATE EXTENSION IF NOT EXISTS ${extension_to_create}" | postgresql_remote_execute "$POSTGRESQL_CLIENT_DATABASE_HOST" "$POSTGRESQL_CLIENT_DATABASE_PORT_NUMBER" "$POSTGRESQL_CLIENT_CREATE_DATABASE_NAME" "$POSTGRESQL_CLIENT_POSTGRES_USER" "$POSTGRESQL_CLIENT_POSTGRES_PASSWORD"
|
||||||
|
done
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
########################
|
||||||
|
# Return PostgreSQL major version
|
||||||
|
# Globals:
|
||||||
|
# POSTGRESQL_*
|
||||||
|
# Arguments:
|
||||||
|
# None
|
||||||
|
# Returns:
|
||||||
|
# String
|
||||||
|
#########################
|
||||||
|
postgresql_get_major_version() {
|
||||||
|
psql --version | grep -oE "[0-9]+\.[0-9]+" | grep -oE "^[0-9]+"
|
||||||
|
}
|
||||||
|
|
||||||
|
########################
|
||||||
|
# Gets an environment variable name based on the suffix
|
||||||
|
# Arguments:
|
||||||
|
# $1 - environment variable suffix
|
||||||
|
# Returns:
|
||||||
|
# environment variable name
|
||||||
|
#########################
|
||||||
|
get_env_var_value() {
|
||||||
|
local env_var_suffix="${1:?missing suffix}"
|
||||||
|
local env_var_name
|
||||||
|
for env_var_prefix in POSTGRESQL POSTGRESQL_CLIENT; do
|
||||||
|
env_var_name="${env_var_prefix}_${env_var_suffix}"
|
||||||
|
if [[ -n "${!env_var_name:-}" ]]; then
|
||||||
|
echo "${!env_var_name}"
|
||||||
|
break
|
||||||
|
fi
|
||||||
|
done
|
||||||
|
}
|
||||||
|
|
||||||
|
########################
|
||||||
|
# Execute an arbitrary query/queries against the running PostgreSQL service and print the output
|
||||||
|
# Stdin:
|
||||||
|
# Query/queries to execute
|
||||||
|
# Globals:
|
||||||
|
# BITNAMI_DEBUG
|
||||||
|
# POSTGRESQL_*
|
||||||
|
# Arguments:
|
||||||
|
# $1 - Database where to run the queries
|
||||||
|
# $2 - User to run queries
|
||||||
|
# $3 - Password
|
||||||
|
# $4 - Extra options (eg. -tA)
|
||||||
|
# Returns:
|
||||||
|
# None
|
||||||
|
#########################
|
||||||
|
postgresql_execute_print_output() {
|
||||||
|
local -r db="${1:-}"
|
||||||
|
local -r user="${2:-postgres}"
|
||||||
|
local -r pass="${3:-}"
|
||||||
|
local opts
|
||||||
|
read -r -a opts <<<"${@:4}"
|
||||||
|
|
||||||
|
local args=("-U" "$user")
|
||||||
|
[[ -n "$db" ]] && args+=("-d" "$db")
|
||||||
|
[[ "${#opts[@]}" -gt 0 ]] && args+=("${opts[@]}")
|
||||||
|
|
||||||
|
# Obtain the command specified via stdin
|
||||||
|
local sql_cmd
|
||||||
|
sql_cmd="$(</dev/stdin)"
|
||||||
|
debug "Executing SQL command:\n$sql_cmd"
|
||||||
|
PGPASSWORD=$pass psql "${args[@]}" <<<"$sql_cmd"
|
||||||
|
}
|
||||||
|
|
||||||
|
########################
|
||||||
|
# Execute an arbitrary query/queries against the running PostgreSQL service
|
||||||
|
# Stdin:
|
||||||
|
# Query/queries to execute
|
||||||
|
# Globals:
|
||||||
|
# BITNAMI_DEBUG
|
||||||
|
# POSTGRESQL_*
|
||||||
|
# Arguments:
|
||||||
|
# $1 - Database where to run the queries
|
||||||
|
# $2 - User to run queries
|
||||||
|
# $3 - Password
|
||||||
|
# $4 - Extra options (eg. -tA)
|
||||||
|
# Returns:
|
||||||
|
# None
|
||||||
|
#########################
|
||||||
|
postgresql_execute() {
|
||||||
|
if [[ "${BITNAMI_DEBUG:-false}" = true ]]; then
|
||||||
|
"postgresql_execute_print_output" "$@"
|
||||||
|
elif [[ "${NO_ERRORS:-false}" = true ]]; then
|
||||||
|
"postgresql_execute_print_output" "$@" 2>/dev/null
|
||||||
|
else
|
||||||
|
"postgresql_execute_print_output" "$@" >/dev/null 2>&1
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
########################
|
||||||
|
# Execute an arbitrary query/queries against a remote PostgreSQL service and print to stdout
|
||||||
|
# Stdin:
|
||||||
|
# Query/queries to execute
|
||||||
|
# Globals:
|
||||||
|
# BITNAMI_DEBUG
|
||||||
|
# DB_*
|
||||||
|
# Arguments:
|
||||||
|
# $1 - Remote PostgreSQL service hostname
|
||||||
|
# $2 - Remote PostgreSQL service port
|
||||||
|
# $3 - Database where to run the queries
|
||||||
|
# $4 - User to run queries
|
||||||
|
# $5 - Password
|
||||||
|
# $6 - Extra options (eg. -tA)
|
||||||
|
# Returns:
|
||||||
|
# None
|
||||||
|
postgresql_remote_execute_print_output() {
|
||||||
|
local -r hostname="${1:?hostname is required}"
|
||||||
|
local -r port="${2:?port is required}"
|
||||||
|
local -a args=("-h" "$hostname" "-p" "$port")
|
||||||
|
shift 2
|
||||||
|
"postgresql_execute_print_output" "$@" "${args[@]}"
|
||||||
|
}
|
||||||
|
|
||||||
|
########################
|
||||||
|
# Execute an arbitrary query/queries against a remote PostgreSQL service
|
||||||
|
# Stdin:
|
||||||
|
# Query/queries to execute
|
||||||
|
# Globals:
|
||||||
|
# BITNAMI_DEBUG
|
||||||
|
# DB_*
|
||||||
|
# Arguments:
|
||||||
|
# $1 - Remote PostgreSQL service hostname
|
||||||
|
# $2 - Remote PostgreSQL service port
|
||||||
|
# $3 - Database where to run the queries
|
||||||
|
# $4 - User to run queries
|
||||||
|
# $5 - Password
|
||||||
|
# $6 - Extra options (eg. -tA)
|
||||||
|
# Returns:
|
||||||
|
# None
|
||||||
|
postgresql_remote_execute() {
|
||||||
|
if [[ "${BITNAMI_DEBUG:-false}" = true ]]; then
|
||||||
|
"postgresql_remote_execute_print_output" "$@"
|
||||||
|
elif [[ "${NO_ERRORS:-false}" = true ]]; then
|
||||||
|
"postgresql_remote_execute_print_output" "$@" 2>/dev/null
|
||||||
|
else
|
||||||
|
"postgresql_remote_execute_print_output" "$@" >/dev/null 2>&1
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
########################
|
||||||
|
# Optionally create the given database user
|
||||||
|
# Flags:
|
||||||
|
# -p|--password - database password
|
||||||
|
# --host - database host
|
||||||
|
# --port - database port
|
||||||
|
# Arguments:
|
||||||
|
# $1 - user
|
||||||
|
# Returns:
|
||||||
|
# None
|
||||||
|
#########################
|
||||||
|
postgresql_ensure_user_exists() {
|
||||||
|
local -r user="${1:?user is missing}"
|
||||||
|
local password=""
|
||||||
|
# For accessing an external database
|
||||||
|
local db_host=""
|
||||||
|
local db_port=""
|
||||||
|
|
||||||
|
# Validate arguments
|
||||||
|
shift 1
|
||||||
|
while [ "$#" -gt 0 ]; do
|
||||||
|
case "$1" in
|
||||||
|
-p | --password)
|
||||||
|
shift
|
||||||
|
password="${1:?missing password}"
|
||||||
|
;;
|
||||||
|
--host)
|
||||||
|
shift
|
||||||
|
db_host="${1:?missing database host}"
|
||||||
|
;;
|
||||||
|
--port)
|
||||||
|
shift
|
||||||
|
db_port="${1:?missing database port}"
|
||||||
|
;;
|
||||||
|
*)
|
||||||
|
echo "Invalid command line flag $1" >&2
|
||||||
|
return 1
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
shift
|
||||||
|
done
|
||||||
|
|
||||||
|
local -a postgresql_execute_cmd=("postgresql_execute")
|
||||||
|
[[ -n "$db_host" && -n "$db_port" ]] && postgresql_execute_cmd=("postgresql_remote_execute" "$db_host" "$db_port")
|
||||||
|
local -a postgresql_execute_flags=("" "$(get_env_var_value POSTGRES_USER)" "$(get_env_var_value POSTGRES_PASSWORD)")
|
||||||
|
|
||||||
|
"${postgresql_execute_cmd[@]}" "${postgresql_execute_flags[@]}" <<EOF
|
||||||
|
DO
|
||||||
|
\$do\$
|
||||||
|
BEGIN
|
||||||
|
IF NOT EXISTS (
|
||||||
|
SELECT FROM pg_catalog.pg_roles WHERE rolname = '${user}'
|
||||||
|
) THEN
|
||||||
|
CREATE ROLE "${user}" LOGIN PASSWORD '${password}';
|
||||||
|
END IF;
|
||||||
|
END
|
||||||
|
\$do\$;
|
||||||
|
EOF
|
||||||
|
}
|
||||||
|
|
||||||
|
########################
|
||||||
|
# Ensure a user has all privileges to access a database
|
||||||
|
# Arguments:
|
||||||
|
# $1 - database name
|
||||||
|
# $2 - database user
|
||||||
|
# $3 - database host (optional)
|
||||||
|
# $4 - database port (optional)
|
||||||
|
# Returns:
|
||||||
|
# None
|
||||||
|
#########################
|
||||||
|
postgresql_ensure_user_has_database_privileges() {
|
||||||
|
local -r user="${1:?user is required}"
|
||||||
|
local -r database="${2:?db is required}"
|
||||||
|
local -r db_host="${3:-}"
|
||||||
|
local -r db_port="${4:-}"
|
||||||
|
|
||||||
|
local -a postgresql_execute_cmd=("postgresql_execute")
|
||||||
|
[[ -n "$db_host" && -n "$db_port" ]] && postgresql_execute_cmd=("postgresql_remote_execute" "$db_host" "$db_port")
|
||||||
|
local -a postgresql_execute_flags=("" "$(get_env_var_value POSTGRES_USER)" "$(get_env_var_value POSTGRES_PASSWORD)")
|
||||||
|
|
||||||
|
debug "Providing privileges to username ${user} on database ${database}"
|
||||||
|
"${postgresql_execute_cmd[@]}" "${postgresql_execute_flags[@]}" <<EOF
|
||||||
|
GRANT ALL PRIVILEGES ON DATABASE "${database}" TO "${user}";
|
||||||
|
ALTER DATABASE "${database}" OWNER TO "${user}";
|
||||||
|
EOF
|
||||||
|
}
|
||||||
|
|
||||||
|
########################
|
||||||
|
# Optionally create the given database, and then optionally give a user
|
||||||
|
# full privileges on the database.
|
||||||
|
# Flags:
|
||||||
|
# -u|--user - database user
|
||||||
|
# --host - database host
|
||||||
|
# --port - database port
|
||||||
|
# Arguments:
|
||||||
|
# $1 - database name
|
||||||
|
# Returns:
|
||||||
|
# None
|
||||||
|
#########################
|
||||||
|
postgresql_ensure_database_exists() {
|
||||||
|
local -r database="${1:?database is missing}"
|
||||||
|
local user=""
|
||||||
|
# For accessing an external database
|
||||||
|
local db_host=""
|
||||||
|
local db_port=""
|
||||||
|
|
||||||
|
# Validate arguments
|
||||||
|
shift 1
|
||||||
|
while [ "$#" -gt 0 ]; do
|
||||||
|
case "$1" in
|
||||||
|
-u | --user)
|
||||||
|
shift
|
||||||
|
user="${1:?missing database user}"
|
||||||
|
;;
|
||||||
|
--host)
|
||||||
|
shift
|
||||||
|
db_host="${1:?missing database host}"
|
||||||
|
;;
|
||||||
|
--port)
|
||||||
|
shift
|
||||||
|
db_port="${1:?missing database port}"
|
||||||
|
;;
|
||||||
|
*)
|
||||||
|
echo "Invalid command line flag $1" >&2
|
||||||
|
return 1
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
shift
|
||||||
|
done
|
||||||
|
|
||||||
|
local -a postgresql_execute_cmd=("postgresql_execute")
|
||||||
|
[[ -n "$db_host" && -n "$db_port" ]] && postgresql_execute_cmd=("postgresql_remote_execute" "$db_host" "$db_port")
|
||||||
|
local -a postgresql_execute_flags=("" "$(get_env_var_value POSTGRES_USER)" "$(get_env_var_value POSTGRES_PASSWORD)")
|
||||||
|
|
||||||
|
"${postgresql_execute_cmd[@]}" "${postgresql_execute_flags[@]}" <<EOF
|
||||||
|
SELECT 'CREATE DATABASE "${database}"'
|
||||||
|
WHERE NOT EXISTS (SELECT FROM pg_database WHERE datname = '${database}')\gexec
|
||||||
|
EOF
|
||||||
|
if [[ -n "$user" ]]; then
|
||||||
|
local -a grant_flags=("$user" "$database")
|
||||||
|
[[ -n "$db_host" ]] && grant_flags+=("$db_host")
|
||||||
|
[[ -n "$db_port" ]] && grant_flags+=("$db_port")
|
||||||
|
postgresql_ensure_user_has_database_privileges "${grant_flags[@]}"
|
||||||
|
fi
|
||||||
|
}
|
||||||
@@ -0,0 +1,443 @@
|
|||||||
|
#!/bin/bash
|
||||||
|
#
|
||||||
|
# Bitnami Redmine 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 libraries
|
||||||
|
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
|
||||||
|
if [[ -f /opt/bitnami/scripts/libpostgresqlclient.sh ]]; then
|
||||||
|
. /opt/bitnami/scripts/libpostgresqlclient.sh
|
||||||
|
elif [[ -f /opt/bitnami/scripts/libpostgresql.sh ]]; then
|
||||||
|
. /opt/bitnami/scripts/libpostgresql.sh
|
||||||
|
fi
|
||||||
|
|
||||||
|
########################
|
||||||
|
# Validate settings in REDMINE_* env vars
|
||||||
|
# Globals:
|
||||||
|
# REDMINE_*
|
||||||
|
# Arguments:
|
||||||
|
# None
|
||||||
|
# Returns:
|
||||||
|
# 0 if the validation succeeded, 1 otherwise
|
||||||
|
#########################
|
||||||
|
redmine_validate() {
|
||||||
|
debug "Validating settings in REDMINE_* 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 "$REDMINE_SKIP_BOOTSTRAP" && check_yes_no_value "REDMINE_SKIP_BOOTSTRAP"
|
||||||
|
|
||||||
|
# Support for MariaDB/MySQL and PostgreSQL
|
||||||
|
if ! is_empty_value "${REDMINE_DB_POSTGRES:-}"; then
|
||||||
|
warn "The environment variable REDMINE_DB_POSTGRES is set. This configuration will be deprecated soon. Please set REDMINE_DATABASE_TYPE=postgresql to avoid errors in the future."
|
||||||
|
export REDMINE_DATABASE_TYPE="postgresql"
|
||||||
|
elif ! is_empty_value "${REDMINE_DB_MYSQL:-}"; then
|
||||||
|
warn "The environment variable REDMINE_DB_MYSQL is set. This configuration will be deprecated soon. Please set REDMINE_DATABASE_TYPE=mariadb to avoid errors in the future."
|
||||||
|
export REDMINE_DATABASE_TYPE="mariadb"
|
||||||
|
else
|
||||||
|
check_multi_value "REDMINE_DATABASE_TYPE" "mariadb mysql postgresql"
|
||||||
|
fi
|
||||||
|
! is_empty_value "$REDMINE_DATABASE_HOST" && check_resolved_hostname "$REDMINE_DATABASE_HOST"
|
||||||
|
! is_empty_value "$REDMINE_DATABASE_PORT_NUMBER" && check_valid_port "REDMINE_DATABASE_PORT_NUMBER"
|
||||||
|
|
||||||
|
# Validate credentials
|
||||||
|
if is_boolean_yes "${ALLOW_EMPTY_PASSWORD:-}"; then
|
||||||
|
warn "You set the environment variable ALLOW_EMPTY_PASSWORD=${ALLOW_EMPTY_PASSWORD:-}. For safety reasons, do not use this flag in a production environment."
|
||||||
|
else
|
||||||
|
for empty_env_var in "REDMINE_DATABASE_PASSWORD" "REDMINE_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 "$REDMINE_SMTP_HOST"; then
|
||||||
|
for empty_env_var in "REDMINE_SMTP_USER" "REDMINE_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 "$REDMINE_SMTP_PORT_NUMBER" && print_validation_error "The REDMINE_SMTP_PORT_NUMBER environment variable is empty or not set."
|
||||||
|
! is_empty_value "$REDMINE_SMTP_PORT_NUMBER" && check_valid_port "REDMINE_SMTP_PORT_NUMBER"
|
||||||
|
check_multi_value "REDMINE_SMTP_AUTH" "plain login cram_md5"
|
||||||
|
if ! is_empty_value "${SMTP_AUTH:-}"; then
|
||||||
|
warn "The environment variable SMTP_TLS is set. This configuration will be deprecated soon. Please set REDMINE_PROTOCOL=tls to avoid errors in the future."
|
||||||
|
export REDMINE_SMTP_PROTOCOL="tls"
|
||||||
|
else
|
||||||
|
! is_empty_value "$REDMINE_SMTP_PROTOCOL" && check_multi_value "REDMINE_SMTP_PROTOCOL" "ssl tls"
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
|
||||||
|
return "$error_code"
|
||||||
|
}
|
||||||
|
|
||||||
|
########################
|
||||||
|
# Ensure Redmine is initialized
|
||||||
|
# Globals:
|
||||||
|
# REDMINE_*
|
||||||
|
# Arguments:
|
||||||
|
# None
|
||||||
|
# Returns:
|
||||||
|
# None
|
||||||
|
#########################
|
||||||
|
redmine_initialize() {
|
||||||
|
# Check if Redmine has already been initialized and persisted in a previous run
|
||||||
|
local -r app_name="redmine"
|
||||||
|
if ! is_app_initialized "$app_name"; then
|
||||||
|
local -a db_execute_args=("$REDMINE_DATABASE_HOST" "$REDMINE_DATABASE_PORT_NUMBER" "$REDMINE_DATABASE_NAME" "$REDMINE_DATABASE_USER" "$REDMINE_DATABASE_PASSWORD")
|
||||||
|
|
||||||
|
# Ensure Redmine persisted directories exist (i.e. when a volume has been mounted to /bitnami)
|
||||||
|
info "Ensuring Redmine directories exist"
|
||||||
|
ensure_dir_exists "$REDMINE_VOLUME_DIR"
|
||||||
|
# Use daemon:root ownership for compatibility when running as a non-root user
|
||||||
|
am_i_root && configure_permissions_ownership "$REDMINE_VOLUME_DIR" -d "775" -f "664" -u "$REDMINE_DAEMON_USER" -g "root"
|
||||||
|
|
||||||
|
info "Trying to connect to the database server"
|
||||||
|
local db_type="mysql"
|
||||||
|
[[ "$REDMINE_DATABASE_TYPE" = "postgresql" ]] && db_type="postgresql"
|
||||||
|
"redmine_wait_for_${db_type}_connection" "${db_execute_args[@]}"
|
||||||
|
|
||||||
|
info "Configuring Redmine database connections"
|
||||||
|
redmine_db_conf_set "${REDMINE_ENV}.host" "$REDMINE_DATABASE_HOST"
|
||||||
|
redmine_db_conf_set "${REDMINE_ENV}.port" "$REDMINE_DATABASE_PORT_NUMBER"
|
||||||
|
redmine_db_conf_set "${REDMINE_ENV}.database" "$REDMINE_DATABASE_NAME"
|
||||||
|
redmine_db_conf_set "${REDMINE_ENV}.username" "$REDMINE_DATABASE_USER"
|
||||||
|
redmine_db_conf_set "${REDMINE_ENV}.password" "$REDMINE_DATABASE_PASSWORD"
|
||||||
|
if [[ "$db_type" = "mysql" ]]; then
|
||||||
|
redmine_db_conf_set "${REDMINE_ENV}.adapter" "mysql2"
|
||||||
|
redmine_db_conf_set "${REDMINE_ENV}.encoding" "utf8mb4"
|
||||||
|
elif [[ "$db_type" = "postgresql" ]]; then
|
||||||
|
redmine_db_conf_set "${REDMINE_ENV}.adapter" "postgresql"
|
||||||
|
redmine_db_conf_set "${REDMINE_ENV}.encoding" "utf8"
|
||||||
|
fi
|
||||||
|
|
||||||
|
info "Configuring Redmine application with settings provided via environment variables"
|
||||||
|
redmine_conf_set "default_language.default" "$REDMINE_LANGUAGE" "" "${REDMINE_CONF_DIR}/settings.yml"
|
||||||
|
|
||||||
|
# SMTP configuration
|
||||||
|
if ! is_empty_value "$REDMINE_SMTP_HOST"; then
|
||||||
|
info "Configuring SMTP credentials"
|
||||||
|
redmine_conf_set "default.email_delivery.delivery_method" ":smtp"
|
||||||
|
redmine_conf_set "default.email_delivery.smtp_settings.address" "$REDMINE_SMTP_HOST"
|
||||||
|
redmine_conf_set "default.email_delivery.smtp_settings.port" "$REDMINE_SMTP_PORT_NUMBER"
|
||||||
|
redmine_conf_set "default.email_delivery.smtp_settings.authentication" "$REDMINE_SMTP_AUTH"
|
||||||
|
redmine_conf_set "default.email_delivery.smtp_settings.user_name" "$REDMINE_SMTP_USER"
|
||||||
|
redmine_conf_set "default.email_delivery.smtp_settings.password" "$REDMINE_SMTP_PASSWORD"
|
||||||
|
# Remove 'USER@' part from e-mail address and use as domain
|
||||||
|
redmine_conf_set "default.email_delivery.smtp_settings.domain" "${REDMINE_SMTP_USER//*@}"
|
||||||
|
if [[ "$REDMINE_SMTP_PROTOCOL" = "tls" ]]; then
|
||||||
|
redmine_conf_set "default.email_delivery.smtp_settings.enable_starttls_auto" "true"
|
||||||
|
else
|
||||||
|
redmine_conf_set "default.email_delivery.smtp_settings.enable_starttls_auto" "false"
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
|
||||||
|
info "Executing database migrations"
|
||||||
|
redmine_migrate_database
|
||||||
|
|
||||||
|
if ! is_boolean_yes "$REDMINE_SKIP_BOOTSTRAP"; then
|
||||||
|
# Redmine does not provide a way to update admin credentials via the CLI
|
||||||
|
# and the default ones are hardcoded in the '001_setup.rb' migration
|
||||||
|
local redmine_password_hash redmine_password_salt
|
||||||
|
redmine_password_salt="$(generate_random_string -t alphanumeric -c 32)"
|
||||||
|
# The password hashing algorithm consists of executing SHA1(salt + SHA1(password))
|
||||||
|
# https://github.com/redmine/redmine/blob/a9aae29708b4c96dbe3756ab791e2c4319dcdfca/app/models/user.rb#L354
|
||||||
|
redmine_password_hash="$(generate_sha_hash "${redmine_password_salt}$(generate_sha_hash "$REDMINE_PASSWORD")")"
|
||||||
|
info "Updating admin user credentials"
|
||||||
|
"${db_type}_remote_execute" "${db_execute_args[@]}" <<EOF
|
||||||
|
UPDATE users SET login = '${REDMINE_USERNAME}', hashed_password = '${redmine_password_hash}', salt = '${redmine_password_salt}', firstname = '${REDMINE_FIRST_NAME}', lastname = '${REDMINE_LAST_NAME}', must_change_passwd = '0' WHERE id = '1';
|
||||||
|
UPDATE email_addresses SET address = '${REDMINE_EMAIL}' WHERE id = '1';
|
||||||
|
EOF
|
||||||
|
|
||||||
|
# This is required to load required configuration data to be able to create projects with issues, bug trackers, etc.
|
||||||
|
# If not executed, a warning will appear in the admin panel:
|
||||||
|
# "Roles, trackers, issue statuses and workflow have not been configured yet."
|
||||||
|
# "It is highly recommended to load the default configuration. You will be able to modify it once loaded."
|
||||||
|
if is_boolean_yes "$REDMINE_LOAD_DEFAULT_DATA"; then
|
||||||
|
info "Loading default configuration data"
|
||||||
|
REDMINE_LANG="$REDMINE_LANGUAGE" redmine_rake_execute "redmine:load_default_data"
|
||||||
|
fi
|
||||||
|
else
|
||||||
|
info "An already initialized Redmine database was provided, skipping admin user creation and default data generation"
|
||||||
|
fi
|
||||||
|
|
||||||
|
info "Persisting Redmine installation"
|
||||||
|
persist_app "$app_name" "$REDMINE_DATA_TO_PERSIST"
|
||||||
|
else
|
||||||
|
# Fix to make upgrades from old images work
|
||||||
|
# Before, we were persisting 'conf' dir instead of 'config', causing errors when restoring persisted data
|
||||||
|
if [[ ! -e "${REDMINE_VOLUME_DIR}/config" && -e "${REDMINE_VOLUME_DIR}/conf" ]]; then
|
||||||
|
warn "Detected legacy configuration directory path ${REDMINE_VOLUME_DIR}/conf in volume"
|
||||||
|
warn "Creating ${REDMINE_VOLUME_DIR}/config symlink pointing to ${REDMINE_VOLUME_DIR}/conf"
|
||||||
|
ln -s "${REDMINE_VOLUME_DIR}/conf" "${REDMINE_VOLUME_DIR}/config"
|
||||||
|
fi
|
||||||
|
|
||||||
|
info "Restoring persisted Redmine installation"
|
||||||
|
restore_persisted_app "$app_name" "$REDMINE_DATA_TO_PERSIST"
|
||||||
|
|
||||||
|
info "Trying to connect to the database server"
|
||||||
|
local db_host db_port db_name db_user db_pass db_adapter db_type
|
||||||
|
db_host="$(redmine_db_conf_get "${REDMINE_ENV}.host")"
|
||||||
|
db_port="$(redmine_db_conf_get "${REDMINE_ENV}.port")"
|
||||||
|
db_name="$(redmine_db_conf_get "${REDMINE_ENV}.database")"
|
||||||
|
db_user="$(redmine_db_conf_get "${REDMINE_ENV}.username")"
|
||||||
|
db_pass="$(redmine_db_conf_get "${REDMINE_ENV}.password")"
|
||||||
|
db_adapter="$(redmine_db_conf_get "${REDMINE_ENV}.adapter")"
|
||||||
|
db_type="mysql"
|
||||||
|
[[ "$db_adapter" = "postgresql" ]] && db_type="postgresql"
|
||||||
|
"redmine_wait_for_${db_type}_connection" "$db_host" "$db_port" "$db_name" "$db_user" "$db_pass"
|
||||||
|
|
||||||
|
info "Executing database migrations"
|
||||||
|
redmine_migrate_database
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Avoid exit code of previous commands to affect the result of this function
|
||||||
|
true
|
||||||
|
}
|
||||||
|
|
||||||
|
########################
|
||||||
|
# Add or modify an entry in a Redmine configuration file (by default configuration.yml)
|
||||||
|
# Globals:
|
||||||
|
# REDMINE_*
|
||||||
|
# Arguments:
|
||||||
|
# $1 - YAML key to set
|
||||||
|
# $2 - Value to assign to the YAML key
|
||||||
|
# $3 - YAML tag (e.g. !!int)
|
||||||
|
# $4 - File to overwrite
|
||||||
|
# Returns:
|
||||||
|
# None
|
||||||
|
#########################
|
||||||
|
redmine_conf_set() {
|
||||||
|
local -r key="${1:?key missing}"
|
||||||
|
local -r value="${2:-}"
|
||||||
|
local -r tag="${3:-!!str}"
|
||||||
|
local -r file="${4:-"${REDMINE_CONF_DIR}/configuration.yml"}"
|
||||||
|
debug "Setting Redmine configuration value '${key}' to '${value}'"
|
||||||
|
yq w --inplace "$file" "$key" --tag "$tag" "$value"
|
||||||
|
}
|
||||||
|
|
||||||
|
########################
|
||||||
|
# Add or modify an entry in the Redmine database configuration file (database.yml)
|
||||||
|
# Globals:
|
||||||
|
# REDMINE_*
|
||||||
|
# Arguments:
|
||||||
|
# $1 - YAML key to set
|
||||||
|
# $2 - Value to assign to the YAML key
|
||||||
|
# $3 - YAML tag (e.g. !!int)
|
||||||
|
# Returns:
|
||||||
|
# None
|
||||||
|
#########################
|
||||||
|
redmine_db_conf_set() {
|
||||||
|
redmine_conf_set "${1:-}" "${2:-}" "${3:-}" "${REDMINE_CONF_DIR}/database.yml"
|
||||||
|
}
|
||||||
|
|
||||||
|
########################
|
||||||
|
# Get an entry from a Redmine configuration file (by default configuration.yml)
|
||||||
|
# Globals:
|
||||||
|
# REDMINE_*
|
||||||
|
# Arguments:
|
||||||
|
# $1 - Variable name
|
||||||
|
# $2 - Configuration file to read
|
||||||
|
# Returns:
|
||||||
|
# None
|
||||||
|
#########################
|
||||||
|
redmine_conf_get() {
|
||||||
|
local -r key="${1:?key missing}"
|
||||||
|
local -r file="${2:-"${REDMINE_CONF_DIR}/configuration.yml"}"
|
||||||
|
debug "Getting ${key} from Redmine configuration"
|
||||||
|
yq r "$file" "$key"
|
||||||
|
}
|
||||||
|
|
||||||
|
########################
|
||||||
|
# Get an entry from the Redmine database configuration file
|
||||||
|
# Globals:
|
||||||
|
# REDMINE_*
|
||||||
|
# Arguments:
|
||||||
|
# $1 - Variable name
|
||||||
|
# Returns:
|
||||||
|
# None
|
||||||
|
#########################
|
||||||
|
redmine_db_conf_get() {
|
||||||
|
redmine_conf_get "${1:-}" "${REDMINE_CONF_DIR}/database.yml"
|
||||||
|
}
|
||||||
|
|
||||||
|
########################
|
||||||
|
# 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
|
||||||
|
#########################
|
||||||
|
redmine_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 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
|
||||||
|
#########################
|
||||||
|
redmine_wait_for_postgresql_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_postgresql_connection() {
|
||||||
|
echo "SELECT 1" | postgresql_remote_execute "$db_host" "$db_port" "$db_name" "$db_user" "$db_pass"
|
||||||
|
}
|
||||||
|
if ! retry_while "check_postgresql_connection"; then
|
||||||
|
error "Could not connect to the database"
|
||||||
|
return 1
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
########################
|
||||||
|
# Executes Bundler with the proper environment and the specified arguments and print result to stdout
|
||||||
|
# Globals:
|
||||||
|
# REDMINE_*
|
||||||
|
# Arguments:
|
||||||
|
# $1..$n - Arguments to pass to the CLI call
|
||||||
|
# Returns:
|
||||||
|
# None
|
||||||
|
#########################
|
||||||
|
redmine_bundle_execute_print_output() {
|
||||||
|
# Avoid creating unnecessary cache files at initialization time
|
||||||
|
local -a cmd=("bundle" "exec" "$@")
|
||||||
|
# Run as application user to avoid having to change permissions/ownership afterwards
|
||||||
|
am_i_root && cmd=("gosu" "$REDMINE_DAEMON_USER" "${cmd[@]}")
|
||||||
|
(
|
||||||
|
export RAILS_ENV="$REDMINE_ENV"
|
||||||
|
cd "$REDMINE_BASE_DIR" || false
|
||||||
|
"${cmd[@]}"
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
########################
|
||||||
|
# Executes Bundler with the proper environment and the specified arguments
|
||||||
|
# Globals:
|
||||||
|
# REDMINE_*
|
||||||
|
# Arguments:
|
||||||
|
# $1..$n - Arguments to pass to the CLI call
|
||||||
|
# Returns:
|
||||||
|
# None
|
||||||
|
#########################
|
||||||
|
redmine_bundle_execute() {
|
||||||
|
debug_execute redmine_bundle_execute_print_output "$@"
|
||||||
|
}
|
||||||
|
|
||||||
|
########################
|
||||||
|
# Executes the 'rake' CLI with the proper Bundler environment and the specified arguments and print result to stdout
|
||||||
|
# Globals:
|
||||||
|
# REDMINE_*
|
||||||
|
# Arguments:
|
||||||
|
# $1..$n - Arguments to pass to the CLI call
|
||||||
|
# Returns:
|
||||||
|
# None
|
||||||
|
#########################
|
||||||
|
redmine_rake_execute_print_output() {
|
||||||
|
redmine_bundle_execute_print_output "rake" "$@"
|
||||||
|
}
|
||||||
|
|
||||||
|
########################
|
||||||
|
# Executes the 'rake' CLI with the proper Bundler environment and the specified arguments
|
||||||
|
# Globals:
|
||||||
|
# REDMINE_*
|
||||||
|
# Arguments:
|
||||||
|
# $1..$n - Arguments to pass to the CLI call
|
||||||
|
# Returns:
|
||||||
|
# None
|
||||||
|
#########################
|
||||||
|
redmine_rake_execute() {
|
||||||
|
debug_execute redmine_rake_execute_print_output "$@"
|
||||||
|
}
|
||||||
|
|
||||||
|
########################
|
||||||
|
# Executes Redmine database migrations
|
||||||
|
# Globals:
|
||||||
|
# REDMINE_*
|
||||||
|
# Arguments:
|
||||||
|
# None
|
||||||
|
# Returns:
|
||||||
|
# None
|
||||||
|
#########################
|
||||||
|
redmine_migrate_database() {
|
||||||
|
# Secret tokens need to be generated or the migration will fail
|
||||||
|
# "Missing `secret_key_base` for 'production' environment, set this string with `rails credentials:edit`"
|
||||||
|
# And since we are not persisting that file, they will always need to be generated
|
||||||
|
debug "Generating secret tokens"
|
||||||
|
redmine_rake_execute "generate_secret_token"
|
||||||
|
|
||||||
|
redmine_rake_execute "db:migrate"
|
||||||
|
redmine_rake_execute "redmine:plugins:migrate"
|
||||||
|
}
|
||||||
@@ -0,0 +1,124 @@
|
|||||||
|
#!/bin/bash
|
||||||
|
#
|
||||||
|
# Environment configuration for mysql
|
||||||
|
|
||||||
|
# The values for all environment variables will be set in the below order of precedence
|
||||||
|
# 1. Custom environment variables defined below after Bitnami defaults
|
||||||
|
# 2. Constants defined in this file (environment variables with no default), i.e. BITNAMI_ROOT_DIR
|
||||||
|
# 3. Environment variables overridden via external files using *_FILE variables (see below)
|
||||||
|
# 4. Environment variables set externally (i.e. current Bash context/Dockerfile/userdata)
|
||||||
|
|
||||||
|
# Load logging library
|
||||||
|
. /opt/bitnami/scripts/liblog.sh
|
||||||
|
|
||||||
|
export BITNAMI_ROOT_DIR="/opt/bitnami"
|
||||||
|
export BITNAMI_VOLUME_DIR="/bitnami"
|
||||||
|
|
||||||
|
# Logging configuration
|
||||||
|
export MODULE="${MODULE:-mysql}"
|
||||||
|
export BITNAMI_DEBUG="${BITNAMI_DEBUG:-false}"
|
||||||
|
|
||||||
|
# By setting an environment variable matching *_FILE to a file path, the prefixed environment
|
||||||
|
# variable will be overridden with the value specified in that file
|
||||||
|
mysql_env_vars=(
|
||||||
|
MYSQL_CLIENT_FLAVOR
|
||||||
|
ALLOW_EMPTY_PASSWORD
|
||||||
|
MYSQL_CLIENT_DATABASE_AUTHENTICATION_PLUGIN
|
||||||
|
MYSQL_CLIENT_DATABASE_HOST
|
||||||
|
MYSQL_CLIENT_DATABASE_PORT_NUMBER
|
||||||
|
MYSQL_CLIENT_DATABASE_ROOT_USER
|
||||||
|
MYSQL_CLIENT_DATABASE_ROOT_PASSWORD
|
||||||
|
MYSQL_CLIENT_CREATE_DATABASE_NAME
|
||||||
|
MYSQL_CLIENT_CREATE_DATABASE_USER
|
||||||
|
MYSQL_CLIENT_CREATE_DATABASE_PASSWORD
|
||||||
|
MYSQL_CLIENT_CREATE_DATABASE_CHARACTER_SET
|
||||||
|
MYSQL_CLIENT_CREATE_DATABASE_COLLATE
|
||||||
|
MYSQL_CLIENT_CREATE_DATABASE_PRIVILEGES
|
||||||
|
MYSQL_CLIENT_ENABLE_SSL_WRAPPER
|
||||||
|
MYSQL_CLIENT_ENABLE_SSL
|
||||||
|
MYSQL_CLIENT_SSL_CA_FILE
|
||||||
|
MYSQL_CLIENT_SSL_CERT_FILE
|
||||||
|
MYSQL_CLIENT_SSL_KEY_FILE
|
||||||
|
MYSQL_CLIENT_EXTRA_FLAGS
|
||||||
|
MARIADB_AUTHENTICATION_PLUGIN
|
||||||
|
MARIADB_HOST
|
||||||
|
MARIADB_PORT_NUMBER
|
||||||
|
MARIADB_ROOT_USER
|
||||||
|
MARIADB_ROOT_PASSWORD
|
||||||
|
)
|
||||||
|
for env_var in "${mysql_env_vars[@]}"; do
|
||||||
|
file_env_var="${env_var}_FILE"
|
||||||
|
if [[ -n "${!file_env_var:-}" ]]; then
|
||||||
|
if [[ -r "${!file_env_var:-}" ]]; then
|
||||||
|
export "${env_var}=$(< "${!file_env_var}")"
|
||||||
|
unset "${file_env_var}"
|
||||||
|
else
|
||||||
|
warn "Skipping export of '${env_var}'. '${!file_env_var:-}' is not readable."
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
done
|
||||||
|
unset mysql_env_vars
|
||||||
|
export MYSQL_CLIENT_FLAVOR="${MYSQL_CLIENT_FLAVOR:-mariadb}"
|
||||||
|
export DB_FLAVOR="$MYSQL_CLIENT_FLAVOR"
|
||||||
|
|
||||||
|
# Paths
|
||||||
|
export DB_BASE_DIR="${BITNAMI_ROOT_DIR}/mysql"
|
||||||
|
export DB_VOLUME_DIR="${BITNAMI_VOLUME_DIR}/mysql"
|
||||||
|
export DB_DATA_DIR="${DB_VOLUME_DIR}/data"
|
||||||
|
export DB_BIN_DIR="${DB_BASE_DIR}/bin"
|
||||||
|
export DB_SBIN_DIR="${DB_BASE_DIR}/bin"
|
||||||
|
export DB_CONF_DIR="${DB_BASE_DIR}/conf"
|
||||||
|
export DB_LOGS_DIR="${DB_BASE_DIR}/logs"
|
||||||
|
export DB_TMP_DIR="${DB_BASE_DIR}/tmp"
|
||||||
|
export DB_CONF_FILE="${DB_CONF_DIR}/my.cnf"
|
||||||
|
export DB_PID_FILE="${DB_TMP_DIR}/mysqld.pid"
|
||||||
|
export DB_SOCKET_FILE="${DB_TMP_DIR}/mysql.sock"
|
||||||
|
export PATH="${DB_SBIN_DIR}:${DB_BIN_DIR}:/opt/bitnami/common/bin:${PATH}"
|
||||||
|
|
||||||
|
# System users (when running with a privileged user)
|
||||||
|
export DB_DAEMON_USER="mysql"
|
||||||
|
export DB_DAEMON_GROUP="mysql"
|
||||||
|
|
||||||
|
# MySQL client configuration
|
||||||
|
export ALLOW_EMPTY_PASSWORD="${ALLOW_EMPTY_PASSWORD:-no}"
|
||||||
|
MYSQL_CLIENT_DATABASE_AUTHENTICATION_PLUGIN="${MYSQL_CLIENT_DATABASE_AUTHENTICATION_PLUGIN:-"${MARIADB_AUTHENTICATION_PLUGIN:-}"}"
|
||||||
|
export MYSQL_CLIENT_DATABASE_AUTHENTICATION_PLUGIN="${MYSQL_CLIENT_DATABASE_AUTHENTICATION_PLUGIN:-}"
|
||||||
|
export DB_AUTHENTICATION_PLUGIN="$MYSQL_CLIENT_DATABASE_AUTHENTICATION_PLUGIN"
|
||||||
|
MYSQL_CLIENT_DATABASE_HOST="${MYSQL_CLIENT_DATABASE_HOST:-"${MARIADB_HOST:-}"}"
|
||||||
|
export MYSQL_CLIENT_DATABASE_HOST="${MYSQL_CLIENT_DATABASE_HOST:-mariadb}"
|
||||||
|
export DB_HOST="$MYSQL_CLIENT_DATABASE_HOST"
|
||||||
|
MYSQL_CLIENT_DATABASE_PORT_NUMBER="${MYSQL_CLIENT_DATABASE_PORT_NUMBER:-"${MARIADB_PORT_NUMBER:-}"}"
|
||||||
|
export MYSQL_CLIENT_DATABASE_PORT_NUMBER="${MYSQL_CLIENT_DATABASE_PORT_NUMBER:-3306}"
|
||||||
|
export DB_PORT_NUMBER="$MYSQL_CLIENT_DATABASE_PORT_NUMBER"
|
||||||
|
MYSQL_CLIENT_DATABASE_ROOT_USER="${MYSQL_CLIENT_DATABASE_ROOT_USER:-"${MARIADB_ROOT_USER:-}"}"
|
||||||
|
export MYSQL_CLIENT_DATABASE_ROOT_USER="${MYSQL_CLIENT_DATABASE_ROOT_USER:-root}"
|
||||||
|
export DB_ROOT_USER="$MYSQL_CLIENT_DATABASE_ROOT_USER" # only used during the first initialization
|
||||||
|
MYSQL_CLIENT_DATABASE_ROOT_PASSWORD="${MYSQL_CLIENT_DATABASE_ROOT_PASSWORD:-"${MARIADB_ROOT_PASSWORD:-}"}"
|
||||||
|
export MYSQL_CLIENT_DATABASE_ROOT_PASSWORD="${MYSQL_CLIENT_DATABASE_ROOT_PASSWORD:-}"
|
||||||
|
export DB_ROOT_PASSWORD="$MYSQL_CLIENT_DATABASE_ROOT_PASSWORD" # only used during the first initialization
|
||||||
|
export MYSQL_CLIENT_CREATE_DATABASE_NAME="${MYSQL_CLIENT_CREATE_DATABASE_NAME:-}"
|
||||||
|
export DB_CREATE_DATABASE_NAME="$MYSQL_CLIENT_CREATE_DATABASE_NAME" # only used during the first initialization
|
||||||
|
export MYSQL_CLIENT_CREATE_DATABASE_USER="${MYSQL_CLIENT_CREATE_DATABASE_USER:-}"
|
||||||
|
export DB_CREATE_DATABASE_USER="$MYSQL_CLIENT_CREATE_DATABASE_USER"
|
||||||
|
export MYSQL_CLIENT_CREATE_DATABASE_PASSWORD="${MYSQL_CLIENT_CREATE_DATABASE_PASSWORD:-}"
|
||||||
|
export DB_CREATE_DATABASE_PASSWORD="$MYSQL_CLIENT_CREATE_DATABASE_PASSWORD"
|
||||||
|
export MYSQL_CLIENT_CREATE_DATABASE_CHARACTER_SET="${MYSQL_CLIENT_CREATE_DATABASE_CHARACTER_SET:-}"
|
||||||
|
export DB_CREATE_DATABASE_CHARACTER_SET="$MYSQL_CLIENT_CREATE_DATABASE_CHARACTER_SET"
|
||||||
|
export MYSQL_CLIENT_CREATE_DATABASE_COLLATE="${MYSQL_CLIENT_CREATE_DATABASE_COLLATE:-}"
|
||||||
|
export DB_CREATE_DATABASE_COLLATE="$MYSQL_CLIENT_CREATE_DATABASE_COLLATE"
|
||||||
|
export MYSQL_CLIENT_CREATE_DATABASE_PRIVILEGES="${MYSQL_CLIENT_CREATE_DATABASE_PRIVILEGES:-}"
|
||||||
|
export DB_CREATE_DATABASE_PRIVILEGES="$MYSQL_CLIENT_CREATE_DATABASE_PRIVILEGES"
|
||||||
|
export MYSQL_CLIENT_ENABLE_SSL_WRAPPER="${MYSQL_CLIENT_ENABLE_SSL_WRAPPER:-no}"
|
||||||
|
export DB_ENABLE_SSL_WRAPPER="$MYSQL_CLIENT_ENABLE_SSL_WRAPPER"
|
||||||
|
export MYSQL_CLIENT_ENABLE_SSL="${MYSQL_CLIENT_ENABLE_SSL:-no}"
|
||||||
|
export DB_ENABLE_SSL="$MYSQL_CLIENT_ENABLE_SSL"
|
||||||
|
export MYSQL_CLIENT_SSL_CA_FILE="${MYSQL_CLIENT_SSL_CA_FILE:-}"
|
||||||
|
export DB_SSL_CA_FILE="$MYSQL_CLIENT_SSL_CA_FILE"
|
||||||
|
export MYSQL_CLIENT_SSL_CERT_FILE="${MYSQL_CLIENT_SSL_CERT_FILE:-}"
|
||||||
|
export DB_SSL_CERT_FILE="$MYSQL_CLIENT_SSL_CERT_FILE"
|
||||||
|
export MYSQL_CLIENT_SSL_KEY_FILE="${MYSQL_CLIENT_SSL_KEY_FILE:-}"
|
||||||
|
export DB_SSL_KEY_FILE="$MYSQL_CLIENT_SSL_KEY_FILE"
|
||||||
|
export MYSQL_CLIENT_EXTRA_FLAGS="${MYSQL_CLIENT_EXTRA_FLAGS:-no}"
|
||||||
|
export DB_EXTRA_FLAGS="$MYSQL_CLIENT_EXTRA_FLAGS"
|
||||||
|
|
||||||
|
# Custom environment variables may be defined below
|
||||||
@@ -0,0 +1,19 @@
|
|||||||
|
#!/bin/bash
|
||||||
|
|
||||||
|
# shellcheck disable=SC1091
|
||||||
|
|
||||||
|
set -o errexit
|
||||||
|
set -o nounset
|
||||||
|
set -o pipefail
|
||||||
|
# set -o xtrace # Uncomment this line for debugging purposes
|
||||||
|
|
||||||
|
# Load libraries
|
||||||
|
. /opt/bitnami/scripts/libfs.sh
|
||||||
|
|
||||||
|
# Load MySQL Client environment variables
|
||||||
|
. /opt/bitnami/scripts/mysql-client-env.sh
|
||||||
|
|
||||||
|
for dir in "$DB_BIN_DIR" "${DB_BASE_DIR}/.bin"; do
|
||||||
|
ensure_dir_exists "$dir"
|
||||||
|
chmod g+rwX "$dir"
|
||||||
|
done
|
||||||
19
bitnami/redmine/4/debian-10/rootfs/opt/bitnami/scripts/mysql-client/setup.sh
Executable file
19
bitnami/redmine/4/debian-10/rootfs/opt/bitnami/scripts/mysql-client/setup.sh
Executable file
@@ -0,0 +1,19 @@
|
|||||||
|
#!/bin/bash
|
||||||
|
|
||||||
|
# shellcheck disable=SC1091
|
||||||
|
|
||||||
|
set -o errexit
|
||||||
|
set -o nounset
|
||||||
|
set -o pipefail
|
||||||
|
# set -o xtrace # Uncomment this line for debugging purposes
|
||||||
|
|
||||||
|
# Load libraries
|
||||||
|
. /opt/bitnami/scripts/libmysqlclient.sh
|
||||||
|
|
||||||
|
# Load MySQL Client environment variables
|
||||||
|
. /opt/bitnami/scripts/mysql-client-env.sh
|
||||||
|
|
||||||
|
# Ensure MySQL Client environment variables settings are valid
|
||||||
|
mysql_client_validate
|
||||||
|
# Ensure MySQL Client is initialized
|
||||||
|
mysql_client_initialize
|
||||||
@@ -0,0 +1,81 @@
|
|||||||
|
#!/bin/bash
|
||||||
|
#
|
||||||
|
# Environment configuration for postgresql-client
|
||||||
|
|
||||||
|
# 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:-postgresql-client}"
|
||||||
|
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
|
||||||
|
postgresql_client_env_vars=(
|
||||||
|
ALLOW_EMPTY_PASSWORD
|
||||||
|
POSTGRESQL_CLIENT_DATABASE_HOST
|
||||||
|
POSTGRESQL_CLIENT_DATABASE_PORT_NUMBER
|
||||||
|
POSTGRESQL_CLIENT_POSTGRES_USER
|
||||||
|
POSTGRESQL_CLIENT_POSTGRES_PASSWORD
|
||||||
|
POSTGRESQL_CLIENT_CREATE_DATABASE_NAME
|
||||||
|
POSTGRESQL_CLIENT_CREATE_DATABASE_USERNAME
|
||||||
|
POSTGRESQL_CLIENT_CREATE_DATABASE_PASSWORD
|
||||||
|
POSTGRESQL_CLIENT_CREATE_DATABASE_EXTENSIONS
|
||||||
|
POSTGRESQL_HOST
|
||||||
|
POSTGRESQL_PORT_NUMBER
|
||||||
|
POSTGRESQL_CLIENT_ROOT_USER
|
||||||
|
POSTGRESQL_POSTGRES_USER
|
||||||
|
POSTGRESQL_ROOT_USER
|
||||||
|
POSTGRESQL_CLIENT_ROOT_PASSWORD
|
||||||
|
POSTGRESQL_POSTGRES_PASSWORD
|
||||||
|
POSTGRESQL_ROOT_PASSWORD
|
||||||
|
POSTGRESQL_CLIENT_CREATE_DATABASE_USER
|
||||||
|
)
|
||||||
|
for env_var in "${postgresql_client_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 postgresql_client_env_vars
|
||||||
|
|
||||||
|
# Paths
|
||||||
|
export POSTGRESQL_BASE_DIR="/opt/bitnami/postgresql"
|
||||||
|
export POSTGRESQL_BIN_DIR="$POSTGRESQL_BASE_DIR/bin"
|
||||||
|
export PATH="${POSTGRESQL_BIN_DIR}:${PATH}"
|
||||||
|
|
||||||
|
# PostgreSQL settings
|
||||||
|
export ALLOW_EMPTY_PASSWORD="${ALLOW_EMPTY_PASSWORD:-no}"
|
||||||
|
POSTGRESQL_CLIENT_DATABASE_HOST="${POSTGRESQL_CLIENT_DATABASE_HOST:-"${POSTGRESQL_HOST:-}"}"
|
||||||
|
export POSTGRESQL_CLIENT_DATABASE_HOST="${POSTGRESQL_CLIENT_DATABASE_HOST:-postgresql}"
|
||||||
|
POSTGRESQL_CLIENT_DATABASE_PORT_NUMBER="${POSTGRESQL_CLIENT_DATABASE_PORT_NUMBER:-"${POSTGRESQL_PORT_NUMBER:-}"}"
|
||||||
|
export POSTGRESQL_CLIENT_DATABASE_PORT_NUMBER="${POSTGRESQL_CLIENT_DATABASE_PORT_NUMBER:-5432}"
|
||||||
|
POSTGRESQL_CLIENT_POSTGRES_USER="${POSTGRESQL_CLIENT_POSTGRES_USER:-"${POSTGRESQL_CLIENT_ROOT_USER:-}"}"
|
||||||
|
POSTGRESQL_CLIENT_POSTGRES_USER="${POSTGRESQL_CLIENT_POSTGRES_USER:-"${POSTGRESQL_POSTGRES_USER:-}"}"
|
||||||
|
POSTGRESQL_CLIENT_POSTGRES_USER="${POSTGRESQL_CLIENT_POSTGRES_USER:-"${POSTGRESQL_ROOT_USER:-}"}"
|
||||||
|
export POSTGRESQL_CLIENT_POSTGRES_USER="${POSTGRESQL_CLIENT_POSTGRES_USER:-postgres}" # only used during the first initialization
|
||||||
|
POSTGRESQL_CLIENT_POSTGRES_PASSWORD="${POSTGRESQL_CLIENT_POSTGRES_PASSWORD:-"${POSTGRESQL_CLIENT_ROOT_PASSWORD:-}"}"
|
||||||
|
POSTGRESQL_CLIENT_POSTGRES_PASSWORD="${POSTGRESQL_CLIENT_POSTGRES_PASSWORD:-"${POSTGRESQL_POSTGRES_PASSWORD:-}"}"
|
||||||
|
POSTGRESQL_CLIENT_POSTGRES_PASSWORD="${POSTGRESQL_CLIENT_POSTGRES_PASSWORD:-"${POSTGRESQL_ROOT_PASSWORD:-}"}"
|
||||||
|
export POSTGRESQL_CLIENT_POSTGRES_PASSWORD="${POSTGRESQL_CLIENT_POSTGRES_PASSWORD:-}" # only used during the first initialization
|
||||||
|
export POSTGRESQL_CLIENT_CREATE_DATABASE_NAME="${POSTGRESQL_CLIENT_CREATE_DATABASE_NAME:-}" # only used during the first initialization
|
||||||
|
POSTGRESQL_CLIENT_CREATE_DATABASE_USERNAME="${POSTGRESQL_CLIENT_CREATE_DATABASE_USERNAME:-"${POSTGRESQL_CLIENT_CREATE_DATABASE_USER:-}"}"
|
||||||
|
export POSTGRESQL_CLIENT_CREATE_DATABASE_USERNAME="${POSTGRESQL_CLIENT_CREATE_DATABASE_USERNAME:-}" # only used during the first initialization
|
||||||
|
export POSTGRESQL_CLIENT_CREATE_DATABASE_PASSWORD="${POSTGRESQL_CLIENT_CREATE_DATABASE_PASSWORD:-}" # only used during the first initialization
|
||||||
|
export POSTGRESQL_CLIENT_CREATE_DATABASE_EXTENSIONS="${POSTGRESQL_CLIENT_CREATE_DATABASE_EXTENSIONS:-}" # only used during the first initialization
|
||||||
|
|
||||||
|
# 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/libpostgresqlclient.sh
|
||||||
|
|
||||||
|
# Load PostgreSQL Client environment variables
|
||||||
|
. /opt/bitnami/scripts/postgresql-client-env.sh
|
||||||
|
|
||||||
|
# Ensure PostgreSQL Client environment variables settings are valid
|
||||||
|
postgresql_client_validate
|
||||||
|
# Ensure PostgreSQL Client is initialized
|
||||||
|
postgresql_client_initialize
|
||||||
@@ -0,0 +1,140 @@
|
|||||||
|
#!/bin/bash
|
||||||
|
#
|
||||||
|
# Environment configuration for redmine
|
||||||
|
|
||||||
|
# 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:-redmine}"
|
||||||
|
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
|
||||||
|
redmine_env_vars=(
|
||||||
|
REDMINE_DATA_TO_PERSIST
|
||||||
|
REDMINE_PORT_NUMBER
|
||||||
|
REDMINE_ENV
|
||||||
|
REDMINE_LANGUAGE
|
||||||
|
REDMINE_LOAD_DEFAULT_DATA
|
||||||
|
REDMINE_SKIP_BOOTSTRAP
|
||||||
|
REDMINE_USERNAME
|
||||||
|
REDMINE_PASSWORD
|
||||||
|
REDMINE_EMAIL
|
||||||
|
REDMINE_FIRST_NAME
|
||||||
|
REDMINE_LAST_NAME
|
||||||
|
REDMINE_SMTP_HOST
|
||||||
|
REDMINE_SMTP_PORT_NUMBER
|
||||||
|
REDMINE_SMTP_USER
|
||||||
|
REDMINE_SMTP_PASSWORD
|
||||||
|
REDMINE_SMTP_PROTOCOL
|
||||||
|
REDMINE_SMTP_AUTH
|
||||||
|
REDMINE_DATABASE_TYPE
|
||||||
|
REDMINE_DATABASE_HOST
|
||||||
|
REDMINE_DATABASE_PORT_NUMBER
|
||||||
|
REDMINE_DATABASE_NAME
|
||||||
|
REDMINE_DATABASE_USER
|
||||||
|
REDMINE_DATABASE_PASSWORD
|
||||||
|
SMTP_HOST
|
||||||
|
SMTP_PORT
|
||||||
|
REDMINE_SMTP_PORT
|
||||||
|
SMTP_USER
|
||||||
|
SMTP_PASSWORD
|
||||||
|
SMTP_PROTOCOL
|
||||||
|
SMTP_AUTHENTICATION
|
||||||
|
REDMINE_DB_MYSQL
|
||||||
|
REDMINE_DB_POSTGRES
|
||||||
|
MARIADB_HOST
|
||||||
|
REDMINE_DB_PORT_NUMBER
|
||||||
|
MARIADB_PORT_NUMBER
|
||||||
|
REDMINE_DB_NAME
|
||||||
|
MARIADB_DATABASE_NAME
|
||||||
|
REDMINE_DB_USERNAME
|
||||||
|
MARIADB_DATABASE_USER
|
||||||
|
REDMINE_DB_PASSWORD
|
||||||
|
MARIADB_DATABASE_PASSWORD
|
||||||
|
)
|
||||||
|
for env_var in "${redmine_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 redmine_env_vars
|
||||||
|
|
||||||
|
# Paths
|
||||||
|
export REDMINE_BASE_DIR="${BITNAMI_ROOT_DIR}/redmine"
|
||||||
|
export REDMINE_CONF_DIR="${REDMINE_BASE_DIR}/config"
|
||||||
|
|
||||||
|
# Redmine persistence configuration
|
||||||
|
export REDMINE_VOLUME_DIR="${BITNAMI_VOLUME_DIR}/redmine"
|
||||||
|
export REDMINE_DATA_TO_PERSIST="${REDMINE_DATA_TO_PERSIST:-${REDMINE_CONF_DIR}/configuration.yml ${REDMINE_CONF_DIR}/database.yml files plugins public/plugin_assets}"
|
||||||
|
|
||||||
|
# System users (when running with a privileged user)
|
||||||
|
export REDMINE_DAEMON_USER="redmine"
|
||||||
|
export REDMINE_DAEMON_GROUP="redmine"
|
||||||
|
|
||||||
|
# Redmine configuration
|
||||||
|
export REDMINE_PORT_NUMBER="${REDMINE_PORT_NUMBER:-3000}" # only used during the first initialization
|
||||||
|
export REDMINE_ENV="${REDMINE_ENV:-production}"
|
||||||
|
export REDMINE_LANGUAGE="${REDMINE_LANGUAGE:-en}" # only used during the first initialization
|
||||||
|
export REDMINE_LOAD_DEFAULT_DATA="${REDMINE_LOAD_DEFAULT_DATA:-yes}" # only used during the first initialization
|
||||||
|
export REDMINE_SKIP_BOOTSTRAP="${REDMINE_SKIP_BOOTSTRAP:-}" # only used during the first initialization
|
||||||
|
|
||||||
|
# Redmine credentials
|
||||||
|
export REDMINE_USERNAME="${REDMINE_USERNAME:-user}" # only used during the first initialization
|
||||||
|
export REDMINE_PASSWORD="${REDMINE_PASSWORD:-bitnami1}" # only used during the first initialization
|
||||||
|
export REDMINE_EMAIL="${REDMINE_EMAIL:-user@example.com}" # only used during the first initialization
|
||||||
|
export REDMINE_FIRST_NAME="${REDMINE_FIRST_NAME:-UserName}" # only used during the first initialization
|
||||||
|
export REDMINE_LAST_NAME="${REDMINE_LAST_NAME:-LastName}" # only used during the first initialization
|
||||||
|
|
||||||
|
# Redmine SMTP credentials
|
||||||
|
REDMINE_SMTP_HOST="${REDMINE_SMTP_HOST:-"${SMTP_HOST:-}"}"
|
||||||
|
export REDMINE_SMTP_HOST="${REDMINE_SMTP_HOST:-}" # only used during the first initialization
|
||||||
|
REDMINE_SMTP_PORT_NUMBER="${REDMINE_SMTP_PORT_NUMBER:-"${SMTP_PORT:-}"}"
|
||||||
|
REDMINE_SMTP_PORT_NUMBER="${REDMINE_SMTP_PORT_NUMBER:-"${REDMINE_SMTP_PORT:-}"}"
|
||||||
|
export REDMINE_SMTP_PORT_NUMBER="${REDMINE_SMTP_PORT_NUMBER:-}" # only used during the first initialization
|
||||||
|
REDMINE_SMTP_USER="${REDMINE_SMTP_USER:-"${SMTP_USER:-}"}"
|
||||||
|
export REDMINE_SMTP_USER="${REDMINE_SMTP_USER:-}" # only used during the first initialization
|
||||||
|
REDMINE_SMTP_PASSWORD="${REDMINE_SMTP_PASSWORD:-"${SMTP_PASSWORD:-}"}"
|
||||||
|
export REDMINE_SMTP_PASSWORD="${REDMINE_SMTP_PASSWORD:-}" # only used during the first initialization
|
||||||
|
REDMINE_SMTP_PROTOCOL="${REDMINE_SMTP_PROTOCOL:-"${SMTP_PROTOCOL:-}"}"
|
||||||
|
export REDMINE_SMTP_PROTOCOL="${REDMINE_SMTP_PROTOCOL:-}" # only used during the first initialization
|
||||||
|
REDMINE_SMTP_AUTH="${REDMINE_SMTP_AUTH:-"${SMTP_AUTHENTICATION:-}"}"
|
||||||
|
export REDMINE_SMTP_AUTH="${REDMINE_SMTP_AUTH:-login}" # only used during the first initialization
|
||||||
|
|
||||||
|
# Database configuration
|
||||||
|
export REDMINE_DATABASE_TYPE="${REDMINE_DATABASE_TYPE:-mariadb}" # only used during the first initialization
|
||||||
|
export REDMINE_DEFAULT_DATABASE_HOST="mariadb" # only used at build time
|
||||||
|
REDMINE_DATABASE_HOST="${REDMINE_DATABASE_HOST:-"${REDMINE_DB_MYSQL:-}"}"
|
||||||
|
REDMINE_DATABASE_HOST="${REDMINE_DATABASE_HOST:-"${REDMINE_DB_POSTGRES:-}"}"
|
||||||
|
REDMINE_DATABASE_HOST="${REDMINE_DATABASE_HOST:-"${MARIADB_HOST:-}"}"
|
||||||
|
export REDMINE_DATABASE_HOST="${REDMINE_DATABASE_HOST:-$REDMINE_DEFAULT_DATABASE_HOST}" # only used during the first initialization
|
||||||
|
REDMINE_DATABASE_PORT_NUMBER="${REDMINE_DATABASE_PORT_NUMBER:-"${REDMINE_DB_PORT_NUMBER:-}"}"
|
||||||
|
REDMINE_DATABASE_PORT_NUMBER="${REDMINE_DATABASE_PORT_NUMBER:-"${MARIADB_PORT_NUMBER:-}"}"
|
||||||
|
export REDMINE_DATABASE_PORT_NUMBER="${REDMINE_DATABASE_PORT_NUMBER:-3306}" # only used during the first initialization
|
||||||
|
REDMINE_DATABASE_NAME="${REDMINE_DATABASE_NAME:-"${REDMINE_DB_NAME:-}"}"
|
||||||
|
REDMINE_DATABASE_NAME="${REDMINE_DATABASE_NAME:-"${MARIADB_DATABASE_NAME:-}"}"
|
||||||
|
export REDMINE_DATABASE_NAME="${REDMINE_DATABASE_NAME:-bitnami_redmine}" # only used during the first initialization
|
||||||
|
REDMINE_DATABASE_USER="${REDMINE_DATABASE_USER:-"${REDMINE_DB_USERNAME:-}"}"
|
||||||
|
REDMINE_DATABASE_USER="${REDMINE_DATABASE_USER:-"${MARIADB_DATABASE_USER:-}"}"
|
||||||
|
export REDMINE_DATABASE_USER="${REDMINE_DATABASE_USER:-bn_redmine}" # only used during the first initialization
|
||||||
|
REDMINE_DATABASE_PASSWORD="${REDMINE_DATABASE_PASSWORD:-"${REDMINE_DB_PASSWORD:-}"}"
|
||||||
|
REDMINE_DATABASE_PASSWORD="${REDMINE_DATABASE_PASSWORD:-"${MARIADB_DATABASE_PASSWORD:-}"}"
|
||||||
|
export REDMINE_DATABASE_PASSWORD="${REDMINE_DATABASE_PASSWORD:-}" # only used during the first initialization
|
||||||
|
|
||||||
|
# Custom environment variables may be defined below
|
||||||
28
bitnami/redmine/4/debian-10/rootfs/opt/bitnami/scripts/redmine/entrypoint.sh
Executable file
28
bitnami/redmine/4/debian-10/rootfs/opt/bitnami/scripts/redmine/entrypoint.sh
Executable file
@@ -0,0 +1,28 @@
|
|||||||
|
#!/bin/bash
|
||||||
|
|
||||||
|
# shellcheck disable=SC1091
|
||||||
|
|
||||||
|
set -o errexit
|
||||||
|
set -o nounset
|
||||||
|
set -o pipefail
|
||||||
|
# set -o xtrace # Uncomment this line for debugging purpose
|
||||||
|
|
||||||
|
# Load Redmine environment
|
||||||
|
. /opt/bitnami/scripts/redmine-env.sh
|
||||||
|
|
||||||
|
# Load libraries
|
||||||
|
. /opt/bitnami/scripts/libbitnami.sh
|
||||||
|
. /opt/bitnami/scripts/liblog.sh
|
||||||
|
|
||||||
|
print_welcome_page
|
||||||
|
|
||||||
|
if [[ "$1" = "/opt/bitnami/scripts/redmine/run.sh" ]]; then
|
||||||
|
/opt/bitnami/scripts/mysql-client/setup.sh
|
||||||
|
/opt/bitnami/scripts/postgresql-client/setup.sh
|
||||||
|
/opt/bitnami/scripts/redmine/setup.sh
|
||||||
|
/post-init.sh
|
||||||
|
info "** Redmine setup finished! **"
|
||||||
|
fi
|
||||||
|
|
||||||
|
echo ""
|
||||||
|
exec "$@"
|
||||||
50
bitnami/redmine/4/debian-10/rootfs/opt/bitnami/scripts/redmine/postunpack.sh
Executable file
50
bitnami/redmine/4/debian-10/rootfs/opt/bitnami/scripts/redmine/postunpack.sh
Executable file
@@ -0,0 +1,50 @@
|
|||||||
|
#!/bin/bash
|
||||||
|
|
||||||
|
# shellcheck disable=SC1091
|
||||||
|
|
||||||
|
set -o errexit
|
||||||
|
set -o nounset
|
||||||
|
set -o pipefail
|
||||||
|
# set -o xtrace # Uncomment this line for debugging purpose
|
||||||
|
|
||||||
|
# Load Redmine environment
|
||||||
|
. /opt/bitnami/scripts/redmine-env.sh
|
||||||
|
|
||||||
|
# Load libraries
|
||||||
|
. /opt/bitnami/scripts/libredmine.sh
|
||||||
|
. /opt/bitnami/scripts/libfile.sh
|
||||||
|
. /opt/bitnami/scripts/libfs.sh
|
||||||
|
. /opt/bitnami/scripts/liblog.sh
|
||||||
|
|
||||||
|
# Enable Redmine configuration file
|
||||||
|
[[ ! -f "${REDMINE_CONF_DIR}/configuration.yml" ]] && cp "${REDMINE_CONF_DIR}/configuration.yml.example" "${REDMINE_CONF_DIR}/configuration.yml"
|
||||||
|
|
||||||
|
# Ensure the Redmine base directory exists and has proper permissions
|
||||||
|
info "Configuring file permissions for Redmine"
|
||||||
|
ensure_user_exists "$REDMINE_DAEMON_USER" --group "$REDMINE_DAEMON_GROUP" --system
|
||||||
|
declare -a writable_dirs=(
|
||||||
|
# Skipping REDMINE_BASE_DIR intentionally because it contains a lot of files/folders that should not be writable
|
||||||
|
"$REDMINE_VOLUME_DIR"
|
||||||
|
# Folders to persist
|
||||||
|
"${REDMINE_BASE_DIR}/files"
|
||||||
|
"${REDMINE_BASE_DIR}/plugins"
|
||||||
|
"${REDMINE_BASE_DIR}/public/plugin_assets"
|
||||||
|
# Folders that need to be writable for the app to work
|
||||||
|
"${REDMINE_BASE_DIR}/log"
|
||||||
|
"${REDMINE_BASE_DIR}/tmp"
|
||||||
|
# Config needs to be writable for actions to update things like tokens or DB credentials
|
||||||
|
"${REDMINE_BASE_DIR}/config"
|
||||||
|
# Redmine creates 'db/schema.rb' file after executing migrations
|
||||||
|
"${REDMINE_BASE_DIR}/db"
|
||||||
|
# Avoid Bundle usage warnings by creating a .bundler folder in the home directory
|
||||||
|
"$(su "$REDMINE_DAEMON_USER" -s "$SHELL" -c "echo ~/.bundle")"
|
||||||
|
)
|
||||||
|
for dir in "${writable_dirs[@]}"; do
|
||||||
|
ensure_dir_exists "$dir"
|
||||||
|
# Use daemon:root ownership for compatibility when running as a non-root user
|
||||||
|
configure_permissions_ownership "$dir" -d "775" -f "664" -u "$REDMINE_DAEMON_USER" -g "root"
|
||||||
|
done
|
||||||
|
|
||||||
|
# Required for running as non-root users, for persistence logic to work properly
|
||||||
|
# Using g+rwx/g+rw instead of explicit 775/664 permissions because Redmine includes executable binaries in different subfolders
|
||||||
|
configure_permissions_ownership "$REDMINE_BASE_DIR" -d "g+rwx" -f "g+rw" -u "$REDMINE_DAEMON_USER" -g "root"
|
||||||
28
bitnami/redmine/4/debian-10/rootfs/opt/bitnami/scripts/redmine/run.sh
Executable file
28
bitnami/redmine/4/debian-10/rootfs/opt/bitnami/scripts/redmine/run.sh
Executable file
@@ -0,0 +1,28 @@
|
|||||||
|
#!/bin/bash
|
||||||
|
|
||||||
|
# shellcheck disable=SC1090,SC1091
|
||||||
|
|
||||||
|
set -o errexit
|
||||||
|
set -o nounset
|
||||||
|
set -o pipefail
|
||||||
|
# set -o xtrace # Uncomment this line for debugging purpose
|
||||||
|
|
||||||
|
# Load Redmine environment
|
||||||
|
. /opt/bitnami/scripts/redmine-env.sh
|
||||||
|
|
||||||
|
# Load libraries
|
||||||
|
. /opt/bitnami/scripts/libos.sh
|
||||||
|
. /opt/bitnami/scripts/liblog.sh
|
||||||
|
. /opt/bitnami/scripts/libredmine.sh
|
||||||
|
|
||||||
|
cd "$REDMINE_BASE_DIR"
|
||||||
|
|
||||||
|
declare -a cmd=(
|
||||||
|
"bundle" "exec" "passenger" "start"
|
||||||
|
"--user" "$REDMINE_DAEMON_USER"
|
||||||
|
"-e" "$REDMINE_ENV"
|
||||||
|
"-p" "$REDMINE_PORT_NUMBER"
|
||||||
|
)
|
||||||
|
|
||||||
|
info "** Starting Redmine **"
|
||||||
|
exec "${cmd[@]}" "$@"
|
||||||
29
bitnami/redmine/4/debian-10/rootfs/opt/bitnami/scripts/redmine/setup.sh
Executable file
29
bitnami/redmine/4/debian-10/rootfs/opt/bitnami/scripts/redmine/setup.sh
Executable file
@@ -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 Redmine environment
|
||||||
|
. /opt/bitnami/scripts/redmine-env.sh
|
||||||
|
|
||||||
|
# Load MySQL Client environment for 'mysql_remote_execute' (after 'redmine-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/libredmine.sh
|
||||||
|
|
||||||
|
# Ensure Redmine environment variables are valid
|
||||||
|
redmine_validate
|
||||||
|
|
||||||
|
# Ensure Redmine is initialized
|
||||||
|
redmine_initialize
|
||||||
31
bitnami/redmine/4/debian-10/rootfs/post-init.d/ruby.sh
Executable file
31
bitnami/redmine/4/debian-10/rootfs/post-init.d/ruby.sh
Executable file
@@ -0,0 +1,31 @@
|
|||||||
|
#!/bin/bash
|
||||||
|
#
|
||||||
|
# Executes custom Ruby 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
|
||||||
|
|
||||||
|
# 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" != *".rb" ]] && continue
|
||||||
|
info "Executing ${custom_init_script} with Ruby interpreter"
|
||||||
|
ruby "$custom_init_script" || failure=1
|
||||||
|
[[ "$failure" -ne 0 ]] && error "Failed to execute ${custom_init_script}"
|
||||||
|
done
|
||||||
|
fi
|
||||||
|
|
||||||
|
exit "$failure"
|
||||||
36
bitnami/redmine/4/debian-10/rootfs/post-init.d/shell.sh
Executable file
36
bitnami/redmine/4/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/redmine/4/debian-10/rootfs/post-init.d/sql-mysql.sh
Executable file
46
bitnami/redmine/4/debian-10/rootfs/post-init.d/sql-mysql.sh
Executable file
@@ -0,0 +1,46 @@
|
|||||||
|
#!/bin/bash
|
||||||
|
#
|
||||||
|
# Executes custom Ruby 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/redmine/4/debian-10/rootfs/post-init.sh
Executable file
23
bitnami/redmine/4/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/redmine/.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/redmine/.user_scripts_initialized" ]]; then
|
||||||
|
mkdir -p "/bitnami/redmine"
|
||||||
|
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/redmine/.user_scripts_initialized"
|
||||||
|
fi
|
||||||
@@ -1,19 +0,0 @@
|
|||||||
{
|
|
||||||
"databaseMysqlHost": "{{$global.env.REDMINE_DB_MYSQL}}",
|
|
||||||
"databaseName": "{{$global.env.REDMINE_DB_NAME}}",
|
|
||||||
"databasePassword": "{{$global.env.REDMINE_DB_PASSWORD}}",
|
|
||||||
"databasePostgresHost": "{{$global.env.REDMINE_DB_POSTGRES}}",
|
|
||||||
"databaseServerPort": "{{$global.env.REDMINE_DB_PORT_NUMBER}}",
|
|
||||||
"databaseUser": "{{$global.env.REDMINE_DB_USERNAME}}",
|
|
||||||
"email": "{{$global.env.REDMINE_EMAIL}}",
|
|
||||||
"language": "{{$global.env.REDMINE_LANGUAGE}}",
|
|
||||||
"password": "{{$global.env.REDMINE_PASSWORD}}",
|
|
||||||
"smtpAuthentication": "{{$global.env.SMTP_AUTHENTICATION}}",
|
|
||||||
"smtpDomain": "{{$global.env.SMTP_DOMAIN}}",
|
|
||||||
"smtpHost": "{{$global.env.SMTP_HOST}}",
|
|
||||||
"smtpPassword": "{{$global.env.SMTP_PASSWORD}}",
|
|
||||||
"smtpPort": "{{$global.env.SMTP_PORT}}",
|
|
||||||
"smtpTls": "{{$global.env.SMTP_TLS}}",
|
|
||||||
"smtpUser": "{{$global.env.SMTP_USER}}",
|
|
||||||
"username": "{{$global.env.REDMINE_USERNAME}}"
|
|
||||||
}
|
|
||||||
@@ -1,19 +0,0 @@
|
|||||||
#!/bin/bash -e
|
|
||||||
|
|
||||||
# shellcheck disable=SC1091
|
|
||||||
|
|
||||||
. /opt/bitnami/base/functions
|
|
||||||
. /opt/bitnami/base/helpers
|
|
||||||
|
|
||||||
USER=redmine
|
|
||||||
RAILS_ENV=production
|
|
||||||
PID_FILE=/opt/bitnami/redmine/tmp/pids/redmine.pid
|
|
||||||
LOG_FILE=/opt/bitnami/redmine/logs/production.log
|
|
||||||
|
|
||||||
mkdir -p /opt/bitnami/redmine/tmp/pids
|
|
||||||
chown ${USER}: -R /opt/bitnami/redmine/tmp
|
|
||||||
chmod -R 1777 /opt/bitnami/redmine/tmp
|
|
||||||
|
|
||||||
info "Starting redmine..."
|
|
||||||
cd /opt/bitnami/redmine || exit 1
|
|
||||||
exec gosu ${USER} bundle exec passenger start -e ${RAILS_ENV} --pid-file ${PID_FILE} --log-file ${LOG_FILE} -p 3000
|
|
||||||
@@ -1,12 +1,12 @@
|
|||||||
# What is Redmine?
|
# Bitnami Docker Image for Redmine
|
||||||
|
|
||||||
|
## What is Redmine?
|
||||||
|
|
||||||
> Redmine is a flexible project management web application. Written using the Ruby on Rails framework, it is cross-platform and cross-database.
|
> Redmine is a flexible project management web application. Written using the Ruby on Rails framework, it is cross-platform and cross-database.
|
||||||
|
|
||||||
https://redmine.org/
|
https://redmine.org/
|
||||||
|
|
||||||
# TL;DR
|
## TL;DR
|
||||||
|
|
||||||
## Docker Compose
|
|
||||||
|
|
||||||
```console
|
```console
|
||||||
$ curl -sSL https://raw.githubusercontent.com/bitnami/bitnami-docker-redmine/master/docker-compose.yml > docker-compose.yml
|
$ curl -sSL https://raw.githubusercontent.com/bitnami/bitnami-docker-redmine/master/docker-compose.yml > docker-compose.yml
|
||||||
@@ -15,42 +15,55 @@ $ docker-compose up -d
|
|||||||
|
|
||||||
You can find the default credentials and available configuration options in the [Environment Variables](#environment-variables) section.
|
You can find the default credentials and available configuration options in the [Environment Variables](#environment-variables) section.
|
||||||
|
|
||||||
# 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/redmine?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/redmine?tab=tags) contains a security report with all open CVEs. To get the list of actionable security issues, find the "latest" tag, click the vulnerability report link under the corresponding "Security scan" field and then select the "Only show fixable" filter on the next page.
|
||||||
|
|
||||||
# How to deploy Redmine in Kubernetes?
|
## How to deploy Redmine in Kubernetes?
|
||||||
|
|
||||||
Deploying Bitnami applications as Helm Charts is the easiest way to get started with our applications on Kubernetes. Read more about the installation in the [Bitnami Redmine Chart GitHub repository](https://github.com/bitnami/charts/tree/master/bitnami/redmine).
|
Deploying Bitnami applications as Helm Charts is the easiest way to get started with our applications on Kubernetes. Read more about the installation in the [Bitnami Redmine Chart GitHub repository](https://github.com/bitnami/charts/tree/master/bitnami/redmine).
|
||||||
|
|
||||||
Bitnami containers can be used with [Kubeapps](https://kubeapps.com/) for deployment and management of Helm Charts in clusters.
|
Bitnami containers can be used with [Kubeapps](https://kubeapps.com/) for deployment and management of Helm Charts in clusters.
|
||||||
|
|
||||||
# Supported tags and respective `Dockerfile` links
|
## Supported tags and respective `Dockerfile` links
|
||||||
|
|
||||||
Learn more about the Bitnami tagging policy and the difference between rolling tags and immutable tags [in our documentation page](https://docs.bitnami.com/tutorials/understand-rolling-tags-containers/).
|
Learn more about the Bitnami tagging policy and the difference between rolling tags and immutable tags [in our documentation page](https://docs.bitnami.com/tutorials/understand-rolling-tags-containers/).
|
||||||
|
|
||||||
|
|
||||||
* [`4`, `4-debian-10`, `4.2.1`, `4.2.1-debian-10-r69`, `latest` (4/debian-10/Dockerfile)](https://github.com/bitnami/bitnami-docker-redmine/blob/4.2.1-debian-10-r69/4/debian-10/Dockerfile)
|
- [`4`, `4-debian-10`, `4.2.1`, `4.2.1-debian-10-r70`, `latest` (4/debian-10/Dockerfile)](https://github.com/bitnami/bitnami-docker-redmine/blob/4.2.1-debian-10-r70/4/debian-10/Dockerfile)
|
||||||
|
|
||||||
Subscribe to project updates by watching the [bitnami/redmine GitHub repo](https://github.com/bitnami/bitnami-docker-redmine).
|
Subscribe to project updates by watching the [bitnami/redmine GitHub repo](https://github.com/bitnami/bitnami-docker-redmine).
|
||||||
|
|
||||||
# Prerequisites
|
## Get this image
|
||||||
|
|
||||||
To run this application you need Docker Engine 1.10.0. Docker Compose is recomended with a version 1.6.0 or later.
|
The recommended way to get the Bitnami Redmine Docker Image is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/redmine).
|
||||||
|
|
||||||
# How to use this image
|
```console
|
||||||
|
$ docker pull bitnami/redmine:latest
|
||||||
|
```
|
||||||
|
|
||||||
## Run Redmine with a Database Container
|
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/redmine/tags/) in the Docker Hub Registry.
|
||||||
|
|
||||||
Running Redmine with a database server is the recommended way. You can either use docker-compose or run the containers manually.
|
```console
|
||||||
|
$ docker pull bitnami/redmine:[TAG]
|
||||||
|
```
|
||||||
|
|
||||||
|
If you wish, you can also build the image yourself.
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ docker build -t bitnami/redmine:latest 'https://github.com/bitnami/bitnami-docker-redmine.git#master:4/debian-10'
|
||||||
|
```
|
||||||
|
|
||||||
|
## How to use this image
|
||||||
|
|
||||||
|
Redmine requires access to a MySQL, MariaDB or PostgreSQL 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
|
### Run the application using Docker Compose
|
||||||
|
|
||||||
@@ -61,342 +74,419 @@ $ curl -sSL https://raw.githubusercontent.com/bitnami/bitnami-docker-redmine/mas
|
|||||||
$ docker-compose up -d
|
$ docker-compose up -d
|
||||||
```
|
```
|
||||||
|
|
||||||
### Run the application manually
|
### Using the Docker Command Line
|
||||||
|
|
||||||
If you want to run the application manually instead of using docker-compose, these are the basic steps you need to run:
|
If you want to run the application manually instead of using `docker-compose`, these are the basic steps you need to run:
|
||||||
|
|
||||||
1. Create a new network for the application and the database:
|
#### Step 1: Create a network
|
||||||
|
|
||||||
```console
|
```console
|
||||||
$ docker network create redmine-tier
|
$ docker network create redmine-network
|
||||||
```
|
|
||||||
|
|
||||||
2. Create a volume for MariaDB persistence and create a MariaDB container
|
|
||||||
```console
|
|
||||||
$ docker volume create --name mariadb_data
|
|
||||||
$ docker run -d --name mariadb \
|
|
||||||
-e ALLOW_EMPTY_PASSWORD=yes \
|
|
||||||
-e MARIADB_USER=bn_redmine \
|
|
||||||
-e MARIADB_DATABASE=bitnami_redmine \
|
|
||||||
--net redmine-tier \
|
|
||||||
--volume mariadb_data:/bitnami \
|
|
||||||
bitnami/mariadb:latest
|
|
||||||
```
|
|
||||||
|
|
||||||
3. Create volumes for Redmine persistence and launch the container
|
|
||||||
|
|
||||||
```console
|
|
||||||
$ docker volume create --name redmine_data
|
|
||||||
$ docker run -d --name redmine -p 80:3000 \
|
|
||||||
-e REDMINE_DB_USERNAME=bn_redmine \
|
|
||||||
-e REDMINE_DB_NAME=bitnami_redmine \
|
|
||||||
--net redmine-tier \
|
|
||||||
--volume redmine_data:/bitnami \
|
|
||||||
bitnami/redmine:latest
|
|
||||||
```
|
|
||||||
|
|
||||||
Then you can access your application at http://your-ip/
|
|
||||||
|
|
||||||
### Run the application using PostgreSQL database
|
|
||||||
|
|
||||||
The Bitnami Redmine Docker Image supports both MariaDB and PostgreSQL databases. In order to use a PostgreSQL database you can run the following command:
|
|
||||||
|
|
||||||
```console
|
|
||||||
$ docker-compose -f docker-compose-postgresql.yml up
|
|
||||||
```
|
|
||||||
|
|
||||||
or use the next docker-compose template:
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
version: '2'
|
|
||||||
services:
|
|
||||||
postgresql:
|
|
||||||
image: 'bitnami/postgresql:11'
|
|
||||||
environment:
|
|
||||||
- ALLOW_EMPTY_PASSWORD=yes
|
|
||||||
- POSTGRESQL_USERNAME=bn_redmine
|
|
||||||
- POSTGRESQL_DATABASE=bitnami_redmine
|
|
||||||
volumes:
|
|
||||||
- 'postgresql_data:/bitnami/postgresql'
|
|
||||||
redmine:
|
|
||||||
image: 'bitnami/redmine:4'
|
|
||||||
ports:
|
|
||||||
- '80:3000'
|
|
||||||
environment:
|
|
||||||
- REDMINE_DB_POSTGRES=postgresql
|
|
||||||
- REDMINE_DB_USERNAME=bn_redmine
|
|
||||||
- REDMINE_DB_NAME=bitnami_redmine
|
|
||||||
volumes:
|
|
||||||
- 'redmine_data:/bitnami'
|
|
||||||
depends_on:
|
|
||||||
- postgresql
|
|
||||||
volumes:
|
|
||||||
postgresql_data:
|
|
||||||
driver: local
|
|
||||||
redmine_data:
|
|
||||||
driver: local
|
|
||||||
```
|
```
|
||||||
|
|
||||||
|
#### Step 2: Create a volume for MariaDB persistence and create a MariaDB container
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ docker volume create --name mariadb_data
|
||||||
|
$ docker run -d --name mariadb \
|
||||||
|
--env ALLOW_EMPTY_PASSWORD=yes \
|
||||||
|
--env MARIADB_USER=bn_redmine \
|
||||||
|
--env MARIADB_PASSWORD=bitnami \
|
||||||
|
--env MARIADB_DATABASE=bitnami_redmine \
|
||||||
|
--network redmine-network \
|
||||||
|
--volume mariadb_data:/bitnami/mariadb \
|
||||||
|
bitnami/mariadb:latest
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Step 3: Create volumes for Redmine persistence and launch the container
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ docker volume create --name redmine_data
|
||||||
|
$ docker run -d --name redmine \
|
||||||
|
-p 8080:8080 -p 8443:8443 \
|
||||||
|
--env ALLOW_EMPTY_PASSWORD=yes \
|
||||||
|
--env REDMINE_DATABASE_USER=bn_redmine \
|
||||||
|
--env REDMINE_DATABASE_PASSWORD=bitnami \
|
||||||
|
--env REDMINE_DATABASE_NAME=bitnami_redmine \
|
||||||
|
--network redmine-network \
|
||||||
|
--volume redmine_data:/bitnami/redmine \
|
||||||
|
bitnami/redmine:latest
|
||||||
|
```
|
||||||
|
|
||||||
|
Access your application at *http://your-ip/*
|
||||||
|
|
||||||
## Persisting your application
|
## Persisting your application
|
||||||
|
|
||||||
If you remove the container all your data and configurations will be lost, and the next time you run the image the database will be reinitialized. To avoid this loss of data, you should mount a volume that will persist even after the container is removed.
|
If you remove the container all your data will be lost, and the next time you run the image the database will be reinitialized. To avoid this loss of data, you should mount a volume that will persist even after the container is removed.
|
||||||
|
|
||||||
For persistence you should mount a volume at the `/bitnami` path. Additionally you should mount a volume for [persistence of the MariaDB data](https://github.com/bitnami/bitnami-docker-mariadb#persisting-your-database). As this is a non-root container, the mounted files and directories must have the proper permissions for the UID `1001`.
|
For persistence you should mount a directory at the `/bitnami/redmine` path. If the mounted directory is empty, it will be initialized on the first run. Additionally you should [mount a volume for persistence of the MariaDB data](https://github.com/bitnami/bitnami-docker-mariadb#persisting-your-database).
|
||||||
|
|
||||||
The above examples define docker volumes namely `mariadb_data` and `redmine_data`. The Redmine application state will persist as long as these volumes are not removed.
|
The above examples define the Docker volumes named `mariadb_data` and `redmine_data`. The Redmine 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 host directories as data volumes with Docker Compose
|
||||||
|
|
||||||
The following `docker-compose.yml` template demonstrates the use of host directories as data volumes.
|
This requires a minor change to the [`docker-compose.yml`](https://github.com/bitnami/bitnami-docker-redmine/blob/master/docker-compose.yml) file present in this repository:
|
||||||
|
|
||||||
```yaml
|
```diff
|
||||||
mariadb:
|
mariadb:
|
||||||
...
|
...
|
||||||
volumes:
|
volumes:
|
||||||
- '/path/to/mariadb-persistence:/bitnami/mariadb'
|
- - 'mariadb_data:/bitnami/mariadb'
|
||||||
...
|
+ - /path/to/mariadb-persistence:/bitnami/mariadb
|
||||||
redmine:
|
...
|
||||||
...
|
redmine:
|
||||||
volumes:
|
...
|
||||||
- '/path/to/redmine-persistence:/bitnami'
|
volumes:
|
||||||
...
|
- - 'redmine_data:/bitnami/redmine'
|
||||||
|
+ - /path/to/redmine-persistence:/bitnami/redmine
|
||||||
|
...
|
||||||
|
-volumes:
|
||||||
|
- mariadb_data:
|
||||||
|
- driver: local
|
||||||
|
- redmine_data:
|
||||||
|
- driver: local
|
||||||
```
|
```
|
||||||
|
|
||||||
|
> NOTE: As this is a non-root container, the mounted files and directories must have the proper permissions for the UID `1001`.
|
||||||
|
|
||||||
### Mount host directories as data volumes using the Docker command line
|
### Mount host directories as data volumes using the Docker command line
|
||||||
|
|
||||||
1. Create a network (if it does not exist):
|
#### Step 1: Create a network (if it does not exist)
|
||||||
|
|
||||||
```console
|
```console
|
||||||
$ docker network create redmine-tier
|
$ docker network create redmine-network
|
||||||
```
|
|
||||||
|
|
||||||
2. Create a MariaDB container with host volume:
|
|
||||||
|
|
||||||
```console
|
|
||||||
$ docker run -d --name mariadb \
|
|
||||||
-e ALLOW_EMPTY_PASSWORD=yes \
|
|
||||||
-e MARIADB_USER=bn_redmine \
|
|
||||||
-e MARIADB_DATABASE=bitnami_redmine \
|
|
||||||
--net redmine-tier \
|
|
||||||
--volume /path/to/mariadb-persistence:/bitnami/mariadb \
|
|
||||||
bitnami/mariadb:latest
|
|
||||||
```
|
|
||||||
|
|
||||||
*Note:* You need to give the container a name in order to Redmine to resolve the host
|
|
||||||
|
|
||||||
3. Run the Redmine container:
|
|
||||||
|
|
||||||
```console
|
|
||||||
$ docker run -d --name redmine -p 80:3000 \
|
|
||||||
-e REDMINE_DB_USERNAME=bn_redmine \
|
|
||||||
-e REDMINE_DB_NAME=bitnami_redmine \
|
|
||||||
--net redmine-tier \
|
|
||||||
--volume /path/to/redmine-persistence:/bitnami \
|
|
||||||
bitnami/redmine:latest
|
|
||||||
```
|
|
||||||
|
|
||||||
## Deploying to a sub-URI
|
|
||||||
|
|
||||||
On certain occasions, you may need that Redmine is available under a specific sub-URI path rather than the root. A common scenario to this problem may arise if you plan to set up your Redmine container behind a reverse proxy. To deploy your Redmine container using a certain sub-URI you just need to follow these steps:
|
|
||||||
|
|
||||||
1. Create a new bash script file in your host system, `subUriInit.sh`, that will replace the default `init.sh`:
|
|
||||||
|
|
||||||
__subUriInit.sh__
|
|
||||||
```
|
|
||||||
#!/bin/bash
|
|
||||||
|
|
||||||
# Set default values depending on database variation
|
|
||||||
if [ -n "$REDMINE_DB_POSTGRES" ]; then
|
|
||||||
export REDMINE_DB_PORT_NUMBER=${REDMINE_DB_PORT_NUMBER:-5432}
|
|
||||||
export REDMINE_DB_USERNAME=${REDMINE_DB_USERNAME:-postgres}
|
|
||||||
elif [ -n "$REDMINE_DB_MYSQL" ]; then
|
|
||||||
export REDMINE_DB_PORT_NUMBER=${REDMINE_DB_PORT_NUMBER:-3306}
|
|
||||||
export REDMINE_DB_USERNAME=${REDMINE_DB_USERNAME:-root}
|
|
||||||
fi
|
|
||||||
|
|
||||||
# REPLACE WITH YOUR OWN SUB-URI
|
|
||||||
SUB_URI_PATH='/redmine'
|
|
||||||
|
|
||||||
#Config files where to apply changes
|
|
||||||
config1=/opt/bitnami/redmine/config.ru
|
|
||||||
config2=/opt/bitnami/redmine/config/environment.rb
|
|
||||||
|
|
||||||
if [[ ! -d /opt/bitnami/redmine/conf/ ]]; then
|
|
||||||
sed -i '$ d' ${config1}
|
|
||||||
echo 'map ActionController::Base.config.try(:relative_url_root) || "/" do' >> ${config1}
|
|
||||||
echo 'run Rails.application' >> ${config1}
|
|
||||||
echo 'end' >> ${config1}
|
|
||||||
echo 'Redmine::Utils::relative_url_root = "'${SUB_URI_PATH}'"' >> ${config2}
|
|
||||||
fi
|
|
||||||
|
|
||||||
SUB_URI_PATH=$(echo ${SUB_URI_PATH} | sed -e 's|/|\\/|g')
|
|
||||||
sed -i -e "s/\(relative_url_root\ \=\ \"\).*\(\"\)/\1${SUB_URI_PATH}\2/" ${config2}
|
|
||||||
```
|
```
|
||||||
|
|
||||||
2. Make sure you replace the value of `SUB_URI_PATH` with your own sub-URI. e.g: '/redmine'. Do not forget to add the leading slash '/'.
|
#### Step 2. Create a MariaDB container with host volume
|
||||||
|
|
||||||
3. Give execution permissions to `subUriInit.sh`:
|
```console
|
||||||
|
$ docker run -d --name mariadb \
|
||||||
|
--env ALLOW_EMPTY_PASSWORD=yes \
|
||||||
|
--env MARIADB_USER=bn_redmine \
|
||||||
|
--env MARIADB_PASSWORD=bitnami \
|
||||||
|
--env MARIADB_DATABASE=bitnami_redmine \
|
||||||
|
--network redmine-network \
|
||||||
|
--volume /path/to/mariadb-persistence:/bitnami/mariadb \
|
||||||
|
bitnami/mariadb:latest
|
||||||
|
```
|
||||||
|
|
||||||
```console
|
#### Step 3. Create the Redmine container with host volumes
|
||||||
$ chmod +x subUriInit.sh
|
|
||||||
```
|
|
||||||
|
|
||||||
4. Replace the default `init.sh` script in favour of our new created `subUriInit.sh`. You can mount this file as a volume in order to accomplish this task.
|
```console
|
||||||
|
$ docker run -d --name redmine \
|
||||||
|
-p 8080:8080 -p 8443:8443 \
|
||||||
|
--env ALLOW_EMPTY_PASSWORD=yes \
|
||||||
|
--env REDMINE_DATABASE_USER=bn_redmine \
|
||||||
|
--env REDMINE_DATABASE_PASSWORD=bitnami \
|
||||||
|
--env REDMINE_DATABASE_NAME=bitnami_redmine \
|
||||||
|
--network redmine-network \
|
||||||
|
--volume /path/to/redmine-persistence:/bitnami/redmine \
|
||||||
|
bitnami/redmine:latest
|
||||||
|
```
|
||||||
|
|
||||||
* For docker-compose:
|
## Configuration
|
||||||
|
|
||||||
|
### Environment variables
|
||||||
|
|
||||||
|
When you start the Redmine 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 add the variable name and value under the application section in the [`docker-compose.yml`](https://github.com/bitnami/bitnami-docker-redmine/blob/master/docker-compose.yml) file present in this repository:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
services:
|
redmine:
|
||||||
redmine:
|
|
||||||
...
|
...
|
||||||
volumes:
|
environment:
|
||||||
- '/path/to/subUriInit.sh:/init.sh'
|
- REDMINE_PASSWORD=my_password
|
||||||
...
|
...
|
||||||
```
|
```
|
||||||
|
|
||||||
* For manual execution (see [Run the application manually](https://github.com/bitnami/bitnami-docker-redmine#run-the-application-manually)):
|
- For manual execution add a `--env` option with each variable and value:
|
||||||
|
|
||||||
```console
|
```console
|
||||||
$ docker run -d --name redmine -p 80:3000 \
|
$ docker run -d --name redmine -p 80:8080 -p 443:8443 \
|
||||||
-e REDMINE_DB_USERNAME=bn_redmine \
|
--env REDMINE_PASSWORD=my_password \
|
||||||
-e REDMINE_DB_NAME=bitnami_redmine \
|
--network redmine-tier \
|
||||||
--net redmine-tier \
|
--volume /path/to/redmine-persistence:/bitnami \
|
||||||
--volume redmine_data:/bitnami \
|
|
||||||
--volume /path/to/subUriInit.sh:/init.sh \
|
|
||||||
bitnami/redmine:latest
|
bitnami/redmine:latest
|
||||||
```
|
```
|
||||||
|
|
||||||
Then you can access your application at http://your-ip/SUB_URI_PATH
|
Available environment variables:
|
||||||
|
|
||||||
# Upgrade this application
|
##### User and Site configuration
|
||||||
|
|
||||||
Bitnami provides up-to-date versions of MariaDB and Redmine, 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 Redmine container. For the MariaDB upgrade see https://github.com/bitnami/bitnami-docker-mariadb/blob/master/README.md#upgrade-this-image
|
- `REDMINE_PORT_NUMBER`: Port number in which Redmine will run. Default: **3000**
|
||||||
|
- `REDMINE_USERNAME`: Redmine application username. Default: **user**
|
||||||
|
- `REDMINE_PASSWORD`: Redmine application password. Default: **bitnami1**
|
||||||
|
- `REDMINE_EMAIL`: Redmine application email. Default: **user@example.com**
|
||||||
|
- `REDMINE_FIRST_NAME`: Redmine user first name. Default: **UserName**
|
||||||
|
- `REDMINE_LAST_NAME`: Redmine user last name. Default: **LastName**
|
||||||
|
- `REDMINE_LANGUAGE`: Redmine site default language. Default: **en**
|
||||||
|
- `REDMINE_LOAD_DEFAULT_DATA`: Whether to load default configuration data for Redmine. Default: **yes**
|
||||||
|
- `REDMINE_SKIP_BOOTSTRAP`: Whether to perform initial bootstrapping for the application. This is necessary in case you use a database that already has Redmine data. Default: **no**
|
||||||
|
|
||||||
1. Get the updated images:
|
##### Database connection configuration
|
||||||
|
|
||||||
```console
|
- `REDMINE_DATABASE_TYPE`: Database type to be used for the Redmine installation. Allowed values: *mariadb*, *postgresql*. Default: **mariadb**
|
||||||
$ docker pull bitnami/redmine:latest
|
- `REDMINE_DATABASE_HOST`: Hostname for the MariaDB or MySQL server. Default: **mariadb**
|
||||||
```
|
- `REDMINE_DATABASE_PORT_NUMBER`: Port used by the MariaDB or MySQL server. Default: **3306**
|
||||||
|
- `REDMINE_DATABASE_NAME`: Database name that Redmine will use to connect with the database. Default: **bitnami_redmine**
|
||||||
|
- `REDMINE_DATABASE_USER`: Database user that Redmine will use to connect with the database. Default: **bn_redmine**
|
||||||
|
- `REDMINE_DATABASE_PASSWORD`: Database password that Redmine will use to connect with the database. No default.
|
||||||
|
- `ALLOW_EMPTY_PASSWORD`: It can be used to allow blank passwords. Default: **no**
|
||||||
|
|
||||||
2. Stop your container
|
##### Create a database for Redmine using mysql-client
|
||||||
|
|
||||||
* For docker-compose: `$ docker-compose stop redmine`
|
- `MYSQL_CLIENT_DATABASE_HOST`: Hostname for the MariaDB or MySQL server. Default: **mariadb**
|
||||||
* For manual execution: `$ docker stop redmine`
|
- `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**
|
||||||
|
|
||||||
3. Take a snapshot of the application state
|
##### Create a database for Redmine using postgresql-client
|
||||||
|
|
||||||
```console
|
- `POSTGRESQL_CLIENT_DATABASE_HOST`: Hostname for the PostgreSQL server. Default: **postgresql**
|
||||||
$ rsync -a /path/to/redmine-persistence /path/to/redmine-persistence.bkp.$(date +%Y%m%d-%H.%M.%S)
|
- `POSTGRESQL_CLIENT_DATABASE_PORT_NUMBER`: Port used by the PostgreSQL server. Default: **5432**
|
||||||
```
|
- `POSTGRESQL_CLIENT_DATABASE_ROOT_USER`: Database admin user. Default: **root**
|
||||||
|
- `POSTGRESQL_CLIENT_DATABASE_ROOT_PASSWORD`: Database password for the database admin user. No defaults.
|
||||||
|
- `POSTGRESQL_CLIENT_CREATE_DATABASE_NAME`: New database to be created by the mysql client module. No defaults.
|
||||||
|
- `POSTGRESQL_CLIENT_CREATE_DATABASE_USER`: New database user to be created by the mysql client module. No defaults.
|
||||||
|
- `POSTGRESQL_CLIENT_CREATE_DATABASE_PASSWORD`: Database password for the `POSTGRESQL_CLIENT_CREATE_DATABASE_USER` user. No defaults.
|
||||||
|
- `POSTGRESQL_CLIENT_CREATE_DATABASE_EXTENSIONS`: PostgreSQL extensions to enable in the specified database during the first initialization. No defaults.
|
||||||
|
- `POSTGRESQL_CLIENT_ENABLE_SSL`: Whether to enable SSL connections for the new database. Default: **no**
|
||||||
|
- `POSTGRESQL_CLIENT_SSL_CA_FILE`: Path to the SSL CA file for the new database. No defaults
|
||||||
|
- `ALLOW_EMPTY_PASSWORD`: It can be used to allow blank passwords. Default: **no**
|
||||||
|
|
||||||
Additionally, [snapshot the MariaDB data](https://github.com/bitnami/bitnami-docker-mariadb#step-2-stop-and-backup-the-currently-running-container)
|
##### SMTP Configuration
|
||||||
|
|
||||||
You can use these snapshots to restore the application state should the upgrade fail.
|
|
||||||
|
|
||||||
4. Remove the currently running container
|
|
||||||
|
|
||||||
* For docker-compose: `$ docker-compose rm redmine`
|
|
||||||
* For manual execution: `$ docker rm redmine`
|
|
||||||
|
|
||||||
5. Run the new image
|
|
||||||
|
|
||||||
* For docker-compose: `$ docker-compose up redmine`
|
|
||||||
* For manual execution ([mount](#mount-persistent-folders-manually) the directories if needed): `docker run --name redmine bitnami/redmine:latest`
|
|
||||||
|
|
||||||
# Configuration
|
|
||||||
|
|
||||||
## Environment variables
|
|
||||||
|
|
||||||
When you start the redmine 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 add the variable name and value under the application section in the [`docker-compose.yml`](https://github.com/bitnami/bitnami-docker-redmine/blob/master/docker-compose.yml) file present in this repository:
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
redmine:
|
|
||||||
...
|
|
||||||
environment:
|
|
||||||
- REDMINE_PASSWORD=my_password
|
|
||||||
...
|
|
||||||
```
|
|
||||||
|
|
||||||
* For manual execution add a `-e` option with each variable and value:
|
|
||||||
|
|
||||||
```console
|
|
||||||
$ docker run -d --name redmine --network=redmine_network -p 80:3000 \
|
|
||||||
-e REDMINE_PASSWORD=my_password \
|
|
||||||
-v /your/local/path/bitnami/redmine:/bitnami \
|
|
||||||
bitnami/redmine
|
|
||||||
```
|
|
||||||
|
|
||||||
Available variables:
|
|
||||||
- `REDMINE_USERNAME`: Redmine application username. Default: **user**
|
|
||||||
- `REDMINE_PASSWORD`: Redmine application password. Default: **bitnami1**
|
|
||||||
- `REDMINE_EMAIL`: Redmine application email. Default: **user@example.com**
|
|
||||||
- `REDMINE_LANGUAGE`: Redmine application default language. Default: **en**
|
|
||||||
- `REDMINE_DB_USERNAME`: Database user the application will connect with. Default: **bn_redmine**
|
|
||||||
- `REDMINE_DB_PASSWORD`: Password for the database user.
|
|
||||||
- `REDMINE_DB_NAME`: Database the application will connect to. Default: **bitnami_redmine**
|
|
||||||
- `REDMINE_DB_MYSQL`: Hostname for MySQL server. Default: **mariadb**
|
|
||||||
- `REDMINE_DB_POSTGRES`: Hostname for PostgreSQL server. No defaults
|
|
||||||
- `REDMINE_DB_PORT_NUMBER`: Port used by database server. Default: **3306**
|
|
||||||
|
|
||||||
### SMTP Configuration
|
|
||||||
|
|
||||||
To configure Redmine to send email using SMTP you can set the following environment variables:
|
To configure Redmine to send email using SMTP you can set the following environment variables:
|
||||||
- `SMTP_HOST`: SMTP host.
|
|
||||||
- `SMTP_PORT`: SMTP port.
|
|
||||||
- `SMTP_USER`: SMTP account user. It can be empty.
|
|
||||||
- `SMTP_PASSWORD`: SMTP account password. It can be empty.
|
|
||||||
- `SMTP_TLS`: Use TLS encription with SMTP. Default **true**
|
|
||||||
- `SMTP_DOMAIN` : Somain for SMTP configuration. Default **example.com**
|
|
||||||
- `SMTP_AUTHENTICATION` : The authentication method for SMTP. Default **login**
|
|
||||||
|
|
||||||
This would be an example of SMTP configuration using a GMail account:
|
- `REDMINE_SMTP_HOST`: SMTP host.
|
||||||
|
- `REDMINE_SMTP_PORT`: SMTP port.
|
||||||
|
- `REDMINE_SMTP_USER`: SMTP account user.
|
||||||
|
- `REDMINE_SMTP_PASSWORD`: SMTP account password.
|
||||||
|
- `REDMINE_SMTP_PROTOCOL`: If specified, SMTP protocol to use. Allowed values: *tls*, *ssl*. No default.
|
||||||
|
- `REDMINE_SMTP_AUTH`: SMTP authentication method. Allowed values: *login*, *plain*, *cram_md5*. Default: **login**.
|
||||||
|
|
||||||
* Modify the [`docker-compose.yml`](https://github.com/bitnami/bitnami-docker-redmine/blob/master/docker-compose.yml) file present in this repository:
|
#### Examples
|
||||||
|
|
||||||
```yaml
|
##### SMTP configuration using a Gmail account
|
||||||
redmine:
|
|
||||||
...
|
|
||||||
environment:
|
|
||||||
- SMTP_HOST=smtp.gmail.com
|
|
||||||
- SMTP_PORT=587
|
|
||||||
- SMTP_USER=your_email@gmail.com
|
|
||||||
- SMTP_PASSWORD=your_password
|
|
||||||
...
|
|
||||||
```
|
|
||||||
|
|
||||||
* For manual execution:
|
This would be an example of SMTP configuration using a Gmail account:
|
||||||
|
|
||||||
|
- Modify the [`docker-compose.yml`](https://github.com/bitnami/bitnami-docker-redmine/blob/master/docker-compose.yml) file present in this repository:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
redmine:
|
||||||
|
...
|
||||||
|
environment:
|
||||||
|
- REDMINE_DATABASE_USER=bn_redmine
|
||||||
|
- REDMINE_DATABASE_NAME=bitnami_redmine
|
||||||
|
- ALLOW_EMPTY_PASSWORD=yes
|
||||||
|
- REDMINE_SMTP_HOST=smtp.gmail.com
|
||||||
|
- REDMINE_SMTP_PORT=587
|
||||||
|
- REDMINE_SMTP_USER=your_email@gmail.com
|
||||||
|
- REDMINE_SMTP_PASSWORD=your_password
|
||||||
|
...
|
||||||
|
```
|
||||||
|
|
||||||
|
- For manual execution:
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ docker run -d --name redmine -p 80:8080 -p 443:8443 \
|
||||||
|
--env REDMINE_DATABASE_USER=bn_redmine \
|
||||||
|
--env REDMINE_DATABASE_NAME=bitnami_redmine \
|
||||||
|
--env REDMINE_SMTP_HOST=smtp.gmail.com \
|
||||||
|
--env REDMINE_SMTP_PORT=587 \
|
||||||
|
--env REDMINE_SMTP_USER=your_email@gmail.com \
|
||||||
|
--env REDMINE_SMTP_PASSWORD=your_password \
|
||||||
|
--network redmine-tier \
|
||||||
|
--volume /path/to/redmine-persistence:/bitnami \
|
||||||
|
bitnami/redmine:latest
|
||||||
|
```
|
||||||
|
|
||||||
|
##### Connect Redmine container to an existing database
|
||||||
|
|
||||||
|
The Bitnami Redmine container supports connecting the Redmine application to an external database. This would be an example of using an external database for Redmine.
|
||||||
|
|
||||||
|
- Modify the [`docker-compose.yml`](https://github.com/bitnami/bitnami-docker-redmine/blob/master/docker-compose.yml) file present in this repository:
|
||||||
|
|
||||||
|
```diff
|
||||||
|
redmine:
|
||||||
|
...
|
||||||
|
environment:
|
||||||
|
- - REDMINE_DATABASE_HOST=mariadb
|
||||||
|
+ - REDMINE_DATABASE_HOST=mariadb_host
|
||||||
|
- REDMINE_DATABASE_PORT_NUMBER=3306
|
||||||
|
- REDMINE_DATABASE_NAME=redmine_db
|
||||||
|
- REDMINE_DATABASE_USER=redmine_user
|
||||||
|
- - ALLOW_EMPTY_PASSWORD=yes
|
||||||
|
+ - REDMINE_DATABASE_PASSWORD=redmine_password
|
||||||
|
...
|
||||||
|
```
|
||||||
|
|
||||||
|
- For manual execution:
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ docker run -d --name redmine\
|
||||||
|
-p 8080:8080 -p 8443:8443 \
|
||||||
|
--network redmine-network \
|
||||||
|
--env REDMINE_DATABASE_HOST=mariadb_host \
|
||||||
|
--env REDMINE_DATABASE_PORT_NUMBER=3306 \
|
||||||
|
--env REDMINE_DATABASE_NAME=redmine_db \
|
||||||
|
--env REDMINE_DATABASE_USER=redmine_user \
|
||||||
|
--env REDMINE_DATABASE_PASSWORD=redmine_password \
|
||||||
|
--volume redmine_data:/bitnami/redmine \
|
||||||
|
bitnami/redmine:latest
|
||||||
|
```
|
||||||
|
|
||||||
|
In case the database already contains data from a previous Redmine installation, you need to set the variable `REDMINE_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 `REDMINE_SKIP_BOOTSTRAP` to `yes`, values for environment variables such as `REDMINE_USERNAME`, `REDMINE_PASSWORD` or `REDMINE_EMAIL` will be ignored.
|
||||||
|
|
||||||
|
## Logging
|
||||||
|
|
||||||
|
The Bitnami Redmine Docker image sends the container logs to `stdout`. To view the logs:
|
||||||
|
|
||||||
```console
|
```console
|
||||||
$ docker run -d -p 80:3000 --name redmine --network=redmine_network \
|
$ docker logs redmine
|
||||||
-e SMTP_HOST=smtp.gmail.com \
|
|
||||||
-e SMTP_PORT=587 \
|
|
||||||
-e SMTP_USER=your_email@gmail.com \
|
|
||||||
-e SMTP_PASSWORD=your_password \
|
|
||||||
-v /your/local/path/bitnami/redmine:/bitnami \
|
|
||||||
bitnami/redmine
|
|
||||||
```
|
```
|
||||||
|
|
||||||
# Contributing
|
Or using Docker Compose:
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ docker-compose logs redmine
|
||||||
|
```
|
||||||
|
|
||||||
|
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 redmine
|
||||||
|
```
|
||||||
|
|
||||||
|
Or using Docker Compose:
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ docker-compose stop redmine
|
||||||
|
```
|
||||||
|
|
||||||
|
#### 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/redmine-backups:/backups --volumes-from redmine busybox \
|
||||||
|
cp -a /bitnami/redmine /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 Redmine container:
|
||||||
|
|
||||||
|
```diff
|
||||||
|
$ docker run -d --name redmine \
|
||||||
|
...
|
||||||
|
- --volume /path/to/redmine-persistence:/bitnami/redmine \
|
||||||
|
+ --volume /path/to/redmine-backups/latest:/bitnami/redmine \
|
||||||
|
bitnami/redmine:latest
|
||||||
|
```
|
||||||
|
|
||||||
|
### Upgrade this image
|
||||||
|
|
||||||
|
Bitnami provides up-to-date versions of MariaDB and Redmine, 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 Redmine container. For the MariaDB upgrade see: https://github.com/bitnami/bitnami-docker-mariadb/blob/master/README.md#upgrade-this-image
|
||||||
|
|
||||||
|
The `bitnami/redmine: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/redmine:latest`. However it is recommended to use [tagged versions](https://hub.docker.com/r/bitnami/redmine/tags/).
|
||||||
|
|
||||||
|
#### Step 1: Get the updated image
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ docker pull bitnami/redmine:latest
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Step 2: Stop the running container
|
||||||
|
|
||||||
|
Stop the currently running container using the command
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ docker-compose stop redmine
|
||||||
|
```
|
||||||
|
|
||||||
|
#### 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 redmine
|
||||||
|
```
|
||||||
|
|
||||||
|
#### 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
|
||||||
|
```
|
||||||
|
|
||||||
|
## Notable Changes
|
||||||
|
|
||||||
|
### 4.2.1-debian-10-r70
|
||||||
|
|
||||||
|
- The size of the container image has been decreased.
|
||||||
|
- The configuration logic is now based on Bash scripts in the *rootfs/* folder.
|
||||||
|
- It is now possible to use an already populated Redmine database from another installation. In order to do this, use the environment variable `REDMINE_SKIP_BOOTSTRAP`, which forces the container not to run the initial Redmine setup wizard.
|
||||||
|
- The following environment variables have been deprecated. They will continue to work as before, but support for these may be removed in a future update:
|
||||||
|
|
||||||
|
- `REDMINE_DB_POSTGRES`, in favor of `REDMINE_DB_TYPE=postgresql`.
|
||||||
|
- `REDMINE_DB_MYSQL`, in favor of `REDMINE_DB_TYPE=mariadb`.
|
||||||
|
- `SMTP_AUTH`, in favor of `REDMINE_PROTOCOL=tls`.
|
||||||
|
|
||||||
|
## 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-redmine/issues), or submit a [pull request](https://github.com/bitnami/bitnami-docker-redmine/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-redmine/issues), or submit a [pull request](https://github.com/bitnami/bitnami-docker-redmine/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-redmine/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-redmine/issues). For us to provide better support, be sure to include the following information in your issue:
|
||||||
|
|
||||||
- Host OS and version
|
- Host OS and version
|
||||||
- Docker version (`docker version`)
|
- Docker version (`docker version`)
|
||||||
- Output of `docker info`
|
- 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)
|
- The command you used to run the container, and any relevant output you saw (masking any sensitive information)
|
||||||
|
|
||||||
# License
|
## License
|
||||||
|
|
||||||
Copyright (c) 2015-2021 Bitnami
|
Copyright (c) 2021 Bitnami
|
||||||
|
|
||||||
Licensed under the Apache License, Version 2.0 (the "License");
|
Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
you may not use this file except in compliance with the License.
|
you may not use this file except in compliance with the License.
|
||||||
|
|||||||
@@ -2,24 +2,27 @@ version: '2'
|
|||||||
services:
|
services:
|
||||||
postgresql:
|
postgresql:
|
||||||
image: docker.io/bitnami/postgresql:11
|
image: docker.io/bitnami/postgresql:11
|
||||||
|
volumes:
|
||||||
|
- 'postgresql_data:/bitnami/postgresql'
|
||||||
environment:
|
environment:
|
||||||
- ALLOW_EMPTY_PASSWORD=yes
|
- ALLOW_EMPTY_PASSWORD=yes
|
||||||
- POSTGRESQL_USERNAME=bn_redmine
|
- POSTGRESQL_USERNAME=bn_redmine
|
||||||
- POSTGRESQL_DATABASE=bitnami_redmine
|
- POSTGRESQL_DATABASE=bitnami_redmine
|
||||||
volumes:
|
|
||||||
- 'postgresql_data:/bitnami/postgresql'
|
|
||||||
redmine:
|
redmine:
|
||||||
image: docker.io/bitnami/redmine:4
|
image: docker.io/bitnami/redmine:4
|
||||||
ports:
|
ports:
|
||||||
- '80:3000'
|
- '80:3000'
|
||||||
environment:
|
|
||||||
- REDMINE_DB_POSTGRES=postgresql
|
|
||||||
- REDMINE_DB_USERNAME=bn_redmine
|
|
||||||
- REDMINE_DB_NAME=bitnami_redmine
|
|
||||||
volumes:
|
volumes:
|
||||||
- 'redmine_data:/bitnami'
|
- 'redmine_data:/bitnami/redmine'
|
||||||
depends_on:
|
depends_on:
|
||||||
- postgresql
|
- postgresql
|
||||||
|
environment:
|
||||||
|
- ALLOW_EMPTY_PASSWORD=yes
|
||||||
|
- REDMINE_DATABASE_TYPE=postgresql
|
||||||
|
- REDMINE_DATABASE_HOST=postgresql
|
||||||
|
- REDMINE_DATABASE_PORT_NUMBER=5432
|
||||||
|
- REDMINE_DATABASE_USER=bn_redmine
|
||||||
|
- REDMINE_DATABASE_NAME=bitnami_redmine
|
||||||
volumes:
|
volumes:
|
||||||
postgresql_data:
|
postgresql_data:
|
||||||
driver: local
|
driver: local
|
||||||
|
|||||||
@@ -1,24 +1,27 @@
|
|||||||
version: '2'
|
version: '2'
|
||||||
services:
|
services:
|
||||||
mariadb:
|
mariadb:
|
||||||
image: docker.io/bitnami/mariadb:10.3
|
image: docker.io/bitnami/mariadb:10.4
|
||||||
|
volumes:
|
||||||
|
- 'mariadb_data:/bitnami/mariadb'
|
||||||
environment:
|
environment:
|
||||||
- ALLOW_EMPTY_PASSWORD=yes
|
- ALLOW_EMPTY_PASSWORD=yes
|
||||||
- MARIADB_USER=bn_redmine
|
- MARIADB_USER=bn_redmine
|
||||||
- MARIADB_DATABASE=bitnami_redmine
|
- MARIADB_DATABASE=bitnami_redmine
|
||||||
volumes:
|
|
||||||
- 'mariadb_data:/bitnami'
|
|
||||||
redmine:
|
redmine:
|
||||||
image: docker.io/bitnami/redmine:4
|
image: docker.io/bitnami/redmine:4
|
||||||
environment:
|
|
||||||
- REDMINE_DB_USERNAME=bn_redmine
|
|
||||||
- REDMINE_DB_NAME=bitnami_redmine
|
|
||||||
ports:
|
ports:
|
||||||
- '80:3000'
|
- '80:3000'
|
||||||
volumes:
|
volumes:
|
||||||
- 'redmine_data:/bitnami'
|
- 'redmine_data:/bitnami/redmine'
|
||||||
depends_on:
|
depends_on:
|
||||||
- mariadb
|
- mariadb
|
||||||
|
environment:
|
||||||
|
- ALLOW_EMPTY_PASSWORD=yes
|
||||||
|
- REDMINE_DATABASE_HOST=mariadb
|
||||||
|
- REDMINE_DATABASE_PORT_NUMBER=3306
|
||||||
|
- REDMINE_DATABASE_USER=bn_redmine
|
||||||
|
- REDMINE_DATABASE_NAME=bitnami_redmine
|
||||||
volumes:
|
volumes:
|
||||||
mariadb_data:
|
mariadb_data:
|
||||||
driver: local
|
driver: local
|
||||||
|
|||||||
Reference in New Issue
Block a user