From c8acedfdd40728c26977da97411b5a724aeeea36 Mon Sep 17 00:00:00 2001 From: Bitnami Bot Date: Tue, 25 Aug 2026 19:01:08 +0200 Subject: [PATCH] [bitnami/mastodon] Release 4.7.0-debian-12-r0 (#96888) Signed-off-by: Bitnami Bot --- bitnami/mastodon/4.7/debian-12/Dockerfile | 65 ++ .../mastodon/4.7/debian-12/docker-compose.yml | 74 ++ ....7.0-0-linux-amd64-debian-12.tar.gz.sha256 | 1 + ....7.0-0-linux-arm64-debian-12.tar.gz.sha256 | 1 + ...23.2-0-linux-amd64-debian-12.tar.gz.sha256 | 1 + ...23.2-0-linux-arm64-debian-12.tar.gz.sha256 | 1 + ....6.0-0-linux-amd64-debian-12.tar.gz.sha256 | 1 + ....6.0-0-linux-arm64-debian-12.tar.gz.sha256 | 1 + ...14.7-5-linux-amd64-debian-12.tar.gz.sha256 | 1 + ...14.7-5-linux-arm64-debian-12.tar.gz.sha256 | 1 + ...10.1-0-linux-amd64-debian-12.tar.gz.sha256 | 1 + ...10.1-0-linux-arm64-debian-12.tar.gz.sha256 | 1 + ...4.10-4-linux-amd64-debian-12.tar.gz.sha256 | 1 + ...4.10-4-linux-arm64-debian-12.tar.gz.sha256 | 1 + ...0.11-2-linux-amd64-debian-12.tar.gz.sha256 | 1 + ...0.11-2-linux-arm64-debian-12.tar.gz.sha256 | 1 + .../opt/bitnami/licenses/licenses.txt | 2 + .../opt/bitnami/scripts/libbitnami.sh | 51 ++ .../prebuildfs/opt/bitnami/scripts/libfile.sh | 178 +++++ .../prebuildfs/opt/bitnami/scripts/libfs.sh | 205 ++++++ .../prebuildfs/opt/bitnami/scripts/libhook.sh | 18 + .../prebuildfs/opt/bitnami/scripts/liblog.sh | 146 ++++ .../prebuildfs/opt/bitnami/scripts/libnet.sh | 171 +++++ .../prebuildfs/opt/bitnami/scripts/libos.sh | 657 ++++++++++++++++++ .../opt/bitnami/scripts/libpersistence.sh | 124 ++++ .../opt/bitnami/scripts/libservice.sh | 446 ++++++++++++ .../opt/bitnami/scripts/libvalidations.sh | 294 ++++++++ .../opt/bitnami/scripts/libversion.sh | 84 +++ .../opt/bitnami/scripts/libwebserver.sh | 396 +++++++++++ .../prebuildfs/usr/sbin/install_packages | 27 + .../debian-12/prebuildfs/usr/sbin/run-script | 24 + .../prebuildfs/usr/sbin/uninstall_packages | 26 + .../rootfs/opt/bitnami/scripts/libmastodon.sh | 525 ++++++++++++++ .../bitnami/scripts/libpostgresqlclient.sh | 424 +++++++++++ .../opt/bitnami/scripts/mastodon-env.sh | 293 ++++++++ .../bitnami/scripts/mastodon/entrypoint.sh | 28 + .../bitnami/scripts/mastodon/postunpack.sh | 46 ++ .../opt/bitnami/scripts/mastodon/run.sh | 53 ++ .../opt/bitnami/scripts/mastodon/setup.sh | 24 + .../bitnami/scripts/postgresql-client-env.sh | 88 +++ .../scripts/postgresql-client/setup.sh | 21 + bitnami/mastodon/docker-compose.yml | 6 +- 42 files changed, 4507 insertions(+), 3 deletions(-) create mode 100644 bitnami/mastodon/4.7/debian-12/Dockerfile create mode 100644 bitnami/mastodon/4.7/debian-12/docker-compose.yml create mode 100644 bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/checksums/mastodon-4.7.0-0-linux-amd64-debian-12.tar.gz.sha256 create mode 100644 bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/checksums/mastodon-4.7.0-0-linux-arm64-debian-12.tar.gz.sha256 create mode 100644 bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/checksums/node-22.23.2-0-linux-amd64-debian-12.tar.gz.sha256 create mode 100644 bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/checksums/node-22.23.2-0-linux-arm64-debian-12.tar.gz.sha256 create mode 100644 bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/checksums/postgresql-client-18.6.0-0-linux-amd64-debian-12.tar.gz.sha256 create mode 100644 bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/checksums/postgresql-client-18.6.0-0-linux-arm64-debian-12.tar.gz.sha256 create mode 100644 bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/checksums/python-3.14.7-5-linux-amd64-debian-12.tar.gz.sha256 create mode 100644 bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/checksums/python-3.14.7-5-linux-arm64-debian-12.tar.gz.sha256 create mode 100644 bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/checksums/redis-client-8.10.1-0-linux-amd64-debian-12.tar.gz.sha256 create mode 100644 bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/checksums/redis-client-8.10.1-0-linux-arm64-debian-12.tar.gz.sha256 create mode 100644 bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/checksums/ruby-3.4.10-4-linux-amd64-debian-12.tar.gz.sha256 create mode 100644 bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/checksums/ruby-3.4.10-4-linux-arm64-debian-12.tar.gz.sha256 create mode 100644 bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/checksums/wait-for-port-1.0.11-2-linux-amd64-debian-12.tar.gz.sha256 create mode 100644 bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/checksums/wait-for-port-1.0.11-2-linux-arm64-debian-12.tar.gz.sha256 create mode 100644 bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/licenses/licenses.txt create mode 100644 bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/scripts/libbitnami.sh create mode 100644 bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/scripts/libfile.sh create mode 100644 bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/scripts/libfs.sh create mode 100644 bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/scripts/libhook.sh create mode 100644 bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/scripts/liblog.sh create mode 100644 bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/scripts/libnet.sh create mode 100644 bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/scripts/libos.sh create mode 100644 bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/scripts/libpersistence.sh create mode 100644 bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/scripts/libservice.sh create mode 100644 bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/scripts/libvalidations.sh create mode 100644 bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/scripts/libversion.sh create mode 100644 bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/scripts/libwebserver.sh create mode 100755 bitnami/mastodon/4.7/debian-12/prebuildfs/usr/sbin/install_packages create mode 100755 bitnami/mastodon/4.7/debian-12/prebuildfs/usr/sbin/run-script create mode 100755 bitnami/mastodon/4.7/debian-12/prebuildfs/usr/sbin/uninstall_packages create mode 100644 bitnami/mastodon/4.7/debian-12/rootfs/opt/bitnami/scripts/libmastodon.sh create mode 100644 bitnami/mastodon/4.7/debian-12/rootfs/opt/bitnami/scripts/libpostgresqlclient.sh create mode 100644 bitnami/mastodon/4.7/debian-12/rootfs/opt/bitnami/scripts/mastodon-env.sh create mode 100755 bitnami/mastodon/4.7/debian-12/rootfs/opt/bitnami/scripts/mastodon/entrypoint.sh create mode 100755 bitnami/mastodon/4.7/debian-12/rootfs/opt/bitnami/scripts/mastodon/postunpack.sh create mode 100755 bitnami/mastodon/4.7/debian-12/rootfs/opt/bitnami/scripts/mastodon/run.sh create mode 100755 bitnami/mastodon/4.7/debian-12/rootfs/opt/bitnami/scripts/mastodon/setup.sh create mode 100644 bitnami/mastodon/4.7/debian-12/rootfs/opt/bitnami/scripts/postgresql-client-env.sh create mode 100755 bitnami/mastodon/4.7/debian-12/rootfs/opt/bitnami/scripts/postgresql-client/setup.sh diff --git a/bitnami/mastodon/4.7/debian-12/Dockerfile b/bitnami/mastodon/4.7/debian-12/Dockerfile new file mode 100644 index 000000000000..d07d3e52b155 --- /dev/null +++ b/bitnami/mastodon/4.7/debian-12/Dockerfile @@ -0,0 +1,65 @@ +# Copyright Broadcom, Inc. All Rights Reserved. +# SPDX-License-Identifier: APACHE-2.0 + +FROM docker.io/bitnami/minideb:bookworm + +ARG DOWNLOADS_URL="https://downloads.bitnami.com/files/stacksmith" +ARG TARGETARCH + +LABEL org.opencontainers.image.base.name="docker.io/bitnami/minideb:bookworm" \ + org.opencontainers.image.created="2026-08-25T16:12:55Z" \ + org.opencontainers.image.description="Application packaged by Broadcom, Inc." \ + org.opencontainers.image.documentation="https://github.com/bitnami/containers/tree/main/bitnami/mastodon/README.md" \ + org.opencontainers.image.source="https://github.com/bitnami/containers/tree/main/bitnami/mastodon" \ + org.opencontainers.image.title="mastodon" \ + org.opencontainers.image.vendor="Broadcom, Inc." \ + org.opencontainers.image.version="4.7.0" + +ENV HOME="/" \ + OS_ARCH="${TARGETARCH:-amd64}" \ + OS_FLAVOUR="debian-12" \ + OS_NAME="linux" + +COPY prebuildfs / +SHELL ["/bin/bash", "-o", "errexit", "-o", "nounset", "-o", "pipefail", "-c"] +# Install required system packages and dependencies +RUN install_packages acl ca-certificates curl ffmpeg file imagemagick libblkid1 libbrotli1 libbsd0 libbz2-1.0 libcairo-gobject2 libcairo2 libcom-err2 libcrypt1 libcurl4 libdatrie1 libdeflate0 libedit2 libexif-dev libexif12 libexpat1 libffi8 libfftw3-double3 libfontconfig1 libfreetype6 libfribidi0 libgcc-s1 libgdk-pixbuf-2.0-0 libglib2.0-0 libgmp10 libgnutls30 libgomp1 libgraphite2-3 libgssapi-krb5-2 libharfbuzz0b libhogweed6 libicu72 libidn12 libidn2-0 libimath-3-1-29 libjbig0 libjemalloc2 libjpeg62-turbo libk5crypto3 libkeyutils1 libkrb5-3 libkrb5support0 liblcms2-2 libldap-2.5-0 liblerc4 liblqr-1-0 libltdl7 liblz4-1 liblzma5 libmagickcore-6.q16-6 libmd0 libmount1 libncursesw6 libnettle8 libnghttp2-14 libopenexr-3-1-30 libopenexr-dev libopenjp2-7 libp11-kit0 libpango-1.0-0 libpangocairo-1.0-0 libpangoft2-1.0-0 libpcre2-8-0 libpixman-1-0 libpng16-16 libpsl5 libreadline-dev libreadline8 librsvg2-2 librtmp1 libsasl2-2 libselinux1 libsqlite3-0 libssh2-1 libssl-dev libssl3 libstdc++6 libtasn1-6 libthai0 libtiff6 libtinfo6 libunistring2 libuuid1 libwebp7 libwebpdemux2 libwebpmux3 libx11-6 libxau6 libxcb-render0 libxcb-shm0 libxcb1 libxdmcp6 libxext6 libxml2 libxrender1 libxslt1.1 libyaml-0-2 libyaml-dev libzstd1 procps zlib1g +RUN --mount=type=secret,id=downloads_url,env=SECRET_DOWNLOADS_URL \ + DOWNLOADS_URL=${SECRET_DOWNLOADS_URL:-${DOWNLOADS_URL}} ; \ + mkdir -p /tmp/bitnami/pkg/cache/ ; cd /tmp/bitnami/pkg/cache/ || exit 1 ; \ + COMPONENTS=( \ + "node-22.23.2-0-linux-${OS_ARCH}-debian-12" \ + "python-3.14.7-5-linux-${OS_ARCH}-debian-12" \ + "postgresql-client-18.6.0-0-linux-${OS_ARCH}-debian-12" \ + "wait-for-port-1.0.11-2-linux-${OS_ARCH}-debian-12" \ + "redis-client-8.10.1-0-linux-${OS_ARCH}-debian-12" \ + "ruby-3.4.10-4-linux-${OS_ARCH}-debian-12" \ + "mastodon-4.7.0-0-linux-${OS_ARCH}-debian-12" \ + ) ; \ + for COMPONENT in "${COMPONENTS[@]}"; do \ + if [ ! -f "${COMPONENT}.tar.gz" ]; then \ + curl -SsLf "${DOWNLOADS_URL}/${COMPONENT}.tar.gz" -O ; \ + fi ; \ + sha256sum -c "/opt/bitnami/checksums/${COMPONENT}.tar.gz.sha256" ; \ + tar -zxf "${COMPONENT}.tar.gz" -C /opt/bitnami --strip-components=2 --no-same-owner ; \ + rm -rf "${COMPONENT}".tar.gz ; \ + done ; \ + rm -rf /opt/bitnami/checksums ; +RUN apt-get update && apt-get upgrade -y && \ + apt-get clean && rm -rf /var/lib/apt/lists /var/cache/apt/archives +RUN chmod g+rwX /opt/bitnami +RUN find / -perm /6000 -type f -exec chmod a-s {} \; || true + +COPY rootfs / +RUN /opt/bitnami/scripts/mastodon/postunpack.sh +ENV APP_VERSION="4.7.0" \ + BITNAMI_APP_NAME="mastodon" \ + IMAGE_REVISION="0" \ + LD_LIBRARY_PATH="/opt/bitnami/common/lib:/opt/bitnami/postgresql/lib" \ + PATH="/opt/bitnami/common/bin:/opt/bitnami/node/bin:/opt/bitnami/python/bin:/opt/bitnami/postgresql/bin:/opt/bitnami/redis/bin:/opt/bitnami/ruby/bin:/opt/bitnami/mastodon/bin:$PATH" + +EXPOSE 3000 4000 + +USER 1001 +ENTRYPOINT [ "/opt/bitnami/scripts/mastodon/entrypoint.sh" ] +CMD [ "/opt/bitnami/scripts/mastodon/run.sh" ] diff --git a/bitnami/mastodon/4.7/debian-12/docker-compose.yml b/bitnami/mastodon/4.7/debian-12/docker-compose.yml new file mode 100644 index 000000000000..49f57c68a3f0 --- /dev/null +++ b/bitnami/mastodon/4.7/debian-12/docker-compose.yml @@ -0,0 +1,74 @@ +# Copyright Broadcom, Inc. All Rights Reserved. +# SPDX-License-Identifier: APACHE-2.0 + +services: + postgresql: + image: docker.io/bitnami/postgresql:latest + volumes: + - 'postgresql_data:/bitnami/postgresql' + environment: + - POSTGRESQL_DATABASE=bitnami_mastodon + - POSTGRESQL_USERNAME=bn_mastodon + - POSTGRESQL_PASSWORD=bitnami1 + redis: + image: docker.io/bitnami/redis:latest + volumes: + - 'redis_data:/bitnami/redis' + environment: + - ALLOW_EMPTY_PASSWORD=yes + elasticsearch: + image: docker.io/bitnami/elasticsearch:latest + volumes: + - 'elasticsearch_data:/bitnami/elasticsearch/data' + environment: + - ELASTICSEARCH_ENABLE_SECURITY=true + - ELASTICSEARCH_SKIP_TRANSPORT_TLS=true + - ELASTICSEARCH_ENABLE_REST_TLS=false + - ELASTICSEARCH_PASSWORD=bitnami123 + mastodon: + image: docker.io/bitnami/mastodon:4.7 + ports: + - 80:3000 + volumes: + - 'mastodon_data:/bitnami/mastodon' + environment: + - ALLOW_EMPTY_PASSWORD=yes + - MASTODON_ADMIN_PASSWORD=bitnami1 + - MASTODON_SECRET_KEY_BASE=secretKeyBase1 + - MASTODON_OTP_SECRET=otpSecret1 + - MASTODON_MODE=web + - MASTODON_DATABASE_PASSWORD=bitnami1 + - MASTODON_ELASTICSEARCH_PASSWORD=bitnami123 + mastodon-streaming: + image: docker.io/bitnami/mastodon:4.7 + ports: + - 4000:4000 + environment: + - ALLOW_EMPTY_PASSWORD=yes + - MASTODON_MODE=streaming + - MASTODON_SECRET_KEY_BASE=secretKeyBase1 + - MASTODON_OTP_SECRET=otpSecret1 + - MASTODON_DATABASE_PASSWORD=bitnami1 + - MASTODON_ELASTICSEARCH_PASSWORD=bitnami123 + mastodon-sidekiq: + image: docker.io/bitnami/mastodon:4.7 + volumes: + - 'mastodon_data:/bitnami/mastodon' + environment: + - ALLOW_EMPTY_PASSWORD=yes + - MASTODON_MODE=sidekiq + - MASTODON_SECRET_KEY_BASE=secretKeyBase1 + - MASTODON_OTP_SECRET=otpSecret1 + - MASTODON_DATABASE_PASSWORD=bitnami1 + - MASTODON_ELASTICSEARCH_PASSWORD=bitnami123 +volumes: + postgresql_data: + driver: local + minio_data: + driver: local + redis_data: + driver: local + elasticsearch_data: + driver: local + mastodon_data: + driver: local diff --git a/bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/checksums/mastodon-4.7.0-0-linux-amd64-debian-12.tar.gz.sha256 b/bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/checksums/mastodon-4.7.0-0-linux-amd64-debian-12.tar.gz.sha256 new file mode 100644 index 000000000000..8d3a53a9e11a --- /dev/null +++ b/bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/checksums/mastodon-4.7.0-0-linux-amd64-debian-12.tar.gz.sha256 @@ -0,0 +1 @@ +47abcd2770bda59c1cff351bcbaed6e15603df81a5639703f83248385e5ad3aa mastodon-4.7.0-0-linux-amd64-debian-12.tar.gz diff --git a/bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/checksums/mastodon-4.7.0-0-linux-arm64-debian-12.tar.gz.sha256 b/bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/checksums/mastodon-4.7.0-0-linux-arm64-debian-12.tar.gz.sha256 new file mode 100644 index 000000000000..f6ebcd8276f0 --- /dev/null +++ b/bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/checksums/mastodon-4.7.0-0-linux-arm64-debian-12.tar.gz.sha256 @@ -0,0 +1 @@ +d875b55db391cde9e6da75e14112016855712523f92342b7321af4796c67a6e1 mastodon-4.7.0-0-linux-arm64-debian-12.tar.gz diff --git a/bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/checksums/node-22.23.2-0-linux-amd64-debian-12.tar.gz.sha256 b/bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/checksums/node-22.23.2-0-linux-amd64-debian-12.tar.gz.sha256 new file mode 100644 index 000000000000..68e21a023c62 --- /dev/null +++ b/bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/checksums/node-22.23.2-0-linux-amd64-debian-12.tar.gz.sha256 @@ -0,0 +1 @@ +c25bbbd186aa5c86f46aa744c39018d94762ee4e82fac587ea2e6f7496016029 node-22.23.2-0-linux-amd64-debian-12.tar.gz diff --git a/bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/checksums/node-22.23.2-0-linux-arm64-debian-12.tar.gz.sha256 b/bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/checksums/node-22.23.2-0-linux-arm64-debian-12.tar.gz.sha256 new file mode 100644 index 000000000000..7afebc5bc178 --- /dev/null +++ b/bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/checksums/node-22.23.2-0-linux-arm64-debian-12.tar.gz.sha256 @@ -0,0 +1 @@ +003d8f539013d5d89dcc4e05e4a9192aa7d6426e1118c0653386a6679cd5323c node-22.23.2-0-linux-arm64-debian-12.tar.gz diff --git a/bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/checksums/postgresql-client-18.6.0-0-linux-amd64-debian-12.tar.gz.sha256 b/bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/checksums/postgresql-client-18.6.0-0-linux-amd64-debian-12.tar.gz.sha256 new file mode 100644 index 000000000000..ea99f43733ba --- /dev/null +++ b/bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/checksums/postgresql-client-18.6.0-0-linux-amd64-debian-12.tar.gz.sha256 @@ -0,0 +1 @@ +7404c38646f02884863d151b5713460a4ab00a1e61444df597eec36b09efce71 postgresql-client-18.6.0-0-linux-amd64-debian-12.tar.gz diff --git a/bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/checksums/postgresql-client-18.6.0-0-linux-arm64-debian-12.tar.gz.sha256 b/bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/checksums/postgresql-client-18.6.0-0-linux-arm64-debian-12.tar.gz.sha256 new file mode 100644 index 000000000000..b41aa502fe69 --- /dev/null +++ b/bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/checksums/postgresql-client-18.6.0-0-linux-arm64-debian-12.tar.gz.sha256 @@ -0,0 +1 @@ +86991478ba1a21cb6c5fadc65f07598c3364aab7a229a1742a6f55b9eacaf0ac postgresql-client-18.6.0-0-linux-arm64-debian-12.tar.gz diff --git a/bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/checksums/python-3.14.7-5-linux-amd64-debian-12.tar.gz.sha256 b/bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/checksums/python-3.14.7-5-linux-amd64-debian-12.tar.gz.sha256 new file mode 100644 index 000000000000..98efccaadb89 --- /dev/null +++ b/bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/checksums/python-3.14.7-5-linux-amd64-debian-12.tar.gz.sha256 @@ -0,0 +1 @@ +71aae4126d5f82a8163b7d16452d5f6be31e48b27725882e57bb5b0c05b16d0a python-3.14.7-5-linux-amd64-debian-12.tar.gz diff --git a/bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/checksums/python-3.14.7-5-linux-arm64-debian-12.tar.gz.sha256 b/bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/checksums/python-3.14.7-5-linux-arm64-debian-12.tar.gz.sha256 new file mode 100644 index 000000000000..6534ea81b783 --- /dev/null +++ b/bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/checksums/python-3.14.7-5-linux-arm64-debian-12.tar.gz.sha256 @@ -0,0 +1 @@ +a8dfe832769573b80bb22b8084eaa9d1b2722af875e7e8768f1f312c88d47bc1 python-3.14.7-5-linux-arm64-debian-12.tar.gz diff --git a/bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/checksums/redis-client-8.10.1-0-linux-amd64-debian-12.tar.gz.sha256 b/bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/checksums/redis-client-8.10.1-0-linux-amd64-debian-12.tar.gz.sha256 new file mode 100644 index 000000000000..f5dbc7018e87 --- /dev/null +++ b/bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/checksums/redis-client-8.10.1-0-linux-amd64-debian-12.tar.gz.sha256 @@ -0,0 +1 @@ +74fa976273443eb7173e5fe7179c4296a7924b0da0d6ad11a84672da734d85d7 redis-client-8.10.1-0-linux-amd64-debian-12.tar.gz diff --git a/bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/checksums/redis-client-8.10.1-0-linux-arm64-debian-12.tar.gz.sha256 b/bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/checksums/redis-client-8.10.1-0-linux-arm64-debian-12.tar.gz.sha256 new file mode 100644 index 000000000000..09042ef42691 --- /dev/null +++ b/bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/checksums/redis-client-8.10.1-0-linux-arm64-debian-12.tar.gz.sha256 @@ -0,0 +1 @@ +1007b3575dc04dc9fc6db4563a40cd58a5e321c25ddd9c4ac5d041d1c93afedb redis-client-8.10.1-0-linux-arm64-debian-12.tar.gz diff --git a/bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/checksums/ruby-3.4.10-4-linux-amd64-debian-12.tar.gz.sha256 b/bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/checksums/ruby-3.4.10-4-linux-amd64-debian-12.tar.gz.sha256 new file mode 100644 index 000000000000..7ccee3eeab80 --- /dev/null +++ b/bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/checksums/ruby-3.4.10-4-linux-amd64-debian-12.tar.gz.sha256 @@ -0,0 +1 @@ +983d77e02d78f8cfe2ba16a15558765c2382a9c168b47594c7cd91c138f0e4c2 ruby-3.4.10-4-linux-amd64-debian-12.tar.gz diff --git a/bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/checksums/ruby-3.4.10-4-linux-arm64-debian-12.tar.gz.sha256 b/bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/checksums/ruby-3.4.10-4-linux-arm64-debian-12.tar.gz.sha256 new file mode 100644 index 000000000000..e8faf5519e55 --- /dev/null +++ b/bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/checksums/ruby-3.4.10-4-linux-arm64-debian-12.tar.gz.sha256 @@ -0,0 +1 @@ +99ff26a57254e372a860d3044cd792ab8352cb64eba6a0103bbcea34fb7c5df1 ruby-3.4.10-4-linux-arm64-debian-12.tar.gz diff --git a/bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/checksums/wait-for-port-1.0.11-2-linux-amd64-debian-12.tar.gz.sha256 b/bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/checksums/wait-for-port-1.0.11-2-linux-amd64-debian-12.tar.gz.sha256 new file mode 100644 index 000000000000..35149c0caf10 --- /dev/null +++ b/bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/checksums/wait-for-port-1.0.11-2-linux-amd64-debian-12.tar.gz.sha256 @@ -0,0 +1 @@ +a268ecd1f6029b9e654e81b7971ab1d17db90086617d840b47052d11287a273f wait-for-port-1.0.11-2-linux-amd64-debian-12.tar.gz diff --git a/bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/checksums/wait-for-port-1.0.11-2-linux-arm64-debian-12.tar.gz.sha256 b/bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/checksums/wait-for-port-1.0.11-2-linux-arm64-debian-12.tar.gz.sha256 new file mode 100644 index 000000000000..67a9aa1ab4de --- /dev/null +++ b/bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/checksums/wait-for-port-1.0.11-2-linux-arm64-debian-12.tar.gz.sha256 @@ -0,0 +1 @@ +391faf5f689deed1ad2dd5e4d34a4361a126688eef0edf75a0ff6d15362b16f9 wait-for-port-1.0.11-2-linux-arm64-debian-12.tar.gz diff --git a/bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/licenses/licenses.txt b/bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/licenses/licenses.txt new file mode 100644 index 000000000000..76956b38e82c --- /dev/null +++ b/bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/licenses/licenses.txt @@ -0,0 +1,2 @@ +Bitnami containers ship with software bundles. You can find the licenses under: +/opt/bitnami/[name-of-bundle]/licenses/[bundle-version].txt diff --git a/bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/scripts/libbitnami.sh b/bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/scripts/libbitnami.sh new file mode 100644 index 000000000000..b134a91c7e24 --- /dev/null +++ b/bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/scripts/libbitnami.sh @@ -0,0 +1,51 @@ +#!/bin/bash +# Copyright Broadcom, Inc. All Rights Reserved. +# SPDX-License-Identifier: APACHE-2.0 +# +# 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/containers" + + info "" + info "${BOLD}Welcome to the Bitnami ${BITNAMI_APP_NAME} container${RESET}" + info "" +} + diff --git a/bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/scripts/libfile.sh b/bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/scripts/libfile.sh new file mode 100644 index 000000000000..335c1c7c9ef7 --- /dev/null +++ b/bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/scripts/libfile.sh @@ -0,0 +1,178 @@ +#!/bin/bash +# Copyright Broadcom, Inc. All Rights Reserved. +# SPDX-License-Identifier: APACHE-2.0 +# +# Library for managing files + +# shellcheck disable=SC1091 + +# Load Generic Libraries +. /opt/bitnami/scripts/libos.sh + +# Functions + +######################## +# Replace a regex-matching string in a file +# Arguments: +# $1 - filename +# $2 - match regex +# $3 - substitute regex +# $4 - use POSIX regex. Default: true +# Returns: +# None +######################### +replace_in_file() { + local filename="${1:?filename is required}" + local match_regex="${2:?match regex is required}" + local substitute_regex="${3:?substitute regex is required}" + local posix_regex=${4:-true} + + local result + + # We should avoid using 'sed in-place' substitutions + # 1) They are not compatible with files mounted from ConfigMap(s) + # 2) We found incompatibility issues with Debian10 and "in-place" substitutions + local -r del=$'\001' # Use a non-printable character as a 'sed' delimiter to avoid issues + if [[ $posix_regex = true ]]; then + result="$(sed -E "s${del}${match_regex}${del}${substitute_regex}${del}g" "$filename")" + else + result="$(sed "s${del}${match_regex}${del}${substitute_regex}${del}g" "$filename")" + fi + echo "$result" > "$filename" +} + +######################## +# Replace a regex-matching multiline string in a file +# Arguments: +# $1 - filename +# $2 - match regex +# $3 - substitute regex +# Returns: +# None +######################### +replace_in_file_multiline() { + local filename="${1:?filename is required}" + local match_regex="${2:?match regex is required}" + local substitute_regex="${3:?substitute regex is required}" + + local result + local -r del=$'\001' # Use a non-printable character as a 'sed' delimiter to avoid issues + result="$(perl -pe "BEGIN{undef $/;} s${del}${match_regex}${del}${substitute_regex}${del}sg" "$filename")" + echo "$result" > "$filename" +} + +######################## +# Remove a line in a file based on a regex +# Arguments: +# $1 - filename +# $2 - match regex +# $3 - use POSIX regex. Default: true +# Returns: +# None +######################### +remove_in_file() { + local filename="${1:?filename is required}" + local match_regex="${2:?match regex is required}" + local posix_regex=${3:-true} + local result + + # We should avoid using 'sed in-place' substitutions + # 1) They are not compatible with files mounted from ConfigMap(s) + # 2) We found incompatibility issues with Debian10 and "in-place" substitutions + if [[ $posix_regex = true ]]; then + result="$(sed -E "/$match_regex/d" "$filename")" + else + result="$(sed "/$match_regex/d" "$filename")" + fi + echo "$result" > "$filename" +} + +######################## +# Appends text after the last line matching a pattern +# Arguments: +# $1 - file +# $2 - match regex +# $3 - contents to add +# Returns: +# None +######################### +append_file_after_last_match() { + local file="${1:?missing file}" + local match_regex="${2:?missing pattern}" + local value="${3:?missing value}" + + # We read the file in reverse, replace the first match (0,/pattern/s) and then reverse the results again + result="$(tac "$file" | sed -E "0,/($match_regex)/s||${value}\n\1|" | tac)" + echo "$result" > "$file" +} + +######################## +# Wait until certain entry is present in a log file +# Arguments: +# $1 - entry to look for +# $2 - log file +# $3 - max retries. Default: 12 +# $4 - sleep between retries (in seconds). Default: 5 +# Returns: +# Boolean +######################### +wait_for_log_entry() { + local -r entry="${1:-missing entry}" + local -r log_file="${2:-missing log file}" + local -r retries="${3:-12}" + local -r interval_time="${4:-5}" + local attempt=0 + + check_log_file_for_entry() { + if ! grep -qE "$entry" "$log_file"; then + debug "Entry \"${entry}\" still not present in ${log_file} (attempt $((++attempt))/${retries})" + return 1 + fi + } + debug "Checking that ${log_file} log file contains entry \"${entry}\"" + if retry_while check_log_file_for_entry "$retries" "$interval_time"; then + debug "Found entry \"${entry}\" in ${log_file}" + true + else + error "Could not find entry \"${entry}\" in ${log_file} after ${retries} retries" + debug_execute cat "$log_file" + return 1 + fi +} + +######################## +# Creates a secure temporary file containing the provided secret +# Arguments: +# $1 - secret to write to the temporary file +# Returns: +# String +######################### +credential_to_temp_file() { + local secret="$1" + local tmp_file + + # Use mktemp with a specific prefix for easier debugging if something lingers + if ! tmp_file=$(mktemp "${TMPDIR:-/tmp}/at.cred.XXXXXXXX"); then + echo "Error: Failed to create temp file" >&2 + return 1 + fi + + # Restrict permissions before writing the secret + chmod 0600 "$tmp_file" + # Write secret and ensure it's flushed to disk + printf "%s" "$secret" > "$tmp_file" + # Output the filename so the caller can capture it + echo "$tmp_file" +} + +######################## +# Cleans up temporary files created by credential_to_temp_file +# Arguments: +# None +# Returns: +# None +######################### +cleanup_credentials() { + debug "Cleaning up temporary files containing credentials" + rm -rf "${TMPDIR:-/tmp}"/at.cred.* +} diff --git a/bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/scripts/libfs.sh b/bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/scripts/libfs.sh new file mode 100644 index 000000000000..b16efabd3230 --- /dev/null +++ b/bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/scripts/libfs.sh @@ -0,0 +1,205 @@ +#!/bin/bash +# Copyright Broadcom, Inc. All Rights Reserved. +# SPDX-License-Identifier: APACHE-2.0 +# +# 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}" + local group="${3:-}" + + if [[ -n $group ]]; then + chown "$owner":"$group" "$path" + else + chown "$owner":"$owner" "$path" + fi +} + +######################## +# 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_user="${2:-}" + local owner_group="${3:-}" + + [ -d "${dir}" ] || mkdir -p "${dir}" + if [[ -n $owner_user ]]; then + owned_by "$dir" "$owner_user" "$owner_group" + fi +} + +######################## +# Checks whether a directory is empty or not +# arguments: +# $1 - directory +# returns: +# boolean +######################### +is_dir_empty() { + local -r path="${1:?missing directory}" + # Calculate real path in order to avoid issues with symlinks + local -r dir="$(realpath "$path")" + 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 permissions 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 +# -n|--no-dereference - do not follow symlinks (use for runtime root chown of daemon-writable dirs) +# Returns: +# None +######################### +configure_permissions_ownership() { + local -r paths="${1:?paths is missing}" + local dir_mode="" + local file_mode="" + local user="" + local group="" + local follow_symlinks="yes" + + # 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}" + ;; + -n | --no-dereference) + follow_symlinks="no" + ;; + *) + echo "Invalid command line flag $1" >&2 + return 1 + ;; + esac + shift + done + + # -L: follow symlinks and emits the target path + # This is dangerous at runtime, given a co-located lower-privileged process with write access + # to the target path can redirect the chown/chmod to arbitrary paths. Example: + # Lower-privileged process run: ln -s /etc /tmp/etc + # Then, setup.sh runs: configure_permissions_ownership --dir-mode 775 /tmp + local find_L_flag=(); [[ "$follow_symlinks" == "yes" ]] && find_L_flag=("-L") + # -h: changes symlink inode ownership without touching the target. + local chown_flags=(); [[ "$follow_symlinks" == "no" ]] && chown_flags=("-h") + read -r -a filepaths <<<"$paths" + for p in "${filepaths[@]}"; do + if [[ -e "$p" ]]; then + if [[ -n $dir_mode ]]; then + find "${find_L_flag[@]}" "$p" -not -type l -type d ! -perm "$dir_mode" -print0 | xargs -r -0 chmod "$dir_mode" + fi + if [[ -n $file_mode ]]; then + find "${find_L_flag[@]}" "$p" -not -type l -type f ! -perm "$file_mode" -print0 | xargs -r -0 chmod "$file_mode" + fi + if [[ -n $user ]] && [[ -n $group ]]; then + find "${find_L_flag[@]}" "$p" -print0 | xargs -r -0 chown "${chown_flags[@]}" "${user}:${group}" + elif [[ -n $user ]] && [[ -z $group ]]; then + find "${find_L_flag[@]}" "$p" -print0 | xargs -r -0 chown "${chown_flags[@]}" "${user}" + elif [[ -z $user ]] && [[ -n $group ]]; then + find "${find_L_flag[@]}" "$p" -print0 | xargs -r -0 chgrp "${chown_flags[@]}" "${group}" + fi + else + stderr_print "$p does not exist" + fi + done +} diff --git a/bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/scripts/libhook.sh b/bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/scripts/libhook.sh new file mode 100644 index 000000000000..f3a5fe7868ee --- /dev/null +++ b/bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/scripts/libhook.sh @@ -0,0 +1,18 @@ +#!/bin/bash +# Copyright Broadcom, Inc. All Rights Reserved. +# SPDX-License-Identifier: APACHE-2.0 +# +# 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 diff --git a/bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/scripts/liblog.sh b/bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/scripts/liblog.sh new file mode 100644 index 000000000000..f873cf875a99 --- /dev/null +++ b/bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/scripts/liblog.sh @@ -0,0 +1,146 @@ +#!/bin/bash +# Copyright Broadcom, Inc. All Rights Reserved. +# SPDX-License-Identifier: APACHE-2.0 +# +# 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}" + # converts the string to lowercase + local bool_val="${bool,,}" + if ! [[ "$bool_val" = 1 || "$bool_val" =~ ^(yes|true)$ ]]; then + printf "%b\\n" "${*}" >&2 + fi +} + +######################## +# Log message +# Arguments: +# Message to log +# Returns: +# None +######################### +log() { + local color_bool="${BITNAMI_COLOR:-true}" + # converts the string to lowercase + local color_bool_val="${color_bool,,}" + if [[ "$color_bool_val" = 1 || "$color_bool_val" =~ ^(yes|true)$ ]]; then + stderr_print "${CYAN}${MODULE:-} ${MAGENTA}$(date "+%T.%2N ")${RESET}${*}" + else + stderr_print "${MODULE:-} $(date "+%T.%2N ")${*}" + fi +} +######################## +# Log an 'info' message +# Arguments: +# Message to log +# Returns: +# None +######################### +info() { + local msg_color="" + local color_bool="${BITNAMI_COLOR:-true}" + # converts the string to lowercase + local color_bool_val="${color_bool,,}" + if [[ "$color_bool_val" = 1 || "$color_bool_val" =~ ^(yes|true)$ ]]; then + msg_color="$GREEN" + fi + log "${msg_color}INFO ${RESET} ==> ${*}" +} +######################## +# Log message +# Arguments: +# Message to log +# Returns: +# None +######################### +warn() { + local msg_color="" + local color_bool="${BITNAMI_COLOR:-true}" + # converts the string to lowercase + local color_bool_val="${color_bool,,}" + if [[ "$color_bool_val" = 1 || "$color_bool_val" =~ ^(yes|true)$ ]]; then + msg_color="$YELLOW" + fi + log "${msg_color}WARN ${RESET} ==> ${*}" +} +######################## +# Log an 'error' message +# Arguments: +# Message to log +# Returns: +# None +######################### +error() { + local msg_color="" + local color_bool="${BITNAMI_COLOR:-true}" + # converts the string to lowercase + local color_bool_val="${color_bool,,}" + if [[ "$color_bool_val" = 1 || "$color_bool_val" =~ ^(yes|true)$ ]]; then + msg_color="$RED" + fi + log "${msg_color}ERROR${RESET} ==> ${*}" +} +######################## +# Log a 'debug' message +# Globals: +# BITNAMI_DEBUG +# Arguments: +# None +# Returns: +# None +######################### +debug() { + local msg_color="" + local color_bool="${BITNAMI_COLOR:-true}" + # converts the string to lowercase + local color_bool_val="${color_bool,,}" + if [[ "$color_bool_val" = 1 || "$color_bool_val" =~ ^(yes|true)$ ]]; then + msg_color="$MAGENTA" + fi + local debug_bool="${BITNAMI_DEBUG:-false}" + if [[ "$debug_bool" = 1 || "$debug_bool" =~ ^(yes|true)$ ]]; then + log "${msg_color}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}/" +} diff --git a/bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/scripts/libnet.sh b/bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/scripts/libnet.sh new file mode 100644 index 000000000000..a1592f3bfde8 --- /dev/null +++ b/bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/scripts/libnet.sh @@ -0,0 +1,171 @@ +#!/bin/bash +# Copyright Broadcom, Inc. All Rights Reserved. +# SPDX-License-Identifier: APACHE-2.0 +# +# Library for network functions + +# shellcheck disable=SC1091 + +# Load Generic Libraries +. /opt/bitnami/scripts/liblog.sh +. /opt/bitnami/scripts/libvalidations.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 + # Check if the first IP address is IPv6 to add brackets + if validate_ipv6 "${ip_addresses[0]}" ; then + echo "[${ip_addresses[0]}]" + else + echo "${ip_addresses[0]}" + fi +} + +######################## +# 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-9a-fA-F:.]+\])(:([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}]}" +} + +######################## +# Wait for a HTTP connection to succeed +# Globals: +# * +# Arguments: +# $1 - URL to wait for +# $2 - Maximum amount of retries (optional) +# $3 - Time between retries (optional) +# Returns: +# true if the HTTP connection succeeded, false otherwise +######################### +wait_for_http_connection() { + local url="${1:?missing url}" + local retries="${2:-}" + local sleep_time="${3:-}" + if ! retry_while "debug_execute curl --silent ${url}" "$retries" "$sleep_time"; then + error "Could not connect to ${url}" + return 1 + fi +} diff --git a/bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/scripts/libos.sh b/bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/scripts/libos.sh new file mode 100644 index 000000000000..2d3c3bdb5f4a --- /dev/null +++ b/bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/scripts/libos.sh @@ -0,0 +1,657 @@ +#!/bin/bash +# Copyright Broadcom, Inc. All Rights Reserved. +# SPDX-License-Identifier: APACHE-2.0 +# +# Library for operating system actions + +# shellcheck disable=SC1091 + +# Load Generic Libraries +. /opt/bitnami/scripts/liblog.sh +. /opt/bitnami/scripts/libfs.sh +. /opt/bitnami/scripts/libvalidations.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: +# -i|--gid - the ID for the new group +# -s|--system - Whether to create new user as system user (uid <= 999) +# Returns: +# None +######################### +ensure_group_exists() { + local group="${1:?group is missing}" + local gid="" + local is_system_user=false + + # Validate arguments + shift 1 + while [ "$#" -gt 0 ]; do + case "$1" in + -i | --gid) + shift + gid="${1:?missing gid}" + ;; + -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") + if [[ -n "$gid" ]]; then + if group_exists "$gid"; then + error "The GID $gid is already in use." >&2 + return 1 + fi + args+=("--gid" "$gid") + fi + $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: +# -i|--uid - the ID for the new user +# -g|--group - the group the new user should belong to +# -a|--append-groups - comma-separated list of supplemental groups to append to the new user +# -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 uid="" + local group="" + local append_groups="" + local home="" + local is_system_user=false + + # Validate arguments + shift 1 + while [ "$#" -gt 0 ]; do + case "$1" in + -i | --uid) + shift + uid="${1:?missing uid}" + ;; + -g | --group) + shift + group="${1:?missing group}" + ;; + -a | --append-groups) + shift + append_groups="${1:?missing append_groups}" + ;; + -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") + if [[ -n "$uid" ]]; then + if user_exists "$uid"; then + error "The UID $uid is already in use." + return 1 + fi + user_args+=("--uid" "$uid") + else + $is_system_user && user_args+=("--system") + fi + 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 "$append_groups" ]]; then + local -a groups + read -ra groups <<<"$(tr ',;' ' ' <<<"$append_groups")" + for group in "${groups[@]}"; do + ensure_group_exists "$group" + usermod -aG "$group" "$user" >/dev/null 2>&1 + done + 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" -n + 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 +} + +######################## +# Print OS metadata +# Arguments: +# $1 - Flag name +# Flags: +# --id - Distro ID +# --version - Distro version +# --branch - Distro branch +# --codename - Distro codename +# --name - Distro name +# --pretty-name - Distro pretty name +# Returns: +# String +######################### +get_os_metadata() { + local -r flag_name="${1:?missing flag}" + # Helper function + get_os_release_metadata() { + local -r env_name="${1:?missing environment variable name}" + ( + . /etc/os-release + echo "${!env_name}" + ) + } + case "$flag_name" in + --id) + get_os_release_metadata ID + ;; + --version) + get_os_release_metadata VERSION_ID + ;; + --branch) + get_os_release_metadata VERSION_ID | sed 's/\..*//' + ;; + --codename) + get_os_release_metadata VERSION_CODENAME + ;; + --name) + get_os_release_metadata NAME + ;; + --pretty-name) + get_os_release_metadata PRETTY_NAME + ;; + *) + error "Unknown flag ${flag_name}" + return 1 + ;; + esac +} + +######################## +# 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 is_boolean_yes "${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:]" + ;; + numeric) + filter="0-9" + ;; + alphanumeric) + filter="a-zA-Z0-9" + ;; + alphanumeric+special|special+alphanumeric) + # Limit variety of special characters, so there is a higher chance of containing more alphanumeric characters + # Special characters are harder to write, and it could impact the overall UX if most passwords are too complex + filter='a-zA-Z0-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}' +} + +######################## +# Converts a string to its hexadecimal representation +# Arguments: +# $1 - string +# Returns: +# hexadecimal representation of the string +######################### +convert_to_hex() { + local -r str=${1:?missing input string} + local -i iterator + local char + for ((iterator = 0; iterator < ${#str}; iterator++)); do + char=${str:iterator:1} + printf '%x' "'${char}" + done +} + +######################## +# Get boot time +# Globals: +# None +# Arguments: +# None +# Returns: +# Boot time metadata +######################### +get_boot_time() { + stat /proc --format=%Y +} + +######################## +# Get machine ID +# Globals: +# None +# Arguments: +# None +# Returns: +# Machine ID +######################### +get_machine_id() { + local machine_id + if [[ -f /etc/machine-id ]]; then + machine_id="$(cat /etc/machine-id)" + fi + if [[ -z "$machine_id" ]]; then + # Fallback to the boot-time, which will at least ensure a unique ID in the current session + machine_id="$(get_boot_time)" + fi + echo "$machine_id" +} + +######################## +# Get the root partition's disk device ID (e.g. /dev/sda1) +# Globals: +# None +# Arguments: +# None +# Returns: +# Root partition disk ID +######################### +get_disk_device_id() { + local device_id="" + if grep -q ^/dev /proc/mounts; then + device_id="$(grep ^/dev /proc/mounts | awk '$2 == "/" { print $1 }' | tail -1)" + fi + # If it could not be autodetected, fallback to /dev/sda1 as a default + if [[ -z "$device_id" || ! -b "$device_id" ]]; then + device_id="/dev/sda1" + fi + echo "$device_id" +} + +######################## +# Get the root disk device ID (e.g. /dev/sda) +# Globals: +# None +# Arguments: +# None +# Returns: +# Root disk ID +######################### +get_root_disk_device_id() { + get_disk_device_id | sed -E 's/p?[0-9]+$//' +} + +######################## +# Get the root disk size in bytes +# Globals: +# None +# Arguments: +# None +# Returns: +# Root disk size in bytes +######################### +get_root_disk_size() { + fdisk -l "$(get_root_disk_device_id)" | grep 'Disk.*bytes' | sed -E 's/.*, ([0-9]+) bytes,.*/\1/' || true +} + +######################## +# Run command as a specific user and group (optional) +# Arguments: +# $1 - USER(:GROUP) to switch to +# $2..$n - command to execute +# Returns: +# Exit code of the specified command +######################### +run_as_user() { + run_chroot "$@" +} + +######################## +# Execute command as a specific user and group (optional), +# replacing the current process image +# Arguments: +# $1 - USER(:GROUP) to switch to +# $2..$n - command to execute +# Returns: +# Exit code of the specified command +######################### +exec_as_user() { + run_chroot --replace-process "$@" +} + +######################## +# Run a command using chroot +# Arguments: +# $1 - USER(:GROUP) to switch to +# $2..$n - command to execute +# Flags: +# -r | --replace-process - Replace the current process image (optional) +# Returns: +# Exit code of the specified command +######################### +run_chroot() { + local userspec + local user + local homedir + local replace=false + local -r cwd="$(pwd)" + + # Parse and validate flags + while [[ "$#" -gt 0 ]]; do + case "$1" in + -r | --replace-process) + replace=true + ;; + --) + shift + break + ;; + -*) + stderr_print "unrecognized flag $1" + return 1 + ;; + *) + break + ;; + esac + shift + done + + # Parse and validate arguments + if [[ "$#" -lt 2 ]]; then + echo "expected at least 2 arguments" + return 1 + else + userspec=$1 + shift + + # userspec can optionally include the group, so we parse the user + user=$(echo "$userspec" | cut -d':' -f1) + fi + + if ! am_i_root; then + error "Could not switch to '${userspec}': Operation not permitted" + return 1 + fi + + # Get the HOME directory for the user to switch, as chroot does + # not properly update this env and some scripts rely on it + homedir=$(eval echo "~${user}") + if [[ ! -d $homedir ]]; then + homedir="${HOME:-/}" + fi + + # Obtaining value for "$@" indirectly in order to properly support shell parameter expansion + if [[ "$replace" = true ]]; then + exec chroot --userspec="$userspec" / bash -c "cd ${cwd}; export HOME=${homedir}; exec \"\$@\"" -- "$@" + else + chroot --userspec="$userspec" / bash -c "cd ${cwd}; export HOME=${homedir}; exec \"\$@\"" -- "$@" + fi +} diff --git a/bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/scripts/libpersistence.sh b/bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/scripts/libpersistence.sh new file mode 100644 index 000000000000..833ee5ab1d65 --- /dev/null +++ b/bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/scripts/libpersistence.sh @@ -0,0 +1,124 @@ +#!/bin/bash +# Copyright Broadcom, Inc. All Rights Reserved. +# SPDX-License-Identifier: APACHE-2.0 +# +# 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 acl_file="$(mktemp "${TMPDIR:-/tmp}"/acl.XXXXXXXXXX)" + 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' > "$acl_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="$acl_file" + else + # When running as non-root, don't change ownership + setfacl --restore=<(grep -E -v '^# (owner|group):' "$acl_file") + fi + popd >/dev/null || exit + done + popd >/dev/null || exit + rm -f "$acl_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 +} diff --git a/bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/scripts/libservice.sh b/bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/scripts/libservice.sh new file mode 100644 index 000000000000..c1d60a5c5f42 --- /dev/null +++ b/bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/scripts/libservice.sh @@ -0,0 +1,446 @@ +#!/bin/bash +# Copyright Broadcom, Inc. All Rights Reserved. +# SPDX-License-Identifier: APACHE-2.0 +# +# 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" + + # 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 + cat > "/etc/cron.d/${service_name}" <> /etc/cron.d/"$service_name" + fi +} + +######################## +# 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 < "${logrotate_conf_dir}/${service_name}" +# Copyright Broadcom, Inc. All Rights Reserved. +# SPDX-License-Identifier: APACHE-2.0 + +${log_path} { + ${period} + rotate ${rotations} + dateext + compress + copytruncate + missingok +$(indent "$extra" 2) +} +EOF +} + +######################## +# Remove a logrotate configuration file +# Arguments: +# $1 - Service name +# Returns: +# None +######################### +remove_logrotate_conf() { + local service_name="${1:?service name is missing}" + local logrotate_conf_dir="/etc/logrotate.d" + rm -f "${logrotate_conf_dir}/${service_name}" +} + +######################## +# Generate a Systemd configuration file +# Arguments: +# $1 - Service name +# Flags: +# --custom-service-content - Custom content to add to the [service] block +# --environment - Environment variable to define (multiple --environment options may be passed) +# --environment-file - Text file with environment variables (multiple --environment-file options may be passed) +# --exec-start - Start command (required) +# --exec-start-pre - Pre-start command (optional) +# --exec-start-post - Post-start command (optional) +# --exec-stop - Stop command (optional) +# --exec-reload - Reload command (optional) +# --group - System group to start the service with +# --name - Service full name (e.g. Apache HTTP Server, defaults to $1) +# --restart - When to restart the Systemd service after being stopped (defaults to always) +# --pid-file - Service PID file +# --standard-output - File where to print stdout output +# --standard-error - File where to print stderr output +# --success-exit-status - Exit code that indicates a successful shutdown +# --type - Systemd unit type (defaults to forking) +# --user - System user to start the service with +# --working-directory - Working directory at which to start the service +# Returns: +# None +######################### +generate_systemd_conf() { + local -r service_name="${1:?service name is missing}" + local -r systemd_units_dir="/etc/systemd/system" + local -r service_file="${systemd_units_dir}/bitnami.${service_name}.service" + # Default values + local name="$service_name" + local type="forking" + local user="" + local group="" + local environment="" + local environment_file="" + local exec_start="" + local exec_start_pre="" + local exec_start_post="" + local exec_stop="" + local exec_reload="" + local restart="always" + local pid_file="" + local standard_output="journal" + local standard_error="" + local limits_content="" + local success_exit_status="" + local custom_service_content="" + local working_directory="" + local timeout_start_sec="2min" + local timeout_stop_sec="30s" + # Parse CLI flags + shift + while [[ "$#" -gt 0 ]]; do + case "$1" in + --name \ + | --type \ + | --user \ + | --group \ + | --exec-start \ + | --exec-stop \ + | --exec-reload \ + | --restart \ + | --pid-file \ + | --standard-output \ + | --standard-error \ + | --success-exit-status \ + | --custom-service-content \ + | --working-directory \ + | --timeout-start-sec \ + | --timeout-stop-sec \ + ) + var_name="$(echo "$1" | sed -e "s/^--//" -e "s/-/_/g")" + shift + declare "$var_name"="${1:?"${var_name} value is missing"}" + ;; + --limit-*) + [[ -n "$limits_content" ]] && limits_content+=$'\n' + var_name="${1//--limit-}" + shift + limits_content+="Limit${var_name^^}=${1:?"--limit-${var_name} value is missing"}" + ;; + --exec-start-pre) + shift + [[ -n "$exec_start_pre" ]] && exec_start_pre+=$'\n' + exec_start_pre+="ExecStartPre=${1:?"--exec-start-pre value is missing"}" + ;; + --exec-start-post) + shift + [[ -n "$exec_start_post" ]] && exec_start_post+=$'\n' + exec_start_post+="ExecStartPost=${1:?"--exec-start-post value is missing"}" + ;; + --environment) + shift + # It is possible to add multiple environment lines + [[ -n "$environment" ]] && environment+=$'\n' + environment+="Environment=${1:?"--environment value is missing"}" + ;; + --environment-file) + shift + # It is possible to add multiple environment-file lines + [[ -n "$environment_file" ]] && environment_file+=$'\n' + environment_file+="EnvironmentFile=${1:?"--environment-file value is missing"}" + ;; + *) + echo "Invalid command line flag ${1}" >&2 + return 1 + ;; + esac + shift + done + # Validate inputs + local error="no" + if [[ -z "$exec_start" ]]; then + error "The --exec-start option is required" + error="yes" + fi + if [[ "$error" != "no" ]]; then + return 1 + fi + # Generate the Systemd unit + cat > "$service_file" <> "$service_file" <<< "WorkingDirectory=${working_directory}" + fi + if [[ -n "$exec_start_pre" ]]; then + # This variable may contain multiple ExecStartPre= directives + cat >> "$service_file" <<< "$exec_start_pre" + fi + if [[ -n "$exec_start" ]]; then + cat >> "$service_file" <<< "ExecStart=${exec_start}" + fi + if [[ -n "$exec_start_post" ]]; then + # This variable may contain multiple ExecStartPost= directives + cat >> "$service_file" <<< "$exec_start_post" + fi + # Optional stop and reload commands + if [[ -n "$exec_stop" ]]; then + cat >> "$service_file" <<< "ExecStop=${exec_stop}" + fi + if [[ -n "$exec_reload" ]]; then + cat >> "$service_file" <<< "ExecReload=${exec_reload}" + fi + # User and group + if [[ -n "$user" ]]; then + cat >> "$service_file" <<< "User=${user}" + fi + if [[ -n "$group" ]]; then + cat >> "$service_file" <<< "Group=${group}" + fi + # PID file allows to determine if the main process is running properly (for Restart=always) + if [[ -n "$pid_file" ]]; then + cat >> "$service_file" <<< "PIDFile=${pid_file}" + fi + if [[ -n "$restart" ]]; then + cat >> "$service_file" <<< "Restart=${restart}" + fi + # Environment flags + if [[ -n "$environment" ]]; then + # This variable may contain multiple Environment= directives + cat >> "$service_file" <<< "$environment" + fi + if [[ -n "$environment_file" ]]; then + # This variable may contain multiple EnvironmentFile= directives + cat >> "$service_file" <<< "$environment_file" + fi + # Logging + if [[ -n "$standard_output" ]]; then + cat >> "$service_file" <<< "StandardOutput=${standard_output}" + fi + if [[ -n "$standard_error" ]]; then + cat >> "$service_file" <<< "StandardError=${standard_error}" + fi + if [[ -n "$custom_service_content" ]]; then + # This variable may contain multiple miscellaneous directives + cat >> "$service_file" <<< "$custom_service_content" + fi + if [[ -n "$success_exit_status" ]]; then + cat >> "$service_file" <> "$service_file" <> "$service_file" <> "$service_file" </dev/null + wait + exit $? + } + trap _service_forward_term TERM +} diff --git a/bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/scripts/libvalidations.sh b/bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/scripts/libvalidations.sh new file mode 100644 index 000000000000..3a996383cfab --- /dev/null +++ b/bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/scripts/libvalidations.sh @@ -0,0 +1,294 @@ +#!/bin/bash +# Copyright Broadcom, Inc. All Rights Reserved. +# SPDX-License-Identifier: APACHE-2.0 +# +# Validation functions library + +# shellcheck disable=SC1091,SC2086 + +# 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:-}" + # converts the string to lowercase + local bool_val="${bool,,}" + if [[ "$bool_val" = 1 || "$bool_val" =~ ^(yes|true)$ ]]; then + true + else + false + fi +} + +######################## +# Check if the provided argument is a boolean yes/no value +# Arguments: +# $1 - Value to check +# Returns: +# Boolean +######################### +is_yes_no_value() { + local -r bool="${1:-}" + if [[ "$bool" =~ ^(yes|no)$ ]]; then + true + else + false + fi +} + +######################## +# Check if the provided argument is a boolean true/false value +# Arguments: +# $1 - Value to check +# Returns: +# Boolean +######################### +is_true_false_value() { + local -r bool="${1:-}" + if [[ "$bool" =~ ^(true|false)$ ]]; then + true + else + false + fi +} + +######################## +# Check if the provided argument is a boolean 1/0 value +# Arguments: +# $1 - Value to check +# Returns: +# Boolean +######################### +is_1_0_value() { + local -r bool="${1:-}" + if [[ "$bool" =~ ^[10]$ ]]; then + true + else + false + fi +} + +######################## +# Check if the provided argument is an empty string or not defined +# Arguments: +# $1 - Value to check +# Returns: +# Boolean +######################### +is_empty_value() { + local -r val="${1:-}" + if [[ -z "$val" ]]; then + true + else + false + fi +} + +######################## +# Validate if the provided argument is a valid port +# Arguments: +# $1 - Port to validate +# Returns: +# Boolean and error message +######################### +validate_port() { + local value + local unprivileged=0 + + # Parse flags + while [[ "$#" -gt 0 ]]; do + case "$1" in + -unprivileged) + unprivileged=1 + ;; + --) + shift + break + ;; + -*) + stderr_print "unrecognized flag $1" + return 1 + ;; + *) + break + ;; + esac + shift + done + + if [[ "$#" -gt 1 ]]; then + echo "too many arguments provided" + return 2 + elif [[ "$#" -eq 0 ]]; then + stderr_print "missing port argument" + return 1 + else + value=$1 + fi + + if [[ -z "$value" ]]; then + echo "the value is empty" + return 1 + else + if ! is_int "$value"; then + echo "value is not an integer" + return 2 + elif [[ "$value" -lt 0 ]]; then + echo "negative value provided" + return 2 + elif [[ "$value" -gt 65535 ]]; then + echo "requested port is greater than 65535" + return 2 + elif [[ "$unprivileged" = 1 && "$value" -lt 1024 ]]; then + echo "privileged port requested" + return 3 + fi + fi +} + +######################## +# Validate if the provided argument is a valid IPv6 address +# Arguments: +# $1 - IP to validate +# Returns: +# Boolean +######################### +validate_ipv6() { + local ip="${1:?ip is missing}" + local stat=1 + local full_address_regex='^([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4}$' + local short_address_regex='^((([0-9a-fA-F]{1,4}:){0,6}[0-9a-fA-F]{1,4}){0,6}::(([0-9a-fA-F]{1,4}:){0,6}[0-9a-fA-F]{1,4}){0,6})$' + + if [[ $ip =~ $full_address_regex || $ip =~ $short_address_regex || $ip == "::" ]]; then + stat=0 + fi + return $stat +} + +######################## +# 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 if the provided argument is a valid IPv4 or IPv6 address +# Arguments: +# $1 - IP to validate +# Returns: +# Boolean +######################### +validate_ip() { + local ip="${1:?ip is missing}" + local stat=1 + + if validate_ipv4 "$ip"; then + stat=0 + else + stat=$(validate_ipv6 "$ip") + 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 + ;; + *) + string="$1" + ;; + esac + shift + done + + if [[ "$min_length" -ge 0 ]] && [[ "${#string}" -lt "$min_length" ]]; then + echo "string length is less than $min_length" + return 1 + fi + if [[ "$max_length" -ge 0 ]] && [[ "${#string}" -gt "$max_length" ]]; then + echo "string length is great than $max_length" + return 1 + fi +} diff --git a/bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/scripts/libversion.sh b/bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/scripts/libversion.sh new file mode 100644 index 000000000000..770861ecedcd --- /dev/null +++ b/bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/scripts/libversion.sh @@ -0,0 +1,84 @@ +#!/bin/bash +# Copyright Broadcom, Inc. All Rights Reserved. +# SPDX-License-Identifier: APACHE-2.0 +# +# 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 +} + +######################## +# Compares two semantic versions +# Arguments: +# $1 - version1: first version to compare +# $2 - version2: second version to compare +# Returns: +# -1 if version1 is less than version2 +# 0 if version1 is equal to version2 +# 1 if version1 is greater than version2 +######################### +compare_semantic_versions() { + local version1="${1:?version1 is required}" + local version2="${2:?version2 is required}" + local major1 major2 minor1 minor2 patch1 patch2 + + major1="$(get_sematic_version "$version1" 1)" + major2="$(get_sematic_version "$version2" 1)" + minor1="$(get_sematic_version "$version1" 2)" + minor2="$(get_sematic_version "$version2" 2)" + patch1="$(get_sematic_version "$version1" 3)" + patch2="$(get_sematic_version "$version2" 3)" + + if [[ "$major1" -eq "$major2" ]] && [[ "$minor1" -eq "$minor2" ]] && [[ "$patch1" -eq "$patch2" ]]; then + echo "0" + elif [[ "$major1" -lt "$major2" ]] || + { [[ "$major1" -eq "$major2" ]] && [[ "$minor1" -lt "$minor2" ]]; } || + { [[ "$major1" -eq "$major2" ]] && [[ "$minor1" -eq "$minor2" ]] && [[ "$patch1" -lt "$patch2" ]]; }; then + echo "-1" + else + echo "1" + fi +} diff --git a/bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/scripts/libwebserver.sh b/bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/scripts/libwebserver.sh new file mode 100644 index 000000000000..bbf4709b729f --- /dev/null +++ b/bitnami/mastodon/4.7/debian-12/prebuildfs/opt/bitnami/scripts/libwebserver.sh @@ -0,0 +1,396 @@ +#!/bin/bash +# Copyright Broadcom, Inc. All Rights Reserved. +# SPDX-License-Identifier: APACHE-2.0 +# +# 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" + if [[ "${BITNAMI_SERVICE_MANAGER:-}" = "systemd" ]]; then + systemctl start "bitnami.$(web_server_type).service" + else + "${BITNAMI_ROOT_DIR}/scripts/$(web_server_type)/start.sh" + fi +} + +######################## +# Stop web server +# Globals: +# * +# Arguments: +# None +# Returns: +# None +######################### +web_server_stop() { + info "Stopping $(web_server_type)" + if [[ "${BITNAMI_SERVICE_MANAGER:-}" = "systemd" ]]; then + systemctl stop "bitnami.$(web_server_type).service" + else + "${BITNAMI_ROOT_DIR}/scripts/$(web_server_type)/stop.sh" + fi +} + +######################## +# 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: +# --type - Application type, which has an effect on which configuration template to use +# --hosts - Host listen addresses +# --server-name - Server name +# --server-aliases - Server aliases +# --allow-remote-connections - Whether to allow remote connections or to require local connections +# --disable - Whether to render server configurations with a .disabled prefix +# --disable-http - Whether to render the app's HTTP server configuration with a .disabled prefix +# --disable-https - Whether to render the app's HTTPS server configuration with a .disabled prefix +# --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-additional-http-configuration - Additional HTTP vhost configuration (no default) +# --apache-additional-https-configuration - Additional HTTPS vhost configuration (no default) +# --apache-before-vhost-configuration - Configuration to add before the directive (no default) +# --apache-allow-override - Whether to allow .htaccess files (only allowed when --move-htaccess is set to 'no' and type is not defined) +# --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 (only allowed when type is not defined) +# 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 + --disable \ + | --disable-http \ + | --disable-https \ + ) + apache_args+=("$1") + nginx_args+=("$1") + ;; + --hosts \ + | --server-name \ + | --server-aliases \ + | --type \ + | --allow-remote-connections \ + | --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-additional-http-configuration \ + | --apache-additional-https-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 - Host listen addresses +# --server-name - Server name +# --server-aliases - Server aliases +# --enable-http - Enable HTTP app configuration (if not enabled already) +# --enable-https - Enable HTTPS app configuration (if not enabled already) +# --disable-http - Disable HTTP app configuration (if not disabled already) +# --disable-https - Disable HTTPS app configuration (if not disabled already) +# --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 + --enable-http \ + | --enable-https \ + | --disable-http \ + | --disable-https \ + ) + args+=("$1") + ;; + --hosts \ + | --server-name \ + | --server-aliases \ + | --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 +} diff --git a/bitnami/mastodon/4.7/debian-12/prebuildfs/usr/sbin/install_packages b/bitnami/mastodon/4.7/debian-12/prebuildfs/usr/sbin/install_packages new file mode 100755 index 000000000000..ccce248b2d14 --- /dev/null +++ b/bitnami/mastodon/4.7/debian-12/prebuildfs/usr/sbin/install_packages @@ -0,0 +1,27 @@ +#!/bin/sh +# Copyright Broadcom, Inc. All Rights Reserved. +# SPDX-License-Identifier: APACHE-2.0 +set -eu + +n=0 +max=2 +export DEBIAN_FRONTEND=noninteractive + +until [ $n -gt $max ]; do + set +e + ( + apt-get update -qq && + apt-get install -y --no-install-recommends "$@" + ) + CODE=$? + set -e + if [ $CODE -eq 0 ]; then + break + fi + if [ $n -eq $max ]; then + exit $CODE + fi + echo "apt failed, retrying" + n=$(($n + 1)) +done +apt-get clean && rm -rf /var/lib/apt/lists /var/cache/apt/archives diff --git a/bitnami/mastodon/4.7/debian-12/prebuildfs/usr/sbin/run-script b/bitnami/mastodon/4.7/debian-12/prebuildfs/usr/sbin/run-script new file mode 100755 index 000000000000..0e07c9038dfd --- /dev/null +++ b/bitnami/mastodon/4.7/debian-12/prebuildfs/usr/sbin/run-script @@ -0,0 +1,24 @@ +#!/bin/sh +# Copyright Broadcom, Inc. All Rights Reserved. +# SPDX-License-Identifier: APACHE-2.0 +set -u + +if [ $# -eq 0 ]; then + >&2 echo "No arguments provided" + exit 1 +fi + +script=$1 +exit_code="${2:-96}" +fail_if_not_present="${3:-n}" + +if test -f "$script"; then + sh $script + + if [ $? -ne 0 ]; then + exit $((exit_code)) + fi +elif [ "$fail_if_not_present" = "y" ]; then + >&2 echo "script not found: $script" + exit 127 +fi diff --git a/bitnami/mastodon/4.7/debian-12/prebuildfs/usr/sbin/uninstall_packages b/bitnami/mastodon/4.7/debian-12/prebuildfs/usr/sbin/uninstall_packages new file mode 100755 index 000000000000..615c430e4e68 --- /dev/null +++ b/bitnami/mastodon/4.7/debian-12/prebuildfs/usr/sbin/uninstall_packages @@ -0,0 +1,26 @@ +#!/bin/sh +# Copyright Broadcom, Inc. All Rights Reserved. +# SPDX-License-Identifier: APACHE-2.0 +set -eu + +n=0 +max=2 +export DEBIAN_FRONTEND=noninteractive + +until [ $n -gt $max ]; do + set +e + ( + apt-get autoremove --purge -y "$@" + ) + CODE=$? + set -e + if [ $CODE -eq 0 ]; then + break + fi + if [ $n -eq $max ]; then + exit $CODE + fi + echo "apt failed, retrying" + n=$(($n + 1)) +done +apt-get clean && rm -rf /var/lib/apt/lists /var/cache/apt/archives diff --git a/bitnami/mastodon/4.7/debian-12/rootfs/opt/bitnami/scripts/libmastodon.sh b/bitnami/mastodon/4.7/debian-12/rootfs/opt/bitnami/scripts/libmastodon.sh new file mode 100644 index 000000000000..7c2b557c208a --- /dev/null +++ b/bitnami/mastodon/4.7/debian-12/rootfs/opt/bitnami/scripts/libmastodon.sh @@ -0,0 +1,525 @@ +#!/bin/bash +# Copyright Broadcom, Inc. All Rights Reserved. +# SPDX-License-Identifier: APACHE-2.0 +# +# Bitnami Mastodon library + +# shellcheck disable=SC1090 +# shellcheck disable=SC1091 + +# Load generic libraries +. /opt/bitnami/scripts/libfs.sh +. /opt/bitnami/scripts/libos.sh +. /opt/bitnami/scripts/libnet.sh +. /opt/bitnami/scripts/libfile.sh +. /opt/bitnami/scripts/libvalidations.sh +. /opt/bitnami/scripts/libpersistence.sh +. /opt/bitnami/scripts/libservice.sh + +######################## +# Validate settings in MASTODON_* env vars +# Globals: +# MASTODON_* +# Arguments: +# None +# Returns: +# 0 if the validation succeeded, 1 otherwise +######################### +mastodon_validate() { + debug "Validating settings in MASTODON_* 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_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 + } + + check_true_false() { + if ! is_true_false_value "${!1}"; then + print_validation_error "The allowed values for ${1} are: true or false" + fi + } + + check_integer() { + if ! is_int "${!1}"; then + print_validation_error "The value for ${1} is not a valid integer" + fi + } + + check_password_length() { + local password_var="${1:?missing password_var}" + local length="${2:?missing length}" + local password="${!1}" + if [[ "${#password}" -lt "$length" ]]; then + print_validation_error "${password_var} must be at least ${length} characters" + fi + } + + check_true_false "MASTODON_ELASTICSEARCH_ENABLED" + if is_boolean_yes "$MASTODON_ELASTICSEARCH_ENABLED"; then + check_true_false "MASTODON_MIGRATE_ELASTICSEARCH" + check_resolved_hostname "MASTODON_ELASTICSEARCH_HOST" + check_valid_port "MASTODON_ELASTICSEARCH_PORT_NUMBER" + fi + + # 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 + if [[ "$MASTODON_MODE" == "web" ]]; then + is_empty_value "${MASTODON_DATABASE_PASSWORD:-}" && print_validation_error "The MASTODON_DATABASE_PASSWORD environment variable is empty or not set. Set the environment variable ALLOW_EMPTY_PASSWORD=yes to allow a blank password. This is only recommended for development environments." + is_empty_value "${MASTODON_REDIS_PASSWORD:-}" && print_validation_error "The MASTODON_REDIS_PASSWORD environment variable is empty or not set. Set the environment variable ALLOW_EMPTY_PASSWORD=yes to allow a blank password. This is only recommended for development environments." + is_boolean_yes "$MASTODON_ELASTICSEARCH_ENABLED" && is_empty_value "${MASTODON_ELASTICSEARCH_PASSWORD:-}" && print_validation_error "The MASTODON_ELASTICSEARCH_PASSWORD environment variable is empty or not set. Set the environment variable ALLOW_EMPTY_PASSWORD=yes to allow a blank password. This is only recommended for development environments." + fi + fi + + # Mastodon mode + check_multi_value "MASTODON_MODE" "web sidekiq streaming" + + check_true_false "MASTODON_CREATE_ADMIN" + if is_boolean_yes "$MASTODON_CREATE_ADMIN"; then + check_empty_value "MASTODON_ADMIN_EMAIL" + check_empty_value "MASTODON_ADMIN_PASSWORD" + check_empty_value "MASTODON_ADMIN_USERNAME" + check_password_length "MASTODON_ADMIN_PASSWORD" "8" + fi + + check_true_false "MASTODON_S3_ENABLED" + + if is_boolean_yes "$MASTODON_S3_ENABLED"; then + check_empty_value "MASTODON_S3_HOSTNAME" + check_resolved_hostname "$MASTODON_S3_HOSTNAME" + check_valid_port "MASTODON_S3_PORT_NUMBER" + check_empty_value "MASTODON_S3_ALIAS_HOST" + check_empty_value "MASTODON_S3_ENDPOINT" + check_empty_value "MASTODON_AWS_ACCESS_KEY_ID" + check_empty_value "MASTODON_AWS_SECRET_ACCESS_KEY" + check_multi_value "MASTODON_S3_PROTOCOL" "http https" + fi + + if [[ $MASTODON_MODE != "web" ]]; then + is_empty_value "${MASTODON_WEB_HOST}" && print_validation_error "For Sidekiq and Streaming modes, the MASTODON_WEB_HOST variable must be set" + check_resolved_hostname "MASTODON_WEB_HOST" + fi + + check_valid_port "MASTODON_WEB_PORT_NUMBER" + check_valid_port "MASTODON_STREAMING_PORT_NUMBER" + + check_empty_value "MASTODON_SECRET_KEY_BASE" + check_empty_value "MASTODON_OTP_SECRET" + + check_true_false "MASTODON_MIGRATE_DATABASE" + check_resolved_hostname "MASTODON_DATABASE_HOST" + check_valid_port "MASTODON_DATABASE_PORT_NUMBER" + check_integer "MASTODON_DATABASE_POOL" + + check_resolved_hostname "MASTODON_REDIS_HOST" + check_valid_port "MASTODON_REDIS_PORT_NUMBER" + + check_true_false "MASTODON_ALLOW_ALL_DOMAINS" + if is_boolean_yes "$MASTODON_ALLOW_ALL_DOMAINS"; then + warn "MASTODON_ALLOW_ALL_DOMAINS is set to true which opens up vulnerability to password-reset poisoning attacks. This is not recommended for production environments." + fi + return "$error_code" +} + +######################## +# Executes Bundler with the proper environment and the specified arguments and print result to stdout +# Globals: +# MASTODON_* +# Arguments: +# $1..$n - Arguments to pass to the CLI call +# Returns: +# None +######################### +mastodon_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=("run_as_user" "$MASTODON_DAEMON_USER" "${cmd[@]}") + ( + cd "$MASTODON_BASE_DIR" || false + "${cmd[@]}" + ) +} + +######################## +# Executes Bundler with the proper environment and the specified arguments +# Globals: +# MASTODON_* +# Arguments: +# $1..$n - Arguments to pass to the CLI call +# Returns: +# None +######################### +mastodon_bundle_execute() { + debug_execute mastodon_bundle_execute_print_output "$@" +} + +######################## +# Executes the 'rake' CLI with the proper Bundler environment and the specified arguments and print result to stdout +# Globals: +# MASTODON_* +# Arguments: +# $1..$n - Arguments to pass to the CLI call +# Returns: +# None +######################### +mastodon_rake_execute_print_output() { + mastodon_bundle_execute_print_output "rake" "$@" +} + +######################## +# Executes the 'rake' CLI with the proper Bundler environment and the specified arguments +# Globals: +# MASTODON_* +# Arguments: +# $1..$n - Arguments to pass to the CLI call +# Returns: +# None +######################### +mastodon_rake_execute() { + debug_execute mastodon_rake_execute_print_output "$@" +} + +######################## +# Executes the commands specified via stdin in the Rails console for Discourse +# Globals: +# MASTODON_* +# Arguments: +# None +# Returns: +# None +######################### +mastodon_console_execute() { + local rails_cmd + rails_cmd="$(&1) + debug "$res" + echo "$res" | grep -q '1 row' + } + if ! retry_while "debug_execute check_postgresql_connection" "$MASTODON_STARTUP_ATTEMPTS"; then + error "Could not connect to the PostgreSQL database" + return 1 + fi + info "PostgreSQL instance is ready" +} + +######################## +# Wait for Elasticsearch to be ready +# Globals: +# * MASTODON_* +# Arguments: +# None +# Returns: None +######################### +mastodon_wait_for_elasticsearch_connection() { + local -r connection_string="${1:?missing connection string}" + info "Waiting for Elasticsearch to be ready at $connection_string" + check_elasticsearch_connection() { + local curl_args=("-k" "$connection_string" "--max-time" "5") + if ! is_empty_value "${MASTODON_ELASTICSEARCH_PASSWORD:-}"; then + curl_args+=("-u" "$MASTODON_ELASTICSEARCH_USER:$MASTODON_ELASTICSEARCH_PASSWORD") + fi + local -r res=$(curl "${curl_args[@]}" 2>&1) + debug "$res" + echo "$res" | grep -q 'You Know' + } + if ! retry_while "debug_execute check_elasticsearch_connection" "$MASTODON_STARTUP_ATTEMPTS"; then + error "Could not connect to Elasticsearch" + return 1 + fi + info "Elasticsearch instance is ready" +} + +######################## +# Wait for S3 connection +# Globals: +# * MASTODON_* +# Arguments: None +# Returns: None +######################### +mastodon_wait_for_s3_connection() { + local -r host="${1:?missing host}" + local -r port="${2:?missing port}" + info "Waiting for S3 to be ready at ${MASTODON_S3_PROTOCOL}://${host}:${port}" + if ! retry_while "debug_execute wait-for-port --host ${host} ${port}" "$MASTODON_STARTUP_ATTEMPTS"; then + error "Could not connect to S3" + return 1 + fi + info "S3 instance is ready" +} + +######################## +# Wait for Redis connection +# Globals: +# * MASTODON_* +# Arguments: +# 1: Connection string +# Returns: None +######################### +mastodon_wait_for_redis_connection() { + local -r connection_string="${1:?missing connection string}" + info "Waiting for Redis to be ready at ${connection_string##*@}" + check_redis_connection() { + local -r redis_args=("-u" "$connection_string" "PING") + local -r res=$(redis-cli "${redis_args[@]}" 2>&1) + debug "$res" + echo "$res" | grep -q 'PONG' + } + if ! retry_while "debug_execute check_redis_connection" "$MASTODON_STARTUP_ATTEMPTS"; then + error "Could not connect to Redis" + return 1 + fi + info "Redis instance is ready" +} + +######################## +# Wait for Mastodon Web to be available +# Globals: +# * MASTODON_* +# Arguments: +# None +# Returns: None +######################### +mastodon_wait_for_web_connection() { + local -r connection_string="${1:?missing connection string}" + info "Checking for web server at $connection_string" + check_web_connection() { + # We use the /health endpoint to check if the web server is ready + # https://github.com/mastodon/mastodon/blob/main/config/initializers/1_hosts.rb#L34 + local -r curl_args=("${connection_string}/health" "--max-time" "5") + local -r res=$(curl "${curl_args[@]}" 2>&1) + debug "$res" + echo "$res" | grep -q 'OK' + } + if ! retry_while "debug_execute check_web_connection" "$MASTODON_STARTUP_ATTEMPTS"; then + error "Could not connect to the Web server" + return 1 + fi + info "Web server is ready" +} + +######################## +# Initialize Mastodon +# Arguments: +# None +# Returns: +# None +######################### +mastodon_initialize() { + # Logic inspired on the official helm chart + # Source: https://github.com/mastodon/mastodon/tree/main/chart/templates + # The logic in this function will be used for docker-compose deployments. In the helm + # chart we will use separate jobs that call the migration and precompilation commands. + # This will allow better scalability and avoid race condition issues. + # There is no configuration file in Mastodon, as everything is done via environment variables + # https://github.com/mastodon/mastodon/blob/main/chart/templates/configmap-env.yaml + info "Initializing Mastodon" + local -r app_name="mastodon" + + # All the initialization logic will be performed by the web node, the other nodes + # will just wait for web to be available + if [[ "$MASTODON_MODE" == "web" ]]; then + # If we are using S3, we do not need to enable persistence. Otherwise we need + # to persist the system and public folders + # https://github.com/mastodon/mastodon/blob/main/chart/templates/deployment-web.yaml#L89 + if is_boolean_yes "$MASTODON_S3_ENABLED"; then + info "Waiting for S3 connection" + mastodon_wait_for_s3_connection "$MASTODON_S3_HOSTNAME" "$MASTODON_S3_PORT_NUMBER" + fi + + local -r psql_connection_string="postgresql://${MASTODON_DATABASE_USERNAME}:${MASTODON_DATABASE_PASSWORD}@${MASTODON_DATABASE_HOST}:${MASTODON_DATABASE_PORT_NUMBER}/${MASTODON_DATABASE_NAME}" + mastodon_wait_for_postgresql_connection "$psql_connection_string" + if is_boolean_yes "$MASTODON_MIGRATE_DATABASE"; then + info "Preparing database" + mastodon_rake_execute db:prepare + info "Migrating database" + mastodon_rake_execute db:migrate + fi + + local redis_connection_string="redis://" + if [[ -n "${MASTODON_REDIS_PASSWORD:-}" ]]; then + redis_connection_string+="${MASTODON_REDIS_PASSWORD}@" + fi + redis_connection_string+="${MASTODON_REDIS_HOST}:${MASTODON_REDIS_PORT_NUMBER}" + mastodon_wait_for_redis_connection "$redis_connection_string" + + # Elasticsearch is an optional component in Mastodon. It is necessary for enabling + # text searches + if is_boolean_yes "$MASTODON_ELASTICSEARCH_ENABLED"; then + local -r elasticsearch_connection_string="http://${MASTODON_ELASTICSEARCH_HOST}:${MASTODON_ELASTICSEARCH_PORT_NUMBER}" + mastodon_wait_for_elasticsearch_connection "$elasticsearch_connection_string" + if is_boolean_yes "$MASTODON_MIGRATE_ELASTICSEARCH"; then + info "Migrating Elasticsearch" + mastodon_rake_execute chewy:upgrade + fi + fi + + if is_boolean_yes "$MASTODON_CREATE_ADMIN"; then + mastodon_ensure_admin_user_exists + fi + + if ! is_boolean_yes "$MASTODON_S3_ENABLED"; then + if ! is_app_initialized "$app_name"; then + info "Persisting Mastodon application" + persist_app "$app_name" "$MASTODON_DATA_TO_PERSIST" + else + info "Mastodon application already initialized, restoring..." + restore_persisted_app "$app_name" "$MASTODON_DATA_TO_PERSIST" + fi + fi + + if is_boolean_yes "$MASTODON_ASSETS_PRECOMPILE"; then + info "Precompiling assets" + mastodon_rake_execute "assets:precompile" + fi + + else + + # When the mode is sidekiq or streaming, we want to wait for the web node to be available + info "Waiting for Mastodon web to be available" + mastodon_wait_for_web_connection "http://${MASTODON_WEB_HOST}:${MASTODON_WEB_PORT_NUMBER}" + if ! is_boolean_yes "$MASTODON_S3_ENABLED" && [[ "$MASTODON_MODE" == "sidekiq" ]]; then + # If the web node is available, we can assume that the shared volume has been initialized so + # we can safely restore it (we don't need it for the streaming service) + # https://github.com/mastodon/mastodon/blob/main/chart/templates/deployment-streaming.yaml#L77 + info "Mastodon application already initialized, restoring..." + restore_persisted_app "$app_name" "$MASTODON_DATA_TO_PERSIST" + fi + fi + + # Avoid exit code of previous commands to affect the result of this function + true +} + +######################## +# Add or modify an entry in the Mastodon configuration file (.env.production) +# Globals: +# MASTODON_BASE_DIR +# MASTODON_CFG_* +# Arguments: +# $1 - Environment variable name +# $2 - Value to assign to the environment variable +# Returns: +# None +######################### +mastodon_conf_set() { + local -r key="${1:?key missing}" + local -r value="${2:-}" + local -r conf_file="${MASTODON_BASE_DIR}/.env.production" + debug "Setting ${key} to '${value}' in Mastodon .env.production configuration" + # Sanitize key (sed does not support fixed string substitutions) + local sanitized_pattern + sanitized_pattern="^\s*(#\s*)?$(sed 's/[]\[^$.*/]/\\&/g' <<< "$key")\s*=.*" + local entry="${key}=${value}" + # Check if the configuration exists in the file + if grep -q -E "$sanitized_pattern" "$conf_file"; then + # It exists, so replace the line + replace_in_file "$conf_file" "$sanitized_pattern" "$entry" + else + cat >> "$conf_file" <<< "$entry" + fi +} + +######################## +# Obtain Mastodon runtime configuration and environment variables +# Arguments: +# None +# Returns: +# Mastodon runtime configuration and environment variables +######################### +mastodon_runtime_env() { + # Convert the .env.production file so it can be loaded with eval + sed -E 's/^\s*([^# ])/export \1/' "${MASTODON_BASE_DIR}/.env.production" +} diff --git a/bitnami/mastodon/4.7/debian-12/rootfs/opt/bitnami/scripts/libpostgresqlclient.sh b/bitnami/mastodon/4.7/debian-12/rootfs/opt/bitnami/scripts/libpostgresqlclient.sh new file mode 100644 index 000000000000..65238dfff60b --- /dev/null +++ b/bitnami/mastodon/4.7/debian-12/rootfs/opt/bitnami/scripts/libpostgresqlclient.sh @@ -0,0 +1,424 @@ +#!/bin/bash +# Copyright Broadcom, Inc. All Rights Reserved. +# SPDX-License-Identifier: APACHE-2.0 +# +# 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 + local -a database_names + read -r -a database_names <<< "$(tr ',;' ' ' <<< "$POSTGRESQL_CLIENT_CREATE_DATABASE_NAMES")" + if [[ -n "$POSTGRESQL_CLIENT_CREATE_DATABASE_USERNAME" || "${#database_names[@]}" -gt 0 ]]; 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 [[ "${#database_names[@]}" -le 0 && "${#extensions[@]}" -gt 0 ]]; then + print_validation_error "POSTGRESQL_CLIENT_CREATE_DATABASE_EXTENSIONS requires POSTGRESQL_CLIENT_CREATE_DATABASE_NAMES to be set." + fi + return "$error_code" +} + +######################## +# Perform actions to a database +# Globals: +# POSTGRESQL_CLIENT_* +# Arguments: +# None +# Returns: +# None +######################### +postgresql_client_initialize() { + local -a database_names + read -r -a database_names <<< "$(tr ',;' ' ' <<< "$POSTGRESQL_CLIENT_CREATE_DATABASE_NAMES")" + # Wait for the database to be accessible if any action needs to be performed + if [[ -n "$POSTGRESQL_CLIENT_CREATE_DATABASE_USERNAME" || "${#database_names[@]}" -gt 0 ]]; 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" "postgres" "$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 [[ "${#database_names[@]}" -gt 0 ]]; then + local -a createdb_args extensions + read -r -a extensions <<< "$(tr ',;' ' ' <<< "$POSTGRESQL_CLIENT_CREATE_DATABASE_EXTENSIONS")" + for database_name in "${database_names[@]}"; do + info "Creating database ${database_name}" + createdb_args=("$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 + 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" "$database_name" "$POSTGRESQL_CLIENT_POSTGRES_USER" "$POSTGRESQL_CLIENT_POSTGRES_PASSWORD" + done + fi + done + fi + # Execute a custom SQL script + if [[ -n "$POSTGRESQL_CLIENT_EXECUTE_SQL" ]]; then + info "Executing custom SQL script" + echo "$POSTGRESQL_CLIENT_EXECUTE_SQL" | postgresql_remote_execute "$POSTGRESQL_CLIENT_DATABASE_HOST" "$POSTGRESQL_CLIENT_DATABASE_PORT_NUMBER" "postgres" "$POSTGRESQL_CLIENT_POSTGRES_USER" "$POSTGRESQL_CLIENT_POSTGRES_PASSWORD" + fi + # Avoid exit code of previous commands to affect the result of this function + true +} + +# Copyright Broadcom, Inc. All Rights Reserved. +# SPDX-License-Identifier: APACHE-2.0 + +# shellcheck disable=SC2148 + +######################## +# 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" "-p" "${POSTGRESQL_PORT_NUMBER:-5432}" "-h" "127.0.0.1") + [[ -n "$db" ]] && args+=("-d" "$db") + [[ "${#opts[@]}" -gt 0 ]] && args+=("${opts[@]}") + + # Execute the Query/queries from stdin + PGPASSWORD=$pass psql "${args[@]}" +} + +######################## +# 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=("postgres" "$(get_env_var_value POSTGRES_USER)" "$(get_env_var_value POSTGRES_PASSWORD)") + + "${postgresql_execute_cmd[@]}" "${postgresql_execute_flags[@]}" <&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=("postgres" "$(get_env_var_value POSTGRES_USER)" "$(get_env_var_value POSTGRES_PASSWORD)") + + "${postgresql_execute_cmd[@]}" "${postgresql_execute_flags[@]}" <