flarum, nixos/flarum: init at 0.1.0-beta.13 #96869

astro · 2020-08-31T20:10:20Z

Motivation for this change

Adds Flarum discussion platform web application. Includes NixOS module.

The dependencies subpackage is output from composer2nix.

Things done

aanderse

A couple discussion points on the module. I haven't reviewed the package.

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

aanderse · 2020-09-01T02:19:09Z

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

+        description = "Domain to serve on.";
+      };
+
+      installPath = mkOption {


What is this needed for? It looks like the software is packaged so you don't need to install (already in /nix/store).

Unfortunately, the software needs to reside in a writable file system location.

All of the software, or just the storage/ folder and config.php?

After reviewing upstream documentation and code I think you can patch this to work with the nix store. Comments in source code even mention this. See here and here.

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

aanderse · 2020-09-01T02:22:57Z

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

+      serviceConfig = {
+        Type = "oneshot";
+      };
+      script = with cfg; ''


It might be worth replacing this with systemd.tmpfiles.rules.

The installPath will contain state: config.php, storage/. The software checks for writeability of these paths.

@astro can this be resolved after doing #96869 (comment) ?

astro · 2020-11-29T20:17:30Z

This PR has been improved to run the installer fully automatic. Rebased.

aanderse · 2021-01-28T03:05:29Z

@astro if you're still interested in working in this and need and help just ping.

sbourdeauducq · 2021-03-04T14:17:31Z

@astro what is the status of this?

astro · 2021-03-16T13:26:08Z

@aanderse Ping. I could definitively use a hand with leaving more files in the nix store.

aanderse · 2021-03-18T00:30:15Z

@astro - see https://github.com/aanderse/nixpkgs/blob/48c8f0302af71c4db7f271bfe51bb157ed4b2831/nixos/modules/services/web-apps/flarum.nix for my take on the module.

A few notes:

unfortunately a few immutable files need to remain in mutable paths¹, via symlink: ${cfg.stateDir}/public/index.php, ${cfg.stateDir}/public/.htaccess (though not really, this is a httpd specific file), ${cfg.stateDir}/flarum, and ${cfg.stateDir}/site.php
i removed "misleading" options - options which have no impact after the initial install of the application - replacing them with a single installConfig option (which could use a more descriptive name possibly) because if a sysadmin ever changed the value of database, forumTitle, or baseUrl they might get confused why there was no change (and in the case of database why their web application suddenly doesn't work)
i used systemd.tmpfiles.rules to provision directories and symlink required files into place which has a few benefits over the way it was
i don't do nginx and the config you had didn't immediately work with the changes i had so i switched to httpd to make it easier on me (you should switch back to nginx asap)
i added a flarum command to the systemPackages which wraps the flarum commend so a sysadmin can type flarum migrate or flarum cache:clear after packages updates
maybe some more...?

There is definitely some room for improvement:

maybe we want to consider running migrations automatically, maybe we don't... if we do then a separate flarum-update.service would be a good idea
it would be nice if we could add more options to database that actually did something if the sysadmin ever changed them - i have some ideas on how to achieve this, but maybe that is for a future PR
the installConfig option should probably be renamed and it requires a better description
- it is "nice" in that it the default value will get you an instance of flarum up and running quickly, but it also hardcodes the default admin password to a known value in the nix store so a big warning of "change the password immediately" is important (maybe even important enough to add to the .enable description... "Whether to enable the Flarum discussion platform and configure a default admin account with username 'admin' and password 'blah' which you should immediately change", etc...)

Questions? Comments? Love it? Hate it? Let me know. I hope this has helped.

well not really "need to"... but it wouldn't be worth the hassle, they're small files anyways 🤷‍♂️

aanderse · 2021-05-12T12:31:24Z

ping @astro

astro · 2021-05-19T01:16:08Z

Awesome! Finally someone who is savvy with all that PHP stuff. :-)

Do you mind proposing your own PR, take all the credits, and we close this one?

Cc: @sbourdeauducq

aanderse · 2021-05-19T02:03:16Z

Well... I'm not familiar with this software, I don't have any interest in running this software, and I don't want to maintain this module in NixOS... I was just trying to help out 🤷‍♂️

stale · 2021-11-16T12:20:51Z

I marked this as stale due to inactivity. → More info

copy installPhase build script from closed PR NixOS/nixpkgs#96869 fix typo

ofborg bot added 6.topic: nixos 8.has: module (update) labels Aug 31, 2020

aanderse requested changes Sep 1, 2020

View reviewed changes

astro force-pushed the flarum branch from da64330 to 0b0c46d Compare September 2, 2020 18:23

astro force-pushed the flarum branch 2 times, most recently from ae48754 to 2718b9c Compare November 29, 2020 20:16

ofborg bot added 10.rebuild-darwin: 0 10.rebuild-linux: 1-10 10.rebuild-linux: 1 labels Nov 29, 2020

flarum, nixos/flarum: init at 0.1.0-beta.13

9e4055d

astro force-pushed the flarum branch from 2718b9c to 9e4055d Compare November 30, 2020 18:27

SuperSandro2000 added the 2.status: merge conflict label Jan 18, 2021

sbourdeauducq requested a review from svanderburg January 28, 2021 02:34

stale bot added the 2.status: stale https://github.com/NixOS/nixpkgs/blob/master/.github/STALE-BOT.md label Nov 16, 2021

astro closed this Jul 11, 2022

albertchae added a commit to ngi-nix/ngipkgs that referenced this pull request Jul 25, 2023

Use albertchae/flarum fork which has composer.lock committed

dc7176e

copy installPhase build script from closed PR NixOS/nixpkgs#96869 fix typo

albertchae mentioned this pull request Jul 25, 2023

Flarum ngi-nix/ngipkgs#10

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

flarum, nixos/flarum: init at 0.1.0-beta.13 #96869

flarum, nixos/flarum: init at 0.1.0-beta.13 #96869

astro commented Aug 31, 2020

aanderse left a comment

aanderse Sep 1, 2020

astro Sep 2, 2020

aanderse Sep 3, 2020

aanderse Sep 3, 2020

aanderse Sep 1, 2020

astro Sep 2, 2020

sbourdeauducq Jan 28, 2021

astro commented Nov 29, 2020

aanderse commented Jan 28, 2021

sbourdeauducq commented Mar 4, 2021

astro commented Mar 16, 2021

aanderse commented Mar 18, 2021

aanderse commented May 12, 2021

astro commented May 19, 2021

aanderse commented May 19, 2021

stale bot commented Nov 16, 2021

flarum, nixos/flarum: init at 0.1.0-beta.13 #96869

flarum, nixos/flarum: init at 0.1.0-beta.13 #96869

Conversation

astro commented Aug 31, 2020

Motivation for this change

Things done

aanderse left a comment

Choose a reason for hiding this comment

aanderse Sep 1, 2020

Choose a reason for hiding this comment

astro Sep 2, 2020

Choose a reason for hiding this comment

aanderse Sep 3, 2020

Choose a reason for hiding this comment

aanderse Sep 3, 2020

Choose a reason for hiding this comment

aanderse Sep 1, 2020

Choose a reason for hiding this comment

astro Sep 2, 2020

Choose a reason for hiding this comment

sbourdeauducq Jan 28, 2021

Choose a reason for hiding this comment

astro commented Nov 29, 2020

aanderse commented Jan 28, 2021

sbourdeauducq commented Mar 4, 2021

astro commented Mar 16, 2021

aanderse commented Mar 18, 2021

aanderse commented May 12, 2021

astro commented May 19, 2021

aanderse commented May 19, 2021

stale bot commented Nov 16, 2021