Configuration File

There is only one place where Flarum configuration cannot be modified through the Flarum admin dashboard (excluding the database), and that is the config.php file located in the root of your Flarum installation.

This file, though small, contains details that are crucial for your Flarum installation to work.

If the file exists, it tells Flarum that it has already been installed. It also provides Flarum with database info and more.

Here's a quick overview of what everything means with an example file:

<?php return array (
  'debug' => false, // enables or disables debug mode, used to troubleshoot issues
  'offline' => false, // none, high, low or safe.
  'database' =>
  array (
    'driver' => 'mysql', // the database driver, i.e. MySQL, MariaDB, PostgreSQL, SQLite
    'host' => 'localhost', // the host of the connection, localhost in most cases unless using an external service
    'database' => 'flarum', // the name of the database in the instance
    'username' => 'root', // database username
    'password' => '', // database password
    'charset' => 'utf8mb4',
    'collation' => 'utf8mb4_unicode_ci',
    'prefix' => '', // the prefix for the tables, useful if you are sharing the same database with another service
    'port' => '3306', // the port of the connection, defaults to 3306 with MySQL
    'strict' => false,
  ),
  'url' => 'https://flarum.localhost', // the URL installation, you will want to change this if you change domains
  'paths' =>
  array (
    'api' => 'api', // /api goes to the API
    'admin' => 'admin', // /admin goes to the admin
  ),
  'queue' =>
  array (
    'driver' => 'sync', // Use the standard sync queue. Omitting this will entirely will have the same effect
  ),
  'fontawesome' =>
  array (
    'source' => 'local', // Use the bundled FontAwesome Free v6 icons. See below for other config options
  )
);

Configuration via environment variables

Whilst the file based method described here is suitable for most Flarum installations, scaled Flarum instances or those deployed via CI/CD will probably benefit from being configured via the environment. Here's an example of how to do this:

<?php return array (
  'debug' => env('DEBUG')
  ...
);

This provides Flarum with the static configuration file it expects, but pulls variables from the environment at runtime.

Queues

Flarum ships with support for two queue types - sync and database. Many tasks, or 'jobs' can be offloaded to a seperate process in order to improve response times and provide a better user experience.

• sync - default behaviour
• database - stores jobs in a dedicated database table, which are then processed via the scheduler in a seperate process. It is strongly advised that the scheduler is configured to run every minute

When the database queue is active, additional configuration options are available under advanced settings.

Other queue processors

At this point in time, use of other schedulers is supported, but configuration via config.php is not required. Example FoF Horizon or Redis Queues.

Maintenance modes

Flarum has a maintenance mode that can be enabled by setting the offline key in the config.php file to one of the following values:

• none - No maintenance mode.
• high - No one can access the forum, not even admins.
• low - Only admins can access the forum.
• safe - Only admins can access the forum, and no extensions are booted.

This can also be configured from the admin panel's advanced settings page:

FontAwesome

By default Flarum uses the bundled FontAwesome 'Free' v6 icons. These can be switched out to use either a CDN hosted icon bundle, or a custom kit.

<?php

return [
    'url' => 'https://example.com',
    // ... other config
    
    // FontAwesome Kit (Pro features + custom icons)
    'fontawesome' => [
        'source' => 'kit',
        'kit_url' => 'https://kit.fontawesome.com/YOUR_KIT_CODE.js',
    ],
    
    // OR use a CDN
    // 'fontawesome' => [
    //     'source' => 'cdn',
    //     'cdn_url' => 'https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.5.2/css/all.min.css',
    // ],
    
    // OR keep local (default, no config needed)
    // 'fontawesome' => [
    //     'source' => 'local',
    // ],
];