Flarum

Flarum is a technically advanced, open and extensible discussion platform.

Demo

Implement missing demo

Options

programs.flarum

: Whether to enable flarum.

Type:

boolean

Default:

false

services.flarum

: Email for first web application administrator

Type:

string

Default:

"admin@example.com"
: Username for first web application administrator

Type:

string

Default:

"flarum"
: Change domain instead.

Type:

string

Default:

"http://localhost"
: Create the database and database user locally, and run installation.

WARNING: Due to https://github.com/flarum/framework/issues/4018, this option is set to false by default. The 'flarum install' command may delete existing database tables. Only set this to true if you are certain you are working with a fresh, empty database.

Type:

boolean

Default:

false
: MySQL database parameters

Type:

attribute set of (string or boolean or signed integer)

Default:

{ database = "flarum"; driver = "mysql"; host = "localhost"; password = ""; port = 3306; prefix = ""; strict = false; username = "flarum"; }
: Domain to serve on.

Type:

string

Default:

"localhost"
: Whether to enable Flarum discussion platform.

Type:

boolean

Default:

false
: Title of the forum.

Type:

string

Default:

"A Flarum Forum on NixOS"
: System group to run Flarum

Type:

string

Default:

"flarum"
: Initial password for the adminUser

Type:

string

Default:

"flarum"
: The flarum package to use.

Type:

package

Default:

pkgs.flarum

Notes:

Missing update script An update script is required for automatically tracking the latest release.
: Home directory for writable storage

Type:

absolute path

Default:

"/var/lib/flarum"
: System user to run Flarum

Type:

string

Default:

"flarum"

Examples

basic

{ ... }:
{
  services.flarum.enable = true;
}

This project is funded by NLnet through these subgrants:

Flarum