Skip to content

README.md

Latest commit

 

History

History
175 lines (112 loc) · 4.56 KB

README.md

File metadata and controls

175 lines (112 loc) · 4.56 KB

phpBB3 docker image

Lightweight Alpine-based phpBB image with nginx and PHP 8.4 FPM.

Published to GitHub Container Registry as ghcr.io/fed1337/docker-phpbb.

Bundled phpBB 3.3.17 with SQLite and MariaDB/MySQL (mysqli) support.

Docker Compose

The stack is split into a shared base and two overlays:

File Purpose
compose.yml Shared MariaDB + phpBB configuration
compose.dev.yml Build the image locally
compose.prod.yml Pull the published image from GHCR

Development (local build)

$ docker compose -f compose.yml -f compose.dev.yml up --build

Production (GHCR image)

$ docker compose -f compose.yml -f compose.prod.yml up -d

Pull a specific phpBB version tag instead of latest:

$ PHPBB_TAG=3.3.17 docker compose -f compose.yml -f compose.prod.yml up -d

Open http://127.0.0.1:8000. For a fresh install, pass PHPBB_INSTALL once:

$ PHPBB_INSTALL=true docker compose -f compose.yml -f compose.dev.yml up --build

During installation, use these database settings:

Field Value
Database type MySQL with MySQLi Extension
Database server mariadb
Database name phpbb (or your MARIADB_DATABASE)
Username phpbb (or your MARIADB_USER)
Password phpbb (or your MARIADB_PASSWORD)

Default MariaDB credentials can be overridden:

  • MARIADB_ROOT_PASSWORD (default: changeme)
  • MARIADB_DATABASE (default: phpbb)
  • MARIADB_USER (default: phpbb)
  • MARIADB_PASSWORD (default: phpbb)

After installation, restart without PHPBB_INSTALL so the install/ directory is removed on startup:

$ docker compose -f compose.yml -f compose.dev.yml up -d

Optionally enable automatic migrations:

$ PHPBB_DB_AUTOMIGRATE=true docker compose -f compose.yml -f compose.dev.yml up -d

Image tags

GitHub Actions publishes to GHCR on manual workflow dispatch. Tags track the phpBB version from the Dockerfile:

  • 3.3.17 — patch (full phpBB version)
  • 3.3 — minor
  • 3 — major
  • latest

Standalone container

$ docker pull ghcr.io/fed1337/docker-phpbb:latest
$ docker run -p 8000:80 --name phpbb-install -e PHPBB_INSTALL=true -d ghcr.io/fed1337/docker-phpbb:latest

By default the standalone image uses SQLite. Set the DSN field to /phpbb/sqlite/sqlite.db during installation and leave username, password, and database name blank.

For an external database:

$ docker run --name phpbb \
    -e PHPBB_DB_DRIVER=mysqli \
    -e PHPBB_DB_HOST=dbhost \
    -e PHPBB_DB_PORT=3306 \
    -e PHPBB_DB_NAME=phpbb \
    -e PHPBB_DB_USER=phpbb \
    -e PHPBB_DB_PASSWD=pass \
    -p 8000:80 -d ghcr.io/fed1337/docker-phpbb:latest

Environment variables

Most variables are written into phpBB's config.php or read by the startup script.

PHPBB_INSTALL

If true, removes config.php and keeps the /install/ directory for a fresh setup. When unset, the startup script deletes install/ automatically.

PHPBB_DB_DRIVER

Supported drivers: sqlite3, mysqli.

Default: sqlite3

PHPBB_DB_HOST

Database hostname, or SQLite file path for the sqlite3 driver.

Default: /phpbb/sqlite/sqlite.db

PHPBB_DB_PORT

Database port (required for PHPBB_DB_WAIT with network databases).

PHPBB_DB_NAME / PHPBB_DB_USER / PHPBB_DB_PASSWD

Database credentials.

PHPBB_DB_TABLE_PREFIX

Default: phpbb_

PHPBB_DB_AUTOMIGRATE

If true, runs bin/phpbbcli.php db:migrate on startup. Requires an existing database schema.

PHPBB_DB_WAIT

If true, waits for the database host/port to accept connections before running migrations. Not used with SQLite.

PHPBB_DISPLAY_LOAD_TIME / PHPBB_DEBUG / PHPBB_DEBUG_CONTAINER

Enable phpBB debug and diagnostics output when set to true.

Volumes

Persistent data paths:

  • /phpbb/www/files
  • /phpbb/www/store
  • /phpbb/www/images/avatars/upload
  • /phpbb/sqlite (SQLite only)

Updating phpBB version

$ ./update.sh 3.3

This updates PHPBB_VERSION and its checksum in the Dockerfile, then rebuild and run the release workflow to publish new GHCR tags.

Custom configuration

Extend the image to add PHP or nginx settings:

FROM ghcr.io/fed1337/docker-phpbb:latest

COPY custom.ini /usr/local/etc/php/conf.d/
COPY custom.conf /etc/nginx/http.d/

To pass the client IP through a reverse proxy, configure nginx real_ip directives in a custom server block.