kubile/flarum

Flarum Docker镜像文档

镜像概述和主要用途

Flarum是一款轻量级、现代化的开源论坛软件，专注于简洁的用户体验和强大的社区功能。本Docker镜像基于GitHub仓库https://github.com/mondediefr/docker-flarum%E6%9E%84%E5%BB%BA%EF%BC%8C%E6%97%A8%E5%9C%A8%E7%AE%80%E5%8C%96Flarum%E8%AE%BA%E5%9D%9B%E7%9A%84%E9%83%A8%E7%BD%B2%E5%92%8C%E8%BF%90%E8%A1%8C%E8%BF%87%E7%A8%8B%EF%BC%8C%E6%8F%90%E4%BE%9B%E4%BE%BF%E6%8D%B7%E7%9A%84%E7%8E%AF%E5%A2%83%E9%85%8D%E7%BD%AE%E3%80%81%E6%95%B0%E6%8D%AE%E6%8C%81%E4%B9%85%E5%8C%96%E5%8F%8A%E6%8F%92%E4%BB%B6%E7%AE%A1%E7%90%86%E8%83%BD%E5%8A%9B%E3%80%82

核心功能和特性

• 环境变量配置：支持通过环境变量灵活配置Flarum运行参数，包括数据库连接、管理员账户、论坛标题等
• 数据持久化：通过Docker卷挂载实现论坛资产、扩展、日志及数据库数据的持久化存储
• 依赖管理：内置MariaDB数据库支持，通过Docker Compose实现服务间依赖管理
• 插件支持：支持通过扩展列表文件自动安装常见插件，简化插件管理流程
• 便捷升级：提供安全的容器升级机制，确保数据不丢失

使用场景和适用范围

• 个人或小型社区快速部署论坛系统
• 开发者搭建Flarum测试环境
• 需要简化部署和维护流程的论坛管理员
• 希望实现数据持久化和灵活配置的Flarum用户

使用方法和配置说明

1. 准备工作目录

首先创建并切换到Flarum的工作目录，同时生成必要的配置文件：

shell
# 创建工作目录
mkdir -p /opt/flarum

# 切换工作目录
cd /opt/flarum

# 生成配置文件
touch .env flarum.env docker-compose.yaml

文件说明：

• .env：Docker Compose运行时环境变量文件
• flarum.env：Flarum容器环境变量文件
• docker-compose.yaml：Docker Compose配置文件

2. 配置文件内容

.env文件

配置Flarum的主目录路径：

shell
# Flarum主目录路径
FLARUM_HOME=/opt/flarum

flarum.env文件

配置Flarum运行参数，包括调试模式、论坛URL、数据库连接和管理员账户信息：

shell
DEBUG=true
FORUM_URL=http://localhost/

PHP_EXTENSIONS=gmp

# 数据库配置
DB_HOST=mariadb
DB_NAME=flarum
DB_USER=flarum
DB_PASS=flarum
DB_PREF=flarum_
DB_PORT=3306

# Flarum管理员账户（首次安装时使用）
# 管理员密码至少包含8个字符
FLARUM_ADMIN_USER=admin
FLARUM_ADMIN_PASS=flarum
FLARUM_ADMIN_MAIL=flarum@flarum.com
FLARUM_TITLE=Flarum

参数说明：

• DEBUG：是否启用调试模式（true/false）
• FORUM_URL：论坛访问URL
• PHP_EXTENSIONS：需要启用的PHP扩展
• DB_*：数据库连接参数（主机、名称、用户、密码、前缀、端口）
• FLARUM_ADMIN_*：管理员账户信息（用户名、密码、***）
• FLARUM_TITLE：论坛标题

docker-compose.yaml文件

定义Flarum和MariaDB服务的Docker Compose配置：

yaml
version: "3"

services:
  flarum:
    image: kubile/flarum:1.3.0
    container_name: flarum-sample
    restart: always
    env_file:
      - ./flarum.env
    volumes:
      - ${FLARUM_HOME}/volumes/assets:/flarum/app/public/assets
      - ${FLARUM_HOME}/volumes/extensions:/flarum/app/extensions
      - ${FLARUM_HOME}/volumes/storage/logs:/flarum/app/storage/logs
      - ${FLARUM_HOME}/volumes/nginx:/etc/nginx/flarum
    ports:
      - 80:8888
    depends_on:
      - mariadb
  mariadb:
    image: mariadb:10.5
    container_name: flarum-mariadb-sample
    restart: always
    environment:
      - MYSQL_ROOT_PASSWORD=flarum
      - MYSQL_DATABASE=flarum
      - MYSQL_USER=flarum
      - MYSQL_PASSWORD=flarum
    volumes:
      - ${FLARUM_HOME}/mysql/db:/var/lib/mysql

服务说明：

• flarum：Flarum服务，使用kubile/flarum:1.3.0镜像，挂载资产、扩展、日志和Nginx配置目录，映射80端口到容器8888端口
• mariadb：MariaDB数据库服务，使用10.5版本，配置数据库root密码、数据库名称及用户，挂载数据库数据目录

3. 启动容器

使用Docker Compose创建并启动服务：

shell
# 按依赖顺序启动所有服务
docker-compose up -d

# 或分步启动
docker-compose up -d mariadb
# 等待数据库创建完成后启动Flarum
docker-compose up -d flarum

4. 升级Flarum容器

仅升级容器而不主动删除挂载目录时，数据不会丢失

shell
# 停止并删除Flarum容器
docker-compose rm -sf flarum
# 重新创建Flarum容器
docker-compose up -d flarum

5. 插件安装

升级安装时可自动安装常见插件，需在本地挂载目录中创建list文件：

shell
# 在FLARUM_HOME下的扩展目录创建list文件
touch /opt/flarum/volumes/extensions/list

在list文件中列出插件名称，例如：

shell
flarum-lang/chinese-simplified
fof/upload

示例

完整示例可参考GitHub仓库：https://github.com/xs-samples/flarum-sample

官方网站

Flarum官方网站：[***]