├── .gitignore
├── .dockerignore
├── php
    ├── php-cli.ini
    ├── conf.d
    │   └── opcache.ini
    └── php.ini
├── .actrc
├── .github
    ├── dependabot.yml
    └── workflows
    │   └── deploy-docker-image.yml
├── apache2
    ├── conf.d
    │   └── mpm.conf
    └── httpd.conf
├── docker-compose.build.yml
├── docker-compose.yml
├── phpbb
    └── config.php
├── update.sh
├── start.sh
├── LICENSE
├── Dockerfile
└── README.MD


/.gitignore:
--------------------------------------------------------------------------------
1 | .secrets


--------------------------------------------------------------------------------
/.dockerignore:
--------------------------------------------------------------------------------
1 | .secrets
2 | .act


--------------------------------------------------------------------------------
/php/php-cli.ini:
--------------------------------------------------------------------------------
1 | [php]
2 | memory_limit = -1
3 | 


--------------------------------------------------------------------------------
/.actrc:
--------------------------------------------------------------------------------
1 | -P ubuntu-latest=catthehacker/ubuntu:act-latest
2 | --secret-file .secrets


--------------------------------------------------------------------------------
/.github/dependabot.yml:
--------------------------------------------------------------------------------
1 | version: 2
2 | updates:
3 |   # Maintain dependencies for GitHub Actions
4 |   - package-ecosystem: "github-actions"
5 |     directory: "/"
6 |     schedule:
7 |       interval: "daily"
8 | 


--------------------------------------------------------------------------------
/php/conf.d/opcache.ini:
--------------------------------------------------------------------------------
1 | opcache.memory_consumption=64
2 | opcache.interned_strings_buffer=8
3 | opcache.max_accelerated_files=4000
4 | opcache.validate_timestamps=0
5 | opcache.revalidate_freq=0
6 | opcache.fast_shutdown=1
7 | opcache.enable_cli=1
8 | opcache.file_cache=/phpbb/opcache


--------------------------------------------------------------------------------
/apache2/conf.d/mpm.conf:
--------------------------------------------------------------------------------
1 | PidFile "/run/apache2/httpd.pid"
2 | 
3 | <IfModule mpm_prefork_module>
4 |     StartServers             5
5 |     MinSpareServers          5
6 |     MaxSpareServers         10
7 |     MaxRequestWorkers      250
8 |     MaxConnectionsPerChild   0
9 | </IfModule>


--------------------------------------------------------------------------------
/php/php.ini:
--------------------------------------------------------------------------------
 1 | [PHP]
 2 | file_uploads = On
 3 | max_file_uploads = 2
 4 | upload_max_filesize = 8M
 5 | post_max_size = 8M
 6 | 
 7 | allow_url_fopen = On
 8 | 
 9 | expose_php = Off
10 | security.limit_extensions = .php
11 | 
12 | output_buffering = On
13 | display_errors = Off
14 | log_errors = On
15 | error_log = /dev/stderr
16 | 
17 | [Date]
18 | date.timezone = 'UTC'


--------------------------------------------------------------------------------
/docker-compose.build.yml:
--------------------------------------------------------------------------------
 1 | volumes:
 2 |   phpbb-sqlite: {}
 3 |   phpbb-files: {}
 4 |   phpbb-store: {}
 5 |   phpbb-avatars: {}
 6 | 
 7 | services:
 8 |   phpbb:
 9 |     build: .
10 |     ports:
11 |       - '127.0.0.1:8000:80'
12 |     volumes:
13 |       - 'phpbb-sqlite:/phpbb/sqlite'
14 |       - 'phpbb-files:/phpbb/www/files'
15 |       - 'phpbb-store:/phpbb/www/store'
16 |       - 'phpbb-avatars:/phpbb/www/images/avatars/upload'
17 |     environment:
18 |       PHPBB_INSTALL: 'true'


--------------------------------------------------------------------------------
/docker-compose.yml:
--------------------------------------------------------------------------------
 1 | volumes:
 2 |   phpbb-sqlite: {}
 3 |   phpbb-files: {}
 4 |   phpbb-store: {}
 5 |   phpbb-avatars: {}
 6 | 
 7 | services:
 8 |   phpbb:
 9 |     image: selim13/phpbb:3.3
10 |     ports:
11 |       - '127.0.0.1:8000:80'
12 |     volumes:
13 |       - 'phpbb-sqlite:/phpbb/sqlite'
14 |       - 'phpbb-files:/phpbb/www/files'
15 |       - 'phpbb-store:/phpbb/www/store'
16 |       - 'phpbb-avatars:/phpbb/www/images/avatars/upload'
17 |     environment:
18 |       #PHPBB_INSTALL: 'true'
19 |       PHPBB_DB_AUTOMIGRATE: 'true'
20 | 


--------------------------------------------------------------------------------
/phpbb/config.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | $dbms = 'phpbb\\db\\driver\\' . getenv('PHPBB_DB_DRIVER');
 4 | $dbhost = getenv('PHPBB_DB_HOST');
 5 | $dbport = getenv('PHPBB_DB_PORT');
 6 | $dbname = getenv('PHPBB_DB_NAME');
 7 | $dbuser = getenv('PHPBB_DB_USER');
 8 | $dbpasswd = getenv('PHPBB_DB_PASSWD');
 9 | $table_prefix = getenv('PHPBB_DB_TABLE_PREFIX');
10 | $phpbb_adm_relative_path = 'adm/';
11 | $acm_type = 'phpbb\\cache\\driver\\file';
12 | 
13 | @define('PHPBB_INSTALLED', true);
14 | 
15 | if (getenv('PHPBB_DISPLAY_LOAD_TIME') === 'true') {
16 | 	@define('PHPBB_DISPLAY_LOAD_TIME', true);
17 | }
18 | 
19 | if (getenv('PHPBB_DEBUG') === 'true') {
20 | 	@define('DEBUG', true);
21 | }
22 | 
23 | if (getenv('PHPBB_DEBUG_CONTAINER') === 'true') {
24 | 	@define('DEBUG_CONTAINER', true);
25 | }


--------------------------------------------------------------------------------
/update.sh:
--------------------------------------------------------------------------------
 1 | #!/bin/bash
 2 | 
 3 | set -e
 4 | 
 5 | VERSION="$1"
 6 | 
 7 | if [ ! -n "$VERSION" ]; then
 8 |     echo "Usage: $0 phpbb_minor_version"
 9 |     echo
10 |     echo "Example: $0 3.3"
11 |     exit 1
12 | fi
13 | 
14 | VERSIONS_URL="http://version.phpbb.com/phpbb/versions.json"
15 | LATEST_VERSION=$(curl --silent --location $VERSIONS_URL | jq --raw-output ".stable[\"$VERSION\"].current")
16 | if [ "$LATEST_VERSION" == "null" ]; then
17 |     echo "PHPBB version not found"
18 |     exit 1
19 | fi
20 | 
21 | SHA_URL="https://download.phpbb.com/pub/release/3.3/$LATEST_VERSION/phpBB-$LATEST_VERSION.tar.bz2.sha256"
22 | SHA=$(curl --silent --location $SHA_URL | cut -d ' ' -f 1)
23 | if [ "${#SHA}" != "64" ]; then
24 |     echo "Failed to fetch SHA256 of an archive"
25 |     exit 1
26 | fi
27 | 
28 | sed -i "s/^ENV PHPBB_VERSION .*$/ENV PHPBB_VERSION $LATEST_VERSION/" Dockerfile
29 | sed -i "s/^ENV PHPBB_SHA256 .*$/ENV PHPBB_SHA256 $SHA/" Dockerfile
30 | 
31 | echo "OK"


--------------------------------------------------------------------------------
/start.sh:
--------------------------------------------------------------------------------
 1 | #!/bin/sh
 2 | 
 3 | set -e
 4 | 
 5 | [[ "${PHPBB_INSTALL}" = "true" ]] && rm config.php
 6 | [[ "${PHPBB_INSTALL}" != "true" ]] && rm -rf install
 7 | 
 8 | db_wait() {
 9 |         if [[ "${PHPBB_DB_WAIT}" = "true" &&  "${PHPBB_DB_DRIVER}" != "sqlite3" && "${PHPBB_DB_DRIVER}" != "sqlite" ]]; then
10 |             until nc -z ${PHPBB_DB_HOST} ${PHPBB_DB_PORT}; do
11 |                 echo "$(date) - waiting for database on ${PHPBB_DB_HOST}:${PHPBB_DB_PORT} to start before applying migrations"
12 |                 sleep 3
13 |             done
14 |         fi
15 | }
16 | 
17 | db_migrate() {
18 |     if [[ "${PHPBB_DB_AUTOMIGRATE}" = "true" && "${PHPBB_INSTALL}" != "true" ]]; then
19 |         echo "$(date) - applying migrations"
20 |         su-exec apache php bin/phpbbcli.php db:migrate
21 |     fi
22 | }
23 | 
24 | # Apache gets grumpy about PID files pre-existing
25 | rm -f /run/apache2/httpd.pid
26 | 
27 | db_wait && db_migrate && exec httpd -DFOREGROUND "$@"
28 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | MIT License
 2 | 
 3 | Copyright (c) 2016 Seleznyov Dmitry
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining a copy
 6 | of this software and associated documentation files (the "Software"), to deal
 7 | in the Software without restriction, including without limitation the rights
 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 | 
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 | 
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 | 


--------------------------------------------------------------------------------
/.github/workflows/deploy-docker-image.yml:
--------------------------------------------------------------------------------
 1 | name: Deploy docker image
 2 | 
 3 | on:
 4 |   push:
 5 |     branches:
 6 |       - "master"
 7 |     tags:
 8 |       - "*"
 9 | 
10 | jobs:
11 |   deploy:
12 |     runs-on: ubuntu-latest
13 |     permissions:
14 |       packages: write
15 |       contents: read
16 | 
17 |     steps:
18 |       - uses: actions/checkout@v4
19 |       - uses: docker/setup-qemu-action@v3
20 |       - uses: docker/setup-buildx-action@v3
21 | 
22 |       - name: Login to Docker Hub
23 |         uses: docker/login-action@v3
24 |         with:
25 |           username: ${{ secrets.DOCKERHUB_USERNAME }}
26 |           password: ${{ secrets.DOCKERHUB_TOKEN }}
27 | 
28 |       - name: Login to Container registry
29 |         uses: docker/login-action@v3
30 |         with:
31 |           registry: ghcr.io
32 |           username: ${{ github.actor }}
33 |           password: ${{ secrets.GITHUB_TOKEN }}
34 | 
35 |       - name: Docker meta
36 |         id: meta
37 |         uses: docker/metadata-action@v5
38 |         with:
39 |           tags: |
40 |             type=ref,event=branch
41 |             type=semver,pattern={{version}}
42 |             type=semver,pattern={{major}}.{{minor}}
43 |           images: |
44 |             ${{ secrets.DOCKERHUB_REPOSITORY }}            
45 |             ghcr.io/${{ github.repository }}
46 | 
47 |       - name: Build and push
48 |         id: docker_build
49 |         uses: docker/build-push-action@v5
50 |         with:
51 |           context: .
52 |           platforms: linux/amd64,linux/arm64
53 |           push: true
54 |           tags: ${{ steps.meta.outputs.tags }}
55 |           labels: ${{ steps.meta.outputs.labels }}
56 | 


--------------------------------------------------------------------------------
/Dockerfile:
--------------------------------------------------------------------------------
 1 | FROM alpine:3.17
 2 | 
 3 | LABEL maintainer="selim013@gmail.com"
 4 | 
 5 | RUN apk add --no-cache curl \
 6 |     imagemagick \
 7 |     apache2 \
 8 |     php81 \
 9 |     php81-apache2 \
10 |     php81-ctype \
11 |     php81-curl \
12 |     php81-dom \
13 |     php81-ftp \
14 |     php81-gd \
15 |     php81-iconv \
16 |     php81-json \
17 |     php81-mbstring \
18 |     php81-mysqli \
19 |     php81-opcache \
20 |     php81-openssl \
21 |     php81-pgsql \
22 |     php81-sqlite3 \
23 |     php81-tokenizer \
24 |     php81-xml \
25 |     php81-zlib \
26 |     php81-zip \
27 |     su-exec
28 | 
29 | ### phpBB
30 | ENV PHPBB_VERSION 3.3.9
31 | ENV PHPBB_SHA256 8eacc10caff2327d51019ed2677b55ff1afdc68a3a7aaeee9ac29747775fe04f
32 | 
33 | WORKDIR /tmp
34 | 
35 | RUN curl -SL https://download.phpbb.com/pub/release/3.3/${PHPBB_VERSION}/phpBB-${PHPBB_VERSION}.tar.bz2 -o phpbb.tar.bz2 \
36 |     && echo "${PHPBB_SHA256}  phpbb.tar.bz2" | sha256sum -c - \
37 |     && tar -xjf phpbb.tar.bz2 \
38 |     && mkdir /phpbb \
39 |     && mkdir /phpbb/sqlite \
40 |     && mv phpBB3 /phpbb/www \
41 |     && rm -f phpbb.tar.bz2
42 | 
43 | COPY phpbb/config.php /phpbb/www
44 | 
45 | ### Server
46 | RUN mkdir -p /run/apache2 /phpbb/opcache \
47 |     && chown apache:apache /run/apache2 /phpbb/opcache
48 | 
49 | COPY apache2/httpd.conf /etc/apache2/
50 | COPY apache2/conf.d/* /etc/apache2/conf.d/
51 | COPY php/php.ini php/php-cli.ini /etc/php81/
52 | COPY php/conf.d/* /etc/php81/conf.d
53 | COPY start.sh /usr/local/bin/
54 | 
55 | RUN chown -R apache:apache /phpbb
56 | WORKDIR /phpbb/www
57 | 
58 | #VOLUME /phpbb/sqlite
59 | #VOLUME /phpbb/www/files
60 | #VOLUME /phpbb/www/store
61 | #VOLUME /phpbb/www/images/avatars/upload
62 | 
63 | ENV PHPBB_INSTALL= \
64 |     PHPBB_DB_DRIVER=sqlite3 \
65 |     PHPBB_DB_HOST=/phpbb/sqlite/sqlite.db \
66 |     PHPBB_DB_PORT= \
67 |     PHPBB_DB_NAME= \
68 |     PHPBB_DB_USER= \
69 |     PHPBB_DB_PASSWD= \
70 |     PHPBB_DB_TABLE_PREFIX=phpbb_ \
71 |     PHPBB_DB_AUTOMIGRATE= \
72 |     PHPBB_DISPLAY_LOAD_TIME= \
73 |     PHPBB_DEBUG= \
74 |     PHPBB_DEBUG_CONTAINER=
75 | 
76 | EXPOSE 80
77 | CMD ["start.sh"]


--------------------------------------------------------------------------------
/apache2/httpd.conf:
--------------------------------------------------------------------------------
  1 | ServerTokens Prod
  2 | 
  3 | ServerRoot /var/www
  4 | 
  5 | Listen 80
  6 | 
  7 | LoadModule authn_file_module modules/mod_authn_file.so
  8 | #LoadModule authn_dbm_module modules/mod_authn_dbm.so
  9 | #LoadModule authn_anon_module modules/mod_authn_anon.so
 10 | #LoadModule authn_dbd_module modules/mod_authn_dbd.so
 11 | #LoadModule authn_socache_module modules/mod_authn_socache.so
 12 | LoadModule authn_core_module modules/mod_authn_core.so
 13 | LoadModule authz_host_module modules/mod_authz_host.so
 14 | LoadModule authz_groupfile_module modules/mod_authz_groupfile.so
 15 | LoadModule authz_user_module modules/mod_authz_user.so
 16 | #LoadModule authz_dbm_module modules/mod_authz_dbm.so
 17 | #LoadModule authz_owner_module modules/mod_authz_owner.so
 18 | #LoadModule authz_dbd_module modules/mod_authz_dbd.so
 19 | LoadModule authz_core_module modules/mod_authz_core.so
 20 | LoadModule access_compat_module modules/mod_access_compat.so
 21 | LoadModule auth_basic_module modules/mod_auth_basic.so
 22 | #LoadModule auth_form_module modules/mod_auth_form.so
 23 | #LoadModule auth_digest_module modules/mod_auth_digest.so
 24 | #LoadModule allowmethods_module modules/mod_allowmethods.so
 25 | #LoadModule file_cache_module modules/mod_file_cache.so
 26 | #LoadModule cache_module modules/mod_cache.so
 27 | #LoadModule cache_disk_module modules/mod_cache_disk.so
 28 | #LoadModule cache_socache_module modules/mod_cache_socache.so
 29 | #LoadModule socache_shmcb_module modules/mod_socache_shmcb.so
 30 | #LoadModule socache_dbm_module modules/mod_socache_dbm.so
 31 | #LoadModule socache_memcache_module modules/mod_socache_memcache.so
 32 | #LoadModule watchdog_module modules/mod_watchdog.so
 33 | #LoadModule macro_module modules/mod_macro.so
 34 | #LoadModule dbd_module modules/mod_dbd.so
 35 | #LoadModule dumpio_module modules/mod_dumpio.so
 36 | #LoadModule echo_module modules/mod_echo.so
 37 | #LoadModule buffer_module modules/mod_buffer.so
 38 | #LoadModule data_module modules/mod_data.so
 39 | #LoadModule ratelimit_module modules/mod_ratelimit.so
 40 | LoadModule reqtimeout_module modules/mod_reqtimeout.so
 41 | #LoadModule ext_filter_module modules/mod_ext_filter.so
 42 | #LoadModule request_module modules/mod_request.so
 43 | #LoadModule include_module modules/mod_include.so
 44 | LoadModule filter_module modules/mod_filter.so
 45 | #LoadModule reflector_module modules/mod_reflector.so
 46 | #LoadModule substitute_module modules/mod_substitute.so
 47 | #LoadModule sed_module modules/mod_sed.so
 48 | #LoadModule charset_lite_module modules/mod_charset_lite.so
 49 | #LoadModule deflate_module modules/mod_deflate.so
 50 | LoadModule mime_module modules/mod_mime.so
 51 | LoadModule log_config_module modules/mod_log_config.so
 52 | #LoadModule log_debug_module modules/mod_log_debug.so
 53 | #LoadModule log_forensic_module modules/mod_log_forensic.so
 54 | #LoadModule logio_module modules/mod_logio.so
 55 | LoadModule env_module modules/mod_env.so
 56 | #LoadModule mime_magic_module modules/mod_mime_magic.so
 57 | #LoadModule expires_module modules/mod_expires.so
 58 | LoadModule headers_module modules/mod_headers.so
 59 | #LoadModule usertrack_module modules/mod_usertrack.so
 60 | #LoadModule unique_id_module modules/mod_unique_id.so
 61 | LoadModule setenvif_module modules/mod_setenvif.so
 62 | LoadModule version_module modules/mod_version.so
 63 | #LoadModule remoteip_module modules/mod_remoteip.so
 64 | #LoadModule session_module modules/mod_session.so
 65 | #LoadModule session_cookie_module modules/mod_session_cookie.so
 66 | #LoadModule session_dbd_module modules/mod_session_dbd.so
 67 | #LoadModule slotmem_shm_module modules/mod_slotmem_shm.so
 68 | #LoadModule slotmem_plain_module modules/mod_slotmem_plain.so
 69 | #LoadModule dialup_module modules/mod_dialup.so
 70 | #LoadModule mpm_event_module modules/mod_mpm_event.so
 71 | LoadModule mpm_prefork_module modules/mod_mpm_prefork.so
 72 | #LoadModule mpm_worker_module modules/mod_mpm_worker.so
 73 | LoadModule unixd_module modules/mod_unixd.so
 74 | #LoadModule heartbeat_module modules/mod_heartbeat.so
 75 | #LoadModule heartmonitor_module modules/mod_heartmonitor.so
 76 | LoadModule status_module modules/mod_status.so
 77 | #LoadModule autoindex_module modules/mod_autoindex.so
 78 | #LoadModule asis_module modules/mod_asis.so
 79 | #LoadModule info_module modules/mod_info.so
 80 | #LoadModule suexec_module modules/mod_suexec.so
 81 | <IfModule !mpm_prefork_module>
 82 | 	#LoadModule cgid_module modules/mod_cgid.so
 83 | </IfModule>
 84 | <IfModule mpm_prefork_module>
 85 | 	#LoadModule cgi_module modules/mod_cgi.so
 86 | </IfModule>
 87 | #LoadModule vhost_alias_module modules/mod_vhost_alias.so
 88 | #LoadModule negotiation_module modules/mod_negotiation.so
 89 | LoadModule dir_module modules/mod_dir.so
 90 | #LoadModule actions_module modules/mod_actions.so
 91 | #LoadModule speling_module modules/mod_speling.so
 92 | #LoadModule userdir_module modules/mod_userdir.so
 93 | LoadModule alias_module modules/mod_alias.so
 94 | LoadModule rewrite_module modules/mod_rewrite.so
 95 | 
 96 | LoadModule negotiation_module modules/mod_negotiation.so
 97 | 
 98 | <IfModule unixd_module>
 99 |     User apache
100 |     Group apache
101 | </IfModule>
102 | 
103 | 
104 | ServerAdmin you@example.com
105 | 
106 | ServerSignature Off
107 | 
108 | #ServerName www.example.com:80
109 | 
110 | <Directory />
111 |     AllowOverride none
112 |     Require all denied
113 | </Directory>
114 | 
115 | DocumentRoot "/phpbb/www"
116 | <Directory "/phpbb/www">
117 |     Options FollowSymLinks
118 |     AllowOverride All
119 |     Require all granted
120 | 
121 |     # Return 404 for all dot files (.htaccess, .git, etc...)
122 |     RedirectMatch 404 /\..*$
123 | </Directory>
124 | 
125 | <IfModule dir_module>
126 |     DirectoryIndex index.php index.html
127 | </IfModule>
128 | 
129 | <Files ".ht*">
130 |     Require all denied
131 | </Files>
132 | 
133 | ErrorLog /dev/stderr
134 | LogLevel warn
135 | 
136 | <IfModule log_config_module>
137 |     LogFormat "%h %l %u %t \"%r\" %>s %b \"%{Referer}i\" \"%{User-Agent}i\"" combined
138 |     LogFormat "%h %l %u %t \"%r\" %>s %b" common
139 | 
140 |     CustomLog /dev/stdout combined
141 | </IfModule>
142 | 
143 | 
144 | <IfModule mime_module>
145 |     TypesConfig /etc/apache2/mime.types
146 |     AddType application/x-compress .Z
147 |     AddType application/x-gzip .gz .tgz
148 | </IfModule>
149 | 
150 | 
151 | <IfModule mime_magic_module>
152 |     MIMEMagicFile /etc/apache2/magic
153 | </IfModule>
154 | 
155 | IncludeOptional /etc/apache2/conf.d/*.conf
156 | 


--------------------------------------------------------------------------------
/README.MD:
--------------------------------------------------------------------------------
  1 | # phpBB3 docker image
  2 | 
  3 | Lightweight, Alpine based [phpBB](https://www.phpbb.com/) docker image.
  4 | 
  5 | # Supported tags and respective `Dockerfile` links
  6 | 
  7 | - [`3.3`, `3.3.4`, `latest`](https://github.com/selim13/docker-phpbb/blob/master/Dockerfile) bundled with PHP 8
  8 | - [`3.2`, `3.2.11`](https://github.com/selim13/docker-phpbb/blob/3.2-alpine-apache/Dockerfile) bundled with PHP 7.2
  9 | 
 10 | # How to use this image
 11 | 
 12 | ## Initial installation
 13 | 
 14 | If you don't have a prepared phpBB database, you can use a standard phpBB 
 15 | installer script, just run a temporary container with `PHPBB_INSTALL=true` 
 16 | environment variable:
 17 | 
 18 | ```console
 19 | $ docker run -p 8000:80 --name phpbb-install -e PHPBB_INSTALL=true -d selim13/phpbb:3.3
 20 | ```
 21 | 
 22 | Point your browser to the http://localhost:8000 to begin the 
 23 | installation process.
 24 | 
 25 | This image is bundled with SQLite3, MySQL and PostgresSQL database engines
 26 | support. Others can be added by creating custom Dockerfile. For MySQL and PostgresSQL
 27 | you can use standard container linking or use SQLite if you want a self
 28 | sufficient container.
 29 | 
 30 | For SQLite3 set `Database server hostname or DSN` field to `/phpbb/sqlite/sqlite.db`.
 31 | This file will be created on a docker volume and outside of the webserver's document root
 32 | for security. Leave user name, password and database name fields blank.
 33 | 
 34 | After the installation process is complete you can safely stop this container: 
 35 | 
 36 | ```console
 37 | $ docker stop phpbb-install
 38 | ```
 39 | 
 40 | ## Starting
 41 | 
 42 | You can start a container as follows:
 43 | 
 44 | 
 45 | ```console
 46 | $ docker run --name phpbb -d selim13/phpbb:3.3
 47 | ```
 48 | 
 49 | By default, it uses SQLite3 as a database backend, so you will need to supply
 50 | it with a database file. It's default path is `/phpbb/sqlite/sqlite.db`.
 51 | 
 52 | You can import it from the temporary installation container above:
 53 | 
 54 | ```console
 55 | $ docker run --volumes-from phpbb-install --name phpbb -d selim13/phpbb:3.3
 56 | ```
 57 | 
 58 | Or just copy it inside container if you have one from previous phpBB
 59 | installations:
 60 | 
 61 | ```console
 62 | $ docker cp /path/at/host/sqlite.db phpbb:/www/sqlite/sqlite.db
 63 | ```
 64 | 
 65 | For other database engines you will need to pass credentials and driver type
 66 | using environment variables:
 67 | 
 68 | ```console
 69 | $ docker run --name phpbb     \
 70 |     -e PHPBB_DB_DRIVER=mysqli \
 71 |     -e PHPBB_DB_HOST=dbmysql  \
 72 |     -e PHPBB_DB_PORT=3306     \
 73 |     -e PHPBB_DB_NAME=phpbb    \
 74 |     -e PHPBB_DB_USER=phpbb    \
 75 |     -e PHPBB_DB_PASSWD=pass -d selim13/phpbb:3.3
 76 | ```
 77 | 
 78 | ## Environment variables 
 79 | 
 80 | This image utilises environment variables for basic configuration. Most of
 81 | them are passed directly to phpBB's `config.php` or to the startup script.
 82 | 
 83 | ### PHPBB_INSTALL
 84 | If set to `true`, container will start with an empty `config.php` file and
 85 | phpBB `/install/` directory intact. This will allow you to initilalize 
 86 | a forum database upon fresh installation.
 87 | 
 88 | ### PHPBB_DB_DRIVER
 89 | 
 90 | Selects a database driver. phpBB3 ships with following drivers:
 91 | - `mssql` - MS SQL Server
 92 | - `mysql` - MySQL via outdated php extension
 93 | - `mysqli` - MySQL via newer php extension
 94 | - `oracle` - Oracle
 95 | - `postgres` - PostgreSQL
 96 | - `sqlite` - SQLite 2
 97 | - `sqlite3` - SQLite 3
 98 | 
 99 | This image is bundled with support of `sqlite3`, `mysqli` and `postgres` drivers.
100 | 
101 | Default value: sqlite3
102 |  
103 | ### PHPBB_DB_HOST
104 | 
105 | Database hostname or ip address.
106 | 
107 | For the SQLite3 driver sets database file path. 
108 | 
109 | Default value: /phpbb/sqlite/sqlite.db
110 |  
111 | ### PHPBB_DB_PORT
112 | 
113 | Database port.
114 | 
115 | ### PHPBB_DB_NAME
116 | 
117 | Supplies database name for phpBB3.
118 | 
119 | ### PHPBB_DB_USER
120 | 
121 | Supplies a user name for phpBB3 database.
122 | 
123 | ### PHPBB_DB_PASSWD
124 | 
125 | Supplies a user password for phpBB3 database.
126 | 
127 | If you feel paranoid about providing your database password in an environment
128 | variable, you can always ship it with a custom `config.php` file using volumes
129 | or by extending this image.
130 | 
131 | ### PHPBB_DB_TABLE_PREFIX
132 | 
133 | Table prefix for phpBB3 database.
134 | 
135 | Default value: phpbb_ 
136 | 
137 | ### PHPBB_DB_AUTOMIGRATE
138 | 
139 | If set to `true`, instructs a container to run database migrations by
140 | executing `bin/phpbbcli.php db:migrate` on every startup.
141 | 
142 | If migrations fail, container will refuse to start.
143 | 
144 | ### PHPBB_DB_WAIT
145 | If set to `true`, container will wait for database service to become available.
146 | You will need to explicitly set `PHPBB_DB_HOST` and `PHPBB_DB_PORT` for this
147 | to work.
148 | 
149 | Use in conjunction with `PHPBB_DB_AUTOMIGRATE` to prevent running migrations
150 | before database is ready.
151 | 
152 | Won't work for SQLite database engine as it is always available. 
153 | 
154 | ### PHPBB_DISPLAY_LOAD_TIME
155 | 
156 | If set to `true`, phpBB will display page loading time, queries count and peak memory
157 | usage at the bottom of the page.
158 | 
159 | ### PHPBB_DEBUG
160 | 
161 | If set to `true`, enables phpBB debug mode.
162 | 
163 | ### PHPBB_DEBUG_CONTAINER
164 |   
165 | ## Volumes
166 | 
167 | By default there are four volumes created for each container:
168 | - /phpbb/sqlite
169 | - /phpbb/www/files
170 | - /phpbb/www/store
171 | - /phpbb/www/images/avatars/upload
172 | 
173 | # Additional configuration
174 | 
175 | This image is based on a stock official Alpine image with apache2 and php5
176 | packages from the Alpine Linux repository, so you can drop their custom 
177 | configuration files to `/etc/apache2/conf.d` and `/etc/php5/conf.d`.
178 | 
179 | ## Pass user's IP from proxy
180 | 
181 | If you are planning to start a container behind proxy 
182 | (like [nginx-proxy](https://github.com/jwilder/nginx-proxy)), it will probably
183 | be a good idea to get user's real IP instead of proxy one. For this, you can use
184 | Apache RemoteIP module. Create a configuration file:
185 | 
186 | ```apache
187 | LoadModule remoteip_module modules/mod_remoteip.so
188 | 
189 | RemoteIPHeader X-Real-IP
190 | RemoteIPInternalProxy nginx-proxy
191 | ```
192 | 
193 | Here `X-Real-IP` is a header name, where proxy passed user's real IP and
194 | `nginx-proxy` is proxy host name.
195 | 
196 | Then push it to `/etc/apache2/conf.d/` directory, for example, by extending this
197 | image:
198 | 
199 | ```dockerfile
200 | FROM selim13/phpbb:3.3
201 | 
202 | COPY remoteip.conf /etc/apache2/conf.d
203 | ```


--------------------------------------------------------------------------------