{"id":23086705,"url":"https://github.com/unkwusr/matterbridge-simplex","last_synced_at":"2025-08-15T19:05:43.208Z","repository":{"id":267532328,"uuid":"901544498","full_name":"UnkwUsr/matterbridge-simplex","owner":"UnkwUsr","description":"matterbridge adapter for simplex-chat","archived":false,"fork":false,"pushed_at":"2025-08-02T23:31:03.000Z","size":30,"stargazers_count":2,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-08-03T01:13:59.534Z","etag":null,"topics":["bridge","matterbridge","simplex-chat"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/UnkwUsr.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,"zenodo":null}},"created_at":"2024-12-10T21:22:05.000Z","updated_at":"2025-08-02T23:31:07.000Z","dependencies_parsed_at":null,"dependency_job_id":"1b9a139d-4f55-4c83-89a6-761f3ae06953","html_url":"https://github.com/UnkwUsr/matterbridge-simplex","commit_stats":null,"previous_names":["unkwusr/matterbridge-simplex"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/UnkwUsr/matterbridge-simplex","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/UnkwUsr%2Fmatterbridge-simplex","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/UnkwUsr%2Fmatterbridge-simplex/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/UnkwUsr%2Fmatterbridge-simplex/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/UnkwUsr%2Fmatterbridge-simplex/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/UnkwUsr","download_url":"https://codeload.github.com/UnkwUsr/matterbridge-simplex/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/UnkwUsr%2Fmatterbridge-simplex/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":270617818,"owners_count":24617121,"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","status":"online","status_checked_at":"2025-08-15T02:00:12.559Z","response_time":110,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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","matterbridge","simplex-chat"],"created_at":"2024-12-16T19:29:55.445Z","updated_at":"2025-08-15T19:05:43.199Z","avatar_url":"https://github.com/UnkwUsr.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"## matter-bridge-simplex\n\nThis is adapter for [matterbridge](https://github.com/42wim/matterbridge) that\nadds support for [SimpleX Chat](https://github.com/simplex-chat/simplex-chat).\n\n* files not yet supported, but currently it can send image previews from\n  simplex chat to matterbridge\n* matterbridge version should be higher than `1.26.0` (although at this moment\n  latest release is exactly `1.26.0`, so you have to build matterbridge from\n  master branch, which have fixes for api endpoint)\n  * UPD: can download latest version from maintained (not by me)\n    [fork](https://github.com/bibanon/matterbridge/releases) or just use docker\n* **bonus feature:** you can mark messages so that they can be read only from\n  simplex chat side. For it you need to send message in simplex chat that\n  starts with `/hide`. Example: `/hide this message will be replaced on all\n  other platforms with informational message about that message is hidden and\n  can be read only via simplex chat`\n\n## Usage\n\n### docker-compose\n\n* Prepare SimpleX Chat database\n  * Easiest way is to run simplex-chat cli version, then your database will be\n    at `~/.simplex` directory.\n  * While you're there, before moving database you have to add this bot profile\n    to some chat you want to be used for bridging. (it's id should be 4, which\n    is default hardcoded in docker-compose file. You can find it by following\n    [Obtaining chat id](#Obtaining_chat_id) tip. If it differs, then edit\n    docker-compose.yml file).\n  * Finally move database to `data/simplex` and give it permissions: `mkdir -p\n    data/simplex \u0026\u0026 mv ~/.simplex/simplex_v1_* data/simplex \u0026\u0026 chmod 777 data/\n    -R`\n    * P.S. giving 777 permissions is not really good idea, but I don't know any\n      other simple way to make it work with docker.\n* Configure `matterbridge.toml` (copy example from `matterbridge.toml.example`\n  and follow matterbridge\n  [documentation](https://github.com/42wim/matterbridge/wiki/How-to-create-your-config))\n* Run:\n\n  ```\n  docker compose up --build\n  ```\n\n### Manual\n\nClone dependency library from simplex-chat repo (it is part of it) and build js\nfrom typescript (you need to have installed nodejs, npm and typescript):\n\n```\ngit submodule update --init --recursive --depth 1\n( cd lib/simplex-chat-client-typescript/ \u0026\u0026 npm install \u0026\u0026 tsc )\n```\n\nStart simplex chat websocket server (example on port 5225):\n\n```\nsimplex-chat -p 5225\n```\n\nConfigure matterbridge api endpoint (copy file `matterbridge.toml.example` to\n`matterbridge.toml` and edit to your needs)\n\nRun matterbridge:\n\n```\nmatterbridge -conf matterbridge.toml\n```\n\nAnd finally run our bridge between matterbridge api and simplex chat:\n\nFormat:\n\n```\nnode main.js \u003cMATTERBRIDGE_API_ADDRESS\u003e \u003cMATTERBRIDGE_GATEWAY\u003e \u003cSIMPLEX_LISTEN_ADDRESS\u003e \u003cSIMPLEX_CHAT_ID\u003e \u003cCHAT_TYPE (contact/group)\u003e\n```\n\nExample:\n\n```\nnode main.js 127.0.0.1:4242 gateway1 127.0.0.1:5225 1 group\n```\n\n## Tips\n\n### Obtaining chat id\n\n**Please note:**, in simplex chat, group chats and contact chats have their own\nseparated ids, that mean you can easily have **group** chat with id 5 AND\n**contact** chat with id 5 and this is normal. This is why you have to know\nboth id and type of the chat.\n\nYou can get chat id of selected chat by using cli command `/i #group_name` or\n`/i @contact_name`.\n\nYou can get list of all chats with their id's with this command (requires\n[jq](https://github.com/jqlang/jq) utility to be installed):\n\n```\nsimplex-chat -e '/_get chats 1 pcc=off' \\\n  | tail -n +2 \\\n  | jq '.[].chatInfo | (.groupInfo // .contact) | {name: .localDisplayName, type: (if .groupId then \"group\" else \"contact\" end), id: .groupId // .contactId}'\n```\n\n## Contact\n\nContact me via simplex chat: \u003chttps://smp12.simplex.im/a#fvW9jWlBynDpPlMfFz-wXfR2D9iRmWf--nsDArGTm5I\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Funkwusr%2Fmatterbridge-simplex","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Funkwusr%2Fmatterbridge-simplex","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Funkwusr%2Fmatterbridge-simplex/lists"}