Skip to content

Commit e697812

Browse files
committed
FIXUP doc bits idk
1 parent 8462f72 commit e697812

File tree

2 files changed

+11
-2
lines changed

2 files changed

+11
-2
lines changed

src/appservice/MjolnirManager.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,12 @@ import { AccessControl } from "./AccessControl";
88
import { Access } from "../models/AccessControlUnit";
99
import { randomUUID } from "crypto";
1010

11+
/**
12+
* The MjolnirManager is responsible for:
13+
* * Provisioning new mjolnir instances.
14+
* * Starting mjolnirs when the appservice is brought online.
15+
* * Informing mjolnirs about new events.
16+
*/
1117
export class MjolnirManager {
1218
public readonly mjolnirs: Map</*the user id of the mjolnir*/string, ManagedMjolnir> = new Map();
1319

src/appservice/cli.ts

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,11 @@ import { Cli } from "matrix-appservice-bridge";
22
import { MjolnirAppService } from "./AppService";
33
import { IConfig } from "./config/config";
44

5-
// ts-node src/appservice/AppService.ts -r -u "http://host.docker.internal:9000"
6-
// ts-node src/appservice/AppService -p 9000 -c your-confg.yaml # to start
5+
/**
6+
* This file provides the entrypoint for the appservice mode for mjolnir.
7+
* A registration file can be generated `ts-node src/appservice/cli.ts -r -u "http://host.docker.internal:9000"`
8+
* and the appservice can be started with `ts-node src/appservice/cli -p 9000 -c your-confg.yaml`.
9+
*/
710
const cli = new Cli({
811
registrationPath: "mjolnir-registration.yaml",
912
bridgeConfig: {

0 commit comments

Comments
 (0)