Skip to content

Commit

Permalink
Update official bridge instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
tulir committed Jul 29, 2023
1 parent 43d9929 commit ef1b4bc
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,13 +57,13 @@ Deleting a bridge will permanently erase all traces of it from the Beeper server
(e.g. any rooms and ghost users it created).

### Official bridges
3. Run `bbctl config <name>` to generate a config file.
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`
4. Install the bridge software, then run the command that `bbctl config`
outputs to start the bridge.
5. For now, you'll have to configure the bridge by sending a DM to the bridge
* 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 ef1b4bc

Please sign in to comment.