jeromegillard/flarum

jeromegillard/flarum

https://img.shields.io/github/v/release/JeromeGillard/docker-flarum](https://github.com/JeromeGillard/docker-flarum/releases) https://img.shields.io/docker/pulls/jeromegillard/flarum](https://hub.docker.com/r/jeromegillard/flarum) https://img.shields.io/docker/stars/jeromegillard/flarum](https://hub.docker.com/r/jeromegillard/flarum)

镜像概述和主要用途

该Docker镜像提供了一个预配置的Flarum论坛系统环境，基于轻量级的Alpine Linux 3.16，集成nginx作为Web服务器和PHP 8.0运行环境，支持最新的Flarum Framework v1.8.4。适用于需要快速部署、安全稳定的论坛平台场景，支持通过环境变量和卷挂载进行灵活配置。

核心功能和特性

• 轻量级与安全性：基于Alpine Linux构建，镜像体积小且安全
• 环境配置：集成nginx Web服务器和PHP 8.0运行环境
• 最新框架：包含最新版Flarum Framework (v1.8.4)
• 数据库支持：原生支持MySQL/MariaDB数据库驱动
• 性能优化：已配置OPCache扩展提升PHP性能
• 灵活定制：支持通过环境变量、卷挂载和自定义扩展进行功能扩展

构建时变量

• VERSION：Flarum框架版本（默认值：v1.8.4，对应https://github.com/flarum/flarum%E9%A1%B9%E7%9B%AE%EF%BC%89

端口

• 默认端口：8888（可通过环境变量配置）

卷挂载

• /flarum/app/extensions：Flarum扩展目录
• /flarum/app/public/assets：Flarum资源文件目录
• /flarum/app/storage/logs：Flarum日志目录
• /etc/nginx/flarum：Nginx配置目录

环境变量

首次安装必填环境变量

使用方法和配置说明

1. 拉取镜像

bash
# 从Docker Hub拉取
docker pull jeromegillard/flarum:latest

# 或手动构建
docker build -t jeromegillard/flarum:latest https://github.com/jeromegillard/docker-flarum.git

# 或构建多架构镜像并推送到DockerHub（需buildx支持）
docker buildx build --push --platform linux/amd64,linux/arm64,linux/arm/v7 --tag jeromegillard/flarum:latest --tag jeromegillard/flarum:1.8.4 --tag jeromegillard/flarum:1.8 https://github.com/jeromegillard/docker-flarum.git

2. Docker Compose配置

yaml
version: "3"

services:
  flarum:
    image: jeromegillard/flarum:latest
    container_name: flarum
    env_file:
      - /mnt/docker/flarum/flarum.env  # 环境变量文件路径
    volumes:
      - /mnt/docker/flarum/assets:/flarum/app/public/assets  # 资源文件挂载
      - /mnt/docker/flarum/extensions:/flarum/app/extensions  # 扩展目录挂载
      - /mnt/docker/flarum/storage/logs:/flarum/app/storage/logs  # 日志目录挂载
      - /mnt/docker/flarum/nginx:/etc/nginx/flarum  # Nginx配置挂载
    ports:
      - 80:8888  # 端口映射（主机端口:容器端口）
    depends_on:
      mariadb:
        condition: service_healthy  # 依赖MariaDB健康检查通过

  mariadb:
    image: mariadb:10.5  # MariaDB数据库镜像
    container_name: mariadb
    environment:
      - MYSQL_ROOT_PASSWORD=xxxxxxxxxx  # 数据库root密码
      - MYSQL_DATABASE=flarum  # 数据库名
      - MYSQL_USER=flarum  # 数据库用户名
      - MYSQL_PASSWORD=xxxxxxxxxx  # 数据库用户密码
    volumes:
      - /mnt/docker/mysql/db:/var/lib/mysql  # 数据库数据持久化
    healthcheck:
      test: ["CMD-SHELL", "mysql -u $MYSQL_USER -p$MYSQL_PASSWORD -e 'SELECT 1;'"]
      start_period: 10s
      interval: 2s
      timeout: 5s
      retries: 20

3. 运行容器

创建环境变量文件

bash
vi /mnt/docker/flarum/flarum.env

文件内容示例：

DEBUG=false
FORUM_URL=http://domain.tld  # 论坛访问URL

# 数据库配置
DB_HOST=mariadb
DB_NAME=flarum
DB_USER=flarum
DB_PASS=xxxxxxxxxx  # 数据库密码（与MariaDB配置一致）
DB_PREF=flarum_  # 表前缀（可选）
DB_PORT=3306

# 管理员信息（首次安装必填）
# /!\ 管理员密码必须至少包含8个字符 /!\
FLARUM_ADMIN_USER=admin  # 管理员用户名
FLARUM_ADMIN_PASS=xxxxxxxxxx  # 管理员密码
FLARUM_ADMIN_MAIL=admin@domain.tld  # 管理员邮箱
FLARUM_TITLE=Test flarum  # 论坛名称（可选）

启动服务

bash
docker compose up -d

注意：管理员密码（FLARUM_ADMIN_PASS）必须至少包含8个字符。如遇到500错误并显示"Something went wrong"，可将DEBUG环境变量设为true查看详细错误信息。

!flarum-home

安装额外PHP扩展

通过PHP_EXTENSIONS环境变量指定需要安装的扩展，多个扩展用空格分隔：

yaml
version: "3"

services:
  flarum:
    image: jeromegillard/flarum:latest
    container_name: flarum
    environment:
      - PHP_EXTENSIONS=gmp session brotli  # 安装php8-gmp、php8-session、php8-brotli
    volumes:
      - /mnt/docker/flarum/assets:/flarum/app/public/assets
      - /mnt/docker/flarum/extensions:/flarum/app/extensions
      - /mnt/docker/flarum/storage/logs:/flarum/app/storage/logs
      - /mnt/docker/flarum/nginx:/etc/nginx/flarum

可在https://pkgs.alpinelinux.org/packages?name=php8-*&branch=v3.13&arch=x86_64%E6%9F%A5%E8%AF%A2%E5%8F%AF%E7%94%A8%E7%9A%84PHP%E6%89%A9%E5%B1%95%E3%80%82

管理Flarum扩展

Flarum扩展列表可参考：Extiverse

安装扩展

bash
docker exec -ti flarum extension require some/extension

移除扩展

bash
docker exec -ti flarum extension remove some/extension

列出所有扩展

bash
docker exec -ti flarum extension list

自定义Nginx虚拟主机配置

通过挂载/etc/nginx/flarum卷，可自定义Nginx配置。在宿主机创建配置文件/mnt/docker/flarum/nginx/custom-vhost-flarum.conf，示例：

nginx
# 自定义Flarum Nginx配置示例
# 修复fof/sitemap扩展的Nginx问题（https://github.com/FriendsOfFlarum/sitemap）

location = /sitemap.xml {
  try_files $uri $uri/ /index.php?$query_string;
}

自定义Composer仓库

在宿主机/mnt/docker/flarum/extensions/composer.repositories.txt文件中添加仓库配置，格式为仓库名称|JSON配置：

my_private_repo|{"type":"path","url":"extensions/*/"}
my_public_repo|{"type":"vcs","url":"https://github.com/my/repo"}

私有GitHub仓库示例：

1. 在composer.repositories.txt添加：

username|{"type":"vcs","url":"https://github.com/username/my-private-repo"}

2. 在GitHub创建具有私有仓库访问权限的令牌：https://github.com/settings/tokens

3. 在环境变量中添加令牌：

GITHUB_TOKEN_AUTH=XXXXXXXXXXXXXXX

4. 在/mnt/docker/flarum/extensions/list文件中添加扩展：

username/my-private-repo:0.1.0

更多Composer仓库配置参考：https://getcomposer.org/doc/03-cli.md#modifying-repositories

升级指南

升级容器的详细说明请参考：https://github.com/jeromegillard/docker-flarum/blob/master/UPGRADE.md

许可证

Docker镜像https://hub.docker.com/r/jeromegillard/flarum%E5%9F%BA%E4%BA%8Ehttps://github.com/jeromegillard/docker-flarum/blob/master/LICENSE%E5%8F%91%E5%B8%83%E3%80%82

Docker镜像https://hub.docker.com/r/mondedie/flarum%E5%9F%BA%E4%BA%8Ehttps://github.com/jeromegillard/docker-flarum/blob/master/LICENSE%E5%8F%91%E5%B8%83%E3%80%82

内置的https://github.com/flarum/%E5%9F%BA%E4%BA%8Ehttps://github.com/flarum/flarum/blob/master/LICENSE%E5%8F%91%E5%B8%83%E3%80%82