Skip to content

Raincal/docker-flarum-china

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code
This branch is 1 commit ahead, 117 commits behind mondediefr:master.

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 

raincal/docker-flarum-china

logo

What is this ?

Flarum is the next-generation forum software that makes online discussion fun. It's simple, fast, and free. http://flarum.org/

Features

  • Lightweight & secure image
  • Based on Alpine Linux with nginx and PHP 7
  • Latest Flarum Beta (v0.1.0-beta.7)
  • MySQL/Mariadb driver
  • OPCache extension configured

Build-time variables

  • VERSION = Version of flarum (default: v0.1.0-beta.7)

Ports

  • 8888

Volume

  • /flarum/app/assets : Flarum assets directory
  • /flarum/app/extensions : Flarum extension directory

Environment variables

Variable Description Type Default value
UID Flarum user id optional 991
GID Flarum group id optional 991
DEBUG Flarum debug mode optional false
FORUM_URL Forum URL required none
DB_HOST MariaDB instance ip/hostname optional mariadb
DB_USER MariaDB database username optional flarum
DB_NAME MariaDB database name optional flarum
DB_PASS MariaDB database password required none
DB_PREF Flarum tables prefix optional none
UPLOAD_MAX_SIZE The maximum size of an uploaded file optional 50M
MEMORY_LIMIT maximum amount of memory used by php optional 128M

Installation

1 - Pull flarum image

# Pull from hub.docker.com :
docker pull raincal/docker-flarum-china:0.1.0-beta.7-stable

# or build it manually :
docker build -t raincal/docker-flarum-china https://github.com/Raincal/docker-flarum-china.git#master

2 - Docker-compose.yml

Adapt to your needs :

flarum:
  image: raincal/docker-flarum-china:0.1.0-beta.7-stable
  container_name: flarum
  links:
    - mariadb:mariadb
  environment:
    - FORUM_URL=https://forum.domain.tld
    - DB_PASS=xxxxxxxx
  volumes:
    - /mnt/docker/flarum/assets:/flarum/app/assets
    - /mnt/docker/flarum/extensions:/flarum/app/extensions

mariadb:
  image: mariadb:10.1
  container_name: mariadb
  volumes:
    - /mnt/docker/mysql/db:/var/lib/mysql
  environment:
    - MYSQL_ROOT_PASSWORD=xxxxxxxx
    - MYSQL_DATABASE=flarum
    - MYSQL_USER=flarum
    - MYSQL_PASSWORD=xxxxxxxx

4 - Reverse proxy setup

See : https://github.com/mondediefr/flarum/wiki/Reverse-proxy-example

5 - Done, congratulation ! πŸŽ‰

You can now run Flarum :

docker-compose up -d

Upgrade from v0.1.0-beta.6

⚠️ Disable 3rd party extensions prior to upgrading.

docker pull raincal/docker-flarum-china:0.1.0-beta.7-stable && docker-compose up -d

Navigate to yourforum.com/admin, enter your database password and update.

flarum-update

Remove and restart your container :

docker-compose stop flarum
docker-compose rm flarum
docker-compose up -d

Install custom extensions

Flarum extensions list : https://packagist.org/search/?q=flarum-ext

Install an extension

docker exec -ti flarum extension require some/extension

Remove an extension

docker exec -ti flarum extension remove some/extension

List all extensions

docker exec -ti flarum extension list

Custom error pages

To use custom error pages, add your .html files in /mnt/docker/flarum/assets/errors folder :

mkdir -p /mnt/docker/flarum/assets/errors
touch 403.html 404.html 500.html 503.html
chown -R 991:991 /mnt/docker/flarum

Custom composer repositories

To use the composer repository system, add your repo name and json representation in /mnt/docker/flarum/extensions/composer.repositories.txt :

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

https://getcomposer.org/doc/03-cli.md#modifying-repositories

Screenshot

Installation

⚠️ Admin password must contain at least 8 characters.

flarum-installation

Home page

flarum-home

Packages

No packages published

Languages

  • Shell 90.2%
  • PHP 9.8%