Add mjolnir support (#30)

.gitignore

@@ -161,3 +161,4 @@ cython_debug/
 # Juju and Rock files
 *.charm
 */*.rock
+*/*.snap

.licenserc.yaml

@@ -34,4 +34,5 @@ header:
     - 'trivy.yaml'
     - 'zap_rules.tsv'
     - 'lib/**'
+    - 'templates/**'
   comment: on-failure

CONTRIBUTING.md

@@ -30,4 +30,11 @@ Build the charm in this git repository using:
 charmcraft pack
 ```
 
-<!-- You may want to include any contribution/style guidelines in this document>
+## Generating src docs for every commit
+
+Run the following command:
+
+```bash
+echo -e "tox -e src-docs\ngit add src-docs\n" > .git/hooks/pre-commit
+chmod +x .git/hooks/pre-commit
+```

config.yaml

@@ -17,5 +17,11 @@ options:
     type: string
     description: |
       The public-facing base URL that clients use to access this Homeserver.
-      It's used as entity_id if set instead of https://server_name. Only used if
-      there is integration with SAML integrator charm.
+      Defaults to https://<server_name>/. Only used if there is integration with
+      SAML integrator charm.
+  enable_mjolnir:
+    type: boolean
+    default: false
+    description: |
+      Configures whether to enable Mjolnir - moderation tool for Matrix.
+      Reference: https://github.com/matrix-org/mjolnir

generate-src-docs.sh

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+
+# Copyright 2023 Canonical Ltd.
+# See LICENSE file for licensing details.
+
+lazydocs --no-watermark --output-path src-docs src/*

metadata.yaml

@@ -61,3 +61,7 @@ requires:
         interface: saml
         limit: 1
         optional: true
+
+peers:
+  synapse-peers:
+    interface: synapse-instance

mjolnir_snap/snapcraft.yaml

@@ -0,0 +1,37 @@
+# Copyright 2023 Canonical Ltd.
+# See LICENSE file for licensing details.
+
+name: mjolnir
+summary: Mjolnir snap
+description: A moderation tool for Matrix
+version: "1.6.4"
+base: core22
+license: Apache-2.0
+confinement: strict
+apps:
+  mjolnir:
+    command: "bin/node $SNAP/mjolnir/index.js"
+    plugs:
+      - network
+parts:
+    node:
+        plugin: dump
+        source: https://nodejs.org/dist/v16.20.2/node-v16.20.2-linux-x64.tar.xz
+        stage:
+            - bin
+            - include
+            - lib
+    install-mjolnir:
+        after: [node]
+        plugin: nil
+        source: https://github.com/matrix-org/mjolnir.git
+        source-tag: v1.6.4
+        source-type: git
+        override-build: |
+            npm install -g yarn
+            yarn install
+            yarn build
+            mv lib $CRAFT_PRIME/mjolnir
+            mv node_modules $CRAFT_PRIME/
+            mv mjolnir-entrypoint.sh $CRAFT_PRIME/
+