mjolnir/src/appservice/config/config.example.yaml


homeserver:
  # The Matrix server name, this will be the name of the server in your matrix id.
  domain: "localhost:9999"
  # The url for the appservice to call the client server API from.
  url: http://localhost:8081

# Database configuration for storing which Mjolnirs have been provisioned.
db:
  engine: "postgres"
  connectionString: "postgres://mjolnir-tester:mjolnir-test@localhost:8083/mjolnir-test-db"

# A room you have created that scopes who can access the appservice.
# See docs/access_control.md
accessControlList: "#access-control-list:localhost:9999"

# This is a web api that the widget connects to in order to interact with the appservice.
webAPI:
  port: 9001

bot:
  # The display name of the bot
  displayName: Moderation bot
manymjolnir appservice (#364) Mjolnir can now be run as an application service, meaning it will host multiple independent mjolnirs that can be requested by users. If the user is on the same homeserver as the appservice is deployed on, then they can provision a mjolnir via a widget https://github.com/matrix-org/mjolnir-widget. Otherwise they can invite the appservice bot to a room they want to protect. This will create them a mjolnir, a management room and a policy list. The appservice shares the same docker image as the bot, but is started slightly differently by specifying "appservice" as the first argument to docker run (this s managed by `mjolnir-entrypoint.sh`. We could have used another Dockerfile for the appservice, extending the existing one but we decided not to because there would have been lots of fiddling around the entrypoint and logistics involved around adding a tag for it via github actions. Not to mention that this would be duplicating the image just to run it with a different binary. A list of followup issues can be found here https://github.com/issues?q=is%3Aopen+is%3Aissue+author%3AGnuxie+archived%3Afalse+label%3AA-Appservice. Somewhat relevant and squashed commit messages(regrettably squashing because frankly these won't make sense in isolation): * draft widget backend * add `managementRoomId` to `provisionNewMjolnir` * remove ratelimits from appservice mjolnirs * add /join endpoint to api backend * tighter guard around room type in PolicyList matrix-bot-sdk imporved the types for this * enable esModuleInterop * launch and use postgres in a container whilst using mx-tester * limited access control policy list used for access control * Redesign initialization API of many mjolnir. It's much harder to forget to initialize the components now that you have to in order to construct them in the first place. * Ammend config not to clash with existing CI this means that the appsrvice bot is now called 'mjolnir-bot' by default which was easier than going through old code base and renaming * Change entrypoint in Dockerfile so that we can start the appservice. We could have used another Dockerfile for the appservice, extending the exising one but we decided not to because there would have been lots of fiddling around the entrypoint and logistics involved around adding a tag for it via github actions. Not to mention that this would be duplicating the image just to run it with a different binary. This solution is much simpler, backwards compatible, and conscious about the future. Co-authored-by: gnuxie <gnuxie@element.io> 2022-11-15 18:03:06 +00:00
			`homeserver:`
			`# The Matrix server name, this will be the name of the server in your matrix id.`
			`domain: "localhost:9999"`
			`# The url for the appservice to call the client server API from.`
			`url: http://localhost:8081`

			`# Database configuration for storing which Mjolnirs have been provisioned.`
			`db:`
			`engine: "postgres"`
			`connectionString: "postgres://mjolnir-tester:mjolnir-test@localhost:8083/mjolnir-test-db"`

			`# A room you have created that scopes who can access the appservice.`
			`# See docs/access_control.md`
			`accessControlList: "#access-control-list:localhost:9999"`

			`# This is a web api that the widget connects to in order to interact with the appservice.`
			`webAPI:`
			`port: 9001`
A first implementation of report-to-moderator Traditionally, when a user clicks "report" in a Matrix client, this goes to the homeserver administrator, who often is the wrong person for the job. MSC3215 introduces a mechanism to let clients cooperate with a bot to send the report to the moderator instead. Client support has landed in Element Web (behind a Labs flag) in in 2021. This allows Mjölnir to serve as the partner bot. 2023-01-05 10:12:48 +00:00
			`bot:`
			`# The display name of the bot`
			`displayName: Moderation bot`