Skip to content

README.md

Latest commit

 

History

History
47 lines (34 loc) · 1.38 KB

README.md

File metadata and controls

47 lines (34 loc) · 1.38 KB

Patch

Patch

Patch, named after the SeaGL mascot, is a Matrix bot that assists with running the SeaGL Matrix space.

Usage

Install dependencies:

  • Node.js, Yarn, and the packages installed via yarn install

Populate environment variables:

  • Matrix Client-Server API:
    • MATRIX_ACCESS_TOKEN: Secret authentication token (see this Stack Exchange question for how to get one)
    • MATRIX_BASE_URL: Homeserver base URL
    • MATRIX_RATE_LIMIT: Rate limit in hertz
    • ISSUE_8895_COOLDOWN: Seconds to wait before room creation (matrix-org/synapse#8895)
  • OSEM:
    • OSEM_RATE_LIMIT: Rate limit in hertz
  • Sentry:
    • SENTRY_DSN (Optional): Data Source Name of Sentry project. If unset, error reporting is not enabled.

yarn install will build the bot automatically.

Start the bot:

yarn start

To rebuild the bot:

yarn prepare