Flarum

programs.flarum.enable

Whether to enable flarum.

Type:

boolean

Default:

false

Declared in:

projects/Flarum/module.nix

services.flarum.adminEmail

Email for first web application administrator

Type:

string

Default:

"admin@example.com"

Declared in:

nixos/modules/services/web-apps/flarum.nix

services.flarum.adminUser

Username for first web application administrator

Type:

string

Default:

"flarum"

Declared in:

nixos/modules/services/web-apps/flarum.nix

services.flarum.baseUrl

Change domain instead.

Type:

string

Default:

"http://localhost"

Declared in:

nixos/modules/services/web-apps/flarum.nix

services.flarum.createDatabaseLocally

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

Declared in:

nixos/modules/services/web-apps/flarum.nix

services.flarum.database

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"; }

Declared in:

nixos/modules/services/web-apps/flarum.nix

services.flarum.domain

Domain to serve on.

Type:

string

Default:

"localhost"

Declared in:

nixos/modules/services/web-apps/flarum.nix

services.flarum.enable

Whether to enable Flarum discussion platform.

Type:

boolean

Default:

false

Declared in:

nixos/modules/services/web-apps/flarum.nix

services.flarum.forumTitle

Title of the forum.

Type:

string

Default:

"A Flarum Forum on NixOS"

Declared in:

nixos/modules/services/web-apps/flarum.nix

services.flarum.group

System group to run Flarum

Type:

string

Default:

"flarum"

Declared in:

nixos/modules/services/web-apps/flarum.nix

services.flarum.initialAdminPassword

Initial password for the adminUser

Type:

string

Default:

"flarum"

Declared in:

nixos/modules/services/web-apps/flarum.nix

services.flarum.package

The flarum package to use.

Type:

package

Default:

pkgs.flarum

Declared in:

nixos/modules/services/web-apps/flarum.nix

Notes:

Missing update script An update script is required for automatically tracking the latest release.

services.flarum.stateDir

Home directory for writable storage

Type:

absolute path

Default:

"/var/lib/flarum"

Declared in:

nixos/modules/services/web-apps/flarum.nix

services.flarum.user

System user to run Flarum

Type:

string

Default:

"flarum"

Declared in:

nixos/modules/services/web-apps/flarum.nix

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

Declared in: projects/Flarum/services-example.nix