Skip to content

Latest commit

 

History

History
80 lines (56 loc) · 4.31 KB

README.md

File metadata and controls

80 lines (56 loc) · 4.31 KB
Raw

matrix-zephyr-bridge

Zephyr bridge for Matrix

Matrix message

Matrix message on Zephyr

How to run?

  1. Install dependencies (pip install . in python-zephyr)
  2. Copy config.sample.yaml to config.yaml and edit to suit your needs
  3. Using pwgen -s 64 1, generate the tokens and add them to the config.yaml
  4. Run generate_registration.py to generate a registration.yaml. Use it to register the appservice with the Matrix homeserver (i.e. https://docs.mau.fi/bridges/general/registering-appservices.html)
  5. Create an empty zephyr.subs file. You may fill it with content like .zephyr.subs to pre-subscribe it to some classes and/or instances.

This bridge is 2 halves: the Matrix-to-Zephyr half is a Flask REST API located on matrix_receive.py, and the Zephyr-to-Matrix half is located in zephyr_receive.py.

How to use?

This is a Matrix application service which will automatically create rooms as needed.

NOTE: Due to case insensitivity, you must type class and instance names using lowercase.

  • To join the zephyr room for the class sipb and instance other, ask your Matrix client to join the room #z/sipb/other:matrix.mit.edu. If it does not exist on the Matrix side, the bridge will automatically subscribe to it and start bridging all future messages from and to Zephyr.*

  • To subscribe to all instances of the class sipb, you can ask your Matrix client to join the room #Z/sipb:matrix.mit.edu. This will be a space containing a room for each instance (not implemented yet).

  • To subscribe to the entire class weather using a single room, ask your Matrix client to join the room #z/weather:matrix.mit.edu. Messages sent to any instance of weather will be sent to the room (not implemented yet).

*prefix, separator and homeserver may vary if config.yaml was changed

Roadmap

  • Bridge specific instances
  • Bridge all instances of specific class (to space)
  • Bridge all instances of specific class (to consolidated room)
  • Make bridge easy to use by providing a DM interface and/or a web interface
  • Allow adding Zephyr briding to an existing Matrix room (#6)
  • Zephyr signatures <-> Matrix metadata
  • Zephyr signatures <-> Matrix display names if display name is similar enough
  • Add bot command on Zephyr to set display name on Matrix
  • Ignore messages from specific hosts opcodes (such as mattermost.mit.edu mattermost, to avoid double bridging)
  • Zephyr->Matrix metadata (authenticity and timestamp)
  • Matrix->Zephyr images, stickers, etc via URL
  • Support unclasses and .d instances (convention for off-topic conversations) (bridge as threads?)
  • Matrix->Zephyr formatting (HTML/MD to custom Zephyr syntax)
  • Matrix->Zephyr spoilers
  • Zephyr->Matrix formatting (parse custom Zephyr syntax into HTML)
  • Render Matrix->Zephyr replies in a reasonable format, even if it is no mention of original message at all (or a chopped version)
  • Import Gravatar/Zulip profile pictures
  • Zulip->Matrix images and files
  • Support unauthenticated DMs (via bot account as proxy) Don't like this idea anymore
  • Support sending and receiving DMs (via user through Webathena tickets, they will not necessarily be authentic) well if you DM someone, it should check if they have a Matrix account first and suggest DMing them there
  • Support sending authentic messages (using Webathena tickets)
  • (only if you file an issue/PR) Test that this works for other Zephyrs outside of ATHENA.MIT.EDU

Features that Zephyr does not support:

  • [ ] Matrix->Zephyr reactions(?) (SMS-style message + AUTO opcode) (not planned, probably a bad idea)
  • Matrix->Zephyr edits and deletions(?) (probably like reactions, send a text message explaining the change)

Appendix: media_base_url

What to set media_base_url to?

If unspecified, it will redirect to the endpoint of your homeserver URL.

If you wish to simplify the endpoint, and you run nginx on your homeserver, you can add the following lines before the Synapse reverse proxying configuration:

# Easier MXC URLs
location /media/ {
    rewrite ^/media/(.*)$ /_matrix/media/v3/download/uplink.mit.edu/$1 last;
}