mirror of
https://github.com/bitnami/containers.git
synced 2026-10-18 03:12:30 +02:00
[bitnami/*] Fix markdown linter issues (#23945)
* [bitnami/*] Fix markdown linter issues Signed-off-by: Carlos Rodríguez Hernández <carlosrh@vmware.com> * Add leftovers Signed-off-by: Carlos Rodríguez Hernández <carlosrh@vmware.com> * Update CODE_OF_CONDUCT.md Co-authored-by: Andrés Bono <andresbonojimenez@gmail.com> Signed-off-by: Carlos Rodríguez Hernández <carrodher1179@gmail.com> * Update CONTRIBUTING.md Signed-off-by: Carlos Rodríguez Hernández <carlosrh@vmware.com> * Update bitnami/zookeeper/README.md Co-authored-by: Andrés Bono <andresbonojimenez@gmail.com> Signed-off-by: Carlos Rodríguez Hernández <carrodher1179@gmail.com> * Linter fix Signed-off-by: Carlos Rodríguez Hernández <carlosrh@vmware.com> * Order lists Signed-off-by: Carlos Rodríguez Hernández <carlosrh@vmware.com> * Fix markdown Signed-off-by: Carlos Rodríguez Hernández <carlosrh@vmware.com> * Order lists Signed-off-by: Carlos Rodríguez Hernández <carlosrh@vmware.com> --------- Signed-off-by: Carlos Rodríguez Hernández <carlosrh@vmware.com> Signed-off-by: Carlos Rodríguez Hernández <carrodher1179@gmail.com> Co-authored-by: Andrés Bono <andresbonojimenez@gmail.com>
This commit is contained in:
co-authored by
Andrés Bono
parent
9d243a6d23
commit
d7bd442eba
+109
-108
@@ -11,8 +11,8 @@ Trademarks: This software listing is packaged by Bitnami. The respective tradema
|
||||
## TL;DR
|
||||
|
||||
```console
|
||||
$ curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/phpbb/docker-compose.yml > docker-compose.yml
|
||||
$ docker-compose up -d
|
||||
curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/phpbb/docker-compose.yml > docker-compose.yml
|
||||
docker-compose up -d
|
||||
```
|
||||
|
||||
**Warning**: This quick setup is only intended for development environments. You are encouraged to change the insecure default credentials and check out the available configuration options in the [Environment Variables](#environment-variables) section for a more secure deployment.
|
||||
@@ -44,7 +44,7 @@ You can see the equivalence between the different tags by taking a look at the `
|
||||
|
||||
Subscribe to project updates by watching the [bitnami/containers GitHub repo](https://github.com/bitnami/containers).
|
||||
|
||||
# Prerequisites
|
||||
## Prerequisites
|
||||
|
||||
To run this application you need Docker Engine 1.10.0. Docker Compose is recomended with a version 1.6.0 or later.
|
||||
|
||||
@@ -53,21 +53,21 @@ To run this application you need Docker Engine 1.10.0. Docker Compose is recomen
|
||||
The recommended way to get the Bitnami phpBB Docker Image is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/phpbb).
|
||||
|
||||
```console
|
||||
$ docker pull bitnami/phpbb:latest
|
||||
docker pull bitnami/phpbb: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/phpbb/tags/) in the Docker Hub Registry.
|
||||
|
||||
```console
|
||||
$ docker pull bitnami/phpbb:[TAG]
|
||||
docker pull bitnami/phpbb:[TAG]
|
||||
```
|
||||
|
||||
If you wish, you can also build the image yourself by cloning the repository, changing to the directory containing the Dockerfile and executing the `docker build` command. Remember to replace the `APP`, `VERSION` and `OPERATING-SYSTEM` path placeholders in the example command below with the correct values.
|
||||
|
||||
```console
|
||||
$ git clone https://github.com/bitnami/containers.git
|
||||
$ cd bitnami/APP/VERSION/OPERATING-SYSTEM
|
||||
$ docker build -t bitnami/APP:latest .
|
||||
git clone https://github.com/bitnami/containers.git
|
||||
cd bitnami/APP/VERSION/OPERATING-SYSTEM
|
||||
docker build -t bitnami/APP:latest .
|
||||
```
|
||||
|
||||
## How to use this image
|
||||
@@ -79,8 +79,8 @@ phpBB requires access to a MySQL or MariaDB database to store information. We'll
|
||||
The main folder of this repository contains a functional [`docker-compose.yml`](https://github.com/bitnami/containers/blob/main/bitnami/phpbb/docker-compose.yml) file. Run the application using it as shown below:
|
||||
|
||||
```console
|
||||
$ curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/phpbb/docker-compose.yml > docker-compose.yml
|
||||
$ docker-compose up -d
|
||||
curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/phpbb/docker-compose.yml > docker-compose.yml
|
||||
docker-compose up -d
|
||||
```
|
||||
|
||||
### Using the Docker Command Line
|
||||
@@ -90,14 +90,14 @@ If you want to run the application manually instead of using `docker-compose`, t
|
||||
#### Step 1: Create a network
|
||||
|
||||
```console
|
||||
$ docker network create phpbb-network
|
||||
docker network create phpbb-network
|
||||
```
|
||||
|
||||
#### 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 \
|
||||
docker volume create --name mariadb_data
|
||||
docker run -d --name mariadb \
|
||||
--env ALLOW_EMPTY_PASSWORD=yes \
|
||||
--env MARIADB_USER=bn_phpbb \
|
||||
--env MARIADB_PASSWORD=bitnami \
|
||||
@@ -110,8 +110,8 @@ $ docker run -d --name mariadb \
|
||||
#### Step 3: Create volumes for phpBB persistence and launch the container
|
||||
|
||||
```console
|
||||
$ docker volume create --name phpbb_data
|
||||
$ docker run -d --name phpbb \
|
||||
docker volume create --name phpbb_data
|
||||
docker run -d --name phpbb \
|
||||
-p 8080:8080 -p 8443:8443 \
|
||||
--env ALLOW_EMPTY_PASSWORD=yes \
|
||||
--env PHPBB_DATABASE_USER=bn_phpbb \
|
||||
@@ -165,13 +165,13 @@ This requires a minor change to the [`docker-compose.yml`](https://github.com/bi
|
||||
#### Step 1: Create a network (if it does not exist)
|
||||
|
||||
```console
|
||||
$ docker network create phpbb-network
|
||||
docker network create phpbb-network
|
||||
```
|
||||
|
||||
#### Step 2. Create a MariaDB container with host volume
|
||||
|
||||
```console
|
||||
$ docker run -d --name mariadb \
|
||||
docker run -d --name mariadb \
|
||||
--env ALLOW_EMPTY_PASSWORD=yes \
|
||||
--env MARIADB_USER=bn_phpbb \
|
||||
--env MARIADB_PASSWORD=bitnami \
|
||||
@@ -184,7 +184,7 @@ $ docker run -d --name mariadb \
|
||||
#### Step 3. Create the phpBB container with host volumes
|
||||
|
||||
```console
|
||||
$ docker run -d --name phpbb \
|
||||
docker run -d --name phpbb \
|
||||
-p 8080:8080 -p 8443:8443 \
|
||||
--env ALLOW_EMPTY_PASSWORD=yes \
|
||||
--env PHPBB_DATABASE_USER=bn_phpbb \
|
||||
@@ -201,7 +201,7 @@ $ docker run -d --name phpbb \
|
||||
|
||||
When you start the phpBB image, you can adjust the configuration of the instance by passing one or more environment variables either on the docker-compose file or on the `docker run` command line. If you want to add a new environment variable:
|
||||
|
||||
* For docker-compose add the variable name and value under the application section in the [`docker-compose.yml`](https://github.com/bitnami/containers/blob/main/bitnami/phpbb/docker-compose.yml) file present in this repository:
|
||||
* For docker-compose add the variable name and value under the application section in the [`docker-compose.yml`](https://github.com/bitnami/containers/blob/main/bitnami/phpbb/docker-compose.yml) file present in this repository:
|
||||
|
||||
```yaml
|
||||
phpbb:
|
||||
@@ -211,10 +211,10 @@ phpbb:
|
||||
...
|
||||
```
|
||||
|
||||
* For manual execution add a `--env` option with each variable and value:
|
||||
* For manual execution add a `--env` option with each variable and value:
|
||||
|
||||
```console
|
||||
$ docker run -d --name phpbb -p 80:8080 -p 443:8443 \
|
||||
docker run -d --name phpbb -p 80:8080 -p 443:8443 \
|
||||
--env PHPBB_PASSWORD=my_password \
|
||||
--network phpbb-tier \
|
||||
--volume /path/to/phpbb-persistence:/bitnami \
|
||||
@@ -223,76 +223,76 @@ phpbb:
|
||||
|
||||
Available environment variables:
|
||||
|
||||
##### User and Site configuration
|
||||
#### User and Site configuration
|
||||
|
||||
- `APACHE_HTTP_PORT_NUMBER`: Port used by Apache for HTTP. Default: **8080**
|
||||
- `APACHE_HTTPS_PORT_NUMBER`: Port used by Apache for HTTPS. Default: **8443**
|
||||
- `PHPBB_USERNAME`: phpBB application username. Default: **user**
|
||||
- `PHPBB_PASSWORD`: phpBB application password. Default: **bitnami**
|
||||
- `PHPBB_EMAIL`: phpBB application email. Default: **user@example.com**
|
||||
- `PHPBB_FORUM_NAME`: Forum Name. Default: **My forum**
|
||||
- `PHPBB_FORUM_DESCRIPTION`: Forum Description. Default: **A little text to describe your forum**
|
||||
- `PHPBB_HOST`: phpBB application host. No defaults.
|
||||
- `PHPBB_SKIP_BOOTSTRAP`: Whether to skip performing the initial bootstrapping for the application. Default: **no**
|
||||
- `PHPBB_COOKIE_SECURE`: Have secure cookies enabled. Default: **no**
|
||||
- `PHPBB_FORUM_SERVER_PROTOCOL`: Forum server protocol for the URL generation. Default: **http://**
|
||||
- `PHPBB_DISABLE_SESSION_VALIDATION`: Disable session validation. This is for phpBB to work in Kubernetes installations. Default: **false**
|
||||
* `APACHE_HTTP_PORT_NUMBER`: Port used by Apache for HTTP. Default: **8080**
|
||||
* `APACHE_HTTPS_PORT_NUMBER`: Port used by Apache for HTTPS. Default: **8443**
|
||||
* `PHPBB_USERNAME`: phpBB application username. Default: **user**
|
||||
* `PHPBB_PASSWORD`: phpBB application password. Default: **bitnami**
|
||||
* `PHPBB_EMAIL`: phpBB application email. Default: **user@example.com**
|
||||
* `PHPBB_FORUM_NAME`: Forum Name. Default: **My forum**
|
||||
* `PHPBB_FORUM_DESCRIPTION`: Forum Description. Default: **A little text to describe your forum**
|
||||
* `PHPBB_HOST`: phpBB application host. No defaults.
|
||||
* `PHPBB_SKIP_BOOTSTRAP`: Whether to skip performing the initial bootstrapping for the application. Default: **no**
|
||||
* `PHPBB_COOKIE_SECURE`: Have secure cookies enabled. Default: **no**
|
||||
* `PHPBB_FORUM_SERVER_PROTOCOL`: Forum server protocol for the URL generation. Default: **<http://>**
|
||||
* `PHPBB_DISABLE_SESSION_VALIDATION`: Disable session validation. This is for phpBB to work in Kubernetes installations. Default: **false**
|
||||
|
||||
##### Use an existing database
|
||||
#### Use an existing database
|
||||
|
||||
- `PHPBB_DATABASE_HOST`: Hostname for MariaDB server. Default: **mariadb**
|
||||
- `PHPBB_DATABASE_PORT_NUMBER`: Port used by MariaDB server. Default: **3306**
|
||||
- `PHPBB_DATABASE_NAME`: Database name that phpBB will use to connect with the database. Default: **bitnami_phpbb**
|
||||
- `PHPBB_DATABASE_USER`: Database user that phpBB will use to connect with the database. Default: **bn_phpbb**
|
||||
- `PHPBB_DATABASE_PASSWORD`: Database password that phpBB will use to connect with the database. No defaults.
|
||||
- `ALLOW_EMPTY_PASSWORD`: It can be used to allow blank passwords. Default: **no**
|
||||
* `PHPBB_DATABASE_HOST`: Hostname for MariaDB server. Default: **mariadb**
|
||||
* `PHPBB_DATABASE_PORT_NUMBER`: Port used by MariaDB server. Default: **3306**
|
||||
* `PHPBB_DATABASE_NAME`: Database name that phpBB will use to connect with the database. Default: **bitnami_phpbb**
|
||||
* `PHPBB_DATABASE_USER`: Database user that phpBB will use to connect with the database. Default: **bn_phpbb**
|
||||
* `PHPBB_DATABASE_PASSWORD`: Database password that phpBB will use to connect with the database. No defaults.
|
||||
* `ALLOW_EMPTY_PASSWORD`: It can be used to allow blank passwords. Default: **no**
|
||||
|
||||
##### Create a database for phpBB using mysql-client
|
||||
#### Create a database for phpBB 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**
|
||||
* `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
|
||||
#### SMTP Configuration
|
||||
|
||||
To configure phpBB to send email using SMTP you can set the following environment variables:
|
||||
|
||||
- `PHPBB_SMTP_HOST`: SMTP host.
|
||||
- `PHPBB_SMTP_PORT`: SMTP port.
|
||||
- `PHPBB_SMTP_USER`: SMTP account user.
|
||||
- `PHPBB_SMTP_PASSWORD`: SMTP account password.
|
||||
- `PHPBB_SMTP_PROTOCOL`: SMTP protocol.
|
||||
* `PHPBB_SMTP_HOST`: SMTP host.
|
||||
* `PHPBB_SMTP_PORT`: SMTP port.
|
||||
* `PHPBB_SMTP_USER`: SMTP account user.
|
||||
* `PHPBB_SMTP_PASSWORD`: SMTP account password.
|
||||
* `PHPBB_SMTP_PROTOCOL`: SMTP protocol.
|
||||
|
||||
##### PHP configuration
|
||||
#### 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.
|
||||
* `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
|
||||
#### Example
|
||||
|
||||
This would be an example of SMTP configuration using a Gmail account:
|
||||
|
||||
* Modify the [`docker-compose.yml`](https://github.com/bitnami/containers/blob/main/bitnami/phpbb/docker-compose.yml) file present in this repository:
|
||||
* Modify the [`docker-compose.yml`](https://github.com/bitnami/containers/blob/main/bitnami/phpbb/docker-compose.yml) file present in this repository:
|
||||
|
||||
```yaml
|
||||
phpbb:
|
||||
@@ -307,10 +307,11 @@ This would be an example of SMTP configuration using a Gmail account:
|
||||
- PHPBB_SMTP_PASSWORD=your_password
|
||||
...
|
||||
```
|
||||
* For manual execution:
|
||||
|
||||
* For manual execution:
|
||||
|
||||
```console
|
||||
$ docker run -d --name phpbb -p 80:8080 -p 443:8443 \
|
||||
docker run -d --name phpbb -p 80:8080 -p 443:8443 \
|
||||
--env PHPBB_DATABASE_USER=bn_phpbb \
|
||||
--env PHPBB_DATABASE_NAME=bitnami_phpbb \
|
||||
--env PHPBB_SMTP_HOST=smtp.gmail.com \
|
||||
@@ -327,13 +328,13 @@ This would be an example of SMTP configuration using a Gmail account:
|
||||
The Bitnami phpBB Docker image sends the container logs to `stdout`. To view the logs:
|
||||
|
||||
```console
|
||||
$ docker logs phpbb
|
||||
docker logs phpbb
|
||||
```
|
||||
|
||||
Or using Docker Compose:
|
||||
|
||||
```console
|
||||
$ docker-compose logs phpbb
|
||||
docker-compose logs phpbb
|
||||
```
|
||||
|
||||
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.
|
||||
@@ -347,13 +348,13 @@ To backup your data, configuration and logs, follow these simple steps:
|
||||
#### Step 1: Stop the currently running container
|
||||
|
||||
```console
|
||||
$ docker stop phpbb
|
||||
docker stop phpbb
|
||||
```
|
||||
|
||||
Or using Docker Compose:
|
||||
|
||||
```console
|
||||
$ docker-compose stop phpbb
|
||||
docker-compose stop phpbb
|
||||
```
|
||||
|
||||
#### Step 2: Run the backup command
|
||||
@@ -361,7 +362,7 @@ $ docker-compose stop phpbb
|
||||
We need to mount two volumes in a container we will use to create the backup: a directory on your host to store the backup in, and the volumes from the container we just stopped so we can access the data.
|
||||
|
||||
```console
|
||||
$ docker run --rm -v /path/to/phpbb-backups:/backups --volumes-from phpbb busybox \
|
||||
docker run --rm -v /path/to/phpbb-backups:/backups --volumes-from phpbb busybox \
|
||||
cp -a /bitnami/phpbb /backups/latest
|
||||
```
|
||||
|
||||
@@ -372,7 +373,7 @@ Restoring a backup is as simple as mounting the backup as volumes in the contain
|
||||
For the MariaDB database container:
|
||||
|
||||
```diff
|
||||
$ docker run -d --name mariadb \
|
||||
docker run -d --name mariadb \
|
||||
...
|
||||
- --volume /path/to/mariadb-persistence:/bitnami/mariadb \
|
||||
+ --volume /path/to/mariadb-backups/latest:/bitnami/mariadb \
|
||||
@@ -382,7 +383,7 @@ For the MariaDB database container:
|
||||
For the phpBB container:
|
||||
|
||||
```diff
|
||||
$ docker run -d --name phpbb \
|
||||
docker run -d --name phpbb \
|
||||
...
|
||||
- --volume /path/to/phpbb-persistence:/bitnami/phpbb \
|
||||
+ --volume /path/to/phpbb-backups/latest:/bitnami/phpbb \
|
||||
@@ -391,12 +392,12 @@ For the phpBB container:
|
||||
|
||||
### Upgrade this image
|
||||
|
||||
Bitnami provides up-to-date versions of MariaDB and phpBB, 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 phpBB container. For the MariaDB upgrade see: https://github.com/bitnami/containers/tree/main/bitnami/mariadb#upgrade-this-image
|
||||
Bitnami provides up-to-date versions of MariaDB and phpBB, 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 phpBB container. For the MariaDB upgrade see: <https://github.com/bitnami/containers/tree/main/bitnami/mariadb#upgrade-this-image>
|
||||
|
||||
#### Step 1: Get the updated image
|
||||
|
||||
```console
|
||||
$ docker pull bitnami/phpbb:latest
|
||||
docker pull bitnami/phpbb:latest
|
||||
```
|
||||
|
||||
#### Step 2: Stop the running container
|
||||
@@ -404,7 +405,7 @@ $ docker pull bitnami/phpbb:latest
|
||||
Stop the currently running container using the command
|
||||
|
||||
```console
|
||||
$ docker-compose stop phpbb
|
||||
docker-compose stop phpbb
|
||||
```
|
||||
|
||||
#### Step 3: Take a snapshot of the application state
|
||||
@@ -424,7 +425,7 @@ docker-compose rm -v phpbb
|
||||
Update the image tag in `docker-compose.yml` and re-create your container with the new image:
|
||||
|
||||
```console
|
||||
$ docker-compose up -d
|
||||
docker-compose up -d
|
||||
```
|
||||
|
||||
## Customize this image
|
||||
@@ -435,10 +436,10 @@ The Bitnami phpBB Docker image is designed to be extended so it can be used as t
|
||||
|
||||
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/containers/blob/main/bitnami/apache#adding-custom-virtual-hosts).
|
||||
- [Replacing the 'httpd.conf' file](https://github.com/bitnami/containers/blob/main/bitnami/apache#full-configuration).
|
||||
- [Using custom SSL certificates](https://github.com/bitnami/containers/blob/main/bitnami/apache#using-custom-ssl-certificates).
|
||||
* 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/containers/blob/main/bitnami/apache#adding-custom-virtual-hosts).
|
||||
* [Replacing the 'httpd.conf' file](https://github.com/bitnami/containers/blob/main/bitnami/apache#full-configuration).
|
||||
* [Using custom SSL certificates](https://github.com/bitnami/containers/blob/main/bitnami/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:
|
||||
|
||||
@@ -450,9 +451,9 @@ FROM bitnami/phpbb
|
||||
|
||||
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
|
||||
* Install the `vim` editor
|
||||
* Modify the Apache configuration file
|
||||
* Modify the ports used by Apache
|
||||
|
||||
```Dockerfile
|
||||
FROM bitnami/phpbb
|
||||
@@ -490,15 +491,15 @@ Based on the extended image, you can update the [`docker-compose.yml`](https://g
|
||||
...
|
||||
```
|
||||
|
||||
# Notable Changes
|
||||
## Notable Changes
|
||||
|
||||
## 3.3.1-debian-10-r44
|
||||
|
||||
- The size of the container image has been decreased.
|
||||
- The configuration logic is now based on Bash scripts in the *rootfs/* folder.
|
||||
- The phpBB 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 phpBB site by exporting its content, and importing it on a new phpBB 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.
|
||||
* The size of the container image has been decreased.
|
||||
* The configuration logic is now based on Bash scripts in the *rootfs/* folder.
|
||||
* The phpBB 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 phpBB site by exporting its content, and importing it on a new phpBB container. Follow the steps in [Backing up your container](#backing-up-your-container) and [Restoring a backup](#restoring-a-backup) to migrate the data between the old and new container.
|
||||
|
||||
To upgrade a previous Bitnami phpBB container image, which did not support non-root, the easiest way is to start the new image as a root user and updating the port numbers. Modify your docker-compose.yml file as follows:
|
||||
|
||||
@@ -515,14 +516,14 @@ To upgrade a previous Bitnami phpBB container image, which did not support non-r
|
||||
|
||||
## 3.3.1-debian-10-r18
|
||||
|
||||
- The PHP version has been updated from 7.2 to 7.3
|
||||
* The PHP version has been updated from 7.2 to 7.3
|
||||
|
||||
## 3.2.7-debian-9-r19 and 3.2.7-ol-7-r30
|
||||
|
||||
- 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`.
|
||||
* This image has been adapted so it's easier to customize. See the [Customize this image](#customize-this-image) section for more information.
|
||||
* The Apache configuration volume (`/bitnami/apache`) has been deprecated, and support for this feature will be dropped in the near future. Until then, the container will enable the Apache configuration from that volume if it exists. By default, and if the configuration volume does not exist, the configuration files will be regenerated each time the container is created. Users wanting to apply custom Apache configuration files are advised to mount a volume for the configuration at `/opt/bitnami/apache/conf`, or mount specific configuration files individually.
|
||||
* The PHP configuration volume (`/bitnami/php`) has been deprecated, and support for this feature will be dropped in the near future. Until then, the container will enable the PHP configuration from that volume if it exists. By default, and if the configuration volume does not exist, the configuration files will be regenerated each time the container is created. Users wanting to apply custom PHP configuration files are advised to mount a volume for the configuration at `/opt/bitnami/php/conf`, or mount specific configuration files individually.
|
||||
* Enabling custom Apache certificates by placing them at `/opt/bitnami/apache/certs` has been deprecated, and support for this functionality will be dropped in the near future. Users wanting to enable custom certificates are advised to mount their certificate files on top of the preconfigured ones at `/certs`.
|
||||
|
||||
## Contributing
|
||||
|
||||
@@ -548,7 +549,7 @@ Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
<http://www.apache.org/licenses/LICENSE-2.0>
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
|
||||
Reference in New Issue
Block a user