{"id":50965625,"url":"https://github.com/tricked-dev/mautrix-simplex","last_synced_at":"2026-06-18T20:01:44.295Z","repository":{"id":339542732,"uuid":"1161491429","full_name":"Tricked-dev/mautrix-simplex","owner":"Tricked-dev","description":null,"archived":false,"fork":false,"pushed_at":"2026-05-02T15:46:33.000Z","size":15244,"stargazers_count":0,"open_issues_count":2,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2026-06-04T04:30:18.564Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Tricked-dev.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null},"funding":{"github":"Tricked-dev","ko_fi":"tricked"}},"created_at":"2026-02-19T06:59:45.000Z","updated_at":"2026-05-02T15:46:37.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/Tricked-dev/mautrix-simplex","commit_stats":null,"previous_names":["tricked-dev/mautrix-simplex"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Tricked-dev/mautrix-simplex","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Tricked-dev%2Fmautrix-simplex","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Tricked-dev%2Fmautrix-simplex/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Tricked-dev%2Fmautrix-simplex/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Tricked-dev%2Fmautrix-simplex/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Tricked-dev","download_url":"https://codeload.github.com/Tricked-dev/mautrix-simplex/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Tricked-dev%2Fmautrix-simplex/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34505423,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-18T02:00:06.871Z","response_time":128,"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":[],"created_at":"2026-06-18T20:01:39.215Z","updated_at":"2026-06-18T20:01:44.289Z","avatar_url":"https://github.com/Tricked-dev.png","language":"Go","funding_links":["https://github.com/sponsors/Tricked-dev","https://ko-fi.com/tricked"],"categories":[],"sub_categories":[],"readme":"# mautrix-simplex\n\nA Matrix-SimpleX puppeting bridge built on [mautrix-go](https://github.com/mautrix/go) bridgev2.\n\n## Features\n\n- Text messages with formatting (bold, italic, strikethrough, code)\n- Files, images, video, and audio\n- Reactions (SimpleX supports 8 emoji: `👍👎😀😂😢❤🚀✅`)\n- Message edits and deletes\n- Group chats and DMs\n- Reply quoting\n- Contact request auto-accept\n- Backfill of recent messages on login\n- Beeper support (hungryserv/websocket mode)\n\n## Requirements\n\n- [simplex-chat](https://github.com/simplex-chat/simplex-chat) binary (v6.x+)\n- Go 1.25+ (to build from source)\n- A Matrix homeserver that supports application services (Synapse, Conduit, etc.)\n\n## Building\n\n```bash\ncd mautrix-simplex\ngo build -o mautrix-simplex ./cmd/mautrix-simplex/\n```\n\nWith version info:\n\n```bash\ngo build -ldflags \"-X main.Tag=v0.1.0 -X main.Commit=$(git rev-parse HEAD) -X main.BuildTime=$(date -u +%Y-%m-%dT%H:%M:%SZ)\" -o mautrix-simplex ./cmd/mautrix-simplex/\n```\n\n## Setup\n\n### 1. Start simplex-chat\n\nThe bridge requires a running `simplex-chat` instance with WebSocket API enabled:\n\n```bash\nsimplex-chat -p 5225 -d /path/to/simplex-data --files-folder /path/to/files --temp-folder /path/to/files/tmp\n```\n\nBoth `--files-folder` and `--temp-folder` **must be on the same filesystem** to avoid cross-device rename errors. The `--temp-folder` should be a subdirectory of `--files-folder`.\n\n### 2. Generate config\n\n```bash\n./mautrix-simplex -g\n# Edit config.yaml with your homeserver details\n```\n\n### 3. Register with your homeserver\n\n```bash\n# Copy the generated registration file to your homeserver\ncp registration.yaml /etc/synapse/mautrix-simplex-registration.yaml\n# Add it to your homeserver's app_service_config_files and restart\n```\n\n### 4. Start the bridge\n\n```bash\n./mautrix-simplex\n```\n\n### 5. Log in\n\nUse the `login` command in your management room or via the provisioning API.\n\n## Login Modes\n\n### WebSocket (external simplex-chat)\n\nConnect to an already-running simplex-chat instance by providing its WebSocket URL (e.g. `ws://localhost:5225`). Use this when you manage the simplex-chat process separately.\n\n### Managed (bridge-spawned)\n\nProvide a SimpleX database directory path and the bridge will spawn and manage a simplex-chat process automatically. The `simplex_binary` config option controls which binary is used (defaults to `simplex-chat` in `$PATH`).\n\n## Configuration\n\nThe network-specific config section supports:\n\n| Key | Description | Default |\n|-----|-------------|---------|\n| `displayname_template` | Go template for ghost display names | `{{.DisplayName}} (SimpleX)` |\n| `simplex_binary` | Path to simplex-chat binary (for managed mode) | `simplex-chat` |\n| `files_folder` | Folder where simplex-chat stores files (must match `--files-folder`) | `~/Downloads` |\n\n## Docker\n\n### Build\n\n```bash\ncd mautrix-simplex\ndocker build -t mautrix-simplex .\n```\n\n### Run\n\nSee the included `docker-compose.yaml` for a full example with simplex-chat sidecar.\n\n```bash\ndocker compose up -d\n```\n\nThe compose file runs simplex-chat alongside the bridge with a shared volume for file transfers.\n\n## NixOS\n\nA NixOS module is provided via the flake:\n\n```nix\n{\n  inputs.mautrix-simplex.url = \"github:tricked-dev/mautrix-simplex\";\n\n  # In your NixOS configuration:\n  imports = [ inputs.mautrix-simplex.nixosModules.default ];\n\n  services.mautrix-simplex = {\n    # Enable the bridge and companion simplex-chat service.\n    enable = true;\n\n    # Matrix user ID of the bridge owner. Only this user gets admin access,\n    # everyone else is blocked. Set to null to configure permissions manually.\n    owner = \"@alice:example.com\";\n\n    # Override the mautrix-simplex package (defaults to the flake's package).\n    # package = pkgs.mautrix-simplex;\n\n    # The simplex-chat package for the companion service.\n    # Defaults to the bundled binary from the flake.\n    # simplexChatPackage = inputs.mautrix-simplex.packages.${pkgs.system}.simplex-chat;\n\n    # Base directory for all state (database, simplex-chat data, files).\n    # Defaults to /var/lib/mautrix-simplex.\n    dataDir = \"/var/lib/selfhosted/matrix/mautrix-simplex\";\n\n    # Port for the companion simplex-chat WebSocket API (default: 5225).\n    simplexChatPort = 5225;\n\n    # Directory for simplex-chat file storage (default: ${dataDir}/files).\n    # Must be on the same filesystem as the temp folder.\n    filesFolder = \"/var/lib/selfhosted/matrix/mautrix-simplex/files\";\n\n    # Whether to automatically register the appservice with Synapse.\n    # Defaults to true when services.matrix-synapse is enabled.\n    registerToSynapse = true;\n\n    # Extra systemd units to wait for before starting the bridge.\n    # Defaults to [ matrix-synapse.service ] when Synapse is enabled.\n    # serviceDependencies = [];\n\n    # Bridge configuration, converted to YAML. All mautrix-go bridgev2 config\n    # options are available here. The module sets sensible defaults for most fields.\n    settings = {\n      # Homeserver connection.\n      homeserver = {\n        address = \"http://localhost:8008\";\n        domain = \"example.com\";\n        # software = \"standard\";   # or \"hungry\" for hungryserv\n        # websocket = false;       # set true for Beeper\n      };\n\n      # Appservice registration (tokens are required).\n      appservice = {\n        # database.type = \"sqlite3-fk-wal\";\n        # database.uri = \"${dataDir}/mautrix-simplex.db\"; # auto-set from dataDir\n        # id = \"simplex\";\n        # bot.username = \"simplexbot\";\n        # bot.displayname = \"SimpleX Bridge Bot\";\n        as_token = \"\"; # fill in after registration\n        hs_token = \"\"; # fill in after registration\n      };\n\n      bridge = {\n        # command_prefix = \"!simplex\";\n\n        # When owner is set, permissions are auto-configured. Otherwise set manually:\n        # permissions = {\n        #   \"*\" = \"block\";\n        #   \"@alice:example.com\" = \"admin\";\n        #   \"@bob:example.com\" = \"user\";    # can use but not admin\n        #   \"example.com\" = \"relay\";         # whole domain gets relay access\n        # };\n      };\n\n      # Network-specific config for the SimpleX connector.\n      network = {\n        # Go template for ghost display names.\n        # displayname_template = \"{{.DisplayName}} (SimpleX)\";\n\n        # Path to simplex-chat binary (auto-set from simplexChatPackage).\n        # simplex_binary = \"/path/to/simplex-chat\";\n\n        # File folder (auto-set from filesFolder option).\n        # files_folder = \"/path/to/files\";\n      };\n    };\n  };\n}\n```\n\n### Options reference\n\n| Option | Type | Default | Description |\n|--------|------|---------|-------------|\n| `enable` | bool | `false` | Enable the bridge and companion simplex-chat service |\n| `owner` | string or null | `null` | Matrix ID of sole user; blocks everyone else when set |\n| `package` | package | flake default | The mautrix-simplex package |\n| `simplexChatPackage` | package | bundled binary | The simplex-chat package for the companion service |\n| `dataDir` | string | `/var/lib/mautrix-simplex` | Base directory for all state |\n| `simplexChatPort` | port | `5225` | WebSocket API port for simplex-chat |\n| `filesFolder` | string | `${dataDir}/files` | simplex-chat file storage directory |\n| `registerToSynapse` | bool | auto | Auto-register appservice with Synapse |\n| `serviceDependencies` | list of strings | auto | Systemd units to wait for |\n| `settings` | attrset | _(see above)_ | Full bridge config (converted to YAML) |\n\nThe module automatically:\n- Runs a companion simplex-chat systemd service (localhost-only WebSocket)\n- Manages state directories and file permissions\n- Uses DynamicUser when dataDir is under `/var/lib/`, static user otherwise\n- Generates the appservice registration file\n\n## Beeper\n\nThe bridge has `BeeperBridgeType: \"simplex\"` built in and supports Beeper's websocket mode natively. You need [bbctl](https://github.com/beeper/bridge-manager) (Beeper bridge manager) to register and connect the bridge.\n\nSelf-hosted bridges on Beeper are **free** and don't count against account limits.\n\n### Manual setup\n\n1. Install bbctl and log in:\n\n```bash\nbbctl login\n```\n\n2. Generate a bridgev2 config for the bridge:\n\n```bash\nbbctl config --type bridgev2 sh-simplex\n```\n\n3. Edit the generated config to add network settings (simplex_binary, files_folder, etc.) and ensure websocket mode is enabled:\n\n```yaml\nhomeserver:\n  websocket: true\n  address: https://matrix.beeper.com\nnetwork:\n  simplex_binary: simplex-chat\n  files_folder: /path/to/files\n```\n\n4. Start simplex-chat alongside the bridge:\n\n```bash\nsimplex-chat -p 5225 -d /path/to/simplex-data --files-folder /path/to/files --temp-folder /path/to/files/tmp\n```\n\n5. Run the bridge with the generated config:\n\n```bash\n./mautrix-simplex -c config.yaml\n```\n\n6. Log in via the bridge bot DM in Beeper using the `login` command.\n\n### NixOS + Beeper\n\nThe flake includes `bbctl` as a package. Here's a full NixOS config for running mautrix-simplex with Beeper:\n\n```nix\n{\n  inputs.mautrix-simplex.url = \"github:tricked-dev/mautrix-simplex\";\n\n  imports = [ inputs.mautrix-simplex.nixosModules.default ];\n\n  # bbctl available as a package\n  environment.systemPackages = [\n    inputs.mautrix-simplex.packages.${system}.bbctl\n  ];\n\n  services.mautrix-simplex = {\n    enable = true;\n    owner = \"@you:beeper.local\"; # restrict to your Beeper account\n    dataDir = \"/var/lib/selfhosted/matrix/mautrix-simplex\"; # optional, custom base path\n\n    settings = {\n      homeserver = {\n        websocket = true;\n        address = \"https://matrix.beeper.com\";\n        domain = \"beeper.local\";\n      };\n    };\n  };\n}\n```\n\nBefore starting the services, run `bbctl login` and `bbctl config --type bridgev2 sh-simplex` to generate the registration and tokens, then add the `as_token` and `hs_token` to your settings.\n\n### Setup steps on NixOS\n\n```bash\n# 1. Install bbctl (available via the flake)\nnix shell github:tricked-dev/mautrix-simplex#bbctl\n\n# 2. Authenticate with Beeper\nbbctl login\n\n# 3. Register the bridge\nbbctl config --type bridgev2 sh-simplex\n\n# 4. Copy the as_token and hs_token from the generated config into your\n#    NixOS services.mautrix-simplex.settings.appservice config\n\n# 5. Rebuild NixOS\nsudo nixos-rebuild switch\n```\n\n## Limitations\n\n- **Single writer**: Each simplex-chat database can only be used by one bridge instance at a time\n- **Reactions**: SimpleX only supports 8 specific emoji reactions (`👍👎😀😂😢❤🚀✅`); other emoji are silently dropped\n- **No typing indicators**: SimpleX doesn't expose typing status via the chat API\n- **No presence**: Presence/online status is not bridged\n- **No read receipts**: Read receipt bridging is not yet implemented\n\n## License\n\nAGPL-3.0-or-later\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftricked-dev%2Fmautrix-simplex","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftricked-dev%2Fmautrix-simplex","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftricked-dev%2Fmautrix-simplex/lists"}