diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 00000000..da2b4da3 --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,60 @@ + + +**Description** + + + +**Steps to reproduce the issue:** + +1. [First Step] +2. [Second Step] +3. [and so on...] + +**Describe the results you received:** + + + +**Describe the results you expected:** + + + +**Additional information you deem important (e.g. issue happens only occasionally):** + + + +**Version** + +- Output of `docker version`: + +``` +(paste your output here) +``` + +- Output of `docker info`: + +``` +(paste your output here) +``` + +- Output of `docker-compose version` (if applicable): + +``` +(paste your output here) +``` + +**Additional environment details (AWS, VirtualBox, Docker for MAC, physical, etc.):** diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..c2acbe6e --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,32 @@ + + +**Description of the change** + + + +**Benefits** + + + +**Possible drawbacks** + + + +**Applicable issues** + + + +**Additional information** + + diff --git a/.github/workflows/stale.yml b/.github/workflows/stale.yml new file mode 100644 index 00000000..0bf90080 --- /dev/null +++ b/.github/workflows/stale.yml @@ -0,0 +1,20 @@ +name: 'Close stale issues and PRs' +on: + schedule: + - cron: '0 1 * * *' + +jobs: + stale: + runs-on: ubuntu-latest + steps: + - uses: actions/stale@v3 + with: + repo-token: ${{ secrets.GITHUB_TOKEN }} + stale-issue-message: 'This Issue has been automatically marked as "stale" because it has not had recent activity (for 15 days). It will be closed if no further activity occurs. Thanks for the feedback.' + stale-pr-message: 'This Pull Request has been automatically marked as "stale" because it has not had recent activity (for 15 days). It will be closed if no further activity occurs. Thank you for your contribution.' + close-issue-message: 'Due to the lack of activity in the last 5 days since it was marked as "stale", we proceed to close this Issue. Do not hesitate to reopen it later if necessary.' + close-pr-message: 'Due to the lack of activity in the last 5 days since it was marked as "stale", we proceed to close this Pull Request. Do not hesitate to reopen it later if necessary.' + days-before-stale: 15 + days-before-close: 5 + exempt-issue-labels: 'on-hold' + exempt-pr-labels: 'on-hold' diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 00000000..48beb02e --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,17 @@ +# Contributor Code of Conduct + +As contributors and maintainers of this project, we pledge to respect everyone who contributes by posting issues, updating documentation, submitting pull requests, providing feedback in comments, and any other activities. + +Communication through any of Bitnami's channels (GitHub, mailing lists, Twitter, and so on) must be constructive and never resort to personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct. + +We promise to extend courtesy and respect to everyone involved in this project, regardless of gender, gender identity, sexual orientation, disability, age, race, ethnicity, religion, or level of experience. We expect anyone contributing to this project to do the same. + +If any member of the community violates this code of conduct, the maintainers of this project may take action, including removing issues, comments, and PRs or blocking accounts, as deemed appropriate. + +If you are subjected to or witness unacceptable behavior, or have any other concerns, please communicate with us. + +If you have suggestions to improve this Code of Conduct, please submit an issue or PR. + +**Attribution** + +This Code of Conduct is adapted from the Angular project available at this page: https://github.com/angular/code-of-conduct/blob/master/CODE_OF_CONDUCT.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..b4270435 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,27 @@ +# Contributing Guidelines + +Contributions are welcome via GitHub Pull Requests. This document outlines the process to help get your contribution accepted. + +Any type of contribution is welcome: new features, bug fixes, documentation improvements, etc. + +## How to Contribute + +1. Fork this repository, develop, and test your changes. +2. Submit a pull request. + +### Requirements + +When submitting a PR make sure that: +- It must pass CI jobs for linting and test the changes (if any). +- It must follow [container best practices](https://engineering.bitnami.com/articles/best-practices-writing-a-dockerfile.html). +- The title of the PR is clear enough. +- If necessary, add information to the repository's `README.md`. + +### PR Approval and Release Process + +1. Changes are manually reviewed by Bitnami team members usually within a business day. +2. Once the changes are accepted, the PR is tested (if needed) into the Bitnami CI pipeline, the container is deployed and tested (verification and functional tests) using docker-compose and Helm (if there is an associated Helm Chart). +3. The PR is merged by the reviewer(s) in the GitHub `master` branch. +4. Then our CI/CD system is going to push the container image to the different registries including the recently merged changes. + +***NOTE***: Please note that, in terms of time, may be a slight difference between the appearance of the code in GitHub and the image with the changes in the different registries. diff --git a/Dockerfile b/Dockerfile index 391af319..863bb5c1 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,16 +1,54 @@ -FROM bitnami/base-apps-ubuntu:14.04 -MAINTAINER Bitnami +FROM docker.io/bitnami/minideb:buster +LABEL maintainer "Bitnami " -ENV BITNAMI_APP_NAME=drupal \ - BITNAMI_APP_VERSION=8.0.2-0 \ - BITNAMI_APP_USER=bitnami \ - BITNAMI_APPLICATION_USER=user \ - BITNAMI_APPLICATION_PASSWORD=bitnami \ - IS_BITNAMI_STACK=1 +ENV HOME="/" \ + OS_ARCH="amd64" \ + OS_FLAVOUR="debian-10" \ + OS_NAME="linux" -#Download latest Drupal Stack from bitnami.com -RUN $BITNAMI_PREFIX/install.sh \ - --base_user $BITNAMI_APPLICATION_USER --base_password $BITNAMI_APPLICATION_PASSWORD --apache_mpm_mode event --enable_phpfpm 1 --logrotate_install 1 && \ - rm $BITNAMI_PREFIX/install.sh +COPY prebuildfs / +# Install required system packages and dependencies +RUN install_packages acl ca-certificates curl dirmngr gnupg gzip libargon2-1 libaudit1 libbsd0 libbz2-1.0 libc6 libcap-ng0 libcom-err2 libcurl4 libexpat1 libffi6 libfftw3-double3 libfontconfig1 libfreetype6 libgcc1 libgcrypt20 libglib2.0-0 libgmp10 libgnutls30 libgomp1 libgpg-error0 libgssapi-krb5-2 libhogweed4 libicu63 libidn2-0 libjemalloc2 libjpeg62-turbo libk5crypto3 libkeyutils1 libkrb5-3 libkrb5support0 liblcms2-2 libldap-2.4-2 liblqr-1-0 libltdl7 liblzma5 libmagickcore-6.q16-6 libmagickwand-6.q16-6 libmcrypt4 libmemcached11 libmemcachedutil2 libncurses6 libnettle6 libnghttp2-14 libp11-kit0 libpam0g libpcre3 libpng16-16 libpq5 libpsl5 libreadline7 librtmp1 libsasl2-2 libsodium23 libsqlite3-0 libssh2-1 libssl1.1 libstdc++6 libsybdb5 libtasn1-6 libtidy5deb1 libtinfo6 libunistring2 libuuid1 libwebp6 libx11-6 libxau6 libxcb1 libxdmcp6 libxext6 libxml2 libxslt1.1 libzip4 procps tar unzip zlib1g +RUN . /opt/bitnami/scripts/libcomponent.sh && component_unpack "php" "7.3.28-0" --checksum 029ca7c2678b4ccfb07db3b4ad18724070e0f49528ad17b42bbcf6b20620e574 +RUN . /opt/bitnami/scripts/libcomponent.sh && component_unpack "apache" "2.4.46-7" --checksum cfb1835e471967ec5a6df8c622bdd907be03fb5b57b4f86f68eb7b73fe0f6be3 +RUN . /opt/bitnami/scripts/libcomponent.sh && component_unpack "mysql-client" "10.3.29-0" --checksum 5bf8f1ed022c8ad75a4db5b8b72ae54ce427bff628d7e4025c5b5e67b876708d +RUN . /opt/bitnami/scripts/libcomponent.sh && component_unpack "libphp" "7.3.28-0" --checksum 70777f4c71ed24d033410bb3eaf4475d12aec111b971d7a3ed3f6935db72ed51 +RUN . /opt/bitnami/scripts/libcomponent.sh && component_unpack "render-template" "1.0.0-3" --checksum 8179ad1371c9a7d897fe3b1bf53bbe763f94edafef19acad2498dd48b3674efe +RUN . /opt/bitnami/scripts/libcomponent.sh && component_unpack "gosu" "1.12.0-2" --checksum 4d858ac600c38af8de454c27b7f65c0074ec3069880cb16d259a6e40a46bbc50 +RUN . /opt/bitnami/scripts/libcomponent.sh && component_unpack "drupal" "9.1.9-0" --checksum 7856ef6b22d4e87f5776cb9607e09b14eb629a367dbc53ac7560a8dec4d7fca7 +RUN chmod g+rwX /opt/bitnami -EXPOSE 80 443 22 +COPY rootfs / +RUN /opt/bitnami/scripts/php/postunpack.sh +RUN /opt/bitnami/scripts/apache/postunpack.sh +RUN /opt/bitnami/scripts/apache-modphp/postunpack.sh +RUN /opt/bitnami/scripts/drupal/postunpack.sh +RUN /opt/bitnami/scripts/mysql-client/postunpack.sh +ENV ALLOW_EMPTY_PASSWORD="no" \ + APACHE_ENABLE_CUSTOM_PORTS="no" \ + APACHE_HTTPS_PORT_NUMBER="" \ + APACHE_HTTP_PORT_NUMBER="" \ + BITNAMI_APP_NAME="drupal" \ + BITNAMI_IMAGE_VERSION="9.1.9-debian-10-r6" \ + MARIADB_HOST="mariadb" \ + MARIADB_PORT_NUMBER="3306" \ + MARIADB_ROOT_PASSWORD="" \ + MARIADB_ROOT_USER="root" \ + MYSQL_CLIENT_CREATE_DATABASE_NAME="" \ + MYSQL_CLIENT_CREATE_DATABASE_PASSWORD="" \ + MYSQL_CLIENT_CREATE_DATABASE_PRIVILEGES="ALL" \ + MYSQL_CLIENT_CREATE_DATABASE_USER="" \ + MYSQL_CLIENT_ENABLE_SSL="no" \ + MYSQL_CLIENT_SSL_CA_FILE="" \ + PATH="/opt/bitnami/php/bin:/opt/bitnami/php/sbin:/opt/bitnami/apache/bin:/opt/bitnami/mysql/bin:/opt/bitnami/common/bin:/opt/bitnami/drupal/vendor/bin:$PATH" + +EXPOSE 8080 8443 + +## Install 'vim' +USER 0 # Required to perform privileged actions +RUN install_packages vim nano +#USER 1001 # Revert to the original non-root user + +USER 1001 +ENTRYPOINT [ "/opt/bitnami/scripts/drupal/entrypoint.sh" ] +CMD [ "/opt/bitnami/scripts/apache/run.sh" ] diff --git a/LICENSE b/LICENSE index c21958cf..c850fde3 100644 --- a/LICENSE +++ b/LICENSE @@ -1,4 +1,4 @@ -Copyright 2015 Bitnami +Copyright (c) 2015-2021 Bitnami Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. diff --git a/README.md b/README.md index 389013fb..3354400f 100644 --- a/README.md +++ b/README.md @@ -1,132 +1,530 @@ -[![Build Status](http://bitnami-container-builds.bitnamiapp.com/jenkins/buildStatus/icon?job=docker-drupal)](http://bitnami-container-builds.bitnamiapp.com/jenkins/job/docker-drupal/) - # Bitnami Docker Image for Drupal -This is an all-in-one container for [Bitnami Drupal Stack](https://bitnami.com/stack/drupal). It includes all the required dependencies to run Drupal in a container in less than 1 minute. -# TLDR -``` -docker run --name=drupal -p 80:80 -p 443:443 bitnami/drupal +## What is Drupal? + +> Drupal is one of the most versatile open source content management systems on the market. Drupal is built for high performance and is scalable to many servers, has easy integration via REST, JSON, SOAP and other formats, and features a whopping 15,000 plugins to extend and customize the application for just about any type of website. + +[https://www.drupal.org/](https://www.drupal.org/) + +## TL;DR + +```console +$ curl -sSL https://raw.githubusercontent.com/bitnami/bitnami-docker-drupal/master/docker-compose.yml > docker-compose.yml +$ docker-compose up -d ``` -The application is configured with default credentials `user` / `bitnami`. -# Get this image +You can find the default credentials and available configuration options in the [Environment Variables](#environment-variables) section. + +## Why use Bitnami Images? + +* Bitnami closely tracks upstream source changes and promptly publishes new versions of this image using our automated systems. +* With Bitnami images the latest bug fixes and features are available as soon as possible. +* Bitnami containers, virtual machines and cloud images use the same components and configuration approach - making it easy to switch between formats based on your project needs. +* All our images are based on [minideb](https://github.com/bitnami/minideb) a minimalist Debian based container image which gives you a small base container image and the familiarity of a leading Linux distribution. +* All Bitnami images available in Docker Hub are signed with [Docker Content Trust (DCT)](https://docs.docker.com/engine/security/trust/content_trust/). You can use `DOCKER_CONTENT_TRUST=1` to verify the integrity of the images. +* Bitnami container images are released daily with the latest distribution packages available. + +> This [CVE scan report](https://quay.io/repository/bitnami/drupal?tab=tags) contains a security report with all open CVEs. To get the list of actionable security issues, find the "latest" tag, click the vulnerability report link under the corresponding "Security scan" field and then select the "Only show fixable" filter on the next page. + +## Why use a non-root container? + +Non-root container images add an extra layer of security and are generally recommended for production environments. However, because they run as a non-root user, privileged tasks are typically off-limits. Learn more about non-root containers [in our docs](https://docs.bitnami.com/tutorials/work-with-non-root-containers/). + +## How to deploy Drupal in Kubernetes? + +Deploying Bitnami applications as Helm Charts is the easiest way to get started with our applications on Kubernetes. Read more about the installation in the [Bitnami Drupal Chart GitHub repository](https://github.com/bitnami/charts/tree/master/bitnami/drupal). -The recommended way to get the Bitnami Docker Image for Drupal is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/drupal). +Bitnami containers can be used with [Kubeapps](https://kubeapps.com/) for deployment and management of Helm Charts in clusters. -```bash -docker pull bitnami/drupal:latest +## Supported tags and respective `Dockerfile` links + +Learn more about the Bitnami tagging policy and the difference between rolling tags and immutable tags [in our documentation page](https://docs.bitnami.com/tutorials/understand-rolling-tags-containers/). + + +* [`9`, `9-debian-10`, `9.1.9`, `9.1.9-debian-10-r6`, `latest` (9/debian-10/Dockerfile)](https://github.com/bitnami/bitnami-docker-drupal/blob/9.1.9-debian-10-r6/9/debian-10/Dockerfile) +* [`8`, `8-debian-10`, `8.9.16`, `8.9.16-debian-10-r4` (8/debian-10/Dockerfile)](https://github.com/bitnami/bitnami-docker-drupal/blob/8.9.16-debian-10-r4/8/debian-10/Dockerfile) + +Subscribe to project updates by watching the [bitnami/drupal GitHub repo](https://github.com/bitnami/bitnami-docker-drupal). + +## Get this image + +The recommended way to get the Bitnami Drupal Docker Image is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/drupal). + +```console +$ docker pull bitnami/drupal:latest ``` -To use a specific version, you can pull a versioned tag. You can view the -[list of available versions](https://hub.docker.com/r/bitnami/drupal/tags/) -in the Docker Hub Registry. +To use a specific version, you can pull a versioned tag. You can view the [list of available versions](https://hub.docker.com/r/bitnami/drupal/tags/) in the Docker Hub Registry. -```bash -docker pull bitnami/drupal:[TAG] +```console +$ docker pull bitnami/drupal:[TAG] ``` If you wish, you can also build the image yourself. -```bash -git clone https://github.com/bitnami/bitnami-docker-drupal.git -cd bitnami-docker-drupal -docker build -t bitnami/drupal . +```console +$ docker build -t bitnami/drupal:latest 'https://github.com/bitnami/bitnami-docker-drupal.git#master:9/debian-10' ``` -# Configuration +## How to use this image + +Drupal requires access to a MySQL or MariaDB database to store information. We'll use the [Bitnami Docker Image for MariaDB](https://www.github.com/bitnami/bitnami-docker-mariadb) for the database requirements. + +### Run the application using Docker Compose -## Application credentials +The main folder of this repository contains a functional [`docker-compose.yml`](https://github.com/bitnami/bitnami-docker-drupal/blob/master/docker-compose.yml) file. Run the application using it as shown below: -Running the container in foreground will show some information about to access your application. If you started the -container with the flag `-d` you can retrieve it by running `docker logs drupal`. +```console +$ curl -sSL https://raw.githubusercontent.com/bitnami/bitnami-docker-drupal/master/docker-compose.yml > docker-compose.yml +$ docker-compose up -d +``` -In case you want to change the default user and password for Drupal you would need to build the image by your own following [this steps](#get-this-image) -and modifying the line `BITNAMI_APPLICATION_PASSWORD=bitnami` in the Dockerfile before starting the build. +### Using the Docker Command Line -## Application files (optional) +If you want to run the application manually instead of using `docker-compose`, these are the basic steps you need to run: -If you want to make the application files accessible for modifying them you could use a volume to share these files with the host. This can be done by adding some extra options to the `docker run` command: +#### Step 1: Create a network +```console +$ docker network create drupal-network ``` -docker run --name=drupal -v ~/drupal-files:/opt/bitnami/apps -e USER_UID=`id -u` -p 80:80 -p 443:443 bitnami/drupal + +#### Step 2: Create a volume for MariaDB persistence and create a MariaDB container + +```console +$ docker volume create --name mariadb_data +$ docker run -d --name mariadb \ + --env ALLOW_EMPTY_PASSWORD=yes \ + --env MARIADB_USER=bn_drupal \ + --env MARIADB_PASSWORD=bitnami \ + --env MARIADB_DATABASE=bitnami_drupal \ + --network drupal-network \ + --volume mariadb_data:/bitnami/mariadb \ + bitnami/mariadb:latest ``` -This will create a folder `drupal-files` in your home directory exposing the folder `/opt/bitnami/apps` into the container. This folder should be empty or non existent when creating the container. -NOTE: Currently is only possible to expose `/opt/bitnami/apps`. Also setting the variable USER_UID will make the files modifiable by your current user. +#### Step 3: Create volumes for Drupal persistence and launch the container + +```console +$ docker volume create --name drupal_data +$ docker run -d --name drupal \ + -p 8080:8080 -p 8443:8443 \ + --env ALLOW_EMPTY_PASSWORD=yes \ + --env DRUPAL_DATABASE_USER=bn_drupal \ + --env DRUPAL_DATABASE_PASSWORD=bitnami \ + --env DRUPAL_DATABASE_NAME=bitnami_drupal \ + --network drupal-network \ + --volume drupal_data:/bitnami/drupal \ + bitnami/drupal:latest +``` -# Logging +Access your application at *http://your-ip:8080/* -The Bitnami Docker Image for Drupal will write to stdout the information about the initialization process so it is accesible by running the command `docker logs drupal`. +## Persisting your application -In order to check the logs from services as the HTTP server or databases you could use the following commands: +If you remove the container all your data will be lost, and the next time you run the image the database will be reinitialized. To avoid this loss of data, you should mount a volume that will persist even after the container is removed. +For persistence you should mount a directory at the `/bitnami/drupal` path. If the mounted directory is empty, it will be initialized on the first run. Additionally you should mount a volume for persistence of the MariaDB data](https://github.com/bitnami/bitnami-docker-mariadb#persisting-your-database). + +The above examples define the Docker volumes named mariadb_data and drupal_data. The Drupal application state will persist as long as volumes are not removed. + +To avoid inadvertent removal of volumes, you can mount host directories as data volumes. Alternatively you can make use of volume plugins to host the volume data. + +### Mount host directories as data volumes with Docker Compose + +This requires a minor change to the [`docker-compose.yml`](https://github.com/bitnami/bitnami-docker-drupal/blob/master/docker-compose.yml) file present in this repository: + +```diff + mariadb: + ... + volumes: +- - 'mariadb_data:/bitnami/mariadb' ++ - /path/to/mariadb-persistence:/bitnami/mariadb + ... + drupal: + ... + volumes: +- - 'drupal_data:/bitnami/drupal' ++ - /path/to/drupal-persistence:/bitnami/drupal + ... +-volumes: +- mariadb_data: +- driver: local +- drupal_data: +- driver: local +``` + +> NOTE: As this is a non-root container, the mounted files and directories must have the proper permissions for the UID `1001`. + +### Mount host directories as data volumes using the Docker command line + +#### Step 1: Create a network (if it does not exist) + +```console +$ docker network create drupal-network +``` + +#### Step 2. Create a MariaDB container with host volume + +```console +$ docker run -d --name mariadb \ + --env ALLOW_EMPTY_PASSWORD=yes \ + --env MARIADB_USER=bn_drupal \ + --env MARIADB_PASSWORD=bitnami \ + --env MARIADB_DATABASE=bitnami_drupal \ + --network drupal-network \ + --volume /path/to/mariadb-persistence:/bitnami/mariadb \ + bitnami/mariadb:latest ``` -docker exec -it drupal /opt/bitnami/scripts/logs.sh apache -docker exec -it drupal /opt/bitnami/scripts/logs.sh mysql + +#### Step 3. Create the Drupal container with host volumes + +```console +$ docker run -d --name drupal \ + -p 8080:8080 -p 8443:8443 \ + --env ALLOW_EMPTY_PASSWORD=yes \ + --env DRUPAL_DATABASE_USER=bn_drupal \ + --env DRUPAL_DATABASE_PASSWORD=bitnami \ + --env DRUPAL_DATABASE_NAME=bitnami_drupal \ + --network drupal-network \ + --volume /path/to/drupal-persistence:/bitnami/drupal \ + bitnami/drupal:latest ``` -# Maintenance +## Configuration + +### Environment variables + +When you start the Drupal image, you can adjust the configuration of the instance by passing one or more environment variables either on the docker-compose file or on the `docker run` command line. If you want to add a new environment variable: -## Backing up your container + * For docker-compose add the variable name and value under the application section in the [`docker-compose.yml`](https://github.com/bitnami/bitnami-docker-drupal/blob/master/docker-compose.yml) file present in this repository: -In order to backup your containers you could pack the `/opt/bitnami` directory and copy it to the host by running the following commands: +```yaml +drupal: + ... + environment: + - DRUPAL_PASSWORD=my_password + ... +``` + * For manual execution add a `--env` option with each variable and value: + + ```console + $ docker run -d --name drupal -p 80:8080 -p 443:8443 \ + --env DRUPAL_PASSWORD=my_password \ + --network drupal-tier \ + --volume /path/to/drupal-persistence:/bitnami \ + bitnami/drupal:latest + ``` + +Available environment variables: + +##### User and Site configuration + +- `DRUPAL_PROFILE`: Drupal installation profile. Default: **standard** +- `DRUPAL_SITE_NAME`: Drupal blog name. Default: **My blog** +- `DRUPAL_SKIP_BOOTSTRAP`: Whether to perform initial bootstrapping for the application. Default: **no** +- `DRUPAL_ENABLE_MODULES`: Comma or space separated list of installed modules to enable during the first initialization. No defaults. +- `DRUPAL_USERNAME`: Drupal application username. Default: **user** +- `DRUPAL_PASSWORD`: Drupal application password. Default: **bitnami** +- `DRUPAL_EMAIL`: Drupal application email. Default: **user@example.com** +- `DRUPAL_CONFIG_SYNC_DIR`: Drupal sync configuration directory location. Only used when `DRUPAL_SKIP_BOOTSTRAP` is enabled. No defaults. +- `DRUPAL_HASH_SALT`: Drupal string used to generate random values. Only used when `DRUPAL_SKIP_BOOTSTRAP` is enabled. No defaults. + +##### Use an existing database + +- `DRUPAL_DATABASE_HOST`: Hostname for MariaDB server. Default: **mariadb** +- `DRUPAL_DATABASE_PORT_NUMBER`: Port used by MariaDB server. Default: **3306** +- `DRUPAL_DATABASE_NAME`: Database name that Drupal will use to connect with the database. Default: **bitnami_drupal** +- `DRUPAL_DATABASE_USER`: Database user that Drupal will use to connect with the database. Default: **bn_drupal** +- `DRUPAL_DATABASE_PASSWORD`: Database password that Drupal will use to connect with the database. No defaults. +- `DRUPAL_DATABASE_TLS_CA_FILE`: TLS CA certificate for connections. No defaults. +- `ALLOW_EMPTY_PASSWORD`: It can be used to allow blank passwords. Default: **no** + +##### Create a database for Drupal using mysql-client + +- `MYSQL_CLIENT_FLAVOR`: SQL database flavor. Valid values: `mariadb` or `mysql`. Default: **mariadb**. +- `MYSQL_CLIENT_DATABASE_HOST`: Hostname for MariaDB server. Default: **mariadb** +- `MYSQL_CLIENT_DATABASE_PORT_NUMBER`: Port used by MariaDB server. Default: **3306** +- `MYSQL_CLIENT_DATABASE_ROOT_USER`: Database admin user. Default: **root** +- `MYSQL_CLIENT_DATABASE_ROOT_PASSWORD`: Database password for the database admin user. No defaults. +- `MYSQL_CLIENT_CREATE_DATABASE_NAME`: New database to be created by the mysql client module. No defaults. +- `MYSQL_CLIENT_CREATE_DATABASE_USER`: New database user to be created by the mysql client module. No defaults. +- `MYSQL_CLIENT_CREATE_DATABASE_PASSWORD`: Database password for the `MYSQL_CLIENT_CREATE_DATABASE_USER` user. No defaults. +- `MYSQL_CLIENT_CREATE_DATABASE_CHARACTER_SET`: Character set to use for the new database. No defaults. +- `MYSQL_CLIENT_CREATE_DATABASE_COLLATE`: Database collation to use for the new database. No defaults. +- `MYSQL_CLIENT_CREATE_DATABASE_PRIVILEGES`: Database privileges to grant for the user specified in `MYSQL_CLIENT_CREATE_DATABASE_USER` to the database specified in `MYSQL_CLIENT_CREATE_DATABASE_NAME`. No defaults. +- `MYSQL_CLIENT_ENABLE_SSL_WRAPPER`: Whether to force SSL connections to the database via the `mysql` CLI tool. Useful for applications that rely on the CLI instead of APIs. Default: **no** +- `MYSQL_CLIENT_ENABLE_SSL`: Whether to force SSL connections for the database. Default: **no** +- `MYSQL_CLIENT_SSL_CA_FILE`: Path to the SSL CA file for the new database. No defaults +- `MYSQL_CLIENT_SSL_CERT_FILE`: Path to the SSL CA file for the new database. No defaults +- `MYSQL_CLIENT_SSL_KEY_FILE`: Path to the SSL CA file for the new database. No defaults +- `ALLOW_EMPTY_PASSWORD`: It can be used to allow blank passwords. Default: **no** + +##### SMTP Configuration + +To configure Drupal to send email using SMTP you can set the following environment variables: + +- `DRUPAL_SMTP_HOST`: SMTP host. +- `DRUPAL_SMTP_PORT`: SMTP port. +- `DRUPAL_SMTP_USER`: SMTP account user. +- `DRUPAL_SMTP_PASSWORD`: SMTP account password. +- `DRUPAL_SMTP_PROTOCOL`: SMTP protocol. (standard, tls, ssl). + +##### PHP configuration + +- `PHP_ENABLE_OPCACHE`: Enable OPcache for PHP scripts. No default. +- `PHP_EXPOSE_PHP`: Enables HTTP header with PHP version. No default. +- `PHP_MAX_EXECUTION_TIME`: Maximum execution time for PHP scripts. No default. +- `PHP_MAX_INPUT_TIME`: Maximum input time for PHP scripts. No default. +- `PHP_MAX_INPUT_VARS`: Maximum amount of input variables for PHP scripts. No default. +- `PHP_MEMORY_LIMIT`: Memory limit for PHP scripts. Default: **256M** +- `PHP_POST_MAX_SIZE`: Maximum size for PHP POST requests. No default. +- `PHP_UPLOAD_MAX_FILESIZE`: Maximum file size for PHP uploads. No default. + +##### Example + +This would be an example of SMTP configuration using a Gmail account: + + * Modify the [`docker-compose.yml`](https://github.com/bitnami/bitnami-docker-drupal/blob/master/docker-compose.yml) file present in this repository: + +```yaml + drupal: + ... + environment: + - DRUPAL_DATABASE_USER=bn_drupal + - DRUPAL_DATABASE_NAME=bitnami_drupal + - ALLOW_EMPTY_PASSWORD=yes + - DRUPAL_SMTP_HOST=smtp.gmail.com + - DRUPAL_SMTP_PORT=587 + - DRUPAL_SMTP_USER=your_email@gmail.com + - DRUPAL_SMTP_PASSWORD=your_password + - DRUPAL_SMTP_PROTOCOL=tls + ... +``` + * For manual execution: + + ```console + $ docker run -d --name drupal -p 80:8080 -p 443:8443 \ + --env DRUPAL_DATABASE_USER=bn_drupal \ + --env DRUPAL_DATABASE_NAME=bitnami_drupal \ + --env DRUPAL_SMTP_HOST=smtp.gmail.com \ + --env DRUPAL_SMTP_PORT=587 \ + --env DRUPAL_SMTP_USER=your_email@gmail.com \ + --env DRUPAL_SMTP_PASSWORD=your_password \ + --env DRUPAL_SMTP_PROTOCOL=tls \ + --network drupal-tier \ + --volume /path/to/drupal-persistence:/bitnami \ + bitnami/drupal:latest + ``` + +## Logging + +The Bitnami Drupal Docker image sends the container logs to `stdout`. To view the logs: + +```console +$ docker logs drupal ``` -docker exec -it drupal /services.sh stop -docker exec -it drupal tar -pczvf /tmp/drupal-backup.tar.gz /opt/bitnami -docker exec -it drupal /services.sh start -docker cp drupal:/tmp/drupal-backup.tar.gz /path/to/destination/directory + +Or using Docker Compose: + +```console +$ docker-compose logs drupal ``` -NOTE: this commands assume that your container is named `drupal`. -## Restoring a backup +You can configure the containers [logging driver](https://docs.docker.com/engine/admin/logging/overview/) using the `--log-driver` option if you wish to consume the container logs differently. In the default configuration docker uses the `json-file` driver. + +## Maintenance + +### Backing up your container -In order to restore a previously created backup of your container, you woild need to copy the compressed file into the container and uncompress it by following commands: +To backup your data, configuration and logs, follow these simple steps: +#### Step 1: Stop the currently running container + +```console +$ docker stop drupal ``` -docker cp /path/to/drupal-backup.tar.gz drupal:/tmp/drupal-backup.tar.gz -docker exec -it drupal /services.sh stop -docker exec -it drupal tar -xzvf /tmp/drupal-backup.tar.gz -docker exec -it drupal /services.sh start + +Or using Docker Compose: + +```console +$ docker-compose stop drupal ``` -NOTE: this commands assume that your container is named `drupal`. -## Upgrade this image +#### Step 2: Run the backup command -This image is intended for development/testing purposes. For this reason, upgrading the individual components is not supported. +We need to mount two volumes in a container we will use to create the backup: a directory on your host to store the backup in, and the volumes from the container we just stopped so we can access the data. -# Testing +```console +$ docker run --rm -v /path/to/drupal-backups:/backups --volumes-from drupal busybox \ + cp -a /bitnami/drupal /backups/latest +``` + +### Restoring a backup + +Restoring a backup is as simple as mounting the backup as volumes in the containers. + +For the MariaDB database container: + +```diff + $ docker run -d --name mariadb \ + ... +- --volume /path/to/mariadb-persistence:/bitnami/mariadb \ ++ --volume /path/to/mariadb-backups/latest:/bitnami/mariadb \ + bitnami/mariadb:latest +``` + +For the Drupal container: + +```diff + $ docker run -d --name drupal \ + ... +- --volume /path/to/drupal-persistence:/bitnami/drupal \ ++ --volume /path/to/drupal-backups/latest:/bitnami/drupal \ + bitnami/drupal:latest +``` + +### Upgrade this image + +Bitnami provides up-to-date versions of MariaDB and Drupal, including security patches, soon after they are made upstream. We recommend that you follow these steps to upgrade your container. We will cover here the upgrade of the Drupal container. For the MariaDB upgrade see: https://github.com/bitnami/bitnami-docker-mariadb/blob/master/README.md#upgrade-this-image + +#### Step 1: Get the updated image + +```console +$ docker pull bitnami/drupal:latest +``` + +#### Step 2: Stop the running container + +Stop the currently running container using the command + +```console +$ docker-compose stop drupal +``` + +#### Step 3: Take a snapshot of the application state + +Follow the steps in [Backing up your container](#backing-up-your-container) to take a snapshot of the current application state. + +#### Step 4: Remove the currently running container + +Remove the currently running container by executing the following command: + +```console +docker-compose rm -v drupal +``` -This image is tested for expected runtime behavior, using the -[Bats](https://github.com/sstephenson/bats) testing framework. You can run the tests on your machine -using the `bats` command. +#### Step 5: Run the new image +Update the image tag in `docker-compose.yml` and re-create your container with the new image: + +```console +$ docker-compose up -d +``` + +## Customize this image + +The Bitnami Drupal Docker image is designed to be extended so it can be used as the base image for your custom web applications. + +### Extend this image + +Before extending this image, please note there are certain configuration settings you can modify using the original image: + +- Settings that can be adapted using environment variables. For instance, you can change the ports used by Apache for HTTP and HTTPS, by setting the environment variables `APACHE_HTTP_PORT_NUMBER` and `APACHE_HTTPS_PORT_NUMBER` respectively. +- [Adding custom virtual hosts](https://github.com/bitnami/bitnami-docker-apache#adding-custom-virtual-hosts). +- [Replacing the 'httpd.conf' file](https://github.com/bitnami/bitnami-docker-apache#full-configuration). +- [Using custom SSL certificates](https://github.com/bitnami/bitnami-docker-apache#using-custom-ssl-certificates). + +If your desired customizations cannot be covered using the methods mentioned above, extend the image. To do so, create your own image using a Dockerfile with the format below: + +```Dockerfile +FROM bitnami/drupal +## Put your customizations below +... +``` + +Here is an example of extending the image with the following modifications: + +- Install the `vim` editor +- Modify the Apache configuration file +- Modify the ports used by Apache + +```Dockerfile +FROM bitnami/drupal +LABEL maintainer "Bitnami " + +## Change user to perform privileged actions +USER 0 +## Install 'vim' +RUN install_packages vim +## Revert to the original non-root user +USER 1001 + +## Enable mod_ratelimit module +RUN sed -i -r 's/#LoadModule ratelimit_module/LoadModule ratelimit_module/' /opt/bitnami/apache/conf/httpd.conf + +## Modify the ports used by Apache by default +# It is also possible to change these environment variables at runtime +ENV APACHE_HTTP_PORT_NUMBER=8181 +ENV APACHE_HTTPS_PORT_NUMBER=8143 +EXPOSE 8181 8143 ``` -bats test.sh + +Based on the extended image, you can update the [`docker-compose.yml`](https://github.com/bitnami/bitnami-docker-drupal/blob/master/docker-compose.yml) file present in this repository to add other features: + +```diff + drupal: +- image: bitnami/drupal:latest ++ build: . + ports: +- - '80:8080' +- - '443:8443' ++ - '80:8181' ++ - '443:8143' + environment: ++ - PHP_MEMORY_LIMIT=512m + ... ``` +# Notable Changes + +## 8.9.2-debian-10-r3 and 9.0.2-debian-10-r3 + +- The size of the container image has been decreased. +- The configuration logic is now based on Bash scripts in the *rootfs/* folder. +- The Drupal container image has been migrated to a "non-root" user approach. Previously the container ran as the `root` user and the Apache daemon was started as the `daemon` user. From now on, both the container and the Apache daemon run as user `1001`. You can revert this behavior by changing `USER 1001` to `USER root` in the Dockerfile, or `user: root` in `docker-compose.yml`. Consequences: + - The HTTP/HTTPS ports exposed by the container are now `8080/8443` instead of `80/443`. + - Backwards compatibility is not guaranteed when data is persisted using docker or docker-compose. We highly recommend migrating the Drupal site by exporting its content, and importing it on a new Drupal container. Follow the steps in [Backing up your container](#backing-up-your-container) and [Restoring a backup](#restoring-a-backup) to migrate the data between the old and new container. + +## 8.7.2-debian-9-r8 and 8.7.2-ol-7-r8 + +- This image has been adapted so it's easier to customize. See the [Customize this image](#customize-this-image) section for more information. +- The Apache configuration volume (`/bitnami/apache`) has been deprecated, and support for this feature will be dropped in the near future. Until then, the container will enable the Apache configuration from that volume if it exists. By default, and if the configuration volume does not exist, the configuration files will be regenerated each time the container is created. Users wanting to apply custom Apache configuration files are advised to mount a volume for the configuration at `/opt/bitnami/apache/conf`, or mount specific configuration files individually. +- The PHP configuration volume (`/bitnami/php`) has been deprecated, and support for this feature will be dropped in the near future. Until then, the container will enable the PHP configuration from that volume if it exists. By default, and if the configuration volume does not exist, the configuration files will be regenerated each time the container is created. Users wanting to apply custom PHP configuration files are advised to mount a volume for the configuration at `/opt/bitnami/php/conf`, or mount specific configuration files individually. +- Enabling custom Apache certificates by placing them at `/opt/bitnami/apache/certs` has been deprecated, and support for this functionality will be dropped in the near future. Users wanting to enable custom certificates are advised to mount their certificate files on top of the preconfigured ones at `/certs`. + +## 8.5.3-r1 + +- The drupal container now uses drush to install and update the Drupal application. + # Contributing -We'd love for you to contribute to this container. You can request new features by creating an -[issue](https://github.com/bitnami/bitnami-docker-drupal/issues), or submit a -[pull request](https://github.com/bitnami/bitnami-docker-drupal/pulls) with your contribution. +We'd love for you to contribute to this container. You can request new features by creating an [issue](https://github.com/bitnami/bitnami-docker-drupal/issues), or submit a [pull request](https://github.com/bitnami/bitnami-docker-drupal/pulls) with your contribution. # Issues -If you encountered a problem running this container, you can file an -[issue](https://github.com/bitnami/bitnami-docker-drupal/issues). For us to provide better support, -be sure to include the following information in your issue: +If you encountered a problem running this container, you can file an [issue](https://github.com/bitnami/bitnami-docker-drupal/issues). For us to provide better support, be sure to include the following information in your issue: - Host OS and version - Docker version (`docker version`) - Output of `docker info` -- Version of this container (`echo $BITNAMI_APP_VERSION` inside the container) -- The command you used to run the container, and any relevant output you saw (masking any sensitive -information) +- Version of this container +- The command you used to run the container, and any relevant output you saw (masking any sensitive information) # License -Copyright 2015 Bitnami +Copyright (c) 2021 Bitnami Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. diff --git a/docker-compose.yml b/docker-compose.yml new file mode 100644 index 00000000..f3cee1b6 --- /dev/null +++ b/docker-compose.yml @@ -0,0 +1,30 @@ +version: '2' +services: + mariadb: + image: docker.io/bitnami/mariadb:10.5 + environment: + - ALLOW_EMPTY_PASSWORD=yes + - MARIADB_USER=bn_drupal + - MARIADB_DATABASE=bitnami_drupal + volumes: + - 'mariadb_data:/bitnami/mariadb' + drupal: + image: docker.io/bitnami/drupal:9 + ports: + - '80:8080' + - '443:8443' + environment: + - DRUPAL_DATABASE_HOST=mariadb + - DRUPAL_DATABASE_PORT_NUMBER=3306 + - DRUPAL_DATABASE_USER=bn_drupal + - DRUPAL_DATABASE_NAME=bitnami_drupal + - ALLOW_EMPTY_PASSWORD=yes + volumes: + - 'drupal_data:/bitnami/drupal' + depends_on: + - mariadb +volumes: + mariadb_data: + driver: local + drupal_data: + driver: local diff --git a/prebuildfs/opt/bitnami/.bitnami_components.json b/prebuildfs/opt/bitnami/.bitnami_components.json new file mode 100644 index 00000000..00412bb8 --- /dev/null +++ b/prebuildfs/opt/bitnami/.bitnami_components.json @@ -0,0 +1,51 @@ +{ + "apache": { + "arch": "amd64", + "digest": "cfb1835e471967ec5a6df8c622bdd907be03fb5b57b4f86f68eb7b73fe0f6be3", + "distro": "debian-10", + "type": "NAMI", + "version": "2.4.46-7" + }, + "drupal": { + "arch": "amd64", + "digest": "7856ef6b22d4e87f5776cb9607e09b14eb629a367dbc53ac7560a8dec4d7fca7", + "distro": "debian-10", + "type": "NAMI", + "version": "9.1.9-0" + }, + "gosu": { + "arch": "amd64", + "digest": "4d858ac600c38af8de454c27b7f65c0074ec3069880cb16d259a6e40a46bbc50", + "distro": "debian-10", + "type": "NAMI", + "version": "1.12.0-2" + }, + "libphp": { + "arch": "amd64", + "digest": "70777f4c71ed24d033410bb3eaf4475d12aec111b971d7a3ed3f6935db72ed51", + "distro": "debian-10", + "type": "NAMI", + "version": "7.3.28-0" + }, + "mysql-client": { + "arch": "amd64", + "digest": "5bf8f1ed022c8ad75a4db5b8b72ae54ce427bff628d7e4025c5b5e67b876708d", + "distro": "debian-10", + "type": "NAMI", + "version": "10.3.29-0" + }, + "php": { + "arch": "amd64", + "digest": "029ca7c2678b4ccfb07db3b4ad18724070e0f49528ad17b42bbcf6b20620e574", + "distro": "debian-10", + "type": "NAMI", + "version": "7.3.28-0" + }, + "render-template": { + "arch": "amd64", + "digest": "8179ad1371c9a7d897fe3b1bf53bbe763f94edafef19acad2498dd48b3674efe", + "distro": "debian-10", + "type": "NAMI", + "version": "1.0.0-3" + } +} \ No newline at end of file diff --git a/prebuildfs/opt/bitnami/licenses/licenses.txt b/prebuildfs/opt/bitnami/licenses/licenses.txt new file mode 100644 index 00000000..c76ba31f --- /dev/null +++ b/prebuildfs/opt/bitnami/licenses/licenses.txt @@ -0,0 +1,3 @@ +Bitnami containers ship with software bundles. You can find the licenses under: +/opt/bitnami/nami/COPYING +/opt/bitnami/[name-of-bundle]/licenses/[bundle-version].txt diff --git a/prebuildfs/opt/bitnami/scripts/libbitnami.sh b/prebuildfs/opt/bitnami/scripts/libbitnami.sh new file mode 100644 index 00000000..ef29e361 --- /dev/null +++ b/prebuildfs/opt/bitnami/scripts/libbitnami.sh @@ -0,0 +1,51 @@ +#!/bin/bash +# +# Bitnami custom library + +# shellcheck disable=SC1091 + +# Load Generic Libraries +. /opt/bitnami/scripts/liblog.sh + +# Constants +BOLD='\033[1m' + +# Functions + +######################## +# Print the welcome page +# Globals: +# DISABLE_WELCOME_MESSAGE +# BITNAMI_APP_NAME +# Arguments: +# None +# Returns: +# None +######################### +print_welcome_page() { + if [[ -z "${DISABLE_WELCOME_MESSAGE:-}" ]]; then + if [[ -n "$BITNAMI_APP_NAME" ]]; then + print_image_welcome_page + fi + fi +} + +######################## +# Print the welcome page for a Bitnami Docker image +# Globals: +# BITNAMI_APP_NAME +# Arguments: +# None +# Returns: +# None +######################### +print_image_welcome_page() { + local github_url="https://github.com/bitnami/bitnami-docker-${BITNAMI_APP_NAME}" + + log "" + log "${BOLD}Welcome to the Bitnami ${BITNAMI_APP_NAME} container${RESET}" + log "Subscribe to project updates by watching ${BOLD}${github_url}${RESET}" + log "Submit issues and feature requests at ${BOLD}${github_url}/issues${RESET}" + log "" +} + diff --git a/prebuildfs/opt/bitnami/scripts/libcomponent.sh b/prebuildfs/opt/bitnami/scripts/libcomponent.sh new file mode 100644 index 00000000..1d8c6bf2 --- /dev/null +++ b/prebuildfs/opt/bitnami/scripts/libcomponent.sh @@ -0,0 +1,65 @@ +#!/bin/bash +# +# Library for managing Bitnami components + +# Constants +CACHE_ROOT="/tmp/bitnami/pkg/cache" +DOWNLOAD_URL="https://downloads.bitnami.com/files/stacksmith" + +# Functions + +######################## +# Download and unpack a Bitnami package +# Globals: +# OS_NAME +# OS_ARCH +# OS_FLAVOUR +# Arguments: +# $1 - component's name +# $2 - component's version +# Returns: +# None +######################### +component_unpack() { + local name="${1:?name is required}" + local version="${2:?version is required}" + local base_name="${name}-${version}-${OS_NAME}-${OS_ARCH}-${OS_FLAVOUR}" + local package_sha256="" + local directory="/opt/bitnami" + + # Validate arguments + shift 2 + while [ "$#" -gt 0 ]; do + case "$1" in + -c|--checksum) + shift + package_sha256="${1:?missing package checksum}" + ;; + *) + echo "Invalid command line flag $1" >&2 + return 1 + ;; + esac + shift + done + + echo "Downloading $base_name package" + if [ -f "${CACHE_ROOT}/${base_name}.tar.gz" ]; then + echo "${CACHE_ROOT}/${base_name}.tar.gz already exists, skipping download." + cp "${CACHE_ROOT}/${base_name}.tar.gz" . + rm "${CACHE_ROOT}/${base_name}.tar.gz" + if [ -f "${CACHE_ROOT}/${base_name}.tar.gz.sha256" ]; then + echo "Using the local sha256 from ${CACHE_ROOT}/${base_name}.tar.gz.sha256" + package_sha256="$(< "${CACHE_ROOT}/${base_name}.tar.gz.sha256")" + rm "${CACHE_ROOT}/${base_name}.tar.gz.sha256" + fi + else + curl --remote-name --silent "${DOWNLOAD_URL}/${base_name}.tar.gz" + fi + if [ -n "$package_sha256" ]; then + echo "Verifying package integrity" + echo "$package_sha256 ${base_name}.tar.gz" | sha256sum --check - + fi + tar --directory "${directory}" --extract --gunzip --file "${base_name}.tar.gz" --no-same-owner --strip-components=2 "${base_name}/files/" + rm "${base_name}.tar.gz" +} diff --git a/prebuildfs/opt/bitnami/scripts/libfile.sh b/prebuildfs/opt/bitnami/scripts/libfile.sh new file mode 100644 index 00000000..b09575cb --- /dev/null +++ b/prebuildfs/opt/bitnami/scripts/libfile.sh @@ -0,0 +1,80 @@ +#!/bin/bash +# +# Library for managing files + +# Functions + +######################## +# Replace a regex in a file +# Arguments: +# $1 - filename +# $2 - match regex +# $3 - substitute regex +# $4 - use POSIX regex. Default: true +# Returns: +# None +######################### +replace_in_file() { + local filename="${1:?filename is required}" + local match_regex="${2:?match regex is required}" + local substitute_regex="${3:?substitute regex is required}" + local posix_regex=${4:-true} + + local result + + # We should avoid using 'sed in-place' substitutions + # 1) They are not compatible with files mounted from ConfigMap(s) + # 2) We found incompatibility issues with Debian10 and "in-place" substitutions + del=$'\001' # Use a non-printable character as a 'sed' delimiter to avoid issues + if [[ $posix_regex = true ]]; then + result="$(sed -E "s${del}${match_regex}${del}${substitute_regex}${del}g" "$filename")" + else + result="$(sed "s${del}${match_regex}${del}${substitute_regex}${del}g" "$filename")" + fi + echo "$result" > "$filename" +} + +######################## +# Remove a line in a file based on a regex +# Arguments: +# $1 - filename +# $2 - match regex +# $3 - use POSIX regex. Default: true +# Returns: +# None +######################### +remove_in_file() { + local filename="${1:?filename is required}" + local match_regex="${2:?match regex is required}" + local posix_regex=${3:-true} + local result + + # We should avoid using 'sed in-place' substitutions + # 1) They are not compatible with files mounted from ConfigMap(s) + # 2) We found incompatibility issues with Debian10 and "in-place" substitutions + if [[ $posix_regex = true ]]; then + result="$(sed -E "/$match_regex/d" "$filename")" + else + result="$(sed "/$match_regex/d" "$filename")" + fi + echo "$result" > "$filename" +} + +######################## +# Appends text after the last line matching a pattern +# Arguments: +# $1 - file +# $2 - match regex +# $3 - contents to add +# Returns: +# None +######################### +append_file_after_last_match() { + local file="${1:?missing file}" + local match_regex="${2:?missing pattern}" + local value="${3:?missing value}" + + # We read the file in reverse, replace the first match (0,/pattern/s) and then reverse the results again + result="$(tac "$file" | sed -E "0,/($match_regex)/s||${value}\n\1|" | tac)" + echo "$result" > "$file" +} diff --git a/prebuildfs/opt/bitnami/scripts/libfs.sh b/prebuildfs/opt/bitnami/scripts/libfs.sh new file mode 100644 index 00000000..ae5e2459 --- /dev/null +++ b/prebuildfs/opt/bitnami/scripts/libfs.sh @@ -0,0 +1,183 @@ +#!/bin/bash +# +# Library for file system actions + +# shellcheck disable=SC1091 + +# Load Generic Libraries +. /opt/bitnami/scripts/liblog.sh + +# Functions + +######################## +# Ensure a file/directory is owned (user and group) but the given user +# Arguments: +# $1 - filepath +# $2 - owner +# Returns: +# None +######################### +owned_by() { + local path="${1:?path is missing}" + local owner="${2:?owner is missing}" + + chown "$owner":"$owner" "$path" +} + +######################## +# Ensure a directory exists and, optionally, is owned by the given user +# Arguments: +# $1 - directory +# $2 - owner +# Returns: +# None +######################### +ensure_dir_exists() { + local dir="${1:?directory is missing}" + local owner="${2:-}" + + mkdir -p "${dir}" + if [[ -n $owner ]]; then + owned_by "$dir" "$owner" + fi +} + +######################## +# Checks whether a directory is empty or not +# arguments: +# $1 - directory +# returns: +# boolean +######################### +is_dir_empty() { + local dir="${1:?missing directory}" + + if [[ ! -e "$dir" ]] || [[ -z "$(ls -A "$dir")" ]]; then + true + else + false + fi +} + +######################## +# Checks whether a mounted directory is empty or not +# arguments: +# $1 - directory +# returns: +# boolean +######################### +is_mounted_dir_empty() { + local dir="${1:?missing directory}" + + if is_dir_empty "$dir" || find "$dir" -mindepth 1 -maxdepth 1 -not -name ".snapshot" -not -name "lost+found" -exec false {} +; then + true + else + false + fi +} + +######################## +# Checks whether a file can be written to or not +# arguments: +# $1 - file +# returns: +# boolean +######################### +is_file_writable() { + local file="${1:?missing file}" + local dir + dir="$(dirname "$file")" + + if [[ ( -f "$file" && -w "$file" ) || ( ! -f "$file" && -d "$dir" && -w "$dir" ) ]]; then + true + else + false + fi +} + +######################## +# Relativize a path +# arguments: +# $1 - path +# $2 - base +# returns: +# None +######################### +relativize() { + local -r path="${1:?missing path}" + local -r base="${2:?missing base}" + pushd "$base" >/dev/null || exit + realpath -q --no-symlinks --relative-base="$base" "$path" | sed -e 's|^/$|.|' -e 's|^/||' + popd >/dev/null || exit +} + +######################## +# Configure permisions and ownership recursively +# Globals: +# None +# Arguments: +# $1 - paths (as a string). +# Flags: +# -f|--file-mode - mode for directories. +# -d|--dir-mode - mode for files. +# -u|--user - user +# -g|--group - group +# Returns: +# None +######################### +configure_permissions_ownership() { + local -r paths="${1:?paths is missing}" + local dir_mode="" + local file_mode="" + local user="" + local group="" + + # Validate arguments + shift 1 + while [ "$#" -gt 0 ]; do + case "$1" in + -f|--file-mode) + shift + file_mode="${1:?missing mode for files}" + ;; + -d|--dir-mode) + shift + dir_mode="${1:?missing mode for directories}" + ;; + -u|--user) + shift + user="${1:?missing user}" + ;; + -g|--group) + shift + group="${1:?missing group}" + ;; + *) + echo "Invalid command line flag $1" >&2 + return 1 + ;; + esac + shift + done + + read -r -a filepaths <<< "$paths" + for p in "${filepaths[@]}"; do + if [[ -e "$p" ]]; then + if [[ -n $dir_mode ]]; then + find -L "$p" -type d -exec chmod "$dir_mode" {} \; + fi + if [[ -n $file_mode ]]; then + find -L "$p" -type f -exec chmod "$file_mode" {} \; + fi + if [[ -n $user ]] && [[ -n $group ]]; then + chown -LR "$user":"$group" "$p" + elif [[ -n $user ]] && [[ -z $group ]]; then + chown -LR "$user" "$p" + elif [[ -z $user ]] && [[ -n $group ]]; then + chgrp -LR "$group" "$p" + fi + else + stderr_print "$p does not exist" + fi + done +} diff --git a/prebuildfs/opt/bitnami/scripts/libhook.sh b/prebuildfs/opt/bitnami/scripts/libhook.sh new file mode 100644 index 00000000..9694852a --- /dev/null +++ b/prebuildfs/opt/bitnami/scripts/libhook.sh @@ -0,0 +1,16 @@ +#!/bin/bash +# +# Library to use for scripts expected to be used as Kubernetes lifecycle hooks + +# shellcheck disable=SC1091 + +# Load generic libraries +. /opt/bitnami/scripts/liblog.sh +. /opt/bitnami/scripts/libos.sh + +# Override functions that log to stdout/stderr of the current process, so they print to process 1 +for function_to_override in stderr_print debug_execute; do + # Output is sent to output of process 1 and thus end up in the container log + # The hook output in general isn't saved + eval "$(declare -f "$function_to_override") >/proc/1/fd/1 2>/proc/1/fd/2" +done diff --git a/prebuildfs/opt/bitnami/scripts/liblog.sh b/prebuildfs/opt/bitnami/scripts/liblog.sh new file mode 100644 index 00000000..c7c0f6d4 --- /dev/null +++ b/prebuildfs/opt/bitnami/scripts/liblog.sh @@ -0,0 +1,112 @@ +#!/bin/bash +# +# Library for logging functions + +# Constants +RESET='\033[0m' +RED='\033[38;5;1m' +GREEN='\033[38;5;2m' +YELLOW='\033[38;5;3m' +MAGENTA='\033[38;5;5m' +CYAN='\033[38;5;6m' + +# Functions + +######################## +# Print to STDERR +# Arguments: +# Message to print +# Returns: +# None +######################### +stderr_print() { + # 'is_boolean_yes' is defined in libvalidations.sh, but depends on this file so we cannot source it + local bool="${BITNAMI_QUIET:-false}" + # comparison is performed without regard to the case of alphabetic characters + shopt -s nocasematch + if ! [[ "$bool" = 1 || "$bool" =~ ^(yes|true)$ ]]; then + printf "%b\\n" "${*}" >&2 + fi +} + +######################## +# Log message +# Arguments: +# Message to log +# Returns: +# None +######################### +log() { + stderr_print "${CYAN}${MODULE:-} ${MAGENTA}$(date "+%T.%2N ")${RESET}${*}" +} +######################## +# Log an 'info' message +# Arguments: +# Message to log +# Returns: +# None +######################### +info() { + log "${GREEN}INFO ${RESET} ==> ${*}" +} +######################## +# Log message +# Arguments: +# Message to log +# Returns: +# None +######################### +warn() { + log "${YELLOW}WARN ${RESET} ==> ${*}" +} +######################## +# Log an 'error' message +# Arguments: +# Message to log +# Returns: +# None +######################### +error() { + log "${RED}ERROR${RESET} ==> ${*}" +} +######################## +# Log a 'debug' message +# Globals: +# BITNAMI_DEBUG +# Arguments: +# None +# Returns: +# None +######################### +debug() { + # 'is_boolean_yes' is defined in libvalidations.sh, but depends on this file so we cannot source it + local bool="${BITNAMI_DEBUG:-false}" + # comparison is performed without regard to the case of alphabetic characters + shopt -s nocasematch + if [[ "$bool" = 1 || "$bool" =~ ^(yes|true)$ ]]; then + log "${MAGENTA}DEBUG${RESET} ==> ${*}" + fi +} + +######################## +# Indent a string +# Arguments: +# $1 - string +# $2 - number of indentation characters (default: 4) +# $3 - indentation character (default: " ") +# Returns: +# None +######################### +indent() { + local string="${1:-}" + local num="${2:?missing num}" + local char="${3:-" "}" + # Build the indentation unit string + local indent_unit="" + for ((i = 0; i < num; i++)); do + indent_unit="${indent_unit}${char}" + done + # shellcheck disable=SC2001 + # Complex regex, see https://github.com/koalaman/shellcheck/wiki/SC2001#exceptions + echo "$string" | sed "s/^/${indent_unit}/" +} diff --git a/prebuildfs/opt/bitnami/scripts/libnet.sh b/prebuildfs/opt/bitnami/scripts/libnet.sh new file mode 100644 index 00000000..4391dacc --- /dev/null +++ b/prebuildfs/opt/bitnami/scripts/libnet.sh @@ -0,0 +1,142 @@ +#!/bin/bash +# +# Library for network functions + +# shellcheck disable=SC1091 + +# Load Generic Libraries +. /opt/bitnami/scripts/liblog.sh + +# Functions + +######################## +# Resolve IP address for a host/domain (i.e. DNS lookup) +# Arguments: +# $1 - Hostname to resolve +# $2 - IP address version (v4, v6), leave empty for resolving to any version +# Returns: +# IP +######################### +dns_lookup() { + local host="${1:?host is missing}" + local ip_version="${2:-}" + getent "ahosts${ip_version}" "$host" | awk '/STREAM/ {print $1 }' | head -n 1 +} + +######################### +# Wait for a hostname and return the IP +# Arguments: +# $1 - hostname +# $2 - number of retries +# $3 - seconds to wait between retries +# Returns: +# - IP address that corresponds to the hostname +######################### +wait_for_dns_lookup() { + local hostname="${1:?hostname is missing}" + local retries="${2:-5}" + local seconds="${3:-1}" + check_host() { + if [[ $(dns_lookup "$hostname") == "" ]]; then + false + else + true + fi + } + # Wait for the host to be ready + retry_while "check_host ${hostname}" "$retries" "$seconds" + dns_lookup "$hostname" +} + +######################## +# Get machine's IP +# Arguments: +# None +# Returns: +# Machine IP +######################### +get_machine_ip() { + local -a ip_addresses + local hostname + hostname="$(hostname)" + read -r -a ip_addresses <<< "$(dns_lookup "$hostname" | xargs echo)" + if [[ "${#ip_addresses[@]}" -gt 1 ]]; then + warn "Found more than one IP address associated to hostname ${hostname}: ${ip_addresses[*]}, will use ${ip_addresses[0]}" + elif [[ "${#ip_addresses[@]}" -lt 1 ]]; then + error "Could not find any IP address associated to hostname ${hostname}" + exit 1 + fi + echo "${ip_addresses[0]}" +} + +######################## +# Check if the provided argument is a resolved hostname +# Arguments: +# $1 - Value to check +# Returns: +# Boolean +######################### +is_hostname_resolved() { + local -r host="${1:?missing value}" + if [[ -n "$(dns_lookup "$host")" ]]; then + true + else + false + fi +} + +######################## +# Parse URL +# Globals: +# None +# Arguments: +# $1 - uri - String +# $2 - component to obtain. Valid options (scheme, authority, userinfo, host, port, path, query or fragment) - String +# Returns: +# String +parse_uri() { + local uri="${1:?uri is missing}" + local component="${2:?component is missing}" + + # Solution based on https://tools.ietf.org/html/rfc3986#appendix-B with + # additional sub-expressions to split authority into userinfo, host and port + # Credits to Patryk Obara (see https://stackoverflow.com/a/45977232/6694969) + local -r URI_REGEX='^(([^:/?#]+):)?(//((([^@/?#]+)@)?([^:/?#]+)(:([0-9]+))?))?(/([^?#]*))?(\?([^#]*))?(#(.*))?' + # || | ||| | | | | | | | | | + # |2 scheme | ||6 userinfo 7 host | 9 port | 11 rpath | 13 query | 15 fragment + # 1 scheme: | |5 userinfo@ 8 :... 10 path 12 ?... 14 #... + # | 4 authority + # 3 //... + local index=0 + case "$component" in + scheme) + index=2 + ;; + authority) + index=4 + ;; + userinfo) + index=6 + ;; + host) + index=7 + ;; + port) + index=9 + ;; + path) + index=10 + ;; + query) + index=13 + ;; + fragment) + index=14 + ;; + *) + stderr_print "unrecognized component $component" + return 1 + ;; + esac + [[ "$uri" =~ $URI_REGEX ]] && echo "${BASH_REMATCH[${index}]}" +} diff --git a/prebuildfs/opt/bitnami/scripts/libos.sh b/prebuildfs/opt/bitnami/scripts/libos.sh new file mode 100644 index 00000000..6a751228 --- /dev/null +++ b/prebuildfs/opt/bitnami/scripts/libos.sh @@ -0,0 +1,350 @@ +#!/bin/bash +# +# Library for operating system actions + +# shellcheck disable=SC1091 + +# Load Generic Libraries +. /opt/bitnami/scripts/liblog.sh +. /opt/bitnami/scripts/libfs.sh + +# Functions + +######################## +# Check if an user exists in the system +# Arguments: +# $1 - user +# Returns: +# Boolean +######################### +user_exists() { + local user="${1:?user is missing}" + id "$user" >/dev/null 2>&1 +} + +######################## +# Check if a group exists in the system +# Arguments: +# $1 - group +# Returns: +# Boolean +######################### +group_exists() { + local group="${1:?group is missing}" + getent group "$group" >/dev/null 2>&1 +} + +######################## +# Create a group in the system if it does not exist already +# Arguments: +# $1 - group +# Flags: +# -s|--system - Whether to create new user as system user (uid <= 999) +# Returns: +# None +######################### +ensure_group_exists() { + local group="${1:?group is missing}" + local is_system_user=false + + # Validate arguments + shift 1 + while [ "$#" -gt 0 ]; do + case "$1" in + -s|--system) + is_system_user=true + ;; + *) + echo "Invalid command line flag $1" >&2 + return 1 + ;; + esac + shift + done + + if ! group_exists "$group"; then + local -a args=("$group") + $is_system_user && args+=("--system") + groupadd "${args[@]}" >/dev/null 2>&1 + fi +} + +######################## +# Create an user in the system if it does not exist already +# Arguments: +# $1 - user +# Flags: +# -g|--group - the group the new user should belong to +# -h|--home - the home directory for the new user +# -s|--system - whether to create new user as system user (uid <= 999) +# Returns: +# None +######################### +ensure_user_exists() { + local user="${1:?user is missing}" + local group="" + local home="" + local is_system_user=false + + # Validate arguments + shift 1 + while [ "$#" -gt 0 ]; do + case "$1" in + -g|--group) + shift + group="${1:?missing group}" + ;; + -h|--home) + shift + home="${1:?missing home directory}" + ;; + -s|--system) + is_system_user=true + ;; + *) + echo "Invalid command line flag $1" >&2 + return 1 + ;; + esac + shift + done + + if ! user_exists "$user"; then + local -a user_args=("-N" "$user") + $is_system_user && user_args+=("--system") + useradd "${user_args[@]}" >/dev/null 2>&1 + fi + + if [[ -n "$group" ]]; then + local -a group_args=("$group") + $is_system_user && group_args+=("--system") + ensure_group_exists "${group_args[@]}" + usermod -g "$group" "$user" >/dev/null 2>&1 + fi + + if [[ -n "$home" ]]; then + mkdir -p "$home" + usermod -d "$home" "$user" >/dev/null 2>&1 + configure_permissions_ownership "$home" -d "775" -f "664" -u "$user" -g "$group" + fi +} + +######################## +# Check if the script is currently running as root +# Arguments: +# $1 - user +# $2 - group +# Returns: +# Boolean +######################### +am_i_root() { + if [[ "$(id -u)" = "0" ]]; then + true + else + false + fi +} + +######################## +# Get total memory available +# Arguments: +# None +# Returns: +# Memory in bytes +######################### +get_total_memory() { + echo $(($(grep MemTotal /proc/meminfo | awk '{print $2}') / 1024)) +} + +######################## +# Get machine size depending on specified memory +# Globals: +# None +# Arguments: +# None +# Flags: +# --memory - memory size (optional) +# Returns: +# Detected instance size +######################### +get_machine_size() { + local memory="" + # Validate arguments + while [[ "$#" -gt 0 ]]; do + case "$1" in + --memory) + shift + memory="${1:?missing memory}" + ;; + *) + echo "Invalid command line flag $1" >&2 + return 1 + ;; + esac + shift + done + if [[ -z "$memory" ]]; then + debug "Memory was not specified, detecting available memory automatically" + memory="$(get_total_memory)" + fi + sanitized_memory=$(convert_to_mb "$memory") + if [[ "$sanitized_memory" -gt 26000 ]]; then + echo 2xlarge + elif [[ "$sanitized_memory" -gt 13000 ]]; then + echo xlarge + elif [[ "$sanitized_memory" -gt 6000 ]]; then + echo large + elif [[ "$sanitized_memory" -gt 3000 ]]; then + echo medium + elif [[ "$sanitized_memory" -gt 1500 ]]; then + echo small + else + echo micro + fi +} + +######################## +# Get machine size depending on specified memory +# Globals: +# None +# Arguments: +# $1 - memory size (optional) +# Returns: +# Detected instance size +######################### +get_supported_machine_sizes() { + echo micro small medium large xlarge 2xlarge +} + +######################## +# Convert memory size from string to amount of megabytes (i.e. 2G -> 2048) +# Globals: +# None +# Arguments: +# $1 - memory size +# Returns: +# Result of the conversion +######################### +convert_to_mb() { + local amount="${1:-}" + if [[ $amount =~ ^([0-9]+)(m|M|g|G) ]]; then + size="${BASH_REMATCH[1]}" + unit="${BASH_REMATCH[2]}" + if [[ "$unit" = "g" || "$unit" = "G" ]]; then + amount="$((size * 1024))" + else + amount="$size" + fi + fi + echo "$amount" +} + + +######################### +# Redirects output to /dev/null if debug mode is disabled +# Globals: +# BITNAMI_DEBUG +# Arguments: +# $@ - Command to execute +# Returns: +# None +######################### +debug_execute() { + if ${BITNAMI_DEBUG:-false}; then + "$@" + else + "$@" >/dev/null 2>&1 + fi +} + +######################## +# Retries a command a given number of times +# Arguments: +# $1 - cmd (as a string) +# $2 - max retries. Default: 12 +# $3 - sleep between retries (in seconds). Default: 5 +# Returns: +# Boolean +######################### +retry_while() { + local cmd="${1:?cmd is missing}" + local retries="${2:-12}" + local sleep_time="${3:-5}" + local return_value=1 + + read -r -a command <<< "$cmd" + for ((i = 1 ; i <= retries ; i+=1 )); do + "${command[@]}" && return_value=0 && break + sleep "$sleep_time" + done + return $return_value +} + +######################## +# Generate a random string +# Arguments: +# -t|--type - String type (ascii, alphanumeric, numeric), defaults to ascii +# -c|--count - Number of characters, defaults to 32 +# Arguments: +# None +# Returns: +# None +# Returns: +# String +######################### +generate_random_string() { + local type="ascii" + local count="32" + local filter + local result + # Validate arguments + while [[ "$#" -gt 0 ]]; do + case "$1" in + -t|--type) + shift + type="$1" + ;; + -c|--count) + shift + count="$1" + ;; + *) + echo "Invalid command line flag $1" >&2 + return 1 + ;; + esac + shift + done + # Validate type + case "$type" in + ascii) + filter="[:print:]" + ;; + alphanumeric) + filter="a-zA-Z0-9" + ;; + numeric) + filter="0-9" + ;; + *) + echo "Invalid type ${type}" >&2 + return 1 + esac + # Obtain count + 10 lines from /dev/urandom to ensure that the resulting string has the expected size + # Note there is a very small chance of strings starting with EOL character + # Therefore, the higher amount of lines read, this will happen less frequently + result="$(head -n "$((count + 10))" /dev/urandom | tr -dc "$filter" | head -c "$count")" + echo "$result" +} + +######################## +# Create md5 hash from a string +# Arguments: +# $1 - string +# Returns: +# md5 hash - string +######################### +generate_md5_hash() { + local -r str="${1:?missing input string}" + echo -n "$str" | md5sum | awk '{print $1}' +} diff --git a/prebuildfs/opt/bitnami/scripts/libpersistence.sh b/prebuildfs/opt/bitnami/scripts/libpersistence.sh new file mode 100644 index 00000000..55e1bef8 --- /dev/null +++ b/prebuildfs/opt/bitnami/scripts/libpersistence.sh @@ -0,0 +1,122 @@ +#!/bin/bash +# +# Bitnami persistence library +# Used for bringing persistence capabilities to applications that don't have clear separation of data and logic + +# shellcheck disable=SC1091 + +# Load Generic Libraries +. /opt/bitnami/scripts/libfs.sh +. /opt/bitnami/scripts/libos.sh +. /opt/bitnami/scripts/liblog.sh +. /opt/bitnami/scripts/libversion.sh + +# Functions + +######################## +# Persist an application directory +# Globals: +# BITNAMI_ROOT_DIR +# BITNAMI_VOLUME_DIR +# Arguments: +# $1 - App folder name +# $2 - List of app files to persist +# Returns: +# true if all steps succeeded, false otherwise +######################### +persist_app() { + local -r app="${1:?missing app}" + local -a files_to_restore + read -r -a files_to_persist <<< "$(tr ',;:' ' ' <<< "$2")" + local -r install_dir="${BITNAMI_ROOT_DIR}/${app}" + local -r persist_dir="${BITNAMI_VOLUME_DIR}/${app}" + # Persist the individual files + if [[ "${#files_to_persist[@]}" -lt 0 ]]; then + warn "No files are configured to be persisted" + return + fi + pushd "$install_dir" >/dev/null || exit + local file_to_persist_relative file_to_persist_destination file_to_persist_destination_folder + local -r tmp_file="/tmp/perms.acl" + for file_to_persist in "${files_to_persist[@]}"; do + if [[ ! -f "$file_to_persist" && ! -d "$file_to_persist" ]]; then + error "Cannot persist '${file_to_persist}' because it does not exist" + return 1 + fi + file_to_persist_relative="$(relativize "$file_to_persist" "$install_dir")" + file_to_persist_destination="${persist_dir}/${file_to_persist_relative}" + file_to_persist_destination_folder="$(dirname "$file_to_persist_destination")" + # Get original permissions for existing files, which will be applied later + # Exclude the root directory with 'sed', to avoid issues when copying the entirety of it to a volume + getfacl -R "$file_to_persist_relative" | sed -E '/# file: (\..+|[^.])/,$!d' > "$tmp_file" + # Copy directories to the volume + ensure_dir_exists "$file_to_persist_destination_folder" + cp -Lr --preserve=links "$file_to_persist_relative" "$file_to_persist_destination_folder" + # Restore permissions + pushd "$persist_dir" >/dev/null || exit + if am_i_root; then + setfacl --restore="$tmp_file" + else + # When running as non-root, don't change ownership + setfacl --restore=<(grep -E -v '^# (owner|group):' "$tmp_file") + fi + popd >/dev/null || exit + done + popd >/dev/null || exit + rm -f "$tmp_file" + # Install the persisted files into the installation directory, via symlinks + restore_persisted_app "$@" +} + +######################## +# Restore a persisted application directory +# Globals: +# BITNAMI_ROOT_DIR +# BITNAMI_VOLUME_DIR +# FORCE_MAJOR_UPGRADE +# Arguments: +# $1 - App folder name +# $2 - List of app files to restore +# Returns: +# true if all steps succeeded, false otherwise +######################### +restore_persisted_app() { + local -r app="${1:?missing app}" + local -a files_to_restore + read -r -a files_to_restore <<< "$(tr ',;:' ' ' <<< "$2")" + local -r install_dir="${BITNAMI_ROOT_DIR}/${app}" + local -r persist_dir="${BITNAMI_VOLUME_DIR}/${app}" + # Restore the individual persisted files + if [[ "${#files_to_restore[@]}" -lt 0 ]]; then + warn "No persisted files are configured to be restored" + return + fi + local file_to_restore_relative file_to_restore_origin file_to_restore_destination + for file_to_restore in "${files_to_restore[@]}"; do + file_to_restore_relative="$(relativize "$file_to_restore" "$install_dir")" + # We use 'realpath --no-symlinks' to ensure that the case of '.' is covered and the directory is removed + file_to_restore_origin="$(realpath --no-symlinks "${install_dir}/${file_to_restore_relative}")" + file_to_restore_destination="$(realpath --no-symlinks "${persist_dir}/${file_to_restore_relative}")" + rm -rf "$file_to_restore_origin" + ln -sfn "$file_to_restore_destination" "$file_to_restore_origin" + done +} + +######################## +# Check if an application directory was already persisted +# Globals: +# BITNAMI_VOLUME_DIR +# Arguments: +# $1 - App folder name +# Returns: +# true if all steps succeeded, false otherwise +######################### +is_app_initialized() { + local -r app="${1:?missing app}" + local -r persist_dir="${BITNAMI_VOLUME_DIR}/${app}" + if ! is_mounted_dir_empty "$persist_dir"; then + true + else + false + fi +} diff --git a/prebuildfs/opt/bitnami/scripts/libservice.sh b/prebuildfs/opt/bitnami/scripts/libservice.sh new file mode 100644 index 00000000..ae8f3101 --- /dev/null +++ b/prebuildfs/opt/bitnami/scripts/libservice.sh @@ -0,0 +1,235 @@ +#!/bin/bash +# +# Library for managing services + +# shellcheck disable=SC1091 + +# Load Generic Libraries +. /opt/bitnami/scripts/libvalidations.sh +. /opt/bitnami/scripts/liblog.sh + +# Functions + +######################## +# Read the provided pid file and returns a PID +# Arguments: +# $1 - Pid file +# Returns: +# PID +######################### +get_pid_from_file() { + local pid_file="${1:?pid file is missing}" + + if [[ -f "$pid_file" ]]; then + if [[ -n "$(< "$pid_file")" ]] && [[ "$(< "$pid_file")" -gt 0 ]]; then + echo "$(< "$pid_file")" + fi + fi +} + +######################## +# Check if a provided PID corresponds to a running service +# Arguments: +# $1 - PID +# Returns: +# Boolean +######################### +is_service_running() { + local pid="${1:?pid is missing}" + + kill -0 "$pid" 2>/dev/null +} + +######################## +# Stop a service by sending a termination signal to its pid +# Arguments: +# $1 - Pid file +# $2 - Signal number (optional) +# Returns: +# None +######################### +stop_service_using_pid() { + local pid_file="${1:?pid file is missing}" + local signal="${2:-}" + local pid + + pid="$(get_pid_from_file "$pid_file")" + [[ -z "$pid" ]] || ! is_service_running "$pid" && return + + if [[ -n "$signal" ]]; then + kill "-${signal}" "$pid" + else + kill "$pid" + fi + + local counter=10 + while [[ "$counter" -ne 0 ]] && is_service_running "$pid"; do + sleep 1 + counter=$((counter - 1)) + done +} + +######################## +# Start cron daemon +# Arguments: +# None +# Returns: +# true if started correctly, false otherwise +######################### +cron_start() { + if [[ -x "/usr/sbin/cron" ]]; then + /usr/sbin/cron + elif [[ -x "/usr/sbin/crond" ]]; then + /usr/sbin/crond + else + false + fi +} + +######################## +# Generate a cron configuration file for a given service +# Arguments: +# $1 - Service name +# $2 - Command +# Flags: +# --run-as - User to run as (default: root) +# --schedule - Cron schedule configuration (default: * * * * *) +# Returns: +# None +######################### +generate_cron_conf() { + local service_name="${1:?service name is missing}" + local cmd="${2:?command is missing}" + local run_as="root" + local schedule="* * * * *" + local clean="true" + + local clean="true" + + # Parse optional CLI flags + shift 2 + while [[ "$#" -gt 0 ]]; do + case "$1" in + --run-as) + shift + run_as="$1" + ;; + --schedule) + shift + schedule="$1" + ;; + --no-clean) + clean="false" + ;; + *) + echo "Invalid command line flag ${1}" >&2 + return 1 + ;; + esac + shift + done + + mkdir -p /etc/cron.d + if "$clean"; then + echo "${schedule} ${run_as} ${cmd}" > /etc/cron.d/"$service_name" + else + echo "${schedule} ${run_as} ${cmd}" >> /etc/cron.d/"$service_name" + fi +} + +######################## +# Generate a monit configuration file for a given service +# Arguments: +# $1 - Service name +# $2 - Pid file +# $3 - Start command +# $4 - Stop command +# Flags: +# --disabled - Whether to disable the monit configuration +# Returns: +# None +######################### +generate_monit_conf() { + local service_name="${1:?service name is missing}" + local pid_file="${2:?pid file is missing}" + local start_command="${3:?start command is missing}" + local stop_command="${4:?stop command is missing}" + local monit_conf_dir="/etc/monit/conf.d" + local disabled="no" + + # Parse optional CLI flags + shift 4 + while [[ "$#" -gt 0 ]]; do + case "$1" in + --disabled) + shift + disabled="$1" + ;; + *) + echo "Invalid command line flag ${1}" >&2 + return 1 + ;; + esac + shift + done + + is_boolean_yes "$disabled" && conf_suffix=".disabled" + mkdir -p "$monit_conf_dir" + cat >"${monit_conf_dir}/${service_name}.conf${conf_suffix:-}" <&2 + return 1 + ;; + esac + shift + done + + mkdir -p "$logrotate_conf_dir" + cat <"${logrotate_conf_dir}/${service_name}" +${log_path} { + ${period} + rotate ${rotations} + dateext + compress + copytruncate + missingok +$(indent "$extra" 2) +} +EOF +} diff --git a/prebuildfs/opt/bitnami/scripts/libvalidations.sh b/prebuildfs/opt/bitnami/scripts/libvalidations.sh new file mode 100644 index 00000000..ca5afc91 --- /dev/null +++ b/prebuildfs/opt/bitnami/scripts/libvalidations.sh @@ -0,0 +1,248 @@ +#!/bin/bash +# +# Validation functions library + +# shellcheck disable=SC1091 + +# Load Generic Libraries +. /opt/bitnami/scripts/liblog.sh + +# Functions + +######################## +# Check if the provided argument is an integer +# Arguments: +# $1 - Value to check +# Returns: +# Boolean +######################### +is_int() { + local -r int="${1:?missing value}" + if [[ "$int" =~ ^-?[0-9]+ ]]; then + true + else + false + fi +} + +######################## +# Check if the provided argument is a positive integer +# Arguments: +# $1 - Value to check +# Returns: +# Boolean +######################### +is_positive_int() { + local -r int="${1:?missing value}" + if is_int "$int" && (( "${int}" >= 0 )); then + true + else + false + fi +} + +######################## +# Check if the provided argument is a boolean or is the string 'yes/true' +# Arguments: +# $1 - Value to check +# Returns: +# Boolean +######################### +is_boolean_yes() { + local -r bool="${1:-}" + # comparison is performed without regard to the case of alphabetic characters + shopt -s nocasematch + if [[ "$bool" = 1 || "$bool" =~ ^(yes|true)$ ]]; then + true + else + false + fi +} + +######################## +# Check if the provided argument is a boolean yes/no value +# Arguments: +# $1 - Value to check +# Returns: +# Boolean +######################### +is_yes_no_value() { + local -r bool="${1:-}" + if [[ "$bool" =~ ^(yes|no)$ ]]; then + true + else + false + fi +} + +######################## +# Check if the provided argument is a boolean true/false value +# Arguments: +# $1 - Value to check +# Returns: +# Boolean +######################### +is_true_false_value() { + local -r bool="${1:-}" + if [[ "$bool" =~ ^(true|false)$ ]]; then + true + else + false + fi +} + +######################## +# Check if the provided argument is an empty string or not defined +# Arguments: +# $1 - Value to check +# Returns: +# Boolean +######################### +is_empty_value() { + local -r val="${1:-}" + if [[ -z "$val" ]]; then + true + else + false + fi +} + +######################## +# Validate if the provided argument is a valid port +# Arguments: +# $1 - Port to validate +# Returns: +# Boolean and error message +######################### +validate_port() { + local value + local unprivileged=0 + + # Parse flags + while [[ "$#" -gt 0 ]]; do + case "$1" in + -unprivileged) + unprivileged=1 + ;; + --) + shift + break + ;; + -*) + stderr_print "unrecognized flag $1" + return 1 + ;; + *) + break + ;; + esac + shift + done + + if [[ "$#" -gt 1 ]]; then + echo "too many arguments provided" + return 2 + elif [[ "$#" -eq 0 ]]; then + stderr_print "missing port argument" + return 1 + else + value=$1 + fi + + if [[ -z "$value" ]]; then + echo "the value is empty" + return 1 + else + if ! is_int "$value"; then + echo "value is not an integer" + return 2 + elif [[ "$value" -lt 0 ]]; then + echo "negative value provided" + return 2 + elif [[ "$value" -gt 65535 ]]; then + echo "requested port is greater than 65535" + return 2 + elif [[ "$unprivileged" = 1 && "$value" -lt 1024 ]]; then + echo "privileged port requested" + return 3 + fi + fi +} + +######################## +# Validate if the provided argument is a valid IPv4 address +# Arguments: +# $1 - IP to validate +# Returns: +# Boolean +######################### +validate_ipv4() { + local ip="${1:?ip is missing}" + local stat=1 + + if [[ $ip =~ ^[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}$ ]]; then + read -r -a ip_array <<< "$(tr '.' ' ' <<< "$ip")" + [[ ${ip_array[0]} -le 255 && ${ip_array[1]} -le 255 \ + && ${ip_array[2]} -le 255 && ${ip_array[3]} -le 255 ]] + stat=$? + fi + return $stat +} + +######################## +# Validate a string format +# Arguments: +# $1 - String to validate +# Returns: +# Boolean +######################### +validate_string() { + local string + local min_length=-1 + local max_length=-1 + + # Parse flags + while [ "$#" -gt 0 ]; do + case "$1" in + -min-length) + shift + min_length=${1:-} + ;; + -max-length) + shift + max_length=${1:-} + ;; + --) + shift + break + ;; + -*) + stderr_print "unrecognized flag $1" + return 1 + ;; + *) + break + ;; + esac + shift + done + + if [ "$#" -gt 1 ]; then + stderr_print "too many arguments provided" + return 2 + elif [ "$#" -eq 0 ]; then + stderr_print "missing string" + return 1 + else + string=$1 + fi + + if [[ "$min_length" -ge 0 ]] && [[ "${#string}" -lt "$min_length" ]]; then + echo "string length is less than $min_length" + return 1 + fi + if [[ "$max_length" -ge 0 ]] && [[ "${#string}" -gt "$max_length" ]]; then + echo "string length is great than $max_length" + return 1 + fi +} diff --git a/prebuildfs/opt/bitnami/scripts/libversion.sh b/prebuildfs/opt/bitnami/scripts/libversion.sh new file mode 100644 index 00000000..f3bc7568 --- /dev/null +++ b/prebuildfs/opt/bitnami/scripts/libversion.sh @@ -0,0 +1,49 @@ +#!/bin/bash +# +# Library for managing versions strings + +# shellcheck disable=SC1091 + +# Load Generic Libraries +. /opt/bitnami/scripts/liblog.sh + +# Functions +######################## +# Gets semantic version +# Arguments: +# $1 - version: string to extract major.minor.patch +# $2 - section: 1 to extract major, 2 to extract minor, 3 to extract patch +# Returns: +# array with the major, minor and release +######################### +get_sematic_version () { + local version="${1:?version is required}" + local section="${2:?section is required}" + local -a version_sections + + #Regex to parse versions: x.y.z + local -r regex='([0-9]+)(\.([0-9]+)(\.([0-9]+))?)?' + + if [[ "$version" =~ $regex ]]; then + local i=1 + local j=1 + local n=${#BASH_REMATCH[*]} + + while [[ $i -lt $n ]]; do + if [[ -n "${BASH_REMATCH[$i]}" ]] && [[ "${BASH_REMATCH[$i]:0:1}" != '.' ]]; then + version_sections[$j]=${BASH_REMATCH[$i]} + ((j++)) + fi + ((i++)) + done + + local number_regex='^[0-9]+$' + if [[ "$section" =~ $number_regex ]] && (( section > 0 )) && (( section <= 3 )); then + echo "${version_sections[$section]}" + return + else + stderr_print "Section allowed values are: 1, 2, and 3" + return 1 + fi + fi +} diff --git a/prebuildfs/opt/bitnami/scripts/libwebserver.sh b/prebuildfs/opt/bitnami/scripts/libwebserver.sh new file mode 100644 index 00000000..1280134f --- /dev/null +++ b/prebuildfs/opt/bitnami/scripts/libwebserver.sh @@ -0,0 +1,424 @@ +#!/bin/bash +# +# Bitnami web server handler library + +# shellcheck disable=SC1090,SC1091 + +# Load generic libraries +. /opt/bitnami/scripts/liblog.sh + +######################## +# Execute a command (or list of commands) with the web server environment and library loaded +# Globals: +# * +# Arguments: +# None +# Returns: +# None +######################### +web_server_execute() { + local -r web_server="${1:?missing web server}" + shift + # Run program in sub-shell to avoid web server environment getting loaded when not necessary + ( + . "/opt/bitnami/scripts/lib${web_server}.sh" + . "/opt/bitnami/scripts/${web_server}-env.sh" + "$@" + ) +} + +######################## +# Prints the list of enabled web servers +# Globals: +# None +# Arguments: +# None +# Returns: +# None +######################### +web_server_list() { + local -r -a supported_web_servers=(apache nginx) + local -a existing_web_servers=() + for web_server in "${supported_web_servers[@]}"; do + [[ -f "/opt/bitnami/scripts/${web_server}-env.sh" ]] && existing_web_servers+=("$web_server") + done + echo "${existing_web_servers[@]:-}" +} + +######################## +# Prints the currently-enabled web server type (only one, in order of preference) +# Globals: +# None +# Arguments: +# None +# Returns: +# None +######################### +web_server_type() { + local -a web_servers + read -r -a web_servers <<< "$(web_server_list)" + echo "${web_servers[0]:-}" +} + +######################## +# Validate that a supported web server is configured +# Globals: +# None +# Arguments: +# None +# Returns: +# None +######################### +web_server_validate() { + local error_code=0 + local supported_web_servers=("apache" "nginx") + + # Auxiliary functions + print_validation_error() { + error "$1" + error_code=1 + } + + if [[ -z "$(web_server_type)" || ! " ${supported_web_servers[*]} " == *" $(web_server_type) "* ]]; then + print_validation_error "Could not detect any supported web servers. It must be one of: ${supported_web_servers[*]}" + elif ! web_server_execute "$(web_server_type)" type -t "is_$(web_server_type)_running" >/dev/null; then + print_validation_error "Could not load the $(web_server_type) web server library from /opt/bitnami/scripts. Check that it exists and is readable." + fi + + return "$error_code" +} + +######################## +# Check whether the web server is running +# Globals: +# * +# Arguments: +# None +# Returns: +# true if the web server is running, false otherwise +######################### +is_web_server_running() { + "is_$(web_server_type)_running" +} + +######################## +# Start web server +# Globals: +# * +# Arguments: +# None +# Returns: +# None +######################### +web_server_start() { + info "Starting $(web_server_type) in background" + "${BITNAMI_ROOT_DIR}/scripts/$(web_server_type)/start.sh" +} + +######################## +# Stop web server +# Globals: +# * +# Arguments: +# None +# Returns: +# None +######################### +web_server_stop() { + info "Stopping $(web_server_type)" + "${BITNAMI_ROOT_DIR}/scripts/$(web_server_type)/stop.sh" +} + +######################## +# Restart web server +# Globals: +# * +# Arguments: +# None +# Returns: +# None +######################### +web_server_restart() { + info "Restarting $(web_server_type)" + "${BITNAMI_ROOT_DIR}/scripts/$(web_server_type)/restart.sh" +} + +######################## +# Reload web server +# Globals: +# * +# Arguments: +# None +# Returns: +# None +######################### +web_server_reload() { + "${BITNAMI_ROOT_DIR}/scripts/$(web_server_type)/reload.sh" +} + +######################## +# Ensure a web server application configuration exists (i.e. Apache virtual host format or NGINX server block) +# It serves as a wrapper for the specific web server function +# Globals: +# * +# Arguments: +# $1 - App name +# Flags: +# --hosts - Hosts to enable +# --type - Application type, which has an effect on which configuration template to use +# --allow-remote-connections - Whether to allow remote connections or to require local connections +# --disabled - Whether to render the file with a .disabled prefix +# --enable-https - Enable app configuration on HTTPS port +# --http-port - HTTP port number +# --https-port - HTTPS port number +# --document-root - Path to document root directory +# Apache-specific flags: +# --apache-additional-configuration - Additional vhost configuration (no default) +# --apache-before-vhost-configuration - Configuration to add before the directive (no default) +# --apache-allow-override - Whether to allow .htaccess files (only allowed when --move-htaccess is set to 'no') +# --apache-extra-directory-configuration - Extra configuration for the document root directory +# --apache-move-htaccess - Move .htaccess files to a common place so they can be loaded during Apache startup +# NGINX-specific flags: +# --nginx-additional-configuration - Additional server block configuration (no default) +# --nginx-external-configuration - Configuration external to server block (no default) +# Returns: +# true if the configuration was enabled, false otherwise +######################## +ensure_web_server_app_configuration_exists() { + local app="${1:?missing app}" + shift + local -a apache_args nginx_args web_servers args_var + apache_args=("$app") + nginx_args=("$app") + # Validate arguments + while [[ "$#" -gt 0 ]]; do + case "$1" in + # Common flags + --hosts \ + | --type \ + | --allow-remote-connections \ + | --disabled \ + | --enable-https \ + | --http-port \ + | --https-port \ + | --document-root \ + ) + apache_args+=("$1" "${2:?missing value}") + nginx_args+=("$1" "${2:?missing value}") + shift + ;; + + # Specific Apache flags + --apache-additional-configuration \ + | --apache-before-vhost-configuration \ + | --apache-allow-override \ + | --apache-extra-directory-configuration \ + | --apache-proxy-address \ + | --apache-move-htaccess \ + ) + apache_args+=("${1//apache-/}" "${2:?missing value}") + shift + ;; + + # Specific NGINX flags + --nginx-additional-configuration \ + | --nginx-external-configuration) + nginx_args+=("${1//nginx-/}" "${2:?missing value}") + shift + ;; + + *) + echo "Invalid command line flag $1" >&2 + return 1 + ;; + esac + shift + done + read -r -a web_servers <<< "$(web_server_list)" + for web_server in "${web_servers[@]}"; do + args_var="${web_server}_args[@]" + web_server_execute "$web_server" "ensure_${web_server}_app_configuration_exists" "${!args_var}" + done +} + +######################## +# Ensure a web server application configuration does not exist anymore (i.e. Apache virtual host format or NGINX server block) +# It serves as a wrapper for the specific web server function +# Globals: +# * +# Arguments: +# $1 - App name +# Returns: +# true if the configuration was disabled, false otherwise +######################## +ensure_web_server_app_configuration_not_exists() { + local app="${1:?missing app}" + local -a web_servers + read -r -a web_servers <<< "$(web_server_list)" + for web_server in "${web_servers[@]}"; do + web_server_execute "$web_server" "ensure_${web_server}_app_configuration_not_exists" "$app" + done +} + +######################## +# Ensure the web server loads the configuration for an application in a URL prefix +# It serves as a wrapper for the specific web server function +# Globals: +# * +# Arguments: +# $1 - App name +# Flags: +# --allow-remote-connections - Whether to allow remote connections or to require local connections +# --document-root - Path to document root directory +# --prefix - URL prefix from where it will be accessible (i.e. /myapp) +# --type - Application type, which has an effect on what configuration template will be used +# Apache-specific flags: +# --apache-additional-configuration - Additional vhost configuration (no default) +# --apache-allow-override - Whether to allow .htaccess files (only allowed when --move-htaccess is set to 'no') +# --apache-extra-directory-configuration - Extra configuration for the document root directory +# --apache-move-htaccess - Move .htaccess files to a common place so they can be loaded during Apache startup +# NGINX-specific flags: +# --nginx-additional-configuration - Additional server block configuration (no default) +# Returns: +# true if the configuration was enabled, false otherwise +######################## +ensure_web_server_prefix_configuration_exists() { + local app="${1:?missing app}" + shift + local -a apache_args nginx_args web_servers args_var + apache_args=("$app") + nginx_args=("$app") + # Validate arguments + while [[ "$#" -gt 0 ]]; do + case "$1" in + # Common flags + --allow-remote-connections \ + | --document-root \ + | --prefix \ + | --type \ + ) + apache_args+=("$1" "${2:?missing value}") + nginx_args+=("$1" "${2:?missing value}") + shift + ;; + + # Specific Apache flags + --apache-additional-configuration \ + | --apache-allow-override \ + | --apache-extra-directory-configuration \ + | --apache-move-htaccess \ + ) + apache_args+=("${1//apache-/}" "$2") + shift + ;; + + # Specific NGINX flags + --nginx-additional-configuration) + nginx_args+=("${1//nginx-/}" "$2") + shift + ;; + + *) + echo "Invalid command line flag $1" >&2 + return 1 + ;; + esac + shift + done + read -r -a web_servers <<< "$(web_server_list)" + for web_server in "${web_servers[@]}"; do + args_var="${web_server}_args[@]" + web_server_execute "$web_server" "ensure_${web_server}_prefix_configuration_exists" "${!args_var}" + done +} + +######################## +# Ensure a web server application configuration is updated with the runtime configuration (i.e. ports) +# It serves as a wrapper for the specific web server function +# Globals: +# * +# Arguments: +# $1 - App name +# Flags: +# --hosts - Hosts to enable +# --enable-https - Update HTTPS app configuration +# --http-port - HTTP port number +# --https-port - HTTPS port number +# Returns: +# true if the configuration was updated, false otherwise +######################## +web_server_update_app_configuration() { + local app="${1:?missing app}" + shift + local -a args web_servers + args=("$app") + # Validate arguments + while [[ "$#" -gt 0 ]]; do + case "$1" in + # Common flags + --hosts \ + | --enable-https \ + | --http-port \ + | --https-port \ + ) + args+=("$1" "${2:?missing value}") + shift + ;; + + *) + echo "Invalid command line flag $1" >&2 + return 1 + ;; + esac + shift + done + read -r -a web_servers <<< "$(web_server_list)" + for web_server in "${web_servers[@]}"; do + web_server_execute "$web_server" "${web_server}_update_app_configuration" "${args[@]}" + done +} + +######################## +# Enable loading page, which shows users that the initialization process is not yet completed +# Globals: +# * +# Arguments: +# None +# Returns: +# None +######################### +web_server_enable_loading_page() { + ensure_web_server_app_configuration_exists "__loading" --hosts "_default_" \ + --apache-additional-configuration " +# Show a HTTP 503 Service Unavailable page by default +RedirectMatch 503 ^/$ +# Show index.html if server is answering with 404 Not Found or 503 Service Unavailable status codes +ErrorDocument 404 /index.html +ErrorDocument 503 /index.html" \ + --nginx-additional-configuration " +# Show a HTTP 503 Service Unavailable page by default +location / { + return 503; +} +# Show index.html if server is answering with 404 Not Found or 503 Service Unavailable status codes +error_page 404 @installing; +error_page 503 @installing; +location @installing { + rewrite ^(.*)$ /index.html break; +}" + web_server_reload +} + +######################## +# Enable loading page, which shows users that the initialization process is not yet completed +# Globals: +# * +# Arguments: +# None +# Returns: +# None +######################### +web_server_disable_install_page() { + ensure_web_server_app_configuration_not_exists "__loading" + web_server_reload +} diff --git a/prebuildfs/usr/sbin/install_packages b/prebuildfs/usr/sbin/install_packages new file mode 100755 index 00000000..c9577647 --- /dev/null +++ b/prebuildfs/usr/sbin/install_packages @@ -0,0 +1,24 @@ +#!/bin/sh +set -e +set -u +export DEBIAN_FRONTEND=noninteractive +n=0 +max=2 +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 +rm -r /var/lib/apt/lists /var/cache/apt/archives diff --git a/rootfs/opt/bitnami/apache/conf/bitnami/certs/server.crt b/rootfs/opt/bitnami/apache/conf/bitnami/certs/server.crt new file mode 100644 index 00000000..466bbeab --- /dev/null +++ b/rootfs/opt/bitnami/apache/conf/bitnami/certs/server.crt @@ -0,0 +1,17 @@ +-----BEGIN CERTIFICATE----- +MIICqDCCAZACCQCz8T3726LYsjANBgkqhkiG9w0BAQUFADAWMRQwEgYDVQQDDAtl +eGFtcGxlLmNvbTAeFw0xMjExMTQxMTE4MjdaFw0yMjExMTIxMTE4MjdaMBYxFDAS +BgNVBAMMC2V4YW1wbGUuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKC +AQEA5NHl5TfZtO6zugau2tp5mWIcQYJhuwKTmYeXDLYAGJpoD2SixwPL5c8glneI +Rz1N2EQIZVeaWGbS0FLFlPdOkCkplpW9isYVC4XqKrk5b4HW4+YC+Cup0k+Kd4NM +eZOTUvWr5N6dIpdibkVumBc/pao8VtdwywlCL/PwGRsQtkXrRICzdtRa3MXqTmEF +foyVCGgBRtronlB9x4Plfb8Psk4GrPkjrWYgO8peKrl0O5+F+sYg7Gj95zCH73BQ +ANzCVNrgD9fs9cyx3ru9CUdEoIxAAJwQFkjm7xr6xqhIlSgnQ7B0uOSTNRcXY6rw +s+PxGneec/kRPRgzjC/QHY6n8QIDAQABMA0GCSqGSIb3DQEBBQUAA4IBAQBbyMqF +RDsX8zX1EW5qA8AQ8Jb2XqWrVeSO8blMV3WagJ2airMm3+c/82FCwsd/cZ08UXhA +/Kou0gi/F16tV26PiiUdp590Qao3d8H2qxc1rzzULimZPgxH4iA4vRyMHtyZN6h4 +7Fdn7O9xNMPu8siOz8rrzsEdEX5URbOMkDLCZsbTIUWVv2XmqrR0K10d5VuLWeLi +r+4G6c6jpa244WmqT9ClqceJ12G1Wnmezy7ybiW0l5M2iuIKFEiRP5Hj0J15o1I2 +pXAbKysAdWRHsJSQOtcgO8Vh9k0wo3tKg4HDp1hbrEzoGzOv92Vjg3lG8X+hzbMJ +MQURotHkD4Gk57wL +-----END CERTIFICATE----- diff --git a/rootfs/opt/bitnami/apache/conf/bitnami/certs/server.key b/rootfs/opt/bitnami/apache/conf/bitnami/certs/server.key new file mode 100644 index 00000000..1904ca70 --- /dev/null +++ b/rootfs/opt/bitnami/apache/conf/bitnami/certs/server.key @@ -0,0 +1,27 @@ +-----BEGIN RSA PRIVATE KEY----- +MIIEpAIBAAKCAQEA5NHl5TfZtO6zugau2tp5mWIcQYJhuwKTmYeXDLYAGJpoD2Si +xwPL5c8glneIRz1N2EQIZVeaWGbS0FLFlPdOkCkplpW9isYVC4XqKrk5b4HW4+YC ++Cup0k+Kd4NMeZOTUvWr5N6dIpdibkVumBc/pao8VtdwywlCL/PwGRsQtkXrRICz +dtRa3MXqTmEFfoyVCGgBRtronlB9x4Plfb8Psk4GrPkjrWYgO8peKrl0O5+F+sYg +7Gj95zCH73BQANzCVNrgD9fs9cyx3ru9CUdEoIxAAJwQFkjm7xr6xqhIlSgnQ7B0 +uOSTNRcXY6rws+PxGneec/kRPRgzjC/QHY6n8QIDAQABAoIBACo3G131tuGtpFTu +xLW11vdYZXQklNlGuWp63IBI162yVv54B5wF9Ek6tH1uIiNaiREcRBxGVEB4/+3V +R4SbN9Ba98RDbgu7TcipdTFaqOEMqFO1bNjSXWtip14zSBmqA2Ur1AHOnFj0awGD +J8tBhsmOpcEz0Ch1VdO5ApPvLV8jH9wQiMI/Q6yYQMtmzTMCUMYdMqe+LOziIOzL +oqN/WXnKL5E5TiO1bIxSpWPbT+IVn1c3/PShmvmRrLWsFUQlkwXJKMYZPO+rCCfe +b+Q9lMLMnj+vOnM3z16WC3aiiJGCZjVTvQ+x22YrBTRPxZmHO2eZ4H/cUQM7Y/tw +I7RjEM0CgYEA9Kxt1t8bWonzBii3P0rwyx0IECvg63k+pp4BpxpeWQKL7NVdSzk3 +AyJVcNjUoZgi2kVPdxzZGLrnZfuZ691xQB3oZF0LwBzQ4GFHkTRCB0s8ZA5lcJaI +9pBu91bhz2VOZSTeQWpdMMURjXVyTXZInU1mwzmjVOIAYmO33shH9gcCgYEA72mX +UoIrFPLkOTSZOb7UbjYH01vf6ThQiYCEWg7mD3CbY7n9oobIcQMzNnt7xN4wOl/V +eKfZ7G56q8enfqm45Dyo9aCBCENVzmwO8wLe5UnvJBNL20KjvtwG8w5A6UZQzC7p +3QS+U2zxVQNEeaE6a8Wrq2d1PlhVAHYw8odgNEcCgYBN38+58xrmrz99d1oTuAt5 +6kyVsRGOgPGS4HmQMRFUbT4R7DscZSKASd4945WRtTVqmWLYe4MRnvNlfzYXX0zb +ZmmAAClsRP+qWuwHaEWXwrd+9SIOOqtvJrta1/lZJFpWUOy4j10H18Flb7sosnwc +LPWHL4Iv0xriNfDg5Iga4wKBgQDLJBU59SkJBW+Q+oho7vrg6QeK15IOGbJ8eYfT +woCC6VFwNQh5N1QsUELMH8rNKJpTba18SzAl5ThBOY9tciVnw/C5Og9CK6BLHnUw +zWbDtxAq1BSxXsIB2EAtTBLX3MoB9myJFNVJhE7hi3w2mA8yEu+u6IIa/Ghjk+XE +ZAnFUQKBgQDjMinRZrK5wA09jcetI+dNiLnKHoQG6OaXDDsNCatex0O2F36BvVXE +P78qDz/i5aBMWsLx6VDvWJAkBIpZoNS5UsOn17tFaocGUSkcm48bs8Dn6VvsE8Bd +XMPAHyKuILlKYifBvNq5T22KhqKX7yGmk/AeOOiKr2KeMnh27JYrCA== +-----END RSA PRIVATE KEY----- diff --git a/rootfs/opt/bitnami/apache/conf/deflate.conf b/rootfs/opt/bitnami/apache/conf/deflate.conf new file mode 100644 index 00000000..ca9bc1d6 --- /dev/null +++ b/rootfs/opt/bitnami/apache/conf/deflate.conf @@ -0,0 +1,5 @@ + + AddOutputFilterByType DEFLATE text/html text/plain text/xml text/css + AddOutputFilterByType DEFLATE application/x-javascript application/javascript application/ecmascript + AddOutputFilterByType DEFLATE application/rss+xml + diff --git a/rootfs/opt/bitnami/apache/conf/vhosts/00_status-vhost.conf b/rootfs/opt/bitnami/apache/conf/vhosts/00_status-vhost.conf new file mode 100644 index 00000000..c0838da2 --- /dev/null +++ b/rootfs/opt/bitnami/apache/conf/vhosts/00_status-vhost.conf @@ -0,0 +1,7 @@ + + ServerName status.localhost + + Require local + SetHandler server-status + + diff --git a/rootfs/opt/bitnami/scripts/apache-env.sh b/rootfs/opt/bitnami/scripts/apache-env.sh new file mode 100644 index 00000000..eec59249 --- /dev/null +++ b/rootfs/opt/bitnami/scripts/apache-env.sh @@ -0,0 +1,76 @@ +#!/bin/bash +# +# Environment configuration for apache + +# The values for all environment variables will be set in the below order of precedence +# 1. Custom environment variables defined below after Bitnami defaults +# 2. Constants defined in this file (environment variables with no default), i.e. BITNAMI_ROOT_DIR +# 3. Environment variables overridden via external files using *_FILE variables (see below) +# 4. Environment variables set externally (i.e. current Bash context/Dockerfile/userdata) + +# Load logging library +. /opt/bitnami/scripts/liblog.sh + +export BITNAMI_ROOT_DIR="/opt/bitnami" +export BITNAMI_VOLUME_DIR="/bitnami" + +# Logging configuration +export MODULE="${MODULE:-apache}" +export BITNAMI_DEBUG="${BITNAMI_DEBUG:-false}" + +# By setting an environment variable matching *_FILE to a file path, the prefixed environment +# variable will be overridden with the value specified in that file +apache_env_vars=( + APACHE_HTTP_PORT_NUMBER + APACHE_HTTPS_PORT_NUMBER + APACHE_HTTP_PORT + APACHE_HTTPS_PORT +) +for env_var in "${apache_env_vars[@]}"; do + file_env_var="${env_var}_FILE" + if [[ -n "${!file_env_var:-}" ]]; then + if [[ -r "${!file_env_var:-}" ]]; then + export "${env_var}=$(< "${!file_env_var}")" + unset "${file_env_var}" + else + warn "Skipping export of '${env_var}'. '${!file_env_var:-}' is not readable." + fi + fi +done +unset apache_env_vars +export WEB_SERVER_TYPE="apache" + +# Paths +export APACHE_BASE_DIR="${BITNAMI_ROOT_DIR}/apache" +export APACHE_BIN_DIR="${APACHE_BASE_DIR}/bin" +export APACHE_CONF_DIR="${APACHE_BASE_DIR}/conf" +export APACHE_HTDOCS_DIR="${APACHE_BASE_DIR}/htdocs" +export APACHE_TMP_DIR="${APACHE_BASE_DIR}/var/run" +export APACHE_LOGS_DIR="${APACHE_BASE_DIR}/logs" +export APACHE_VHOSTS_DIR="${APACHE_CONF_DIR}/vhosts" +export APACHE_HTACCESS_DIR="${APACHE_VHOSTS_DIR}/htaccess" +export APACHE_MOD_PAGESPEED_CACHE_DIR="${APACHE_BASE_DIR}/var/cache" +export APACHE_CONF_FILE="${APACHE_CONF_DIR}/httpd.conf" +export APACHE_PID_FILE="${APACHE_TMP_DIR}/httpd.pid" +export PATH="${APACHE_BIN_DIR}:${BITNAMI_ROOT_DIR}/common/bin:${PATH}" + +# System users (when running with a privileged user) +export APACHE_DAEMON_USER="daemon" +export WEB_SERVER_DAEMON_USER="$APACHE_DAEMON_USER" +export APACHE_DAEMON_GROUP="daemon" +export WEB_SERVER_DAEMON_GROUP="$APACHE_DAEMON_GROUP" +export WEB_SERVER_GROUP="$APACHE_DAEMON_GROUP" + +# Apache configuration +export APACHE_DEFAULT_HTTP_PORT_NUMBER="8080" +export WEB_SERVER_DEFAULT_HTTP_PORT_NUMBER="$APACHE_DEFAULT_HTTP_PORT_NUMBER" # only used at build time +export APACHE_DEFAULT_HTTPS_PORT_NUMBER="8443" +export WEB_SERVER_DEFAULT_HTTPS_PORT_NUMBER="$APACHE_DEFAULT_HTTPS_PORT_NUMBER" # only used at build time +APACHE_HTTP_PORT_NUMBER="${APACHE_HTTP_PORT_NUMBER:-"${APACHE_HTTP_PORT:-}"}" +export APACHE_HTTP_PORT_NUMBER="${APACHE_HTTP_PORT_NUMBER:-}" +export WEB_SERVER_HTTP_PORT_NUMBER="$APACHE_HTTP_PORT_NUMBER" +APACHE_HTTPS_PORT_NUMBER="${APACHE_HTTPS_PORT_NUMBER:-"${APACHE_HTTPS_PORT:-}"}" +export APACHE_HTTPS_PORT_NUMBER="${APACHE_HTTPS_PORT_NUMBER:-}" +export WEB_SERVER_HTTPS_PORT_NUMBER="$APACHE_HTTPS_PORT_NUMBER" + +# Custom environment variables may be defined below diff --git a/rootfs/opt/bitnami/scripts/apache-modphp/postunpack.sh b/rootfs/opt/bitnami/scripts/apache-modphp/postunpack.sh new file mode 100755 index 00000000..8b5bb7a7 --- /dev/null +++ b/rootfs/opt/bitnami/scripts/apache-modphp/postunpack.sh @@ -0,0 +1,37 @@ +#!/bin/bash + +# shellcheck disable=SC1091 + +set -o errexit +set -o nounset +set -o pipefail +# set -o xtrace # Uncomment this line for debugging purpose + +# Load libraries +. /opt/bitnami/scripts/libversion.sh +. /opt/bitnami/scripts/libapache.sh + +# Load Apache environment +. /opt/bitnami/scripts/apache-env.sh +. /opt/bitnami/scripts/php-env.sh + +# Enable required Apache modules +apache_enable_module "mpm_prefork_module" +php_version="$("${PHP_BIN_DIR}/php" -v | grep ^PHP | cut -d' ' -f2))" +php_major_version="$(get_sematic_version "$php_version" 1)" +if [[ "$php_major_version" -eq "8" ]]; then + apache_enable_module "php_module" "modules/libphp.so" +else + apache_enable_module "php${php_major_version}_module" "modules/libphp${php_major_version}.so" +fi + +# Disable incompatible Apache modules +apache_disable_module "mpm_event_module" + +# Write Apache configuration +apache_php_conf_file="${APACHE_CONF_DIR}/bitnami/php.conf" +cat > "$apache_php_conf_file" < + ServerAlias * + {{additional_configuration}} + diff --git a/rootfs/opt/bitnami/scripts/apache/bitnami-templates/app-generic-https-vhost.conf.tpl b/rootfs/opt/bitnami/scripts/apache/bitnami-templates/app-generic-https-vhost.conf.tpl new file mode 100644 index 00000000..b7e33c75 --- /dev/null +++ b/rootfs/opt/bitnami/scripts/apache/bitnami-templates/app-generic-https-vhost.conf.tpl @@ -0,0 +1,8 @@ +{{before_vhost_configuration}} + + ServerAlias * + SSLEngine on + SSLCertificateFile "{{APACHE_CONF_DIR}}/bitnami/certs/server.crt" + SSLCertificateKeyFile "{{APACHE_CONF_DIR}}/bitnami/certs/server.key" + {{additional_configuration}} + diff --git a/rootfs/opt/bitnami/scripts/apache/bitnami-templates/app-generic-prefix.conf.tpl b/rootfs/opt/bitnami/scripts/apache/bitnami-templates/app-generic-prefix.conf.tpl new file mode 100644 index 00000000..c895e537 --- /dev/null +++ b/rootfs/opt/bitnami/scripts/apache/bitnami-templates/app-generic-prefix.conf.tpl @@ -0,0 +1 @@ +{{additional_configuration}} diff --git a/rootfs/opt/bitnami/scripts/apache/bitnami-templates/app-http-vhost.conf.tpl b/rootfs/opt/bitnami/scripts/apache/bitnami-templates/app-http-vhost.conf.tpl new file mode 100644 index 00000000..97bc1927 --- /dev/null +++ b/rootfs/opt/bitnami/scripts/apache/bitnami-templates/app-http-vhost.conf.tpl @@ -0,0 +1,13 @@ +{{before_vhost_configuration}} + + ServerAlias * + DocumentRoot {{document_root}} + + Options -Indexes +FollowSymLinks -MultiViews + AllowOverride {{allow_override}} + {{acl_configuration}} + {{extra_directory_configuration}} + + {{additional_configuration}} + {{htaccess_include}} + diff --git a/rootfs/opt/bitnami/scripts/apache/bitnami-templates/app-https-vhost.conf.tpl b/rootfs/opt/bitnami/scripts/apache/bitnami-templates/app-https-vhost.conf.tpl new file mode 100644 index 00000000..c6debd7f --- /dev/null +++ b/rootfs/opt/bitnami/scripts/apache/bitnami-templates/app-https-vhost.conf.tpl @@ -0,0 +1,16 @@ +{{before_vhost_configuration}} + + ServerAlias * + SSLEngine on + SSLCertificateFile "{{APACHE_CONF_DIR}}/bitnami/certs/server.crt" + SSLCertificateKeyFile "{{APACHE_CONF_DIR}}/bitnami/certs/server.key" + DocumentRoot {{document_root}} + + Options -Indexes +FollowSymLinks -MultiViews + AllowOverride {{allow_override}} + {{acl_configuration}} + {{extra_directory_configuration}} + + {{additional_configuration}} + {{htaccess_include}} + diff --git a/rootfs/opt/bitnami/scripts/apache/bitnami-templates/app-prefix.conf.tpl b/rootfs/opt/bitnami/scripts/apache/bitnami-templates/app-prefix.conf.tpl new file mode 100644 index 00000000..fc0f6c21 --- /dev/null +++ b/rootfs/opt/bitnami/scripts/apache/bitnami-templates/app-prefix.conf.tpl @@ -0,0 +1,9 @@ +{{prefix_conf}} + + Options -Indexes +FollowSymLinks -MultiViews + AllowOverride {{allow_override}} + {{acl_configuration}} + {{extra_directory_configuration}} + +{{additional_configuration}} +{{htaccess_include}} diff --git a/rootfs/opt/bitnami/scripts/apache/bitnami-templates/app-proxy-http-vhost.conf.tpl b/rootfs/opt/bitnami/scripts/apache/bitnami-templates/app-proxy-http-vhost.conf.tpl new file mode 100644 index 00000000..6c320e3f --- /dev/null +++ b/rootfs/opt/bitnami/scripts/apache/bitnami-templates/app-proxy-http-vhost.conf.tpl @@ -0,0 +1,6 @@ + + ServerAlias * + ProxyPass / {{proxy_address}} + ProxyPassReverse / {{proxy_address}} + {{additional_configuration}} + diff --git a/rootfs/opt/bitnami/scripts/apache/bitnami-templates/app-proxy-https-vhost.conf.tpl b/rootfs/opt/bitnami/scripts/apache/bitnami-templates/app-proxy-https-vhost.conf.tpl new file mode 100644 index 00000000..2273f610 --- /dev/null +++ b/rootfs/opt/bitnami/scripts/apache/bitnami-templates/app-proxy-https-vhost.conf.tpl @@ -0,0 +1,8 @@ + + ServerAlias * + SSLCertificateFile "{{APACHE_CONF_DIR}}/bitnami/certs/server.crt" + SSLCertificateKeyFile "{{APACHE_CONF_DIR}}/bitnami/certs/server.key" + ProxyPass / {{proxy_address}} + ProxyPassReverse / {{proxy_address}} + {{additional_configuration}} + diff --git a/rootfs/opt/bitnami/scripts/apache/bitnami-templates/app-proxy-prefix.conf.tpl b/rootfs/opt/bitnami/scripts/apache/bitnami-templates/app-proxy-prefix.conf.tpl new file mode 100644 index 00000000..ffd0e721 --- /dev/null +++ b/rootfs/opt/bitnami/scripts/apache/bitnami-templates/app-proxy-prefix.conf.tpl @@ -0,0 +1,10 @@ +{{prefix_conf}} + + Options -Indexes +FollowSymLinks -MultiViews + AllowOverride {{allow_override}} + {{acl_configuration}} + ProxyPass / {{proxy_address}} + ProxyPassReverse / {{proxy_address}} + {{extra_directory_configuration}} + +{{additional_configuration}} diff --git a/rootfs/opt/bitnami/scripts/apache/bitnami-templates/app-ruby-passenger-http-vhost.conf.tpl b/rootfs/opt/bitnami/scripts/apache/bitnami-templates/app-ruby-passenger-http-vhost.conf.tpl new file mode 100644 index 00000000..e8a3788d --- /dev/null +++ b/rootfs/opt/bitnami/scripts/apache/bitnami-templates/app-ruby-passenger-http-vhost.conf.tpl @@ -0,0 +1,14 @@ +{{before_vhost_configuration}} +PassengerPreStart http://localhost:{{APACHE_DEFAULT_HTTP_PORT_NUMBER}}/ + + ServerAlias * + DocumentRoot {{document_root}} + + Options -Indexes +FollowSymLinks -MultiViews + AllowOverride {{allow_override}} + {{acl_configuration}} + PassengerEnabled on + {{extra_directory_configuration}} + + {{additional_configuration}} + diff --git a/rootfs/opt/bitnami/scripts/apache/bitnami-templates/app-ruby-passenger-https-vhost.conf.tpl b/rootfs/opt/bitnami/scripts/apache/bitnami-templates/app-ruby-passenger-https-vhost.conf.tpl new file mode 100644 index 00000000..289a3b09 --- /dev/null +++ b/rootfs/opt/bitnami/scripts/apache/bitnami-templates/app-ruby-passenger-https-vhost.conf.tpl @@ -0,0 +1,17 @@ +{{before_vhost_configuration}} +PassengerPreStart https://localhost:{{APACHE_DEFAULT_HTTPS_PORT_NUMBER}}/ + + ServerAlias * + SSLEngine on + SSLCertificateFile "{{APACHE_CONF_DIR}}/bitnami/certs/server.crt" + SSLCertificateKeyFile "{{APACHE_CONF_DIR}}/bitnami/certs/server.key" + DocumentRoot {{document_root}} + + Options -Indexes +FollowSymLinks -MultiViews + AllowOverride {{allow_override}} + {{acl_configuration}} + PassengerEnabled on + {{extra_directory_configuration}} + + {{additional_configuration}} + diff --git a/rootfs/opt/bitnami/scripts/apache/bitnami-templates/app-ruby-passenger-prefix.conf.tpl b/rootfs/opt/bitnami/scripts/apache/bitnami-templates/app-ruby-passenger-prefix.conf.tpl new file mode 100644 index 00000000..2242d656 --- /dev/null +++ b/rootfs/opt/bitnami/scripts/apache/bitnami-templates/app-ruby-passenger-prefix.conf.tpl @@ -0,0 +1,9 @@ +{{prefix_conf}} + + Options -Indexes +FollowSymLinks -MultiViews + AllowOverride {{allow_override}} + {{acl_configuration}} + PassengerEnabled on + {{extra_directory_configuration}} + +{{additional_configuration}} diff --git a/rootfs/opt/bitnami/scripts/apache/bitnami-templates/bitnami-ssl.conf.tpl b/rootfs/opt/bitnami/scripts/apache/bitnami-templates/bitnami-ssl.conf.tpl new file mode 100644 index 00000000..f1d31ed3 --- /dev/null +++ b/rootfs/opt/bitnami/scripts/apache/bitnami-templates/bitnami-ssl.conf.tpl @@ -0,0 +1,29 @@ +# Default SSL Virtual Host configuration. + + + LoadModule ssl_module modules/mod_ssl.so + + +Listen 443 +SSLProtocol all -SSLv2 -SSLv3 +SSLHonorCipherOrder on +SSLCipherSuite "EECDH+ECDSA+AESGCM EECDH+aRSA+AESGCM EECDH+ECDSA+SHA384 EECDH+ECDSA+SHA256 EECDH+aRSA+SHA384 EECDH+aRSA+SHA256 EECDH !aNULL !eNULL !LOW !3DES !MD5 !EXP !PSK !SRP !DSS !EDH !RC4" +SSLPassPhraseDialog builtin +SSLSessionCache "shmcb:{{APACHE_LOGS_DIR}}/ssl_scache(512000)" +SSLSessionCacheTimeout 300 + + + DocumentRoot "{{APACHE_BASE_DIR}}/htdocs" + SSLEngine on + SSLCertificateFile "{{APACHE_CONF_DIR}}/bitnami/certs/server.crt" + SSLCertificateKeyFile "{{APACHE_CONF_DIR}}/bitnami/certs/server.key" + + + Options Indexes FollowSymLinks + AllowOverride All + Require all granted + + + # Error Documents + ErrorDocument 503 /503.html + diff --git a/rootfs/opt/bitnami/scripts/apache/bitnami-templates/bitnami.conf.tpl b/rootfs/opt/bitnami/scripts/apache/bitnami-templates/bitnami.conf.tpl new file mode 100644 index 00000000..6d3b2289 --- /dev/null +++ b/rootfs/opt/bitnami/scripts/apache/bitnami-templates/bitnami.conf.tpl @@ -0,0 +1,18 @@ +# Default Virtual Host configuration. + +# Let Apache know we're behind a SSL reverse proxy +SetEnvIf X-Forwarded-Proto https HTTPS=on + + + DocumentRoot "{{APACHE_BASE_DIR}}/htdocs" + + Options Indexes FollowSymLinks + AllowOverride All + Require all granted + + + # Error Documents + ErrorDocument 503 /503.html + + +Include "{{APACHE_CONF_DIR}}/bitnami/bitnami-ssl.conf" diff --git a/rootfs/opt/bitnami/scripts/apache/entrypoint.sh b/rootfs/opt/bitnami/scripts/apache/entrypoint.sh new file mode 100755 index 00000000..3d0e4ce6 --- /dev/null +++ b/rootfs/opt/bitnami/scripts/apache/entrypoint.sh @@ -0,0 +1,27 @@ +#!/bin/bash + +# shellcheck disable=SC1091 + +set -o errexit +set -o nounset +set -o pipefail +#set -o xtrace + +# Load libraries +. /opt/bitnami/scripts/libapache.sh +. /opt/bitnami/scripts/libbitnami.sh +. /opt/bitnami/scripts/liblog.sh + +# Load Apache environment +. /opt/bitnami/scripts/apache-env.sh + +print_welcome_page + +if [[ "$*" == *"/opt/bitnami/scripts/apache/run.sh"* ]]; then + info "** Starting Apache setup **" + /opt/bitnami/scripts/apache/setup.sh + info "** Apache setup finished! **" +fi + +echo "" +exec "$@" diff --git a/rootfs/opt/bitnami/scripts/apache/postunpack.sh b/rootfs/opt/bitnami/scripts/apache/postunpack.sh new file mode 100755 index 00000000..e7d67d19 --- /dev/null +++ b/rootfs/opt/bitnami/scripts/apache/postunpack.sh @@ -0,0 +1,115 @@ +#!/bin/bash + +# shellcheck disable=SC1091 + +set -o errexit +set -o nounset +set -o pipefail +# set -o xtrace # Uncomment this line for debugging purpose + +# Load libraries +. /opt/bitnami/scripts/libapache.sh +. /opt/bitnami/scripts/libfs.sh +. /opt/bitnami/scripts/liblog.sh + +######################## +# Sets up the default Bitnami configuration +# Globals: +# APACHE_* +# Arguments: +# None +# Returns: +# None +######################### +apache_setup_bitnami_config() { + local template_dir="${BITNAMI_ROOT_DIR}/scripts/apache/bitnami-templates" + + # Enable Apache modules + local -a modules_to_enable=( + "deflate_module" + "negotiation_module" + "proxy[^\s]*_module" + "rewrite_module" + "slotmem_shm_module" + "socache_shmcb_module" + "ssl_module" + "status_module" + "version_module" + ) + for module in "${modules_to_enable[@]}"; do + apache_enable_module "$module" + done + + # Disable Apache modules + local -a modules_to_disable=( + "http2_module" + "proxy_hcheck_module" + ) + for module in "${modules_to_disable[@]}"; do + apache_disable_module "$module" + done + + # Bitnami customizations + render-template "${template_dir}/bitnami.conf.tpl" > "${APACHE_CONF_DIR}/bitnami/bitnami.conf" + render-template "${template_dir}/bitnami-ssl.conf.tpl" > "${APACHE_CONF_DIR}/bitnami/bitnami-ssl.conf" + + # Add new configuration only once, to avoid a second postunpack run breaking Apache + local apache_conf_add + apache_conf_add="$(cat <>"$APACHE_CONF_FILE" < + RequestHeader unset Proxy + +EOF + fi +} + +# Load Apache environment +. /opt/bitnami/scripts/apache-env.sh + +apache_setup_bitnami_config + +# Ensure non-root user has write permissions on a set of directories +for dir in "$APACHE_TMP_DIR" "$APACHE_CONF_DIR" "$APACHE_LOGS_DIR" "$APACHE_VHOSTS_DIR" "$APACHE_HTACCESS_DIR" "$APACHE_HTDOCS_DIR" "$APACHE_MOD_PAGESPEED_CACHE_DIR"; do + ensure_dir_exists "$dir" + chmod -R g+rwX "$dir" +done + +# Create 'apache2' symlink pointing to the 'apache' directory, for compatibility with Bitnami Docs guides +ln -sf apache "${BITNAMI_ROOT_DIR}/apache2" + +ln -sf "/dev/stdout" "${APACHE_LOGS_DIR}/access_log" +ln -sf "/dev/stderr" "${APACHE_LOGS_DIR}/error_log" diff --git a/rootfs/opt/bitnami/scripts/apache/reload.sh b/rootfs/opt/bitnami/scripts/apache/reload.sh new file mode 100755 index 00000000..3bf21a28 --- /dev/null +++ b/rootfs/opt/bitnami/scripts/apache/reload.sh @@ -0,0 +1,18 @@ +#!/bin/bash + +# shellcheck disable=SC1091 + +set -o errexit +set -o nounset +set -o pipefail +# set -o xtrace # Uncomment this line for debugging purpose + +# Load libraries +. /opt/bitnami/scripts/libapache.sh +. /opt/bitnami/scripts/liblog.sh + +# Load Apache environment +. /opt/bitnami/scripts/apache-env.sh + +info "** Reloading Apache configuration **" +exec "${APACHE_BIN_DIR}/apachectl" -k graceful diff --git a/rootfs/opt/bitnami/scripts/apache/restart.sh b/rootfs/opt/bitnami/scripts/apache/restart.sh new file mode 100755 index 00000000..8993aaa5 --- /dev/null +++ b/rootfs/opt/bitnami/scripts/apache/restart.sh @@ -0,0 +1,17 @@ +#!/bin/bash + +# shellcheck disable=SC1091 + +set -o errexit +set -o nounset +set -o pipefail +# set -o xtrace # Uncomment this line for debugging purposes + +# Load libraries +. /opt/bitnami/scripts/libapache.sh + +# Load Apache environment variables +. /opt/bitnami/scripts/apache-env.sh + +/opt/bitnami/scripts/apache/stop.sh +/opt/bitnami/scripts/apache/start.sh diff --git a/rootfs/opt/bitnami/scripts/apache/run.sh b/rootfs/opt/bitnami/scripts/apache/run.sh new file mode 100755 index 00000000..1ab422dd --- /dev/null +++ b/rootfs/opt/bitnami/scripts/apache/run.sh @@ -0,0 +1,18 @@ +#!/bin/bash + +# shellcheck disable=SC1091 + +set -o errexit +set -o nounset +set -o pipefail +# set -o xtrace # Uncomment this line for debugging purpose + +# Load libraries +. /opt/bitnami/scripts/libapache.sh +. /opt/bitnami/scripts/liblog.sh + +# Load Apache environment +. /opt/bitnami/scripts/apache-env.sh + +info "** Starting Apache **" +exec "${APACHE_BIN_DIR}/httpd" -f "$APACHE_CONF_FILE" -D "FOREGROUND" diff --git a/rootfs/opt/bitnami/scripts/apache/setup.sh b/rootfs/opt/bitnami/scripts/apache/setup.sh new file mode 100755 index 00000000..4aec08b3 --- /dev/null +++ b/rootfs/opt/bitnami/scripts/apache/setup.sh @@ -0,0 +1,60 @@ +#!/bin/bash + +# shellcheck disable=SC1091 + +set -o errexit +set -o nounset +set -o pipefail +# set -o xtrace # Uncomment this line for debugging purpose + +# Load libraries +. /opt/bitnami/scripts/libapache.sh + +# Load Apache environment +. /opt/bitnami/scripts/apache-env.sh + +# Ensure Apache environment variables are valid +apache_validate + +# Ensure Apache daemon user exists when running as 'root' +am_i_root && ensure_user_exists "$APACHE_DAEMON_USER" --group "$APACHE_DAEMON_GROUP" + +# Copy vhosts files +if ! is_dir_empty "/vhosts"; then + info "Found mounted virtual hosts in '/vhosts'. Copying them to '${APACHE_BASE_DIR}/conf/vhosts'" + cp -Lr "/vhosts/." "${APACHE_VHOSTS_DIR}" +fi + +# Mount certificate files +if ! is_dir_empty "${APACHE_BASE_DIR}/certs"; then + warn "The directory '${APACHE_BASE_DIR}/certs' was externally mounted. This is a legacy configuration and will be deprecated soon. Please mount certificate files at '/certs' instead. Find an example at: https://github.com/bitnami/bitnami-docker-apache#using-custom-ssl-certificates" + warn "Restoring certificates at '${APACHE_BASE_DIR}/certs' to '${APACHE_CONF_DIR}/bitnami/certs'" + rm -rf "${APACHE_CONF_DIR}/bitnami/certs" + ln -sf "${APACHE_BASE_DIR}/certs" "${APACHE_CONF_DIR}/bitnami/certs" +elif ! is_dir_empty "/certs"; then + info "Mounting certificates files from '/certs'" + rm -rf "${APACHE_CONF_DIR}/bitnami/certs" + ln -sf "/certs" "${APACHE_CONF_DIR}/bitnami/certs" +fi + +# Mount application files +if ! is_dir_empty "/app"; then + info "Mounting application files from '/app'" + rm -rf "$APACHE_HTDOCS_DIR" + ln -sf "/app" "$APACHE_HTDOCS_DIR" +fi + +# Restore persisted configuration files (deprecated) +if ! is_dir_empty "/bitnami/apache/conf"; then + warn "The directory '/bitnami/apache/conf' was externally mounted. This is a legacy configuration and will be deprecated soon. Please mount certificate files at '${APACHE_CONF_DIR}' instead. Find an example at: https://github.com/bitnami/bitnami-docker-apache#full-configuration" + warn "Restoring configuration at '/bitnami/apache/conf' to '${APACHE_CONF_DIR}'" + rm -rf "$APACHE_CONF_DIR" + ln -sf "/bitnami/apache/conf" "$APACHE_CONF_DIR" +fi + +# Update ports in configuration +[[ -n "$APACHE_HTTP_PORT_NUMBER" ]] && info "Configuring the HTTP port" && apache_configure_http_port "$APACHE_HTTP_PORT_NUMBER" +[[ -n "$APACHE_HTTPS_PORT_NUMBER" ]] && info "Configuring the HTTPS port" && apache_configure_https_port "$APACHE_HTTPS_PORT_NUMBER" + +# Fix logging issue when running as root +! am_i_root || chmod o+w "$(readlink /dev/stdout)" "$(readlink /dev/stderr)" diff --git a/rootfs/opt/bitnami/scripts/apache/start.sh b/rootfs/opt/bitnami/scripts/apache/start.sh new file mode 100755 index 00000000..fe367807 --- /dev/null +++ b/rootfs/opt/bitnami/scripts/apache/start.sh @@ -0,0 +1,32 @@ +#!/bin/bash + +# shellcheck disable=SC1091 + +set -o errexit +set -o nounset +set -o pipefail +# set -o xtrace # Uncomment this line for debugging purposes + +# Load libraries +. /opt/bitnami/scripts/libapache.sh +. /opt/bitnami/scripts/libos.sh +. /opt/bitnami/scripts/liblog.sh + +# Load Apache environment variables +. /opt/bitnami/scripts/apache-env.sh + +error_code=0 + +if is_apache_not_running; then + "${APACHE_BIN_DIR}/httpd" -f "$APACHE_CONF_FILE" + if ! retry_while "is_apache_running"; then + error "apache did not start" + error_code=1 + else + info "apache started" + fi +else + info "apache is already running" +fi + +exit "$error_code" diff --git a/rootfs/opt/bitnami/scripts/apache/status.sh b/rootfs/opt/bitnami/scripts/apache/status.sh new file mode 100755 index 00000000..c6f434dd --- /dev/null +++ b/rootfs/opt/bitnami/scripts/apache/status.sh @@ -0,0 +1,21 @@ +#!/bin/bash + +# shellcheck disable=SC1091 + +set -o errexit +set -o nounset +set -o pipefail +# set -o xtrace # Uncomment this line for debugging purposes + +# Load libraries +. /opt/bitnami/scripts/libapache.sh +. /opt/bitnami/scripts/liblog.sh + +# Load Apache environment variables +. /opt/bitnami/scripts/apache-env.sh + +if is_apache_running; then + info "apache is already running" +else + info "apache is not running" +fi diff --git a/rootfs/opt/bitnami/scripts/apache/stop.sh b/rootfs/opt/bitnami/scripts/apache/stop.sh new file mode 100755 index 00000000..6ac7f07e --- /dev/null +++ b/rootfs/opt/bitnami/scripts/apache/stop.sh @@ -0,0 +1,32 @@ +#!/bin/bash + +# shellcheck disable=SC1091 + +set -o errexit +set -o nounset +set -o pipefail +# set -o xtrace # Uncomment this line for debugging purposes + +# Load libraries +. /opt/bitnami/scripts/libapache.sh +. /opt/bitnami/scripts/libos.sh +. /opt/bitnami/scripts/liblog.sh + +# Load Apache environment variables +. /opt/bitnami/scripts/apache-env.sh + +error_code=0 + +if is_apache_running; then + BITNAMI_QUIET=1 apache_stop + if ! retry_while "is_apache_not_running"; then + error "apache could not be stopped" + error_code=1 + else + info "apache stopped" + fi +else + info "apache is not running" +fi + +exit "$error_code" diff --git a/rootfs/opt/bitnami/scripts/drupal-env.sh b/rootfs/opt/bitnami/scripts/drupal-env.sh new file mode 100644 index 00000000..872cbeec --- /dev/null +++ b/rootfs/opt/bitnami/scripts/drupal-env.sh @@ -0,0 +1,117 @@ +#!/bin/bash +# +# Environment configuration for drupal + +# The values for all environment variables will be set in the below order of precedence +# 1. Custom environment variables defined below after Bitnami defaults +# 2. Constants defined in this file (environment variables with no default), i.e. BITNAMI_ROOT_DIR +# 3. Environment variables overridden via external files using *_FILE variables (see below) +# 4. Environment variables set externally (i.e. current Bash context/Dockerfile/userdata) + +# Load logging library +. /opt/bitnami/scripts/liblog.sh + +export BITNAMI_ROOT_DIR="/opt/bitnami" +export BITNAMI_VOLUME_DIR="/bitnami" + +# Logging configuration +export MODULE="${MODULE:-drupal}" +export BITNAMI_DEBUG="${BITNAMI_DEBUG:-false}" + +# By setting an environment variable matching *_FILE to a file path, the prefixed environment +# variable will be overridden with the value specified in that file +drupal_env_vars=( + DRUPAL_DATA_TO_PERSIST + DRUPAL_PROFILE + DRUPAL_SITE_NAME + DRUPAL_SKIP_BOOTSTRAP + DRUPAL_ENABLE_MODULES + DRUPAL_CONFIG_SYNC_DIR + DRUPAL_HASH_SALT + DRUPAL_USERNAME + DRUPAL_PASSWORD + DRUPAL_EMAIL + DRUPAL_SMTP_HOST + DRUPAL_SMTP_PORT_NUMBER + DRUPAL_SMTP_USER + DRUPAL_SMTP_PASSWORD + DRUPAL_SMTP_PROTOCOL + DRUPAL_DATABASE_HOST + DRUPAL_DATABASE_PORT_NUMBER + DRUPAL_DATABASE_NAME + DRUPAL_DATABASE_USER + DRUPAL_DATABASE_PASSWORD + DRUPAL_DATABASE_TLS_CA_FILE + SMTP_HOST + SMTP_PORT + DRUPAL_SMTP_PORT + SMTP_USER + SMTP_PASSWORD + SMTP_PROTOCOL + MARIADB_HOST + MARIADB_PORT_NUMBER +) +for env_var in "${drupal_env_vars[@]}"; do + file_env_var="${env_var}_FILE" + if [[ -n "${!file_env_var:-}" ]]; then + if [[ -r "${!file_env_var:-}" ]]; then + export "${env_var}=$(< "${!file_env_var}")" + unset "${file_env_var}" + else + warn "Skipping export of '${env_var}'. '${!file_env_var:-}' is not readable." + fi + fi +done +unset drupal_env_vars + +# Paths +export DRUPAL_BASE_DIR="${BITNAMI_ROOT_DIR}/drupal" +export DRUPAL_CONF_FILE="${DRUPAL_BASE_DIR}/sites/default/settings.php" +export DRUPAL_MODULES_DIR="${DRUPAL_BASE_DIR}/modules" + +# Drupal persistence configuration +export DRUPAL_VOLUME_DIR="${BITNAMI_VOLUME_DIR}/drupal" +export DRUPAL_MOUNTED_CONF_FILE="${DRUPAL_VOLUME_DIR}/settings.php" +export DRUPAL_DATA_TO_PERSIST="${DRUPAL_DATA_TO_PERSIST:-sites/ themes/ modules/ profiles/}" + +# Drupal configuration +export DRUPAL_PROFILE="${DRUPAL_PROFILE:-standard}" # only used during the first initialization +export DRUPAL_SITE_NAME="${DRUPAL_SITE_NAME:-My blog}" # only used during the first initialization +export DRUPAL_SKIP_BOOTSTRAP="${DRUPAL_SKIP_BOOTSTRAP:-}" # only used during the first initialization +export DRUPAL_ENABLE_MODULES="${DRUPAL_ENABLE_MODULES:-}" # only used during the first initialization +export DRUPAL_CONFIG_SYNC_DIR="${DRUPAL_CONFIG_SYNC_DIR:-}" # only used during the first initialization +export DRUPAL_HASH_SALT="${DRUPAL_HASH_SALT:-}" # only used during the first initialization + +# Drupal credentials +export DRUPAL_USERNAME="${DRUPAL_USERNAME:-user}" # only used during the first initialization +export DRUPAL_PASSWORD="${DRUPAL_PASSWORD:-bitnami}" # only used during the first initialization +export DRUPAL_EMAIL="${DRUPAL_EMAIL:-user@example.com}" # only used during the first initialization + +# Drupal SMTP credentials +DRUPAL_SMTP_HOST="${DRUPAL_SMTP_HOST:-"${SMTP_HOST:-}"}" +export DRUPAL_SMTP_HOST="${DRUPAL_SMTP_HOST:-}" # only used during the first initialization +DRUPAL_SMTP_PORT_NUMBER="${DRUPAL_SMTP_PORT_NUMBER:-"${SMTP_PORT:-}"}" +DRUPAL_SMTP_PORT_NUMBER="${DRUPAL_SMTP_PORT_NUMBER:-"${DRUPAL_SMTP_PORT:-}"}" +export DRUPAL_SMTP_PORT_NUMBER="${DRUPAL_SMTP_PORT_NUMBER:-25}" # only used during the first initialization +DRUPAL_SMTP_USER="${DRUPAL_SMTP_USER:-"${SMTP_USER:-}"}" +export DRUPAL_SMTP_USER="${DRUPAL_SMTP_USER:-}" # only used during the first initialization +DRUPAL_SMTP_PASSWORD="${DRUPAL_SMTP_PASSWORD:-"${SMTP_PASSWORD:-}"}" +export DRUPAL_SMTP_PASSWORD="${DRUPAL_SMTP_PASSWORD:-}" # only used during the first initialization +DRUPAL_SMTP_PROTOCOL="${DRUPAL_SMTP_PROTOCOL:-"${SMTP_PROTOCOL:-}"}" +export DRUPAL_SMTP_PROTOCOL="${DRUPAL_SMTP_PROTOCOL:-standard}" # only used during the first initialization + +# Database configuration +export DRUPAL_DEFAULT_DATABASE_HOST="mariadb" # only used at build time +DRUPAL_DATABASE_HOST="${DRUPAL_DATABASE_HOST:-"${MARIADB_HOST:-}"}" +export DRUPAL_DATABASE_HOST="${DRUPAL_DATABASE_HOST:-$DRUPAL_DEFAULT_DATABASE_HOST}" # only used during the first initialization +DRUPAL_DATABASE_PORT_NUMBER="${DRUPAL_DATABASE_PORT_NUMBER:-"${MARIADB_PORT_NUMBER:-}"}" +export DRUPAL_DATABASE_PORT_NUMBER="${DRUPAL_DATABASE_PORT_NUMBER:-3306}" # only used during the first initialization +export DRUPAL_DATABASE_NAME="${DRUPAL_DATABASE_NAME:-bitnami_drupal}" # only used during the first initialization +export DRUPAL_DATABASE_USER="${DRUPAL_DATABASE_USER:-bn_drupal}" # only used during the first initialization +export DRUPAL_DATABASE_PASSWORD="${DRUPAL_DATABASE_PASSWORD:-}" # only used during the first initialization +export DRUPAL_DATABASE_TLS_CA_FILE="${DRUPAL_DATABASE_TLS_CA_FILE:-}" # only used during the first initialization + +# PHP configuration +export PHP_DEFAULT_MEMORY_LIMIT="256M" # only used at build time + +# Custom environment variables may be defined below diff --git a/rootfs/opt/bitnami/scripts/drupal/entrypoint.sh b/rootfs/opt/bitnami/scripts/drupal/entrypoint.sh new file mode 100755 index 00000000..28199c59 --- /dev/null +++ b/rootfs/opt/bitnami/scripts/drupal/entrypoint.sh @@ -0,0 +1,31 @@ +#!/bin/bash + +# shellcheck disable=SC1091 + +set -o errexit +set -o nounset +set -o pipefail +# set -o xtrace # Uncomment this line for debugging purpose + +# Load Drupal environment +. /opt/bitnami/scripts/drupal-env.sh + +# Load libraries +. /opt/bitnami/scripts/libbitnami.sh +. /opt/bitnami/scripts/liblog.sh +. /opt/bitnami/scripts/libwebserver.sh + +print_welcome_page + +if [[ "$1" = "/opt/bitnami/scripts/$(web_server_type)/run.sh" || "$1" = "/opt/bitnami/scripts/nginx-php-fpm/run.sh" ]]; then + info "** Starting Drupal setup **" + /opt/bitnami/scripts/"$(web_server_type)"/setup.sh + /opt/bitnami/scripts/php/setup.sh + /opt/bitnami/scripts/mysql-client/setup.sh + /opt/bitnami/scripts/drupal/setup.sh + /post-init.sh + info "** Drupal setup finished! **" +fi + +echo "" +exec "$@" diff --git a/rootfs/opt/bitnami/scripts/drupal/postunpack.sh b/rootfs/opt/bitnami/scripts/drupal/postunpack.sh new file mode 100755 index 00000000..07e151b9 --- /dev/null +++ b/rootfs/opt/bitnami/scripts/drupal/postunpack.sh @@ -0,0 +1,127 @@ +#!/bin/bash + +# shellcheck disable=SC1090,SC1091 + +set -o errexit +set -o nounset +set -o pipefail +# set -o xtrace # Uncomment this line for debugging purpose + +# Load Drupal environment +. /opt/bitnami/scripts/drupal-env.sh + +# Load PHP environment for 'php_conf_set' (after 'drupal-env.sh' so that MODULE is not set to a wrong value) +. /opt/bitnami/scripts/php-env.sh + +# Load libraries +. /opt/bitnami/scripts/libdrupal.sh +. /opt/bitnami/scripts/libfile.sh +. /opt/bitnami/scripts/libfs.sh +. /opt/bitnami/scripts/liblog.sh +. /opt/bitnami/scripts/libphp.sh +. /opt/bitnami/scripts/libwebserver.sh + +# Load web server environment and functions (after Drupal environment file so MODULE is not set to a wrong value) +. "/opt/bitnami/scripts/$(web_server_type)-env.sh" + +# Enable Drupal configuration file +[[ ! -f "$DRUPAL_CONF_FILE" ]] && cp "${DRUPAL_BASE_DIR}/sites/default/default.settings.php" "$DRUPAL_CONF_FILE" + +# Create .htaccess file to avoid warning in Drupal administration panel +drupal_fix_htaccess_warning_protection + +# Ensure the Drupal base directory exists and has proper permissions +info "Configuring file permissions for Drupal" +for dir in "$DRUPAL_BASE_DIR" "${DRUPAL_BASE_DIR}/sites/default/files" "$DRUPAL_VOLUME_DIR" "${HOME}/.drush"; do + ensure_dir_exists "$dir" + configure_permissions_ownership "$dir" -d "775" -f "664" +done +for dir in "${DRUPAL_BASE_DIR}/themes" "${DRUPAL_BASE_DIR}/modules" "${DRUPAL_BASE_DIR}/sites/default/files"; do + ensure_dir_exists "$dir" + configure_permissions_ownership "$dir" -u "$WEB_SERVER_DAEMON_USER" -g "root" +done +chown "$WEB_SERVER_DAEMON_USER" "${DRUPAL_BASE_DIR}/sites/default" +chown "$WEB_SERVER_DAEMON_USER" "$DRUPAL_CONF_FILE" +for script in "${DRUPAL_BASE_DIR}/vendor/drush/drush/drush" "${DRUPAL_BASE_DIR}/vendor/drush/drush/drush.launcher"; do + [[ -f "$script" ]] && chmod +x "$script" +done + +# Configure Drupal based on build-time defaults +drupal_conf_set "\$settings['trusted_host_patterns']" "array('^.*$')" yes + +# Configure required PHP options for application to work properly, based on build-time defaults +info "Configuring default PHP options for Drupal" +php_conf_set memory_limit "$PHP_DEFAULT_MEMORY_LIMIT" + +# Enable default web server configuration for Drupal +info "Creating default web server configuration for Drupal" +web_server_validate +ensure_web_server_app_configuration_exists "drupal" \ + --type php \ + --nginx-additional-configuration $' +location = /favicon.ico { + log_not_found off; + access_log off; +} + +location = /robots.txt { + allow all; + log_not_found off; + access_log off; +} + +location ~ ^/sites/.*/private/ { + return 403; +} + +# Block access to scripts in site files directory +location ~ ^/sites/[^/]+/files/.*\.php$ { + deny all; +} + +# Allow "Well-Known URIs" as per RFC 5785 +location ~* ^/.well-known/ { + allow all; +} + +location / { + try_files $uri /index.php?$query_string; +} + +location @rewrite { + rewrite ^/(.*)$ /index.php?q=$1; +} + +# Don\'t allow direct access to PHP files in the vendor directory. +location ~ /vendor/.*\.php$ { + deny all; + return 404; +} + +# Fighting with Styles? This little gem is amazing. +location ~ ^/sites/.*/files/styles/ { + try_files $uri @rewrite; +} + +# Handle private files through Drupal. Private file\'s path can come +# with a language prefix. +location ~ ^(/[a-z\-]+)?/system/files/ { + try_files $uri /index.php?$query_string; +} + +location ~* \.(js|css|png|jpg|jpeg|gif|ico|svg)$ { + try_files $uri @rewrite; + expires max; + log_not_found off; +}' + +# Fix common issues running Drupal on top of the NGINX web server, if enabled +# See: https://pantheon.io/blog/update-your-nginx-config-drupal-8 +nginx_php_fpm_conf_file="${BITNAMI_ROOT_DIR}/nginx/conf/bitnami/php-fpm.conf" +if [[ -f "$nginx_php_fpm_conf_file" ]]; then + replace_in_file "$nginx_php_fpm_conf_file" '^(\s*)(fastcgi_index\s+index\.php;)$' '\1\2\n\1fastcgi_split_path_info ^(.+?\.php)(|/.*)$;' + replace_in_file "$nginx_php_fpm_conf_file" '(\s\\.php\$)(\s)' '\1|^/update.php\2' +fi + +# Re-create .htaccess file after being moved into 'apache/conf/vhosts/htaccess' directory, to avoid Drupal warning +drupal_fix_htaccess_warning_protection diff --git a/rootfs/opt/bitnami/scripts/drupal/setup.sh b/rootfs/opt/bitnami/scripts/drupal/setup.sh new file mode 100755 index 00000000..514792f9 --- /dev/null +++ b/rootfs/opt/bitnami/scripts/drupal/setup.sh @@ -0,0 +1,36 @@ +#!/bin/bash + +# shellcheck disable=SC1090,SC1091 + +set -o errexit +set -o nounset +set -o pipefail +# set -o xtrace # Uncomment this line for debugging purpose + +# Load Drupal environment +. /opt/bitnami/scripts/drupal-env.sh + +# Load MySQL Client environment for 'mysql_remote_execute' (after 'drupal-env.sh' so that MODULE is not set to a wrong value) +if [[ -f /opt/bitnami/scripts/mysql-client-env.sh ]]; then + . /opt/bitnami/scripts/mysql-client-env.sh +elif [[ -f /opt/bitnami/scripts/mysql-env.sh ]]; then + . /opt/bitnami/scripts/mysql-env.sh +elif [[ -f /opt/bitnami/scripts/mariadb-env.sh ]]; then + . /opt/bitnami/scripts/mariadb-env.sh +fi + +# Load libraries +. /opt/bitnami/scripts/libdrupal.sh +. /opt/bitnami/scripts/libwebserver.sh + +# Load web server environment and functions (after Drupal environment file so MODULE is not set to a wrong value) +. "/opt/bitnami/scripts/$(web_server_type)-env.sh" + +# Ensure Drupal environment variables are valid +drupal_validate + +# Update web server configuration with runtime environment (needs to happen before the initialization) +web_server_update_app_configuration "drupal" + +# Ensure Drupal is initialized +drupal_initialize diff --git a/rootfs/opt/bitnami/scripts/libapache.sh b/rootfs/opt/bitnami/scripts/libapache.sh new file mode 100644 index 00000000..18146f22 --- /dev/null +++ b/rootfs/opt/bitnami/scripts/libapache.sh @@ -0,0 +1,671 @@ +#!/bin/bash +# +# Bitnami Apache library + +# shellcheck disable=SC1091 + +# Load Generic Libraries +. /opt/bitnami/scripts/libfs.sh +. /opt/bitnami/scripts/libfile.sh +. /opt/bitnami/scripts/liblog.sh +. /opt/bitnami/scripts/libos.sh +. /opt/bitnami/scripts/libvalidations.sh +. /opt/bitnami/scripts/libservice.sh + +######################## +# Validate settings in APACHE_* env vars +# Globals: +# APACHE_* +# Arguments: +# None +# Returns: +# None +######################### +apache_validate() { + debug "Validating settings in APACHE_* environment variables" + local error_code=0 + + # Auxiliary functions + print_validation_error() { + error "$1" + error_code=1 + } + + check_allowed_port() { + local port_var="${1:?missing port variable}" + local -a validate_port_args=() + ! am_i_root && validate_port_args+=("-unprivileged") + validate_port_args+=("${!port_var}") + if ! err=$(validate_port "${validate_port_args[@]}"); then + print_validation_error "An invalid port was specified in the environment variable ${port_var}: ${err}." + fi + } + + [[ -w "$APACHE_CONF_FILE" ]] || warn "The Apache configuration file '${APACHE_CONF_FILE}' is not writable. Configurations based on environment variables will not be applied." + + if [[ -n "$APACHE_HTTP_PORT_NUMBER" ]] && [[ -n "$APACHE_HTTPS_PORT_NUMBER" ]]; then + if [[ "$APACHE_HTTP_PORT_NUMBER" -eq "$APACHE_HTTPS_PORT_NUMBER" ]]; then + print_validation_error "APACHE_HTTP_PORT_NUMBER and APACHE_HTTPS_PORT_NUMBER are bound to the same port!" + fi + fi + + [[ -n "$APACHE_HTTP_PORT_NUMBER" ]] && check_allowed_port APACHE_HTTP_PORT_NUMBER + [[ -n "$APACHE_HTTPS_PORT_NUMBER" ]] && check_allowed_port APACHE_HTTPS_PORT_NUMBER + + [[ "$error_code" -eq 0 ]] || exit "$error_code" +} + +######################## +# Configure Apache's HTTP port +# Globals: +# APACHE_CONF_FILE, APACHE_CONF_DIR +# Arguments: +# None +# Returns: +# None +######################### +apache_configure_http_port() { + local -r port=${1:?missing port} + local -r listen_exp="s|^\s*Listen\s+([^:]*:)?[0-9]+\s*$|Listen ${port}|" + local -r server_name_exp="s|^\s*#?\s*ServerName\s+([^:\s]+)(:[0-9]+)?$|ServerName \1:${port}|" + local -r vhost_exp="s|VirtualHost\s+([^:>]+)(:[0-9]+)|VirtualHost \1:${port}|" + local apache_configuration + + if [[ -w "$APACHE_CONF_FILE" ]]; then + debug "Configuring port ${port} on file ${APACHE_CONF_FILE}" + apache_configuration="$(sed -E -e "$listen_exp" -e "$server_name_exp" "$APACHE_CONF_FILE")" + echo "$apache_configuration" > "$APACHE_CONF_FILE" + fi + + if [[ -w "${APACHE_CONF_DIR}/bitnami/bitnami.conf" ]]; then + debug "Configuring port ${port} on file ${APACHE_CONF_DIR}/bitnami/bitnami.conf" + apache_configuration="$(sed -E "$vhost_exp" "${APACHE_CONF_DIR}/bitnami/bitnami.conf")" + echo "$apache_configuration" > "${APACHE_CONF_DIR}/bitnami/bitnami.conf" + fi + + if [[ -w "${APACHE_VHOSTS_DIR}/00_status-vhost.conf" ]]; then + debug "Configuring port ${port} on file ${APACHE_VHOSTS_DIR}/00_status-vhost.conf" + apache_configuration="$(sed -E "$vhost_exp" "${APACHE_VHOSTS_DIR}/00_status-vhost.conf")" + echo "$apache_configuration" > "${APACHE_VHOSTS_DIR}/00_status-vhost.conf" + fi +} + +######################## +# Configure Apache's HTTPS port +# Globals: +# APACHE_CONF_DIR +# Arguments: +# None +# Returns: +# None +######################### +apache_configure_https_port() { + local -r port=${1:?missing port} + local -r listen_exp="s|^\s*Listen\s+([^:]*:)?[0-9]+\s*$|Listen ${port}|" + local -r vhost_exp="s|VirtualHost\s+([^:>]+)(:[0-9]+)|VirtualHost \1:${port}|" + local apache_configuration + + if [[ -w "${APACHE_CONF_DIR}/bitnami/bitnami-ssl.conf" ]]; then + debug "Configuring port ${port} on file ${APACHE_CONF_DIR}/bitnami/bitnami-ssl.conf" + apache_configuration="$(sed -E -e "$listen_exp" -e "$vhost_exp" "${APACHE_CONF_DIR}/bitnami/bitnami-ssl.conf")" + echo "$apache_configuration" > "${APACHE_CONF_DIR}/bitnami/bitnami-ssl.conf" + fi +} + +######################## +# Enable a module in the Apache configuration file +# Globals: +# APACHE_CONF_FILE +# Arguments: +# $1 - Module to enable +# $2 - Path to module .so file (optional if already defined in httpd.conf) +# Returns: +# None +######################### +apache_enable_module() { + local -r name="${1:?missing name}" + local -r file="${2:-}" + local -r regex="[#\s]*(LoadModule\s+${name}\s+.*)$" + local apache_configuration + + if [[ -w "$APACHE_CONF_FILE" ]]; then + debug "Enabling module '${name}'" + if grep -q -E "$regex" "$APACHE_CONF_FILE"; then + # Uncomment line if the module was already defined + replace_in_file "$APACHE_CONF_FILE" "$regex" "\1" + elif [[ -n "$file" ]]; then + # Add right after the last LoadModule, so all Apache modules are organized in the same section of the file + append_file_after_last_match "$APACHE_CONF_FILE" "^[#\s]*LoadModule" "LoadModule ${name} ${file}" + else + error "Module ${name} was not defined in ${APACHE_CONF_FILE}. Please specify the 'file' parameter for 'apache_enable_module'." + fi + fi +} + +######################## +# Disable a module in the Apache configuration file +# Globals: +# APACHE_CONF_FILE +# Arguments: +# $1 - Module to disable +# Returns: +# None +######################### +apache_disable_module() { + local -r name="${1:?missing name}" + local -r file="${2:-}" + local -r regex="[#\s]*(LoadModule\s+${name}\s+.*)$" + local apache_configuration + + if [[ -w "$APACHE_CONF_FILE" ]]; then + debug "Disabling module '${name}'" + replace_in_file "$APACHE_CONF_FILE" "$regex" "#\1" + fi +} + +######################## +# Stop Apache +# Globals: +# APACHE_* +# Arguments: +# None +# Returns: +# None +######################### +apache_stop() { + is_apache_not_running && return + stop_service_using_pid "$APACHE_PID_FILE" +} + +######################## +# Check if Apache is running +# Globals: +# APACHE_PID_FILE +# Arguments: +# None +# Returns: +# Whether Apache is running +######################## +is_apache_running() { + local pid + pid="$(get_pid_from_file "$APACHE_PID_FILE")" + if [[ -n "$pid" ]]; then + is_service_running "$pid" + else + false + fi +} + +######################## +# Check if Apache is running +# Globals: +# APACHE_PID_FILE +# Arguments: +# None +# Returns: +# Whether Apache is not running +######################## +is_apache_not_running() { + ! is_apache_running +} + +######################## +# Ensure configuration gets added to the main Apache configuration file +# Globals: +# APACHE_* +# Arguments: +# $1 - configuration string +# $2 - pattern to use for checking if the configuration already exists (default: $1) +# Returns: +# None +######################## +ensure_apache_configuration_exists() { + local -r conf="${1:?conf missing}" + local -r pattern="${2:-"$conf"}" + # Enable configuration by appending to httpd.conf + if ! grep -E -q "$pattern" "$APACHE_CONF_FILE"; then + if is_file_writable "$APACHE_CONF_FILE"; then + cat >> "$APACHE_CONF_FILE" <<< "$conf" + else + error "Could not add the following configuration to '${APACHE_CONF_FILE}:" + error "" + error "$(indent "$conf" 4)" + error "" + error "Include the configuration manually and try again." + return 1 + fi + fi +} + +######################## +# Collect all the .htaccess files from /opt/bitnami/$name and write the result in the 'htaccess' directory +# Globals: +# APACHE_* +# Arguments: +# $1 - App name +# $2 - Overwrite the original .htaccess with the explanation text (defaults to 'yes') +# Flags: +# --document-root - Path to document root directory +# Returns: +# None +######################## +apache_replace_htaccess_files() { + local -r app="${1:?missing app}" + local -r result_file="${APACHE_HTACCESS_DIR}/${app}-htaccess.conf" + # Default options + local document_root="${BITNAMI_ROOT_DIR}/${app}" + local overwrite="yes" + local -a htaccess_files + local htaccess_dir + local htaccess_contents + # Validate arguments + shift + while [[ "$#" -gt 0 ]]; do + case "$1" in + --document-root) + shift + document_root="$1" + ;; + --overwrite) + shift + overwrite="$1" + ;; + *) + echo "Invalid command line flag ${1}" >&2 + return 1 + ;; + esac + shift + done + if is_file_writable "$result_file"; then + # Locate all .htaccess files inside the document root + read -r -a htaccess_files <<< "$(find "$document_root" -name .htaccess -print0 | xargs -0)" + [[ "${#htaccess_files[@]}" = 0 ]] && return + # Create file with root group write privileges, so it can be modified in non-root containers + [[ ! -f "$result_file" ]] && touch "$result_file" && chmod g+rw "$result_file" + for htaccess_file in "${htaccess_files[@]}"; do + htaccess_dir="$(dirname "$htaccess_file")" + htaccess_contents="$(indent "$(< "$htaccess_file")" 2)" + # Skip if it was already included to the resulting htaccess file + if grep -q "^" <<< "$htaccess_contents"; then + continue + fi + # Add to the htaccess file + cat >> "$result_file" < +${htaccess_contents} + +EOF + # Overwrite the original .htaccess with the explanation text + if is_boolean_yes "$overwrite"; then + echo "# This configuration has been moved to the ${result_file} config file for performance and security reasons" > "$htaccess_file" + fi + done + elif [[ ! -f "$result_file" ]]; then + error "Could not create htaccess for ${app} at '${result_file}'. Check permissions and ownership for parent directories." + return 1 + else + warn "The ${app} htaccess file '${result_file}' is not writable. Configurations based on environment variables will not be applied for this file." + return + fi +} + +######################## +# Ensure an Apache application configuration exists (in virtual host format) +# Globals: +# APACHE_* +# Arguments: +# $1 - App name +# Flags: +# --hosts - Hosts to enable +# --type - Application type, which has an effect on what configuration template will be used, allowed values: php, (empty) +# --allow-remote-connections - Whether to allow remote connections or to require local connections +# --disabled - Whether to render the file with a .disabled prefix +# --enable-https - Enable app configuration on HTTPS port +# --http-port - HTTP port number +# --https-port - HTTPS port number +# --move-htaccess - Move .htaccess files to a common place so they can be loaded during Apache startup +# --additional-configuration - Additional vhost configuration (no default) +# --before-vhost-configuration - Configuration to add before the directive (no default) +# --allow-override - Whether to allow .htaccess files (only allowed when --move-htaccess is set to 'no') +# --document-root - Path to document root directory +# --extra-directory-configuration - Extra configuration for the document root directory +# Returns: +# true if the configuration was enabled, false otherwise +######################## +ensure_apache_app_configuration_exists() { + local -r app="${1:?missing app}" + # Default options + local -a hosts=("127.0.0.1" "_default_") + local type="" + local allow_remote_connections="yes" + local disabled="no" + local enable_https="yes" + local http_port="${APACHE_HTTP_PORT_NUMBER:-"$APACHE_DEFAULT_HTTP_PORT_NUMBER"}" + local https_port="${APACHE_HTTPS_PORT_NUMBER:-"$APACHE_DEFAULT_HTTPS_PORT_NUMBER"}" + local move_htaccess="yes" + local var_name + # Template variables defaults + export additional_configuration="" + export before_vhost_configuration="" + export allow_override="All" + export document_root="${BITNAMI_ROOT_DIR}/${app}" + export extra_directory_configuration="" + export proxy_address="" + # Validate arguments + shift + while [[ "$#" -gt 0 ]]; do + case "$1" in + --hosts) + shift + read -r -a hosts <<< "$1" + ;; + --type \ + | --allow-remote-connections \ + | --disabled \ + | --enable-https \ + | --http-port \ + | --https-port \ + | --move-htaccess \ + | --additional-configuration \ + | --before-vhost-configuration \ + | --allow-override \ + | --document-root \ + | --extra-directory-configuration \ + | --proxy-address \ + ) + var_name="$(echo "$1" | sed -e "s/^--//" -e "s/-/_/g")" + shift + export "${var_name}"="$1" + ;; + *) + echo "Invalid command line flag $1" >&2 + return 1 + ;; + esac + shift + done + # Construct host string in the format of "host1:port1[ host2:port2[ ...]]" + export http_listen_addresses="" + export https_listen_addresses="" + for host in "${hosts[@]}"; do + http_listen="${host}:${http_port}" + https_listen="${host}:${https_port}" + [[ -z "${http_listen_addresses:-}" ]] && http_listen_addresses="$http_listen" || http_listen_addresses="${http_listen_addresses} ${http_listen}" + [[ -z "${https_listen_addresses:-}" ]] && https_listen_addresses="$https_listen" || https_listen_addresses="${https_listen_addresses} ${https_listen}" + done + # App .htaccess support + export htaccess_include + is_boolean_yes "$move_htaccess" && apache_replace_htaccess_files "$app" --document-root "$document_root" + if [[ -f "${APACHE_HTACCESS_DIR}/${app}-htaccess.conf" ]]; then + allow_override="None" + htaccess_include="Include \"${APACHE_HTACCESS_DIR}/${app}-htaccess.conf\"" + else + allow_override="$allow_override" + htaccess_include="" + fi + # ACL configuration + export acl_configuration + if is_boolean_yes "$allow_remote_connections"; then + acl_configuration="Require all granted" + else + acl_configuration="$(cat < "$http_vhost" + elif [[ ! -f "$http_vhost" ]]; then + error "Could not create virtual host for ${app} at '${http_vhost}'. Check permissions and ownership for parent directories." + return 1 + else + warn "The ${app} virtual host file '${http_vhost}' is not writable. Configurations based on environment variables will not be applied for this file." + fi + if is_boolean_yes "$enable_https"; then + if is_file_writable "$https_vhost"; then + # Create file with root group write privileges, so it can be modified in non-root containers + [[ ! -f "$https_vhost" ]] && touch "$https_vhost" && chmod g+rw "$https_vhost" + render-template "${template_dir}/${template_name}-https-vhost.conf.tpl" | sed '/^\s*$/d' > "$https_vhost" + elif [[ ! -f "$https_vhost" ]]; then + error "Could not create virtual host for ${app} at '${https_vhost}'. Check permissions and ownership for parent directories." + return 1 + else + warn "The ${app} virtual host file '${https_vhost}' is not writable. Configurations based on environment variables will not be applied for this file." + fi + fi +} + +######################## +# Ensure an Apache application configuration does not exist anymore (in virtual hosts format) +# Globals: +# * +# Arguments: +# $1 - App name +# Returns: +# true if the configuration was disabled, false otherwise +######################## +ensure_apache_app_configuration_not_exists() { + local -r app="${1:?missing app}" + local -r http_vhost="${APACHE_VHOSTS_DIR}/${app}-vhost.conf" + local -r https_vhost="${APACHE_VHOSTS_DIR}/${app}-https-vhost.conf" + # Note that 'rm -f' will not fail if the files don't exist + # However if we lack permissions to remove the file, it will result in a non-zero exit code, as expected by this function + rm -f "$http_vhost" "$https_vhost" +} + +######################## +# Ensure Apache loads the configuration for an application in a URL prefix +# Globals: +# APACHE_* +# Arguments: +# $1 - App name +# Flags: +# --type - Application type, which has an effect on what configuration template will be used, allowed values: php, (empty) +# --allow-remote-connections - Whether to allow remote connections or to require local connections +# --move-htaccess - Move .htaccess files to a common place so they can be loaded during Apache startup +# --prefix - URL prefix from where it will be accessible (i.e. /myapp) +# --additional-configuration - Additional vhost configuration (no default) +# --allow-override - Whether to allow .htaccess files (only allowed when --move-htaccess is set to 'no') +# --document-root - Path to document root directory +# --extra-directory-configuration - Extra configuration for the document root directory +# Returns: +# true if the configuration was enabled, false otherwise +######################## +ensure_apache_prefix_configuration_exists() { + local -r app="${1:?missing app}" + # Default options + local type="" + local allow_remote_connections="yes" + local move_htaccess="yes" + local prefix="/${app}" + local var_name + # Template variables defaults + export additional_configuration="" + export allow_override="All" + export document_root="${BITNAMI_ROOT_DIR}/${app}" + export extra_directory_configuration="" + # Validate arguments + shift + while [[ "$#" -gt 0 ]]; do + case "$1" in + --type \ + | --allow-remote-connections \ + | --move-htaccess \ + | --prefix \ + | --additional-configuration \ + | --allow-override \ + | --document-root \ + | --extra-directory-configuration \ + ) + var_name="$(echo "$1" | sed -e "s/^--//" -e "s/-/_/g")" + shift + declare "${var_name}"="$1" + ;; + *) + echo "Invalid command line flag $1" >&2 + return 1 + ;; + esac + shift + done + # App .htaccess support + export htaccess_include + is_boolean_yes "$move_htaccess" && apache_replace_htaccess_files "$app" --document-root "$document_root" + if [[ -f "${APACHE_HTACCESS_DIR}/${app}-htaccess.conf" ]]; then + allow_override="None" + htaccess_include="Include \"${APACHE_HTACCESS_DIR}/${app}-htaccess.conf\"" + else + allow_override="$allow_override" + htaccess_include="" + fi + # ACL configuration + export acl_configuration + if is_boolean_yes "$allow_remote_connections"; then + acl_configuration="Require all granted" + else + acl_configuration="$(cat < "$prefix_file" + ensure_apache_configuration_exists "Include \"$prefix_file\"" + elif [[ ! -f "$prefix_file" ]]; then + error "Could not create web server configuration file for ${app} at '${prefix_file}'. Check permissions and ownership for parent directories." + return 1 + else + warn "The ${app} web server configuration file '${prefix_file}' is not writable. Configurations based on environment variables will not be applied for this file." + fi +} + +######################## +# Ensure Apache application configuration is updated with the runtime configuration (i.e. ports) +# Globals: +# * +# Arguments: +# $1 - App name +# Flags: +# --hosts - Hosts to enable +# --enable-https - Update HTTPS app configuration +# --http-port - HTTP port number +# --https-port - HTTPS port number +# Returns: +# true if the configuration was updated, false otherwise +######################## +apache_update_app_configuration() { + local -r app="${1:?missing app}" + # Default options + local -a hosts=("127.0.0.1" "_default_") + local enable_https="yes" + local http_port="${APACHE_HTTP_PORT_NUMBER:-"$APACHE_DEFAULT_HTTP_PORT_NUMBER"}" + local https_port="${APACHE_HTTPS_PORT_NUMBER:-"$APACHE_DEFAULT_HTTPS_PORT_NUMBER"}" + # Validate arguments + shift + while [[ "$#" -gt 0 ]]; do + case "$1" in + --hosts) + shift + read -r -a hosts <<< "$1" + ;; + + # Common flags + --enable-https \ + | --http-port \ + | --https-port \ + ) + args+=("$1" "$2") + shift + ;; + + *) + echo "Invalid command line flag $1" >&2 + return 1 + ;; + esac + shift + done + # Construct host string in the format of "host1:port1[ host2:port2[ ...]]" + export http_listen_addresses="" + export https_listen_addresses="" + for host in "${hosts[@]}"; do + http_listen="${host}:${http_port}" + https_listen="${host}:${https_port}" + [[ -z "${http_listen_addresses:-}" ]] && http_listen_addresses="$http_listen" || http_listen_addresses="${http_listen_addresses} ${http_listen}" + [[ -z "${https_listen_addresses:-}" ]] && https_listen_addresses="$https_listen" || https_listen_addresses="${https_listen_addresses} ${https_listen}" + done + # Update configuration + local -r http_vhost="${APACHE_VHOSTS_DIR}/${app}-vhost.conf" + local -r https_vhost="${APACHE_VHOSTS_DIR}/${app}-https-vhost.conf" + if is_file_writable "$http_vhost"; then + replace_in_file "$http_vhost" "^$" "" + else + warn "The ${app} virtual host file '${http_vhost}' is not writable. Configurations based on environment variables will not be applied for this file." + fi + if is_boolean_yes "$enable_https"; then + if is_file_writable "$https_vhost"; then + replace_in_file "$https_vhost" "^$" "" + else + warn "The ${app} virtual host file '${https_vhost}' is not writable. Configurations based on environment variables will not be applied for this file." + fi + fi +} + +######################## +# Create a password file for basic authentication and restrict its permissions +# Globals: +# * +# Arguments: +# $1 - file +# $2 - username +# $3 - password +# Returns: +# true if the configuration was updated, false otherwise +######################## +apache_create_password_file() { + local -r file="${1:?missing file}" + local -r username="${2:?missing username}" + local -r password="${3:?missing password}" + + "${APACHE_BIN_DIR}/htpasswd" -bc "$file" "$username" "$password" + am_i_root && configure_permissions_ownership "$file" --file-mode "600" --user "$APACHE_DAEMON_USER" --group "$APACHE_DAEMON_GROUP" +} diff --git a/rootfs/opt/bitnami/scripts/libdrupal.sh b/rootfs/opt/bitnami/scripts/libdrupal.sh new file mode 100644 index 00000000..7a9c72b5 --- /dev/null +++ b/rootfs/opt/bitnami/scripts/libdrupal.sh @@ -0,0 +1,565 @@ +#!/bin/bash +# +# Bitnami Drupal library + +# shellcheck disable=SC1091 + +# Load Generic Libraries +. /opt/bitnami/scripts/libphp.sh +. /opt/bitnami/scripts/libfs.sh +. /opt/bitnami/scripts/libos.sh +. /opt/bitnami/scripts/libnet.sh +. /opt/bitnami/scripts/libvalidations.sh +. /opt/bitnami/scripts/libversion.sh +. /opt/bitnami/scripts/libpersistence.sh +. /opt/bitnami/scripts/libwebserver.sh + +# Load database library +if [[ -f /opt/bitnami/scripts/libmysqlclient.sh ]]; then + . /opt/bitnami/scripts/libmysqlclient.sh +elif [[ -f /opt/bitnami/scripts/libmysql.sh ]]; then + . /opt/bitnami/scripts/libmysql.sh +elif [[ -f /opt/bitnami/scripts/libmariadb.sh ]]; then + . /opt/bitnami/scripts/libmariadb.sh +fi + +######################## +# Validate settings in DRUPAL_* env vars +# Globals: +# DRUPAL_* +# Arguments: +# None +# Returns: +# 0 if the validation succeeded, 1 otherwise +######################### +drupal_validate() { + debug "Validating settings in DRUPAL_* environment variables..." + local error_code=0 + + # Auxiliary functions + print_validation_error() { + error "$1" + error_code=1 + } + + check_multi_value() { + if [[ " ${2} " != *" ${!1} "* ]]; then + print_validation_error "The allowed values for ${1} are: ${2}" + fi + } + + check_yes_no_value() { + if ! is_yes_no_value "${!1}" && ! is_true_false_value "${!1}"; then + print_validation_error "The allowed values for ${1} are: yes no" + fi + } + + check_resolved_hostname() { + if ! is_hostname_resolved "$1"; then + warn "Hostname $1 could not be resolved. This could lead to connection issues" + fi + } + + check_mounted_file() { + if [[ -n "${!1:-}" ]] && ! [[ -f "${!1:-}" ]]; then + print_validation_error "The variable ${1} is defined but the file ${!1} is not accessible or does not exist" + fi + } + + # Warn users in case the configuration file is not writable + is_file_writable "$DRUPAL_CONF_FILE" || warn "The Drupal configuration file '${DRUPAL_CONF_FILE}' is not writable. Configurations based on environment variables will not be applied for this file." + + # Validate user inputs + ! is_empty_value "$DRUPAL_SKIP_BOOTSTRAP" && check_yes_no_value "DRUPAL_SKIP_BOOTSTRAP" + ! is_empty_value "$DRUPAL_DATABASE_PORT_NUMBER" && validate_port "$DRUPAL_DATABASE_PORT_NUMBER" + ! is_empty_value "$DRUPAL_DATABASE_HOST" && check_resolved_hostname "$DRUPAL_DATABASE_HOST" + check_mounted_file "DRUPAL_DATABASE_TLS_CA_FILE" + + # Validate database credentials + if is_boolean_yes "$ALLOW_EMPTY_PASSWORD"; then + warn "You set the environment variable ALLOW_EMPTY_PASSWORD=${ALLOW_EMPTY_PASSWORD}. For safety reasons, do not use this flag in a production environment." + else + for empty_env_var in "DRUPAL_DATABASE_PASSWORD" "DRUPAL_PASSWORD"; do + is_empty_value "${!empty_env_var}" && print_validation_error "The ${empty_env_var} environment variable is empty or not set. Set the environment variable ALLOW_EMPTY_PASSWORD=yes to allow a blank password. This is only recommended for development environments." + done + fi + + # Validate SMTP credentials + if ! is_empty_value "$DRUPAL_SMTP_HOST"; then + for empty_env_var in "DRUPAL_SMTP_USER" "DRUPAL_SMTP_PASSWORD" "DRUPAL_SMTP_PORT_NUMBER" "DRUPAL_SMTP_PROTOCOL"; do + is_empty_value "${!empty_env_var}" && warn "The ${empty_env_var} environment variable is empty or not set." + done + ! is_empty_value "$DRUPAL_SMTP_PORT_NUMBER" && validate_port "$DRUPAL_SMTP_PORT_NUMBER" + ! is_empty_value "$DRUPAL_SMTP_PROTOCOL" && check_multi_value "DRUPAL_SMTP_PROTOCOL" "standard tls ssl" + fi + + # Check that the web server is properly set up + web_server_validate || print_validation_error "Web server validation failed" + + return "$error_code" +} + +######################## +# Ensure Drupal is initialized +# Globals: +# DRUPAL_* +# Arguments: +# None +# Returns: +# None +######################### +drupal_initialize() { + # Update Drupal configuration via mounted configuration files and environment variables + if is_file_writable "$DRUPAL_CONF_FILE"; then + # Enable mounted configuration files + if [[ -f "$DRUPAL_MOUNTED_CONF_FILE" ]]; then + info "Found mounted Drupal configuration file '${DRUPAL_MOUNTED_CONF_FILE}', copying to '${DRUPAL_CONF_FILE}'" + cp "$DRUPAL_MOUNTED_CONF_FILE" "$DRUPAL_CONF_FILE" + return + fi + fi + + # Check if Drupal has already been initialized and persisted in a previous run + local -r app_name="drupal" + if ! is_app_initialized "$app_name"; then + info "Trying to connect to the database server" + drupal_wait_for_db_connection "$DRUPAL_DATABASE_HOST" "$DRUPAL_DATABASE_PORT_NUMBER" "$DRUPAL_DATABASE_NAME" "$DRUPAL_DATABASE_USER" "$DRUPAL_DATABASE_PASSWORD" + + # Ensure the Drupal base directory exists and has proper permissions + info "Configuring file permissions for Drupal" + ensure_dir_exists "$DRUPAL_VOLUME_DIR" + # Use daemon:root ownership for compatibility when running as a non-root user + am_i_root && configure_permissions_ownership "$DRUPAL_VOLUME_DIR" -d "775" -f "664" -u "$WEB_SERVER_DAEMON_USER" -g "root" + + if ! is_boolean_yes "$DRUPAL_SKIP_BOOTSTRAP"; then + # Perform initial bootstrapping for Drupal + info "Installing Drupal site" + drupal_site_install + if ! is_empty_value "$DRUPAL_ENABLE_MODULES"; then + info "Enabling Drupal modules" + drupal_enable_modules + fi + if ! is_empty_value "$DRUPAL_SMTP_HOST"; then + info "Configuring SMTP" + drupal_configure_smtp + fi + info "Flushing Drupal cache" + drupal_flush_cache + else + info "An already initialized Drupal database was provided, configuration will be skipped" + if is_empty_value "$DRUPAL_DATABASE_TLS_CA_FILE"; then + drupal_set_database_settings + else + drupal_set_database_ssl_settings + fi + + # Drupal expects a directory for storing site configuration + # For more info see https://www.drupal.org/docs/configuration-management + drupal_create_config_directory + + # Drupal needs a hash value to build one-time login links, cancel links, form tokens, etc. + drupal_set_hash_salt + drupal_update_database + fi + + info "Persisting Drupal installation" + persist_app "$app_name" "$DRUPAL_DATA_TO_PERSIST" + else + info "Restoring persisted Drupal installation" + restore_persisted_app "$app_name" "$DRUPAL_DATA_TO_PERSIST" + info "Trying to connect to the database server" + db_host="$(drupal_database_conf_get 'host')" + db_port="$(drupal_database_conf_get 'port')" + db_name="$(drupal_database_conf_get 'database')" + db_user="$(drupal_database_conf_get 'username')" + db_pass="$(drupal_database_conf_get 'password')" + drupal_wait_for_db_connection "$db_host" "$db_port" "$db_name" "$db_user" "$db_pass" + drupal_update_database + fi + + # Avoid exit code of previous commands to affect the result of this function + true +} + +######################## +# Get a database entry from the Drupal configuration file (settings.php) +# Globals: +# DRUPAL_* +# Arguments: +# $1 - Key +# Returns: +# None +######################### +drupal_database_conf_get() { + local -r key="${1:?key missing}" + debug "Getting ${key} from Drupal database configuration" + grep -E "^\s*'${key}' =>" "$DRUPAL_CONF_FILE" | grep -E -o "=> '.*'" | cut -f2 -d\' +} + +######################## +# Add or modify an entry in the Drupal configuration file (settings.php) +# Globals: +# DRUPAL_* +# Arguments: +# $1 - PHP variable name +# $2 - Value to assign to the PHP variable +# $3 - Whether the value is a literal, or if instead it should be quoted (default: no) +# Returns: +# None +######################### +drupal_conf_set() { + local -r key="${1:?key missing}" + local -r value="${2:?value missing}" + local -r is_literal="${3:-no}" + debug "Setting ${key} to '${value}' in Drupal configuration (literal: ${is_literal})" + # Sanitize key (sed does not support fixed string substitutions) + local sanitized_pattern + sanitized_pattern="^(#\s*)?$(sed 's/[]\[^$.*/]/\\&/g' <<< "$key")\s*=.*" + local entry + is_boolean_yes "$is_literal" && entry="${key} = $value;" || entry="${key} = '$value';" + # Check if the configuration exists in the file + if grep -q -E "$sanitized_pattern" "$DRUPAL_CONF_FILE"; then + # It exists, so replace the line + replace_in_file "$DRUPAL_CONF_FILE" "$sanitized_pattern" "$entry" + else + echo "$entry" >> "$DRUPAL_CONF_FILE" + fi +} + +######################## +# Wait until the database is accessible with the currently-known credentials +# Globals: +# * +# Arguments: +# $1 - database host +# $2 - database port +# $3 - database name +# $4 - database username +# $5 - database user password (optional) +# Returns: +# true if the database connection succeeded, false otherwise +######################### +drupal_wait_for_db_connection() { + local -r db_host="${1:?missing database host}" + local -r db_port="${2:?missing database port}" + local -r db_name="${3:?missing database name}" + local -r db_user="${4:?missing database user}" + local -r db_pass="${5:-}" + check_mysql_connection() { + echo "SELECT 1" | mysql_remote_execute "$db_host" "$db_port" "$db_name" "$db_user" "$db_pass" + } + if ! retry_while "check_mysql_connection"; then + error "Could not connect to the database" + return 1 + fi +} + +######################## +# Drupal Site Install +# Globals: +# * +# Arguments: +# None +# Returns: +# None +######################### +drupal_site_install() { + is_empty_value "$DRUPAL_DATABASE_TLS_CA_FILE" || drupal_set_database_ssl_settings + + ( + # Unfortunately there is no way to disable mail sending via sendmail when installing Drupal + # The "hack" consists of overriding the sendmail path to an executable that does nothing (i.e. "/bin/true") + # This is also what Drush is doing in their CI + PHP_OPTIONS="-d sendmail_path=$(which true)" + export PHP_OPTIONS + + drush_execute "site:install" \ + "--db-url=mysql://${DRUPAL_DATABASE_USER}:${DRUPAL_DATABASE_PASSWORD}@${DRUPAL_DATABASE_HOST}:${DRUPAL_DATABASE_PORT_NUMBER}/${DRUPAL_DATABASE_NAME}" \ + "--account-name=${DRUPAL_USERNAME}" \ + "--account-mail=${DRUPAL_EMAIL}" \ + "--account-pass=${DRUPAL_PASSWORD}" \ + "--site-name=${DRUPAL_SITE_NAME}" \ + "--site-mail=${DRUPAL_EMAIL}" \ + "-y" "$DRUPAL_PROFILE" + ) + + # When Drupal settings are patched to allow SSL database connections, the database settings block is duplicated + # after the installation with Drush + is_empty_value "$DRUPAL_DATABASE_TLS_CA_FILE" || drupal_remove_duplicated_database_settings + # Restrict permissions of the configuration file to keep the site secure + if am_i_root; then + configure_permissions_ownership "$DRUPAL_CONF_FILE" -u "root" -g "$WEB_SERVER_DAEMON_USER" -f "644" + fi +} + +######################## +# Create Drupal sync configuration directory (DRUPAL_SKIP_BOOTSTRAP only) +# Globals: +# DRUPAL_BASE_DIR +# Arguments: +# None +# Returns: +# None +######################### +drupal_create_config_directory() { + local config_sync_dir="${DRUPAL_CONFIG_SYNC_DIR:-}" + if is_empty_value "$config_sync_dir"; then + config_sync_dir="${DRUPAL_BASE_DIR}/sites/default/files/config_$(generate_random_string -t alphanumeric -c 16)" + fi + ensure_dir_exists "$config_sync_dir" + drupal_conf_set "\$settings['config_sync_directory']" "$config_sync_dir" +} + +######################## +# Create Drupal hash salt value (DRUPAL_SKIP_BOOTSTRAP only) +# Globals: +# DRUPAL_HASH_SALT +# Arguments: +# None +# Returns: +# None +######################### +drupal_set_hash_salt() { + local hash_salt="${DRUPAL_HASH_SALT:-}" + if is_empty_value "$hash_salt"; then + hash_salt="$(generate_random_string -t alphanumeric -c 32)" + fi + drupal_conf_set "\$settings['hash_salt']" "$hash_salt" +} + +######################## +# Execute Drush Tool +# Globals: +# * +# Arguments: +# $@ - Arguments to pass to the Drush tool +# Returns: +# None +######################### +drush_execute() { + if am_i_root; then + debug_execute gosu "$WEB_SERVER_DAEMON_USER" drush "--root=${DRUPAL_BASE_DIR}" "$@" + else + debug_execute drush "--root=${DRUPAL_BASE_DIR}" "$@" + fi +} + +######################## +# Execute Drush Tool to set a config option +# Globals: +# * +# Arguments: +# $1 - config group +# $2 - config key +# $3 - config value +# Returns: +# None +######################### +drush_config_set() { + local -r group="${1:?missing config group}" + local -r key="${2:?missing config key}" + local -r value="${3:?missing config value}" + + local -r major_version="$(get_sematic_version "$(drupal_get_version)" 1)" + if [[ "$major_version" -gt 7 ]]; then + drush_execute "config-set" "--yes" "$group" "$key" "$value" + else + drush_execute "variable-set" "$key" "$value" + fi +} + +######################## +# Get Drupal version +# Globals: +# * +# Arguments: +# None +# Returns: +# Version string +######################### +drupal_get_version() { + BITNAMI_DEBUG=true drush_execute "status" "drupal-version" "--pipe" | grep -E -o '[0-9.]+' +} + +######################## +# Drupal enable modules +# Globals: +# * +# Arguments: +# None +# Returns: +# None +######################### +drupal_enable_modules() { + local -a modules + read -r -a modules <<< "${DRUPAL_ENABLE_MODULES/,/ }" + [[ "${#modules[@]}" -gt 0 ]] || return 0 + drush_execute "pm:enable" "--yes" "${modules[@]}" +} + +######################## +# Drupal configure SMTP +# Globals: +# * +# Arguments: +# None +# Returns: +# None +######################### +drupal_configure_smtp() { + local -r major_version="$(get_sematic_version "$(drupal_get_version)" 1)" + + drush_execute "pm:enable" "--yes" "smtp" + + if [[ "$major_version" -gt 7 ]]; then + drush_config_set "system.mail" "interface.default" "SMTPMailSystem" + else + drush_execute "php:eval" 'variable_set("mail_system", array("default-system" => "SmtpMailSystem"))' + fi + + drush_config_set "smtp.settings" "smtp_on" "1" + drush_config_set "smtp.settings" "smtp_host" "$DRUPAL_SMTP_HOST" + drush_config_set "smtp.settings" "smtp_port" "$DRUPAL_SMTP_PORT_NUMBER" + drush_config_set "smtp.settings" "smtp_protocol" "$DRUPAL_SMTP_PROTOCOL" + drush_config_set "smtp.settings" "smtp_username" "$DRUPAL_SMTP_USER" + drush_config_set "smtp.settings" "smtp_password" "$DRUPAL_SMTP_PASSWORD" + drush_config_set "smtp.settings" "smtp_from" "$DRUPAL_EMAIL" + drush_config_set "smtp.settings" "smtp_fromname" "$DRUPAL_SITE_NAME" +} + +######################## +# Drupal flush cache +# Globals: +# * +# Arguments: +# None +# Returns: +# None +######################### +drupal_flush_cache() { + local -r major_version="$(get_sematic_version "$(drupal_get_version)" 1)" + if [[ "$major_version" -gt 7 ]]; then + drush_execute "cache:rebuild" + else + # This is occasionally needed by modules that make system-wide changes to access levels. + drush_execute "php:eval" 'node_access_rebuild();' + drush_execute "cache:clear" "all" + fi +} + +######################## +# Drupal update database +# Globals: +# * +# Arguments: +# None +# Returns: +# None +######################### +drupal_update_database() { + debug 'Upgrading Drupal database with drush...' + drush_execute "updatedb" +} + +######################## +# Drupal set database SSL settings +# Globals: +# * +# Arguments: +# None +# Returns: +# None +######################### +drupal_set_database_ssl_settings() { + cat >>"$DRUPAL_CONF_FILE" < '${DRUPAL_DATABASE_NAME}', + 'username' => '${DRUPAL_DATABASE_USER}', + 'password' => '${DRUPAL_DATABASE_PASSWORD}', + 'prefix' => '', + 'host' => '${DRUPAL_DATABASE_HOST}', + 'port' => '${DRUPAL_DATABASE_PORT_NUMBER}', + 'namespace' => 'Drupal\\Core\\Database\\Driver\\mysql', + 'driver' => 'mysql', + 'pdo' => array ( + PDO::MYSQL_ATTR_SSL_CA => '${DRUPAL_DATABASE_TLS_CA_FILE}', + PDO::MYSQL_ATTR_SSL_VERIFY_SERVER_CERT => 0 + ) +); +EOF +} + +######################## +# Drupal set database non-SSL settings (DRUPAL_SKIP_BOOTSTRAP only) +# Globals: +# * +# Arguments: +# None +# Returns: +# None +######################### +drupal_set_database_settings() { + cat >>"$DRUPAL_CONF_FILE" < '${DRUPAL_DATABASE_NAME}', + 'username' => '${DRUPAL_DATABASE_USER}', + 'password' => '${DRUPAL_DATABASE_PASSWORD}', + 'prefix' => '', + 'host' => '${DRUPAL_DATABASE_HOST}', + 'port' => '${DRUPAL_DATABASE_PORT_NUMBER}', + 'namespace' => 'Drupal\\Core\\Database\\Driver\\mysql', + 'driver' => 'mysql', +); +EOF +} + +######################## +# Drupal remove duplicated database block from settings file +# Globals: +# * +# Arguments: +# None +# Returns: +# None +######################### +drupal_remove_duplicated_database_settings() { + local -r first_line_block=$'\$databases\[\'default\'\]\[\'default\'\] = array \($' + local -r last_line_block='\);' + + remove_in_file "$DRUPAL_CONF_FILE" "${first_line_block}/,/${last_line_block}" +} + +######################## +# Drupal fix htaccess warning protection. +# Drupal checks for the htaccess file to prevent malicious attacks +# Globals: +# * +# Arguments: +# None +# Returns: +# None +######################### +drupal_fix_htaccess_warning_protection() { + local -r files_dir="${DRUPAL_BASE_DIR}/sites/default/files/" + local -r htaccess_file="${files_dir}/.htaccess" + + ensure_dir_exists "$files_dir" + cat <"$htaccess_file" +# Recommended protections: https://www.drupal.org/forum/newsletters/security-advisories-for-drupal-core/2013-11-20/sa-core-2013-003-drupal-core + +# Turn off all options we don\'t need. +Options -Indexes -ExecCGI -Includes -MultiViews + +# Set the catch-all handler to prevent scripts from being executed. +SetHandler Drupal_Security_Do_Not_Remove_See_SA_2006_006 + + # Override the handler again if we\'re run later in the evaluation list. + SetHandler Drupal_Security_Do_Not_Remove_See_SA_2013_003 + + +# If we know how to do it safely, disable the PHP engine entirely. + + php_flag engine off + +EOF +} diff --git a/rootfs/opt/bitnami/scripts/libmysqlclient.sh b/rootfs/opt/bitnami/scripts/libmysqlclient.sh new file mode 100644 index 00000000..dbc8ac30 --- /dev/null +++ b/rootfs/opt/bitnami/scripts/libmysqlclient.sh @@ -0,0 +1,1065 @@ +#!/bin/bash +# +# Bitnami MySQL 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 MYSQL_CLIENT_* environment variables +# Globals: +# MYSQL_CLIENT_* +# Arguments: +# None +# Returns: +# None +######################### +mysql_client_validate() { + info "Validating settings in MYSQL_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." + } + backslash_password_error() { + print_validation_error "The password cannot contain backslashes ('\'). Set the environment variable $1 with no backslashes (more info at https://dev.mysql.com/doc/refman/8.0/en/string-comparison-functions.html)" + } + + check_yes_no_value() { + if ! is_yes_no_value "${!1}" && ! is_true_false_value "${!1}"; then + print_validation_error "The allowed values for ${1} are: yes no" + fi + } + + check_multi_value() { + if [[ " ${2} " != *" ${!1} "* ]]; then + print_validation_error "The allowed values for ${1} are: ${2}" + fi + } + + # Only validate environment variables if any action needs to be performed + check_yes_no_value "MYSQL_CLIENT_ENABLE_SSL_WRAPPER" + check_multi_value "MYSQL_CLIENT_FLAVOR" "mariadb mysql" + + if [[ -n "$MYSQL_CLIENT_CREATE_DATABASE_USER" || -n "$MYSQL_CLIENT_CREATE_DATABASE_NAME" ]]; then + if is_boolean_yes "$ALLOW_EMPTY_PASSWORD"; then + empty_password_enabled_warn + else + if [[ -z "$MYSQL_CLIENT_DATABASE_ROOT_PASSWORD" ]]; then + empty_password_error "MYSQL_CLIENT_DATABASE_ROOT_PASSWORD" + fi + if [[ -n "$MYSQL_CLIENT_CREATE_DATABASE_USER" ]] && [[ -z "$MYSQL_CLIENT_CREATE_DATABASE_PASSWORD" ]]; then + empty_password_error "MYSQL_CLIENT_CREATE_DATABASE_PASSWORD" + fi + fi + if [[ "${MYSQL_CLIENT_DATABASE_ROOT_PASSWORD:-}" = *\\* ]]; then + backslash_password_error "MYSQL_CLIENT_DATABASE_ROOT_PASSWORD" + fi + if [[ "${MYSQL_CLIENT_CREATE_DATABASE_PASSWORD:-}" = *\\* ]]; then + backslash_password_error "MYSQL_CLIENT_CREATE_DATABASE_PASSWORD" + fi + fi + return "$error_code" +} + +######################## +# Perform actions to a database +# Globals: +# DB_* +# MYSQL_CLIENT_* +# Arguments: +# None +# Returns: +# None +######################### +mysql_client_initialize() { + # Wrap binary to force the usage of SSL + if is_boolean_yes "$MYSQL_CLIENT_ENABLE_SSL_WRAPPER"; then + mysql_client_wrap_binary_for_ssl + fi + # Wait for the database to be accessible if any action needs to be performed + if [[ -n "$MYSQL_CLIENT_CREATE_DATABASE_USER" || -n "$MYSQL_CLIENT_CREATE_DATABASE_NAME" ]]; then + info "Trying to connect to the database server" + check_mysql_connection() { + echo "SELECT 1" | mysql_execute "mysql" "$MYSQL_CLIENT_DATABASE_ROOT_USER" "$MYSQL_CLIENT_DATABASE_ROOT_PASSWORD" "-h" "$MYSQL_CLIENT_DATABASE_HOST" "-P" "$MYSQL_CLIENT_DATABASE_PORT_NUMBER" + } + if ! retry_while "check_mysql_connection"; then + error "Could not connect to the database server" + return 1 + fi + fi + # Ensure a database user exists in the server + if [[ -n "$MYSQL_CLIENT_CREATE_DATABASE_USER" ]]; then + info "Creating database user ${MYSQL_CLIENT_CREATE_DATABASE_USER}" + local -a args=("$MYSQL_CLIENT_CREATE_DATABASE_USER" "--host" "$MYSQL_CLIENT_DATABASE_HOST" "--port" "$MYSQL_CLIENT_DATABASE_PORT_NUMBER") + [[ -n "$MYSQL_CLIENT_CREATE_DATABASE_PASSWORD" ]] && args+=("-p" "$MYSQL_CLIENT_CREATE_DATABASE_PASSWORD") + [[ -n "$MYSQL_CLIENT_DATABASE_AUTHENTICATION_PLUGIN" ]] && args+=("--auth-plugin" "$MYSQL_CLIENT_DATABASE_AUTHENTICATION_PLUGIN") + mysql_ensure_optional_user_exists "${args[@]}" + fi + # Ensure a database exists in the server (and that the user has write privileges, if specified) + if [[ -n "$MYSQL_CLIENT_CREATE_DATABASE_NAME" ]]; then + info "Creating database ${MYSQL_CLIENT_CREATE_DATABASE_NAME}" + local -a createdb_args=("$MYSQL_CLIENT_CREATE_DATABASE_NAME" "--host" "$MYSQL_CLIENT_DATABASE_HOST" "--port" "$MYSQL_CLIENT_DATABASE_PORT_NUMBER") + [[ -n "$MYSQL_CLIENT_CREATE_DATABASE_USER" ]] && createdb_args+=("-u" "$MYSQL_CLIENT_CREATE_DATABASE_USER") + [[ -n "$MYSQL_CLIENT_CREATE_DATABASE_CHARACTER_SET" ]] && createdb_args+=("--character-set" "$MYSQL_CLIENT_CREATE_DATABASE_CHARACTER_SET") + [[ -n "$MYSQL_CLIENT_CREATE_DATABASE_COLLATE" ]] && createdb_args+=("--collate" "$MYSQL_CLIENT_CREATE_DATABASE_COLLATE") + [[ -n "$MYSQL_CLIENT_CREATE_DATABASE_PRIVILEGES" ]] && createdb_args+=("--privileges" "$MYSQL_CLIENT_CREATE_DATABASE_PRIVILEGES") + mysql_ensure_optional_database_exists "${createdb_args[@]}" + fi +} + +######################## +# Wrap binary to force the usage of SSL +# Globals: +# DB_* +# MYSQL_CLIENT_* +# Arguments: +# None +# Returns: +# None +######################### +mysql_client_wrap_binary_for_ssl() { + local -r wrapper_file="${DB_BIN_DIR}/mysql" + local -r wrapped_binary_file="${DB_BASE_DIR}/.bin/mysql" + local -a ssl_opts=() + read -r -a ssl_opts <<< "$(mysql_client_extra_opts)" + + mv "$wrapper_file" "$wrapped_binary_file" + cat >"$wrapper_file" <> "$custom_conf_file" + cat "$old_custom_conf_file" >> "$custom_conf_file" + fi + if am_i_root; then + [[ -e "$DB_VOLUME_DIR/.initialized" ]] && rm "$DB_VOLUME_DIR/.initialized" + rm -rf "$DB_VOLUME_DIR/conf" + else + warn "Old custom configuration migrated, please manually remove the 'conf' directory from the volume use to persist data" + fi +} + +######################## +# Ensure a db user exists with the given password for the '%' host +# Globals: +# DB_* +# Flags: +# -p|--password - database password +# -u|--user - database user +# --auth-plugin - authentication plugin +# --use-ldap - authenticate user via LDAP +# --host - database host +# --port - database host +# Arguments: +# $1 - database user +# Returns: +# None +######################### +mysql_ensure_user_exists() { + local -r user="${1:?user is required}" + local password="" + local auth_plugin="" + local use_ldap="no" + local hosts + local auth_string="" + # 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 database password}" + ;; + --auth-plugin) + shift + auth_plugin="${1:?missing authentication plugin}" + ;; + --use-ldap) + use_ldap="yes" + ;; + --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 + if is_boolean_yes "$use_ldap"; then + auth_string="identified via pam using '$DB_FLAVOR'" + elif [[ -n "$password" ]]; then + if [[ -n "$auth_plugin" ]]; then + auth_string="identified with $auth_plugin by \"$password\"" + else + auth_string="identified by \"$password\"" + fi + fi + debug "creating database user \'$user\'" + + local -a mysql_execute_cmd=("mysql_execute") + local -a mysql_execute_print_output_cmd=("mysql_execute_print_output") + if [[ -n "$db_host" && -n "$db_port" ]]; then + mysql_execute_cmd=("mysql_remote_execute" "$db_host" "$db_port") + mysql_execute_print_output_cmd=("mysql_remote_execute_print_output" "$db_host" "$db_port") + fi + + local mysql_create_user_cmd + [[ "$DB_FLAVOR" = "mariadb" ]] && mysql_create_user_cmd="create or replace user" || mysql_create_user_cmd="create user if not exists" + "${mysql_execute_cmd[@]}" "mysql" "$DB_ROOT_USER" "$DB_ROOT_PASSWORD" <=10.4, the mysql.user table was replaced with a view: https://mariadb.com/kb/en/mysqluser-table/ + # Views have a definer user, in this case set to 'root', which needs to exist for the view to work + # In MySQL, to avoid issues when renaming the root user, they use the 'mysql.sys' user as a definer: https://dev.mysql.com/doc/refman/5.7/en/sys-schema.html + # However, for MariaDB that is not the case, so when the 'root' user is renamed the 'mysql.user' table stops working and the view needs to be fixed + if [[ "$user" != "root" && ! "$(mysql_get_version)" =~ ^10.[0123]. ]]; then + alter_view_str="$(mysql_execute_print_output "mysql" "$user" "$password" "-s" <&2 + return 1 + ;; + esac + shift + done + + local -a mysql_execute_cmd=("mysql_execute") + [[ -n "$db_host" && -n "$db_port" ]] && mysql_execute_cmd=("mysql_remote_execute" "$db_host" "$db_port") + + local -a create_database_args=() + [[ -n "$character_set" ]] && create_database_args+=("character set = '${character_set}'") + [[ -n "$collate" ]] && create_database_args+=("collate = '${collate}'") + + debug "Creating database $database" + "${mysql_execute_cmd[@]}" "mysql" "$DB_ROOT_USER" "$DB_ROOT_PASSWORD" <&2 + return 1 + ;; + esac + shift + done + + local -a flags=("$user") + [[ -n "$db_host" ]] && flags+=("--host" "${db_host}") + [[ -n "$db_port" ]] && flags+=("--port" "${db_port}") + if is_boolean_yes "$use_ldap"; then + flags+=("--use-ldap") + elif [[ -n "$password" ]]; then + flags+=("-p" "$password") + [[ -n "$auth_plugin" ]] && flags=("${flags[@]}" "--auth-plugin" "$auth_plugin") + fi + mysql_ensure_user_exists "${flags[@]}" +} + +######################## +# Optionally create the given database, and then optionally give a user +# full privileges on the database. +# Flags: +# -u|--user - database user +# --character-set - character set +# --collation - collation +# --host - database host +# --port - database port +# Arguments: +# $1 - database name +# Returns: +# None +######################### +mysql_ensure_optional_database_exists() { + local -r database="${1:?database is missing}" + local character_set="" + local collate="" + local user="" + local privileges="" + # For accessing an external database + local db_host="" + local db_port="" + + # Validate arguments + shift 1 + while [ "$#" -gt 0 ]; do + case "$1" in + --character-set) + shift + character_set="${1:?missing character set}" + ;; + --collate) + shift + collate="${1:?missing collate}" + ;; + -u|--user) + shift + user="${1:?missing database user}" + ;; + --host) + shift + db_host="${1:?missing database host}" + ;; + --port) + shift + db_port="${1:?missing database port}" + ;; + --privileges) + shift + privileges="${1:?missing privileges}" + ;; + *) + echo "Invalid command line flag $1" >&2 + return 1 + ;; + esac + shift + done + + local -a flags=("$database") + [[ -n "$character_set" ]] && flags+=("--character-set" "$character_set") + [[ -n "$collate" ]] && flags+=("--collate" "$collate") + [[ -n "$db_host" ]] && flags+=("--host" "$db_host") + [[ -n "$db_port" ]] && flags+=("--port" "$db_port") + mysql_ensure_database_exists "${flags[@]}" + + if [[ -n "$user" ]]; then + mysql_ensure_user_has_database_privileges "$user" "$database" "$privileges" "$db_host" "$db_port" + fi +} + +######################## +# Add or modify an entry in the MySQL configuration file ("$DB_CONF_FILE") +# Globals: +# DB_* +# Arguments: +# $1 - MySQL variable name +# $2 - Value to assign to the MySQL variable +# $3 - Section in the MySQL configuration file the key is located (default: mysqld) +# $4 - Configuration file (default: "$BD_CONF_FILE") +# Returns: +# None +######################### +mysql_conf_set() { + local -r key="${1:?key missing}" + local -r value="${2:?value missing}" + read -r -a sections <<<"${3:-mysqld}" + local -r file="${4:-"$DB_CONF_FILE"}" + info "Setting ${key} option" + debug "Setting ${key} to '${value}' in ${DB_FLAVOR} configuration file ${file}" + # Check if the configuration exists in the file + for section in "${sections[@]}"; do + ini-file set --section "$section" --key "$key" --value "$value" "$file" + done +} + +######################## +# Update MySQL/MariaDB configuration file with user custom inputs +# Globals: +# DB_* +# Arguments: +# None +# Returns: +# None +######################### +mysql_update_custom_config() { + # Persisted configuration files from old versions + ! is_dir_empty "$DB_VOLUME_DIR" && [[ -d "$DB_VOLUME_DIR/conf" ]] && mysql_migrate_old_configuration + + # User injected custom configuration + if [[ -f "$DB_CONF_DIR/my_custom.cnf" ]]; then + debug "Injecting custom configuration from my_custom.conf" + cat "$DB_CONF_DIR/my_custom.cnf" > "$DB_CONF_DIR/bitnami/my_custom.cnf" + fi + + ! is_empty_value "$DB_USER" && mysql_conf_set "user" "$DB_USER" "mysqladmin" + ! is_empty_value "$DB_PORT_NUMBER" && mysql_conf_set "port" "$DB_PORT_NUMBER" "mysqld client manager" + ! is_empty_value "$DB_CHARACTER_SET" && mysql_conf_set "character_set_server" "$DB_CHARACTER_SET" + ! is_empty_value "$DB_COLLATE" && mysql_conf_set "collation_server" "$DB_COLLATE" + ! is_empty_value "$DB_BIND_ADDRESS" && mysql_conf_set "bind_address" "$DB_BIND_ADDRESS" + ! is_empty_value "$DB_AUTHENTICATION_PLUGIN" && mysql_conf_set "default_authentication_plugin" "$DB_AUTHENTICATION_PLUGIN" + ! is_empty_value "$DB_SQL_MODE" && mysql_conf_set "sql_mode" "$DB_SQL_MODE" + + # Avoid exit code of previous commands to affect the result of this function + true +} + +######################## +# Find the path to the libjemalloc library file +# Globals: +# None +# Arguments: +# None +# Returns: +# Path to a libjemalloc shared object file +######################### +find_jemalloc_lib() { + local -a locations=( "/usr/lib" "/usr/lib64" ) + local -r pattern='libjemalloc.so.[0-9]' + local path + for dir in "${locations[@]}"; do + # Find the first element matching the pattern and quit + [[ ! -d "$dir" ]] && continue + path="$(find "$dir" -name "$pattern" -print -quit)" + [[ -n "$path" ]] && break + done + echo "${path:-}" +} + +######################## +# Execute a reliable health check against the current mysql instance +# Globals: +# DB_ROOT_PASSWORD, DB_MASTER_ROOT_PASSWORD +# Arguments: +# None +# Returns: +# mysqladmin output +######################### +mysql_healthcheck() { + local args=("-uroot" "-h0.0.0.0") + local root_password + + root_password="$(get_master_env_var_value ROOT_PASSWORD)" + if [[ -n "$root_password" ]]; then + args+=("-p${root_password}") + fi + + mysqladmin "${args[@]}" ping && mysqladmin "${args[@]}" status +} + +######################## +# Prints flavor of 'mysql' client (useful to determine proper CLI flags that can be used) +# Globals: +# DB_* +# Arguments: +# None +# Returns: +# mysql client flavor +######################### +mysql_client_flavor() { + if "${DB_BIN_DIR}/mysql" "--version" 2>&1 | grep -q MariaDB; then + echo "mariadb" + else + echo "mysql" + fi +} + +######################## +# Prints extra options for MySQL client calls (i.e. SSL options) +# Globals: +# DB_* +# Arguments: +# None +# Returns: +# List of options to pass to "mysql" CLI +######################### +mysql_client_extra_opts() { + # Helper to get the proper value for the MySQL client environment variable + mysql_client_env_value() { + local env_name="MYSQL_CLIENT_${1:?missing name}" + if [[ -n "${!env_name:-}" ]]; then + echo "${!env_name:-}" + else + env_name="DB_CLIENT_${1}" + echo "${!env_name:-}" + fi + } + local -a opts=() + local key value + if is_boolean_yes "${DB_ENABLE_SSL:-no}"; then + if [[ "$(mysql_client_flavor)" = "mysql" ]]; then + opts+=("--ssl-mode=REQUIRED") + else + opts+=("--ssl=TRUE") + fi + # Add "--ssl-ca", "--ssl-key" and "--ssl-cert" options if the env vars are defined + for key in ca key cert; do + value="$(mysql_client_env_value "SSL_${key^^}_FILE")" + [[ -n "${value}" ]] && opts+=("--ssl-${key}=${value}") + done + fi + echo "${opts[@]:-}" +} diff --git a/rootfs/opt/bitnami/scripts/libphp.sh b/rootfs/opt/bitnami/scripts/libphp.sh new file mode 100644 index 00000000..c0a910a2 --- /dev/null +++ b/rootfs/opt/bitnami/scripts/libphp.sh @@ -0,0 +1,256 @@ +#!/bin/bash +# +# Bitnami PHP library + +# shellcheck disable=SC1091 + +# Load Generic Libraries +. /opt/bitnami/scripts/libfs.sh +. /opt/bitnami/scripts/libfile.sh +. /opt/bitnami/scripts/libservice.sh +. /opt/bitnami/scripts/libvalidations.sh +. /opt/bitnami/scripts/libwebserver.sh + +######################## +# Add or modify an entry in the main PHP configuration file (php.ini) +# Globals: +# PHP_CONF_FILE +# Arguments: +# $1 - Key +# $2 - Value +# $3 - File to modify (default: $PHP_CONF_FILE) +# Returns: +# None +######################### +php_conf_set() { + local -r key="${1:?key missing}" + local -r value="${2:?value missing}" + local -r file="${3:-"$PHP_CONF_FILE"}" + local pattern="^[; ]*${key}\s*=.*$" + if [[ "$key" = "extension" || "$key" = "zend_extension" ]]; then + # The "extension" property works a bit different for PHP, as there is one per module to be included, meaning it is additive unlike other configurations + # Because of that, we first check if the extension was defined in the file to replace the proper entry + pattern="^[; ]*${key}\s*=\s*[\"]?${value}(\.so)?[\"]?\s*$" + fi + local -r entry="${key} = ${value}" + if is_file_writable "$file"; then + # Not using the ini-file tool since it does not play well with php.ini + if grep -q -E "$pattern" "$file"; then + replace_in_file "$file" "$pattern" "$entry" + else + cat >> "$file" <<< "$entry" + fi + else + warn "The PHP configuration file '${file}' is not writable. The '${key}' option will not be configured." + fi +} + +######################## +# Ensure PHP is initialized +# Globals: +# PHP_* +# Arguments: +# None +# Returns: +# None +######################### +php_initialize() { + # Configure PHP options based on the runtime environment + info "Configuring PHP options" + php_set_runtime_config "$PHP_CONF_FILE" + + # PHP-FPM configuration + ! is_empty_value "$PHP_FPM_LISTEN_ADDRESS" && info "Setting PHP-FPM listen option" && php_conf_set "listen" "$PHP_FPM_LISTEN_ADDRESS" "${PHP_CONF_DIR}/php-fpm.d/www.conf" + + # Avoid exit code of previous commands to affect the result of this function + true +} + +######################## +# Set PHP runtime options, based on user-provided environment variables +# Globals: +# PHP_* +# Arguments: +# None +# Returns: +# None +######################### +php_set_runtime_config() { + local -r conf_file="${1:?missing conf file}" + + ! is_empty_value "$PHP_ENABLE_OPCACHE" && info "Setting PHP opcache.enable option" && php_conf_set opcache.enable "$PHP_ENABLE_OPCACHE" "$conf_file" + ! is_empty_value "$PHP_EXPOSE_PHP" && info "Setting PHP expose_php option" && php_conf_set expose_php "$PHP_EXPOSE_PHP" "$conf_file" + ! is_empty_value "$PHP_MAX_EXECUTION_TIME" && info "Setting PHP max_execution_time option" && php_conf_set max_execution_time "$PHP_MAX_EXECUTION_TIME" "$conf_file" + ! is_empty_value "$PHP_MAX_INPUT_TIME" && info "Setting PHP max_input_time option" && php_conf_set max_input_time "$PHP_MAX_INPUT_TIME" "$conf_file" + ! is_empty_value "$PHP_MAX_INPUT_VARS" && info "Setting PHP max_input_vars option" && php_conf_set max_input_vars "$PHP_MAX_INPUT_VARS" "$conf_file" + ! is_empty_value "$PHP_MEMORY_LIMIT" && info "Setting PHP memory_limit option" && php_conf_set memory_limit "$PHP_MEMORY_LIMIT" "$conf_file" + ! is_empty_value "$PHP_POST_MAX_SIZE" && info "Setting PHP post_max_size option" && php_conf_set post_max_size "$PHP_POST_MAX_SIZE" "$conf_file" + ! is_empty_value "$PHP_UPLOAD_MAX_FILESIZE" && info "Setting PHP upload_max_filesize option" && php_conf_set upload_max_filesize "$PHP_UPLOAD_MAX_FILESIZE" "$conf_file" + + true +} + +######################## +# Convert a yes/no value to a PHP boolean +# Globals: +# None +# Arguments: +# $1 - yes/no value +# Returns: +# None +######################### +php_convert_to_boolean() { + local -r value="${1:?missing value}" + is_boolean_yes "$value" && echo "true" || echo "false" +} + +######################## +# Execute/run PHP code and print to stdout +# Globals: +# None +# Stdin: +# Code to execute +# Arguments: +# $1..$n - Input arguments to script +# Returns: +# None +######################### +php_execute_print_output() { + local php_cmd + # Obtain the command specified via stdin + php_cmd="$(/dev/null 2>&1 & + if ! retry_while "is_php_fpm_running"; then + error "php-fpm did not start" + error_code=1 + else + info "php-fpm started" + fi +else + info "php-fpm is already running" +fi + +exit "$error_code" diff --git a/rootfs/opt/bitnami/scripts/php/status.sh b/rootfs/opt/bitnami/scripts/php/status.sh new file mode 100755 index 00000000..d2f4b058 --- /dev/null +++ b/rootfs/opt/bitnami/scripts/php/status.sh @@ -0,0 +1,21 @@ +#!/bin/bash + +# shellcheck disable=SC1091 + +set -o errexit +set -o nounset +set -o pipefail +# set -o xtrace # Uncomment this line for debugging purposes + +# Load libraries +. /opt/bitnami/scripts/libphp.sh +. /opt/bitnami/scripts/liblog.sh + +# Load PHP-FPM environment variables +. /opt/bitnami/scripts/php-env.sh + +if is_php_fpm_running; then + info "php-fpm is already running" +else + info "php-fpm is not running" +fi diff --git a/rootfs/opt/bitnami/scripts/php/stop.sh b/rootfs/opt/bitnami/scripts/php/stop.sh new file mode 100755 index 00000000..ab1592be --- /dev/null +++ b/rootfs/opt/bitnami/scripts/php/stop.sh @@ -0,0 +1,32 @@ +#!/bin/bash + +# shellcheck disable=SC1091 + +set -o errexit +set -o nounset +set -o pipefail +# set -o xtrace # Uncomment this line for debugging purposes + +# Load libraries +. /opt/bitnami/scripts/libphp.sh +. /opt/bitnami/scripts/libos.sh +. /opt/bitnami/scripts/liblog.sh + +# Load PHP-FPM environment variables +. /opt/bitnami/scripts/php-env.sh + +error_code=0 + +if is_php_fpm_running; then + BITNAMI_QUIET=1 php_fpm_stop + if ! retry_while "is_php_fpm_not_running"; then + error "php-fpm could not be stopped" + error_code=1 + else + info "php-fpm stopped" + fi +else + info "php-fpm is not running" +fi + +exit "$error_code" diff --git a/rootfs/post-init.d/php.sh b/rootfs/post-init.d/php.sh new file mode 100755 index 00000000..8d76ab89 --- /dev/null +++ b/rootfs/post-init.d/php.sh @@ -0,0 +1,31 @@ +#!/bin/bash +# +# Executes custom PHP init scripts + +# shellcheck disable=SC1091 + +set -o errexit +set -o nounset +set -o pipefail +# set -o xtrace # Uncomment this line for debugging purposes + +# Load libraries with logging functions +if [[ -f /opt/bitnami/base/functions ]]; then + . /opt/bitnami/base/functions +else + . /opt/bitnami/scripts/liblog.sh +fi + +# Loop through all input files passed via stdin +read -r -a custom_init_scripts <<< "$@" +failure=0 +if [[ "${#custom_init_scripts[@]}" -gt 0 ]]; then + for custom_init_script in "${custom_init_scripts[@]}"; do + [[ "$custom_init_script" != *".php" ]] && continue + info "Executing ${custom_init_script} with PHP interpreter" + php "$custom_init_script" || failure=1 + [[ "$failure" -ne 0 ]] && error "Failed to execute ${custom_init_script}" + done +fi + +exit "$failure" diff --git a/rootfs/post-init.d/shell.sh b/rootfs/post-init.d/shell.sh new file mode 100755 index 00000000..7b244a71 --- /dev/null +++ b/rootfs/post-init.d/shell.sh @@ -0,0 +1,36 @@ +#!/bin/bash +# +# Executes custom Bash init scripts + +# shellcheck disable=SC1090,SC1091 + +set -o errexit +set -o nounset +set -o pipefail +# set -o xtrace # Uncomment this line for debugging purposes + +# Load libraries with logging functions +if [[ -f /opt/bitnami/base/functions ]]; then + . /opt/bitnami/base/functions +else + . /opt/bitnami/scripts/liblog.sh +fi + +# Loop through all input files passed via stdin +read -r -a custom_init_scripts <<< "$@" +failure=0 +if [[ "${#custom_init_scripts[@]}" -gt 0 ]]; then + for custom_init_script in "${custom_init_scripts[@]}"; do + [[ "$custom_init_script" != *".sh" ]] && continue + if [[ -x "$custom_init_script" ]]; then + info "Executing ${custom_init_script}" + "$custom_init_script" || failure="1" + else + info "Sourcing ${custom_init_script} as it is not executable by the current user, any error may cause initialization to fail" + . "$custom_init_script" + fi + [[ "$failure" -ne 0 ]] && error "Failed to execute ${custom_init_script}" + done +fi + +exit "$failure" diff --git a/rootfs/post-init.d/sql-mysql.sh b/rootfs/post-init.d/sql-mysql.sh new file mode 100755 index 00000000..f5c8436f --- /dev/null +++ b/rootfs/post-init.d/sql-mysql.sh @@ -0,0 +1,46 @@ +#!/bin/bash +# +# Executes custom Ruby init scripts + +# shellcheck disable=SC1091 + +set -o errexit +set -o nounset +set -o pipefail +# set -o xtrace # Uncomment this line for debugging purposes + +# Load libraries with logging functions +if [[ -f /opt/bitnami/base/functions ]]; then + . /opt/bitnami/base/functions +else + . /opt/bitnami/scripts/liblog.sh +fi + +mysql_execute() { + local -r sql_file="${1:?missing file}" + local failure=0 + mysql_cmd=("mysql" "-h" "$MARIADB_HOST" "-P" "$MARIADB_PORT_NUMBER" "-u" "$MARIADB_ROOT_USER") + if [[ "${ALLOW_EMPTY_PASSWORD:-no}" != "yes" ]]; then + mysql_cmd+=("-p${MARIADB_ROOT_PASSWORD}") + fi + if [[ "$sql_file" == *".sql" ]]; then + "${mysql_cmd[@]}" < "$sql_file" || failure=$? + elif [[ "$sql_file" == *".sql.gz" ]]; then + gunzip -c "$sql_file" | "${mysql_cmd[@]}" || failure=$? + fi + return "$failure" +} + +# Loop through all input files passed via stdin +read -r -a custom_init_scripts <<< "$@" +failure=0 +if [[ "${#custom_init_scripts[@]}" -gt 0 ]]; then + for custom_init_script in "${custom_init_scripts[@]}"; do + [[ ! "$custom_init_script" =~ ^.*(\.sql|\.sql\.gz)$ ]] && continue + info "Executing ${custom_init_script}" + mysql_execute "$custom_init_script" || failure=1 + [[ "$failure" -ne 0 ]] && error "Failed to execute ${custom_init_script}" + done +fi + +exit "$failure" diff --git a/rootfs/post-init.sh b/rootfs/post-init.sh new file mode 100755 index 00000000..d1412b42 --- /dev/null +++ b/rootfs/post-init.sh @@ -0,0 +1,23 @@ +#!/bin/bash + +# shellcheck disable=SC1091 + +set -o errexit +set -o nounset +set -o pipefail +# set -o xtrace # Uncomment this line for debugging purposes + +# Only execute init scripts once +if [[ ! -f "/bitnami/drupal/.user_scripts_initialized" && -d "/docker-entrypoint-init.d" ]]; then + read -r -a init_scripts <<< "$(find "/docker-entrypoint-init.d" -type f -print0 | sort -z | xargs -0)" + if [[ "${#init_scripts[@]}" -gt 0 ]] && [[ ! -f "/bitnami/drupal/.user_scripts_initialized" ]]; then + mkdir -p "/bitnami/drupal" + for init_script in "${init_scripts[@]}"; do + for init_script_type_handler in /post-init.d/*.sh; do + "$init_script_type_handler" "$init_script" + done + done + fi + + touch "/bitnami/drupal/.user_scripts_initialized" +fi diff --git a/test.sh b/test.sh deleted file mode 100644 index 6f566744..00000000 --- a/test.sh +++ /dev/null @@ -1,64 +0,0 @@ -#!/usr/bin/env bats - -BITNAMI_APP_NAME=drupal -WELCOME_PAGE_TEXT="Welcome to" -CONTAINER_NAME=bitnami-$BITNAMI_APP_NAME-test -IMAGE_NAME=bitnami/$BITNAMI_APP_NAME -SLEEP_TIME=90 - -# Check config override from host -cleanup_running_containers() { - if [ "$(docker ps -a | grep $CONTAINER_NAME)" ]; then - docker rm -fv $CONTAINER_NAME - fi -} - -setup() { - cleanup_running_containers -} - -teardown() { - cleanup_running_containers -} - -create_container(){ - docker run -d --name $CONTAINER_NAME \ - --expose 80 --expose 443 $IMAGE_NAME - echo "Waiting $SLEEP_TIME for the container to initialize" - sleep $SLEEP_TIME -} - - -@test "We can connect to the port 80 and 443" { - create_container - docker run --link $CONTAINER_NAME:$BITNAMI_APP_NAME --rm bitnami/$BITNAMI_APP_NAME curl -L -i http://$BITNAMI_APP_NAME:80 | { - run grep "200 OK" - [ $status = 0 ] - } - - docker run --link $CONTAINER_NAME:$BITNAMI_APP_NAME --rm bitnami/$BITNAMI_APP_NAME curl -L -i -k https://$BITNAMI_APP_NAME:443 | { - run grep "200 OK" - [ $status = 0 ] - } -} - -@test "Returns default page" { - create_container - docker run --link $CONTAINER_NAME:$BITNAMI_APP_NAME --rm bitnami/$BITNAMI_APP_NAME curl -L -i http://$BITNAMI_APP_NAME:80 | { - run grep "$WELCOME_PAGE_TEXT" - [ $status = 0 ] - } - - docker run --link $CONTAINER_NAME:$BITNAMI_APP_NAME --rm bitnami/$BITNAMI_APP_NAME curl -L -i -k https://$BITNAMI_APP_NAME:443 | { - run grep "$WELCOME_PAGE_TEXT" - [ $status = 0 ] - } -} - -@test "Logs to stdout" { - create_container - docker exec $CONTAINER_NAME bash -c '$BITNAMI_PREFIX/ctlscript.sh status' | { - run grep -v "not running" - [ $status = 0 ] - } -}