{"id":24554725,"url":"https://github.com/gearkite/matrixzulipbridge","last_synced_at":"2025-10-28T14:43:08.619Z","repository":{"id":218012328,"uuid":"745134204","full_name":"GearKite/MatrixZulipBridge","owner":"GearKite","description":"A puppeting Matrix - Zulip bridge","archived":false,"fork":false,"pushed_at":"2024-09-30T08:29:05.000Z","size":657,"stargazers_count":15,"open_issues_count":3,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-16T03:17:11.036Z","etag":null,"topics":["bridge","matrix","zulip"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/GearKite.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-01-18T17:54:32.000Z","updated_at":"2025-04-05T09:06:52.000Z","dependencies_parsed_at":"2024-03-08T15:41:54.014Z","dependency_job_id":"ca548d3c-e77d-4fb4-876b-107c0648e577","html_url":"https://github.com/GearKite/MatrixZulipBridge","commit_stats":null,"previous_names":["gearkite/matrixzulipbridge"],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GearKite%2FMatrixZulipBridge","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GearKite%2FMatrixZulipBridge/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GearKite%2FMatrixZulipBridge/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GearKite%2FMatrixZulipBridge/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/GearKite","download_url":"https://codeload.github.com/GearKite/MatrixZulipBridge/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249188432,"owners_count":21227015,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bridge","matrix","zulip"],"created_at":"2025-01-23T03:33:18.124Z","updated_at":"2025-10-28T14:43:08.529Z","avatar_url":"https://github.com/GearKite.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# MatrixZulipBridge\n\n![Tests](https://github.com/GearKite/MatrixZulipBridge/actions/workflows/tests.yml/badge.svg)\n![PyPI version](https://img.shields.io/pypi/v/matrixzulipbridge.svg)\n![Python versions](https://img.shields.io/pypi/pyversions/matrixzulipbridge.svg)\n\nA Matrix puppeting appservice bridge for Zulip\n\nJoin the Matrix room [#MatrixZulipBridge:shema.lv](https://matrix.to/#/#matrixzulipbridge:shema.lv) if you have any questions or just want to chat.\n\n## Features\n\n- [x] Streams\n- [x] Zulip topics - Matrix threads\n- [x] Direct messages\n- [x] Formatted text\\* (not all of Zulip's formatting)\n- [x] Matrix puppets\n- [x] Zulip puppets\n- [x] Message Media\\* (only translating URIs)\n- [ ] Presence\n- [x] Reactions\n- [x] Redactions\\* (only from Matrix in DMs)\n- [x] Replies\n- [ ] Typing indicators\n\n## Installation\n\n### Prerequisites\n\n- [Python \u003e=3.10](https://wiki.python.org/moin/BeginnersGuide/Download)\n- Matrix homeserver with ability to add appservices\n\n### PyPI\n\n`pip install matrixzulipbridge`\n\n### Docker\n\n`docker run ghcr.io/gearkite/matrixzulipbridge:{tag} ...`  \nSee [packages](https://github.com/GearKite/MatrixZulipBridge/pkgs/container/matrixzulipbridge) for possible tags\n\n### From source\n\n1. Clone or download this git repository  \n   `git clone https://github.com/GearKite/MatrixZulipBridge.git`\n2. Install [Poetry](https://python-poetry.org/docs/#installation)\n3. Install dependencies  \n   `poetry install`\n4. Enter the virtual environment  \n   `poetry shell`\n\n## Running\n\n### Example\n\n1. Generate a registration file  \n   `python3 -m matrixzulipbridge --config config.yaml --generate`\n2. Install the appservice on your homeserver\n3. Run the bridge  \n   `python3 -m matrixzulipbridge --config config.yaml https://homeserver.example.com`\n\n### Usage\n\n```shell\nusage: python3 -m matrixzulipbridge [-h] [-v] (-c CONFIG | --version) [-l LISTEN_ADDRESS] [-p LISTEN_PORT] [-u UID] [-g GID] [--generate] [--generate-compat] [--reset] [--unsafe-mode] [-o OWNER] [homeserver]\n\nA puppeting Matrix - Zulip appservice bridge (v0.1.1.dev2+g3ed8ed7)\n\npositional arguments:\n  homeserver            URL of Matrix homeserver (default: http://localhost:8008)\n\noptions:\n  -h, --help            show this help message and exit\n  -v, --verbose         log debug messages\n  -c CONFIG, --config CONFIG\n                        registration YAML file path, must be writable if generating (default: None)\n  --version             show bridge version\n  -l LISTEN_ADDRESS, --listen-address LISTEN_ADDRESS\n                        bridge listen address (default: as specified in url in config, 127.0.0.1 otherwise) (default: None)\n  -p LISTEN_PORT, --listen-port LISTEN_PORT\n                        bridge listen port (default: as specified in url in config, 28464 otherwise) (default: None)\n  -u UID, --uid UID     user id to run as (default: None)\n  -g GID, --gid GID     group id to run as (default: None)\n  --generate            generate registration YAML for Matrix homeserver (Synapse)\n  --generate-compat     generate registration YAML for Matrix homeserver (Dendrite and Conduit)\n  --reset               reset ALL bridge configuration from homeserver and exit\n  --unsafe-mode         allow appservice to leave rooms on error (default: False)\n  -o OWNER, --owner OWNER\n                        set owner MXID (eg: @user:homeserver) or first talking local user will claim the bridge (default: None)\n```\n\nAfter registering and launching the bridge, start a chat. You can find the localpart in your `registration.yaml`  \nThis bridge is mainly configurable through Matrix, send `help` to get a list of commands\n\n### Bridging a stream\n\nIn your control room chat with the bridge send:\n\n1.  `addorganization {name}`\n2.  `open {name}`\n\nIn the organization room send:\n\n1. `site example.com`\n2. `email my-bot@example.com`\n3. `apikey xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx`\n4. `connect`\n5. `subscribe {zulip stream name}`\n\n## Credits\n\nThis bridge is heavily based on [Heisenbridge](https://github.com/hifi/heisenbridge). Thank you, Heisenbridge contributors!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgearkite%2Fmatrixzulipbridge","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgearkite%2Fmatrixzulipbridge","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgearkite%2Fmatrixzulipbridge/lists"}