github.com/tiredofit/docker-flarum

About

This will build a Docker Image for Flarum. A web based discussion forum. It will:

• Supports Data Persistence
• Automatically detect new version of Image/Flarum and upgrade it

Maintainer

• Dave Conroy

Table of Contents

• About
• Maintainer
• Table of Contents
• Prerequisites and Assumptions
• Installation
  • Build from Source
  • Prebuilt Images
  • Multi Architecture
• Configuration
  • Quick Start
  • Persistent Storage
  • Environment Variables
  • Base Images used
• Maintenance
  • Shell Access
  • Installing Plugins and Extensions
• Support
  • Usage
  • Bugfixes
  • Feature Requests
  • Updates
• License
• Maintenance
  • Shell Access
• References

Prerequisites and Assumptions

• Assumes you are using some sort of SSL terminating reverse proxy such as:
  • Traefik
  • Nginx
  • Caddy

Installation

Build from Source

Clone this repository and build the image with docker build <arguments> (imagename) .

Prebuilt Images

Builds of the image are available on Docker Hub and is the recommended method of installation.

docker pull tiredofit/flarum:(imagetag)

The following image tags are available along with their tagged release based on what's written in the Changelog:

Multi Architecture

Images are built primarily for amd64 architecture, and may also include builds for arm/v7, arm64 and others. These variants are all unsupported. Consider sponsoring my work so that I can work with various hardware. To see if this image supports multiple architecures, type docker manifest (image):(tag)

Configuration

Quick Start

• The quickest way to get started is using docker-compose. See the examples folder for a working docker-compose.yml that can be modified for development or production use.

• Set various environment variables to understand the capabilities of this image.

• Map persistent storage for access to configuration and data files for backup.

Persistent Storage

The following directories are used for configuration and can be mapped for persistent storage.

Environment Variables

Base Images used

This image relies on an Alpine Linux base image that relies on an init system for added capabilities. Outgoing SMTP capabilities are handlded via msmtp. Individual container performance monitoring is performed by zabbix-agent. Additional tools include: bash,curl,less,logrotate,nano,vim.

Be sure to view the following repositories to understand all the customizable options:

Maintenance

Shell Access

For debugging and maintenance purposes you may want access the containers shell.

docker exec -it (whatever your container name is) bash

Installing Plugins and Extensions

• Make a file in your /data/extensions folder called install and place on each line the Github Repositories name. Upon startup, the container will fetch the source code via composer, save a cache of the install, and then install. Upon further restarts of the container, the image will check to see if there are any updates to the extension, and will proceed with upgrading to the latest.

Example:

[/data/flarum] 1 $ cd data
[/data/flarum/data] $ ls
assets  composer.json  extensions  storage
[/data/flarum/data] $ cd extensions/
[/data/flarum/data/extensions] $ ls
list
[/data/flarum/data/extensions] $ cat list
flagrow/upload
michaelbelgium/flarum-discussion-views
[/data/flarum/data/extensions] $

Alternatively, if you wish to install an extension while the container is running without restarting, you can use the tool located in /usr/sbin/extension-tool

Syntax is as follows:

Usage:
  extension-tool {install|remove|update} {packagename}
  extension-tool {install|remove|update} {packagename} --debug
  extension-tool -h|--help

For example, if you wished to install fof/drafts then here is a command to do it from your host:

docker exec -it (yourcontainername) extension-tool install fof/drafts

The rest of the options are self explanatory.

Support

These images were built to serve a specific need in a production environment and gradually have had more functionality added based on requests from the community.

Usage

• The Discussions board is a great place for working with the community on tips and tricks of using this image.
• Consider sponsoring me personalized support.

  Bugfixes

• Please, submit a Bug Report if something isn't working as expected. I'll do my best to issue a fix in short order.

Feature Requests

• Feel free to submit a feature request, however there is no guarantee that it will be added, or at what timeline.
• Consider sponsoring me regarding development of features.

Updates

• Best effort to track upstream changes, More priority if I am actively using the image in a production environment.
• Consider sponsoring me for up to date releases.

License

MIT. See LICENSE for more details.

Maintenance

Shell Access

For debugging and maintenance purposes you may want access the containers shell.

docker exec -it (whatever your container name is e.g. flarum) bash

References

• https://www.flarum.org