Metadata-Version: 2.4
Name: synapse-registration-notifier
Version: 0.1.2
Summary: A Synapse module that notifies a room when users register on the server.
Author-email: timedout <pip@nexy7574.co.uk>
License-Expression: MPL-2.0
Project-URL: Source, https://codeberg.org/timedout/synapse-registration-notifier
Project-URL: Tracker, https://codeberg.org/timedout/synapse-registration-notifier/issues
Project-URL: Matrix Room, https://matrix.to/#/#general:nexy7574.co.uk
Project-URL: Funding, https://ko-fi.com/nexy7574
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: matrix-synapse>=1.36.0
Dynamic: license-file

# Synapse Registration Notifier

A simple [Synapse](https://github.com/element-hq/synapse) module that sends a notification to a specified room whenever
a new user registers on the server, containing some basic information and also configurable alerting capabilities.

## Installing

Install the module:
```sh
pip install git+https://codeberg.org/timedout/synapse-registration-notifier.git
```

And then configure it:
```yaml
modules:
  - module: synapse_registration_notifier.RegistrationNotifier
    config:
      # (required) The room to send the notification to, in the form of !roomid:server.name
      notification_room: "!yourroomid:yourserver.example"
      # (required) The user to send the notification as. Must be joined to the notification_room.
      admin_user_id: "@modbot:yourserver.example"
      # Whether to include a mention of @room in the notification
      mention_room: false
      # Whether to include individual user mentions in the notification, in the form of @user:server.name
      mention_user_ids:
        - "@user1:yourserver.example"
```
