Add MatrixZulipBridge #4695

luixxiul · 2025-11-01T17:17:57Z

No description provided.

Signed-off-by: Suguru Hirahara <[email protected]>

…vice.j2 - Add the license header to matrix-matrixzulipbridge.service.j2 Signed-off-by: Suguru Hirahara <[email protected]>

…atrixzulipbridge", respectively Signed-off-by: Suguru Hirahara <[email protected]>

Signed-off-by: Suguru Hirahara <[email protected]>

…asks Reuse https://app.radicle.xyz/nodes/seed.radicle.garden/rad%3Az3EdzLb58oJYY4L17xrVpYtRPz4ej/tree/aa0591f8b0ff19cee5523ffe5d070ee062e09d62/tasks/main.yml Signed-off-by: Suguru Hirahara <[email protected]>

Signed-off-by: Suguru Hirahara <[email protected]>

Run `pip install matrixzulipbridge && python3 -m matrixzulipbridge --config config.yaml --generate` to generate config.yaml Signed-off-by: Suguru Hirahara <[email protected]>

Signed-off-by: Suguru Hirahara <[email protected]>

Reuse https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/b108c8a15165cebe346c7b16cbe181a495db6bf7/docs/configuring-playbook-bridge-heisenbridge.md Signed-off-by: Suguru Hirahara <[email protected]>

Signed-off-by: Suguru Hirahara <[email protected]>

Signed-off-by: Suguru Hirahara <did:key:z6MkvVZk1A3KBApWJXv2Ju4H14ErDfRGxh8zxdXSZ4vACDg5>

group_vars/matrix_servers

aine-etke · 2025-11-02T19:58:11Z

roles/custom/matrix-bridge-zulip/defaults/main.yml

+# MatrixZulipBridge is a puppeting appservice bridge for Zulip
+# Project source code URL: https://github.com/GearKite/MatrixZulipBridge
+
+matrix_bridge_zulip_enabled: true


matrix_zulip_bridge_* vars look more natural, IMO. Don't steam and go-skype bridge follow the same pattern?

There is not a consistent pattern at all as far as I see:

matrix-bridge-heisenbridge: matrix_heisenbridge_*

matrix-bridge-hookshot: matrix_hookshot_*

matrix-bridge-steam: matrix_steam_bridge_*

I would change them into what's based on a hierarchy:

matrix-bridge-heisenbridge: matrix_bridge_heisenbridge_* (we won't set it to matrix_bridge_heisen_* as "heisenbridge" is the name of the bridge)

matrix-bridge-hookshot: matrix_bridge_hookshot_*

matrix-bridge-steam: matrix_bridge_steam_*

Regarding to matrix-bridge-zulip, it seems confusing to switch the place of "bridge" and "zulip" like matrix_zulip_bridge_* against the name of the bridge itself, which respects the hierarchy (despite there being some exceptions like matrix-sms-bridge).

The bridge for Steam is named as matrix-steam-bridge simply because it is the same as the same of the bridge itself (see: https://github.com/jasonlaguidice/matrix-steam-bridge).

If matrix-bridge-heisenbridge variables are set to matrix_bridge_heisenbridge_*, the variables for this bridge should be set to matrix_bridge_matrixzulipbridge_* if we respect the hierarchy for the sake of predictability.

Still, it is a completely different theme, and should definitely be addressed on another occasion.

Heisenbridge, Hookshot, Matrix Steam Bridge are component names, so the vars for them are matrix_COMPONENT_*. In the case of Matrix Steam Bridge, the Matrix from the name is omitted/deduplicated to get matrix_steam_bridge_* vars, and I'd personally expect it to be the same for Zulip - matrix_zulip_bridge_*, because the project name is MatrixZulipBridge.

Your point is completely fair - currently hierarchy naming is broken for some components, but considering unique names, I, personally, don't see a big problem here - matrix_mautrix_slack_*, matrix_postmoogle_*, matrix_heisenbridge_*, matrix_hookshot_* look okay-ish

Created an issue on naming policy here: #4705

roles/custom/matrix-bridge-zulip/tasks/main.yml

Signed-off-by: Suguru Hirahara <did:key:z6MkvVZk1A3KBApWJXv2Ju4H14ErDfRGxh8zxdXSZ4vACDg5>

Refer to spantaleev#4695 (comment) Signed-off-by: Suguru Hirahara <did:key:z6MkvVZk1A3KBApWJXv2Ju4H14ErDfRGxh8zxdXSZ4vACDg5>

…dge_owner` Signed-off-by: Suguru Hirahara <did:key:z6MkvVZk1A3KBApWJXv2Ju4H14ErDfRGxh8zxdXSZ4vACDg5>

docs/configuring-playbook-bridge-zulip.md

aine-etke · 2025-11-03T19:12:04Z

group_vars/matrix_servers

    +
    ([{'name': 'matrix-hookshot.service', 'priority': 2000, 'groups': ['matrix', 'bridges', 'hookshot', 'bridge-hookshot']}] if matrix_hookshot_enabled else [])
    +
+    ([{'name': 'matrix-bridge-zulip.service', 'priority': 2000, 'groups': ['matrix', 'bridges', 'matrixzulipbridge']}] if matrix_zulip_bridge_enabled else [])


Please use matrix-zulip-bridge for service name and zulip for tags, similar to other bridges

group_vars/matrix_servers

roles/custom/matrix-bridge-zulip/defaults/main.yml

roles/custom/matrix-bridge-zulip/templates/systemd/matrix-zulip-bridge.service.j2

Signed-off-by: Suguru Hirahara <did:key:z6MkvVZk1A3KBApWJXv2Ju4H14ErDfRGxh8zxdXSZ4vACDg5>

…guring-playbook-bridge-postmoogle.md Reuse https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/7862fd7cddf82cc067962a6b55747c3242c05630/docs/configuring-playbook-bridge-postmoogle.md Signed-off-by: Suguru Hirahara <did:key:z6MkvVZk1A3KBApWJXv2Ju4H14ErDfRGxh8zxdXSZ4vACDg5>

…ansible-deploy into matrixzulipbridge

Signed-off-by: Suguru Hirahara <did:key:z6MkvVZk1A3KBApWJXv2Ju4H14ErDfRGxh8zxdXSZ4vACDg5>

…ansible-deploy into matrixzulipbridge

Ref: #4695

* Add links to MatrixZulipBridge Signed-off-by: Suguru Hirahara <[email protected]> * Add MatrixZulipBridge: copy matrix-bridge-heisenbridge Signed-off-by: Suguru Hirahara <[email protected]> * Rename matrix-heisenbridge.service.j2 to matrix-matrixzulipbridge.service.j2 - Add the license header to matrix-matrixzulipbridge.service.j2 Signed-off-by: Suguru Hirahara <[email protected]> * Replace "Heisenbridge" to "MatrixZulipBridge" to "heisenbridge" to "matrixzulipbridge", respectively Signed-off-by: Suguru Hirahara <[email protected]> * Replace variables related to container image and version Signed-off-by: Suguru Hirahara <[email protected]> * Update comments and copyright headers Signed-off-by: Suguru Hirahara <[email protected]> * Update matrix-bridge-matrixzulipbridge/tasks/main.yml: add names to tasks Reuse https://app.radicle.xyz/nodes/seed.radicle.garden/rad%3Az3EdzLb58oJYY4L17xrVpYtRPz4ej/tree/aa0591f8b0ff19cee5523ffe5d070ee062e09d62/tasks/main.yml Signed-off-by: Suguru Hirahara <[email protected]> * Remove configuration for identd Signed-off-by: Suguru Hirahara <[email protected]> * Add `matrix_matrixzulipbridge_container_http_port` Signed-off-by: Suguru Hirahara <[email protected]> * Run ansible-lint for files in tasks/ Signed-off-by: Suguru Hirahara <[email protected]> * Update `matrix_matrixzulipbridge_registration_yaml` Run `pip install matrixzulipbridge && python3 -m matrixzulipbridge --config config.yaml --generate` to generate config.yaml Signed-off-by: Suguru Hirahara <[email protected]> * Add MatrixZulipBridge to files in group_vars Signed-off-by: Suguru Hirahara <[email protected]> * Add configuring-playbook-bridge-matrixzulipbridge.md Reuse https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/b108c8a15165cebe346c7b16cbe181a495db6bf7/docs/configuring-playbook-bridge-heisenbridge.md Signed-off-by: Suguru Hirahara <[email protected]> * Fix `matrix_matrixzulipbridge_config_media_path` Signed-off-by: Suguru Hirahara <[email protected]> * Remove space characters Signed-off-by: Suguru Hirahara <did:key:z6MkvVZk1A3KBApWJXv2Ju4H14ErDfRGxh8zxdXSZ4vACDg5> * Replace "matrixzulipbridge" with "zulip", etc. Signed-off-by: Suguru Hirahara <did:key:z6MkvVZk1A3KBApWJXv2Ju4H14ErDfRGxh8zxdXSZ4vACDg5> * Remove irrelevant instruction Signed-off-by: Suguru Hirahara <did:key:z6MkvVZk1A3KBApWJXv2Ju4H14ErDfRGxh8zxdXSZ4vACDg5> * MatrixZulipBridge → Zulip bridge Signed-off-by: Suguru Hirahara <did:key:z6MkvVZk1A3KBApWJXv2Ju4H14ErDfRGxh8zxdXSZ4vACDg5> * Rename `@matrixzulipbridge` to `@zulipbot` Signed-off-by: Suguru Hirahara <did:key:z6MkvVZk1A3KBApWJXv2Ju4H14ErDfRGxh8zxdXSZ4vACDg5> * Replace `matrix_bridge_zulip` with `matrix_zulip_bridge` for now Refer to spantaleev#4695 (comment) Signed-off-by: Suguru Hirahara <did:key:z6MkvVZk1A3KBApWJXv2Ju4H14ErDfRGxh8zxdXSZ4vACDg5> * Set `{{ matrix_admin if matrix_admin else '' }}` to `matrix_zulip_bridge_owner` Signed-off-by: Suguru Hirahara <did:key:z6MkvVZk1A3KBApWJXv2Ju4H14ErDfRGxh8zxdXSZ4vACDg5> * Apply the review Signed-off-by: Suguru Hirahara <did:key:z6MkvVZk1A3KBApWJXv2Ju4H14ErDfRGxh8zxdXSZ4vACDg5> * Reuse the section about adjusting the playbook configuration on configuring-playbook-bridge-postmoogle.md Reuse https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/7862fd7cddf82cc067962a6b55747c3242c05630/docs/configuring-playbook-bridge-postmoogle.md Signed-off-by: Suguru Hirahara <did:key:z6MkvVZk1A3KBApWJXv2Ju4H14ErDfRGxh8zxdXSZ4vACDg5> * Update configuring-playbook.md: sort list items Signed-off-by: Suguru Hirahara <did:key:z6MkvVZk1A3KBApWJXv2Ju4H14ErDfRGxh8zxdXSZ4vACDg5> --------- Signed-off-by: Suguru Hirahara <[email protected]> Signed-off-by: Suguru Hirahara <did:key:z6MkvVZk1A3KBApWJXv2Ju4H14ErDfRGxh8zxdXSZ4vACDg5> Co-authored-by: Suguru Hirahara <[email protected]> Co-authored-by: Suguru Hirahara <did:key:z6MkvVZk1A3KBApWJXv2Ju4H14ErDfRGxh8zxdXSZ4vACDg5>

Ref: spantaleev#4695

Add links to MatrixZulipBridge

4027514

Signed-off-by: Suguru Hirahara <[email protected]>

luixxiul added the enhancement label Nov 1, 2025

Suguru Hirahara and others added 14 commits November 2, 2025 02:21

Add MatrixZulipBridge: copy matrix-bridge-heisenbridge

898fc1e

Signed-off-by: Suguru Hirahara <[email protected]>

Rename matrix-heisenbridge.service.j2 to matrix-matrixzulipbridge.ser…

2498495

…vice.j2 - Add the license header to matrix-matrixzulipbridge.service.j2 Signed-off-by: Suguru Hirahara <[email protected]>

Replace "Heisenbridge" to "MatrixZulipBridge" to "heisenbridge" to "m…

b67b7a4

…atrixzulipbridge", respectively Signed-off-by: Suguru Hirahara <[email protected]>

Replace variables related to container image and version

d54a729

Signed-off-by: Suguru Hirahara <[email protected]>

Update comments and copyright headers

c734042

Signed-off-by: Suguru Hirahara <[email protected]>

Update matrix-bridge-matrixzulipbridge/tasks/main.yml: add names to t…

551a2b7

…asks Reuse https://app.radicle.xyz/nodes/seed.radicle.garden/rad%3Az3EdzLb58oJYY4L17xrVpYtRPz4ej/tree/aa0591f8b0ff19cee5523ffe5d070ee062e09d62/tasks/main.yml Signed-off-by: Suguru Hirahara <[email protected]>

Remove configuration for identd

a25ead8

Signed-off-by: Suguru Hirahara <[email protected]>

Add matrix_matrixzulipbridge_container_http_port

9dd47f4

Signed-off-by: Suguru Hirahara <[email protected]>

Run ansible-lint for files in tasks/

a0c1918

Signed-off-by: Suguru Hirahara <[email protected]>

Update matrix_matrixzulipbridge_registration_yaml

3f238d1

Run `pip install matrixzulipbridge && python3 -m matrixzulipbridge --config config.yaml --generate` to generate config.yaml Signed-off-by: Suguru Hirahara <[email protected]>

Add MatrixZulipBridge to files in group_vars

b257b8d

Signed-off-by: Suguru Hirahara <[email protected]>

Add configuring-playbook-bridge-matrixzulipbridge.md

f3154d3

Reuse https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/b108c8a15165cebe346c7b16cbe181a495db6bf7/docs/configuring-playbook-bridge-heisenbridge.md Signed-off-by: Suguru Hirahara <[email protected]>

Fix matrix_matrixzulipbridge_config_media_path

30cc674

Signed-off-by: Suguru Hirahara <[email protected]>

Remove space characters

b1c6b70

Signed-off-by: Suguru Hirahara <did:key:z6MkvVZk1A3KBApWJXv2Ju4H14ErDfRGxh8zxdXSZ4vACDg5>

luixxiul force-pushed the matrixzulipbridge branch from dc6a9a3 to b1c6b70 Compare November 2, 2025 14:50

luixxiul marked this pull request as ready for review November 2, 2025 14:54

Replace "matrixzulipbridge" with "zulip", etc.

313737e

Signed-off-by: Suguru Hirahara <did:key:z6MkvVZk1A3KBApWJXv2Ju4H14ErDfRGxh8zxdXSZ4vACDg5>

luixxiul force-pushed the matrixzulipbridge branch from 0e873e2 to 313737e Compare November 2, 2025 16:22

Remove irrelevant instruction

ea99044

Signed-off-by: Suguru Hirahara <did:key:z6MkvVZk1A3KBApWJXv2Ju4H14ErDfRGxh8zxdXSZ4vACDg5>

aine-etke reviewed Nov 2, 2025

View reviewed changes

Suguru Hirahara added 4 commits November 3, 2025 14:23

MatrixZulipBridge → Zulip bridge

bcce68d

Signed-off-by: Suguru Hirahara <did:key:z6MkvVZk1A3KBApWJXv2Ju4H14ErDfRGxh8zxdXSZ4vACDg5>

Rename @matrixzulipbridge to @zulipbot

5b86c4e

Signed-off-by: Suguru Hirahara <did:key:z6MkvVZk1A3KBApWJXv2Ju4H14ErDfRGxh8zxdXSZ4vACDg5>

Replace matrix_bridge_zulip with matrix_zulip_bridge for now

a79b4e2

Refer to spantaleev#4695 (comment) Signed-off-by: Suguru Hirahara <did:key:z6MkvVZk1A3KBApWJXv2Ju4H14ErDfRGxh8zxdXSZ4vACDg5>

Set {{ matrix_admin if matrix_admin else '' }} to `matrix_zulip_bri…

84ad18b

…dge_owner` Signed-off-by: Suguru Hirahara <did:key:z6MkvVZk1A3KBApWJXv2Ju4H14ErDfRGxh8zxdXSZ4vACDg5>

aine-etke reviewed Nov 3, 2025

View reviewed changes

luixxiul mentioned this pull request Nov 4, 2025

Set and adopt naming policy for bridges #4705

Open

Suguru Hirahara added 2 commits November 4, 2025 14:22

Apply the review

6b21b03

Signed-off-by: Suguru Hirahara <did:key:z6MkvVZk1A3KBApWJXv2Ju4H14ErDfRGxh8zxdXSZ4vACDg5>

Suguru Hirahara added 3 commits November 6, 2025 19:59

Merge branch 'master' of https://github.com/spantaleev/matrix-docker-…

428aa25

…ansible-deploy into matrixzulipbridge

Update configuring-playbook.md: sort list items

9744357

Signed-off-by: Suguru Hirahara <did:key:z6MkvVZk1A3KBApWJXv2Ju4H14ErDfRGxh8zxdXSZ4vACDg5>

Merge branch 'master' of https://github.com/spantaleev/matrix-docker-…

edc64ff

…ansible-deploy into matrixzulipbridge

spantaleev merged commit ee97624 into spantaleev:master Nov 8, 2025
3 checks passed

luixxiul deleted the matrixzulipbridge branch November 8, 2025 07:09

spantaleev added a commit that referenced this pull request Nov 8, 2025

Announce Zulip bridge

8979fde

Ref: #4695

ayushin pushed a commit to apexive/matrix-docker-ansible-deploy that referenced this pull request Nov 16, 2025

Announce Zulip bridge

21d10af

Ref: spantaleev#4695

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add MatrixZulipBridge #4695

Add MatrixZulipBridge #4695

Uh oh!

luixxiul commented Nov 1, 2025

Uh oh!

Uh oh!

Uh oh!

aine-etke Nov 2, 2025

Uh oh!

luixxiul Nov 3, 2025 •

edited

Loading

Uh oh!

aine-etke Nov 3, 2025

Uh oh!

luixxiul Nov 4, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

aine-etke Nov 3, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Add MatrixZulipBridge #4695

Add MatrixZulipBridge #4695

Uh oh!

Conversation

luixxiul commented Nov 1, 2025

Uh oh!

Uh oh!

Uh oh!

aine-etke Nov 2, 2025

Choose a reason for hiding this comment

Uh oh!

luixxiul Nov 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

aine-etke Nov 3, 2025

Choose a reason for hiding this comment

Uh oh!

luixxiul Nov 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

aine-etke Nov 3, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

luixxiul Nov 3, 2025 •

edited

Loading

luixxiul Nov 4, 2025 •

edited

Loading