Skip to content

Commit

Permalink
Update changelog and readme
Browse files Browse the repository at this point in the history
  • Loading branch information
tulir committed Jan 21, 2024
1 parent 936cc36 commit 41ccf6f
Show file tree
Hide file tree
Showing 2 changed files with 48 additions and 3 deletions.
8 changes: 8 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
# v0.10.0 (unreleased)

* Added option to configure the device name that bridges expose to the remote
network using `--param device_name="..."`
* Added support for new Meta bridge (Instagram/Facebook).
* Added support for the new BlueBubbles connector on the old iMessage bridge.
* Fixed quoting issue in Signal bridge config template.

# v0.9.1 (2023-12-21)

* Added support for new iMessage bridge.
Expand Down
43 changes: 40 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,9 +51,7 @@ After installing relevant dependencies:
* `<name>` should start with `sh-` and consist of a-z, 0-9 and -.
* If `<name>` contains the bridge type, it will be automatically detected.
Otherwise pass the type with `--type <type>`.
* Currently supported types: `discord`, `whatsapp`, `slack`, `heisenbridge`,
`gmessages`, `telegram`, `facebook`, `instagram`, `googlechat`, `twitter`,
`signal`, `linkedin`, `imessage` (legacy), `imessagego` (new)
* See the table below for supported official bridges.
* The bridge will be installed to `~/.local/share/bbctl`. You can change the
directory in the config file at `~/.config/bbctl.json`.
4. For now, you'll have to configure the bridge by sending a DM to the bridge
Expand All @@ -73,6 +71,45 @@ active somewhere (tmux is a good option). In the future, a service mode will be
added where the bridge is registered as a systemd or launchd service to be
started automatically by the OS.

#### Official bridge list
When using `bbctl run` or `bbctl config` and the provided `<name>` contains one
of the identifiers (second column) listed below, bbctl will automatically guess
that type. A substring match is sufficient, e.g. `sh-mywhatsappbridge` will
match `whatsapp`. The first listed identifier is the "primary" one that can be
used with the `--type` flag.

| Bridge | Identifier |
|----------------------|--------------------------------------|
| [mautrix-telegram] | telegram |
| [mautrix-whatsapp] | whatsapp |
| [mautrix-signal] | signal |
| [mautrix-discord] | discord |
| [mautrix-slack] | slack |
| [mautrix-gmessages] | gmessages, googlemessages, rcs, sms |
|[mautrix-meta] | meta, instagramgo, facebookgo |
| [mautrix-facebook] | facebook |
| [mautrix-instagram] | instagram |
| [mautrix-googlechat] | googlechat, gchat |
| [mautrix-twitter] | twitter |
| [beeper-imessage] | imessagego |
| [heisenbridge] | heisenbridge, irc |

† indicates a new/experimental bridge that will likely have bugs

[mautrix-telegram]: https://github.com/mautrix/telegram
[mautrix-whatsapp]: https://github.com/mautrix/whatsapp
[mautrix-signal]: https://github.com/mautrix/signal
[mautrix-discord]: https://github.com/mautrix/discord
[mautrix-slack]: https://github.com/mautrix/slack
[mautrix-gmessages]: https://github.com/mautrix/gmessages
[mautrix-meta]: https://github.com/mautrix/meta
[mautrix-facebook]: https://github.com/mautrix/facebook
[mautrix-instagram]: https://github.com/mautrix/instagram
[mautrix-googlechat]: https://github.com/mautrix/googlechat
[mautrix-twitter]: https://github.com/mautrix/twitter
[beeper-imessage]: https://github.com/beeper/imessage
[heisenbridge]: https://github.com/hifi/heisenbridge

### 3rd party bridges
3. Run `bbctl register <name>` to generate an appservice registration file.
* `<name>` is a short name for the bridge (a-z, 0-9, -). The name should
Expand Down

0 comments on commit 41ccf6f

Please sign in to comment.