pkgs/servers/mjolnir/default.nix

   1 { lib
   2 , mkYarnPackage
   3 , fetchFromGitHub
   4 , fetchYarnDeps
   5 , matrix-sdk-crypto-nodejs
   6 , makeWrapper
   7 , nodejs
   8 , nixosTests
   9 }:
  10
  11 mkYarnPackage rec {
  12   pname = "mjolnir";
  13   version = "1.8.3";
  14
  15   src = fetchFromGitHub {
  16     owner = "matrix-org";
  17     repo = "mjolnir";
  18     rev = "refs/tags/v${version}";
  19     hash = "sha256-yD7QGsS2Em8Z95po9pGRUDmHgHe4z0j0Jnvy3IG7xKY=";
  20   };
  21
  22   patches = [
  23     # TODO: Fix tfjs-node dependency
  24     ./001-disable-nsfwprotection.patch
  25   ];
  26
  27   packageJSON = ./package.json;
  28
  29   offlineCache = fetchYarnDeps {
  30     yarnLock = src + "/yarn.lock";
  31     hash = "sha256-05DqddK8+136Qq/JGeiITZkVJ8Dw9K9HfACKW86989U=";
  32   };
  33
  34   packageResolutions = {
  35     "@matrix-org/matrix-sdk-crypto-nodejs" = "${matrix-sdk-crypto-nodejs}/lib/node_modules/@matrix-org/matrix-sdk-crypto-nodejs";
  36   };
  37
  38   nativeBuildInputs = [ makeWrapper ];
  39
  40   buildPhase = ''
  41     runHook preBuild
  42
  43     pushd deps/${pname}
  44     yarn run build
  45     popd
  46
  47     runHook postBuild
  48   '';
  49
  50   postInstall = ''
  51     makeWrapper ${nodejs}/bin/node "$out/bin/mjolnir" \
  52       --add-flags "$out/libexec/mjolnir/deps/mjolnir/lib/index.js"
  53   '';
  54
  55   passthru = {
  56     tests = {
  57       inherit (nixosTests) mjolnir;
  58     };
  59   };
  60
  61   meta = with lib; {
  62     description = "Moderation tool for Matrix";
  63     homepage = "https://github.com/matrix-org/mjolnir";
  64     longDescription = ''
  65       As an all-in-one moderation tool, it can protect your server from
  66       malicious invites, spam messages, and whatever else you don't want.
  67       In addition to server-level protection, Mjolnir is great for communities
  68       wanting to protect their rooms without having to use their personal
  69       accounts for moderation.
  70
  71       The bot by default includes support for bans, redactions, anti-spam,
  72       server ACLs, room directory changes, room alias transfers, account
  73       deactivation, room shutdown, and more.
  74
  75       A Synapse module is also available to apply the same rulesets the bot
  76       uses across an entire homeserver.
  77     '';
  78     license = licenses.asl20;
  79     maintainers = with maintainers; [ jojosch ];
  80     mainProgram = "mjolnir";
  81   };
  82 }