A dockerised install of Flarum designed to aid in development and testing.

This is not designed to be used for production systems.

• Setup
  • Prerequisites
  • Setting up PHP
    • Linux
    • Windows
  • Setting up Composer
    • Linux
    • Windows
  • Setting up Docker
    • Linux
    • Windows
  • Installing Docker compose
  • Access from other devices on your network
• Usage
  • Flarum
  • CLI access to the container
  • Resetting the database
  • PHPMyAdmin
• Development

You might need to configure a few things before using this container to get it working how you need it.

⚠️ If you're using Windows 10/11, you might want to consider using the Windows Subsystem for Linux (WSL) instead of running this on Windows natively.

To set up WSL2, follow these steps in order:

• Docker for Windows setup in this README
• https://docs.microsoft.com/en-us/windows/wsl/install-win10
• https://docs.microsoft.com/en-us/windows/wsl/tutorials/wsl-git#git-credential-manager-setup
• In Docker Desktop, click Settings, Resources, WSL Integration, and toggle all switches on. Click Apply & Restart.
• Perform Linux PHP and Composer setup instructions within WSL2.

• git is set up and configured on your system
• You have a basic understanding of editing configuration files
• You have some experience in the command prompt/interpreter
• You have this repo downloaded where you'd like to install Flarum

PHP installation varies across systems.

One of the most common methods on Ubuntu is via apt and a PHP PPA. You're relying on the PPA being trustworthy -- in production systems, you should build PHP from source to ensure you are not running a build that has been modified maliciously.

sudo add-apt-repository ppa:ondrej/php
sudo apt update
sudo apt install php8.0 php8.0-curl php8.0-mbstring php8.0-dom

You'll need PHP installed locally to use Composer. Download PHP 8.0 for Windows.

You need to extract this to a folder on your PC, then add this folder to your PATH. I recommend a location such as C:\PHP8, or similar.

Adding to your system PATH:

1. Press ⊞ Win and search for "environment variables"
2. In the new window, click "Environment Variables..."
3. In the bottom-half of the new window (labelled system variables), double-click "Path"
4. Click "New" on the right, then enter the path to your PHP folder (e.g. C:\PHP8)
5. Click "OK" until all windows are closed
6. Open command prompt (⊞ Win + R, cmd, ⏎ Enter), then run php -v to ensure you're using the correct version and PHP could be found.
   • If PHP isn't found or recognised, you might need to restart your PC for the environment variable changes to take effect.

Composer is used to install Flarum itself, so it's pretty important. You'll also use it to install extensions, too.

Follow the command-line installation instructions here: https://getcomposer.org/download/

If you want to run composer from anywhere (recommended), then you also need to move it to your bin folder:

sudo mv composer.phar /usr/local/bin/composer

You can check it installed correctly by opening a command prompt and running composer -V.

Download the latest Composer setup from the Composer website: https://getcomposer.org/Composer-Setup.exe

Run it, choose "All users", then follow the instructions. Make sure to point it to the php.exe file in your PHP install directory, and to choose to use the php.ini file it will create for you.

You can check it installed correctly by opening a command prompt and running composer -V.

You will need to set up and configure your system to work with Docker.

Follow the installation instructions on the Docker website for your Linux distro: https://docs.docker.com/engine/install/ubuntu/

Please also remember to follow the post-install instructions, otherwise you will have strange errors: https://docs.docker.com/engine/install/linux-postinstall/

Docker compose allows you to set up Docker containers from a configuration file (called a compose file).

Follow the Docker setup instructions: https://docs.docker.com/compose/install/

You only need to perform this setup on Linux and Mac. Docker Desktop comes with Compose out of the box.

To allow access to the forum from other devices on your network, or from devices outside your network if you have set up port forwarding, you need to perform a minor configuration change.

You might not need this, but if you want to test on multiple devices, it can be very helpful. You'll also need this if you install Flarum on a server via Docker to be able to access it on client devices.

Open the compose file (docker-compose.yml). Under the "PHP Apache Docker container", find the ports: entry and uncomment 80:8080, and comment 127.0.0.1:80:8080.

It should look like this:

ports:
  # - "127.0.0.1:80:8080"
  # Switch to this line if you want to access Flarum from other devices on your network
  - "80:8080"

Note: this does not expose the database and PHPMyAdmin to any other devices on your local network. You usually shouldn't do this, as if these ports are forwarded on your router, you could open yourself to security risks via people modifying your database.

If you're only using this within your local network, you can enable access to PHPMyAdmin and the MySQL server by copying the same ports syntax to those sections in the compose file.

From the root of the repository, run:

# Installs Flarum and other needed dependencies
composer update
# Builds the docker container
docker-compose build
# Runs the containers
docker-compose up

If you'd like to start the containers without having them attached to your terminal, you can run docker-compose up -d.

Note: if you see some errors similar to 'permission denied' and 'Connection aborted' on Linux, make sure Docker is started with sudo systemctl start docker.

The Flarum installation will be available at http://localhost

Default credentials:

To perform some actions, e.g. those done via the Flarum CLI, you'll need command-line access to the Flarum docker container.

This command will get you to a bash interpreter:

docker exec -it flarum-svc /bin/bash

You can then run Flarum CLI commands, as well as many others, like normal.

Tip: If you just want to clear the cache, try the clear-cache.sh helper script first. This should work on Windows, Mac and Linux.

If you've messed it all up and need to reset the Flarum database to a known good state, run the resetdb script:

./scripts/dev/resetdb.sh

Note: this requires mysql-client to be available locally. This also needs to be run in Linux using bash.

PMA can be accessed at http://localhost:8002

Default credentials:

Username: flarum Password: flarum

You can also develop on local packages using this container.

1. Create an extension from a template or clone an existing repo to the workbench folder.
2. Run composer require <vendor/package>, inserting your package name into the command
3. Enable the extension inside Flarum's admin page

You can also do this with Flarum's core by cloning the repo and running compose require flarum/core. Any packages in the workbench folder will take precedence over those downloaded by Composer from Packagist.

If you want to go back to the latest published version of an extension/package, remove it from your workbench folder, then run composer update -W <vendor/package>.

This ties in nicely with the CLI access provided by docker exec, explained above.