[WIP] Mob moss work on packaging flarum

all-packages.nix

@@ -1,10 +1,11 @@
 { newScope, ... }:
 let
   self = rec {
-    libgnunetchat = callPackage ./pkgs/libgnunetchat { };
+    flarum = callPackage ./pkgs/flarum { };
     gnunet-messenger-cli = callPackage ./pkgs/gnunet-messenger-cli { };
     liberaforms = callPackage ./pkgs/liberaforms { };
     liberaforms-env = callPackage ./pkgs/liberaforms/env.nix { };
+    libgnunetchat = callPackage ./pkgs/libgnunetchat { };
   };
 
   callPackage = newScope self;

modules/all-modules.nix

@@ -1,3 +1,4 @@
 {
   liberaforms = import ./liberaforms.nix;
+  flarum = import ./flarum.nix;
 }

modules/flarum.nix

@@ -0,0 +1,193 @@
+{ config, lib, pkgs, utils, ... }:
+
+let
+  inherit (lib) concatStrings literalExample mapAttrs mkDefault mkEnableOption mkIf mkOption types;
+  inherit (pkgs) writeText;
+
+  cfg = config.services.flarum;
+
+  flarumInstallConfig =
+    writeText "config.yml" (builtins.toJSON {
+      debug = false;
+      baseUrl = cfg.baseUrl;
+      databaseConfiguration = cfg.database;
+      adminUser = {
+        username = cfg.adminUser;
+        password = cfg.initialAdminPassword;
+      };
+      settings = {
+        forum_title = cfg.forumTitle;
+      };
+    });
+in {
+  options = {
+    services.flarum = {
+      enable = mkEnableOption "Flarum discussion platform";
+
+      forumTitle = mkOption {
+        type = types.str;
+        default = "A Flarum Forum on NixOS";
+        description = "Title of the forum.";
+      };
+
+      domain = mkOption {
+        type = types.str;
+        default = "localhost";
+        example = "forum.example.com";
+        description = "Domain to serve on.";
+      };
+
+      baseUrl = mkOption {
+        type = types.str;
+        default = "https://${cfg.domain}";
+        example = "https://forum.example.com";
+        description = "Change `domain` instead.";
+      };
+
+      adminUser = mkOption {
+        type = types.str;
+        default = "flarum";
+        description = "Username for first web application administrator";
+      };
+
+      initialAdminPassword = mkOption {
+        type = types.str;
+        default = "flarum";
+        description = "Initial password for the adminUser";
+      };
+
+      user = mkOption {
+        type = types.str;
+        default = "flarum";
+        description = "System user to run Flarum";
+      };
+
+      group = mkOption {
+        type = types.str;
+        default = "flarum";
+        description = "System group to run Flarum";
+      };
+
+      stateDir = mkOption {
+        type = types.path;
+        default = "/var/lib/flarum";
+        description = "Home directory for writable storage";
+      };
+
+      database = mkOption rec {
+        type = with types; attrsOf (oneOf [str bool int]);
+        description = "MySQL database parameters";
+        default = {
+          # the database driver; i.e. MySQL; MariaDB...
+          driver = "mysql";
+          # the host of the connection; localhost in most cases unless using an external service
+          host = "localhost";
+           # the name of the database in the instance
+          database = "flarum";
+          # database username
+          username = "flarum";
+          # database password
+          password = "";
+          # the prefix for the tables; useful if you are sharing the same database with another service
+          prefix = "";
+          # the port of the connection; defaults to 3306 with MySQL
+          port = 3306;
+          strict = false;
+        };
+      };
+
+      createDatabaseLocally = mkOption {
+        type = types.bool;
+        default = true;
+        description = "Create the database and database user locally, and run installation.";
+      };
+    };
+  };
+
+  config = mkIf cfg.enable {
+    users.users.${cfg.user} = {
+      isSystemUser = true;
+      home = cfg.stateDir;
+      createHome = true;
+      group = cfg.group;
+    };
+    users.groups.${cfg.group} = {};
+
+    services.phpfpm.pools.flarum = {
+      user = cfg.user;
+      settings = {
+        "listen.owner" = config.services.nginx.user;
+        "listen.group" = config.services.nginx.group;
+        "listen.mode" = "0600";
+        "pm" = mkDefault "dynamic";
+        "pm.max_children" = mkDefault 10;
+        "pm.max_requests" = mkDefault 500;
+        "pm.start_servers" = mkDefault 2;
+        "pm.min_spare_servers" = mkDefault 1;
+        "pm.max_spare_servers" = mkDefault 3;
+      };
+    };
+
+    services.nginx = {
+      enable = true;
+      virtualHosts."${cfg.domain}" = {
+        root = "${cfg.stateDir}/public";
+        locations."~ \.php$".extraConfig =
+          ''
+          fastcgi_pass unix:${config.services.phpfpm.pools.flarum.socket};
+          fastcgi_index site.php;
+          '';
+        extraConfig =
+          ''
+          index index.php;
+          include ${pkgs.flarum.src}/.nginx.conf;
+          '';
+      };
+    };
+
+    services.mysql = mkIf cfg.enable {
+      enable = true;
+      ensureDatabases = [ cfg.database.database ];
+      ensureUsers = [ {
+        name = cfg.database.username;
+        ensurePermissions = {
+          "${cfg.database.database}.*" = "ALL PRIVILEGES";
+        };
+      } ];
+    };
+
+    assertions = [ {
+      assertion = !cfg.createDatabaseLocally || cfg.database.driver == "mysql";
+      message = "Flarum can only be automatically installed in MySQL/MariaDB.";
+    } ];
+
+    systemd.services.flarum-install = {
+      description = "Flarum installation";
+      after = [ "mysql.service" ];
+      requires = [ "mysql.service" ];
+      before = [ "nginx.service" "phpfm-flarum.service" ];
+      wantedBy = [ "phpfpm-flarum.service" ];
+      serviceConfig = {
+        Type = "oneshot";
+        User = cfg.user;
+        Group = cfg.group;
+      };
+      path = [ config.services.phpfpm.phpPackage ];
+      script = ''
+        mkdir -p ${cfg.stateDir}/{extensions,public/assets/avatars}
+        mkdir -p ${cfg.stateDir}/storage/{formatter,sessions,views}
+        cd ${cfg.stateDir}
+        cp -f ${pkgs.flarum.src}/{extend.php,site.php,flarum} .
+        ln -sf ${pkgs.flarum.dependencies}/vendor .
+        ln -sf ${pkgs.flarum.src}/public/index.php public/
+        chmod a+x . public
+      '' + lib.optionalString (cfg.createDatabaseLocally && cfg.database.driver == "mysql") ''
+        if [ ! -f config.php ]; then
+           php flarum install --file=${flarumInstallConfig}
+        fi
+        php flarum migrate
+        php flarum cache:clear
+      '';
+    };
+  };
+}