Skip to content

Commit

Permalink
Move official bridge usage above 3rd party bridges
Browse files Browse the repository at this point in the history
  • Loading branch information
tulir committed Jul 29, 2023
1 parent 810b226 commit 945581c
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,18 @@ support room.
Windows is not supported natively, please use WSL.
2. Log into your Beeper account with `bbctl login`.

### Official bridges
3. Run `bbctl run <name>` to run the bridge.
* `<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`, `imessage`, `heisenbridge`, `gmessages`
* 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
bot. Configuring self-hosted bridges through the chat networks dialog will
be available in the future.

### 3rd party bridges
3. Run `bbctl register -a <address> <name>` to generate an appservice
registration file.
Expand All @@ -57,15 +69,3 @@ you want to automate fetching the homeserver URL.
If you don't want a self-hosted bridge anymore, you can delete it using `bbctl delete <name>`.
Deleting a bridge will permanently erase all traces of it from the Beeper servers
(e.g. any rooms and ghost users it created).

### Official bridges
3. Run `bbctl run <name>` to run the bridge.
* `<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`, `imessage`, `heisenbridge`, `gmessages`
* 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
bot. Configuring self-hosted bridges through the chat networks dialog will
be available in the future.

0 comments on commit 945581c

Please sign in to comment.