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