2024-10-22 19:36:24 +02:00
# Setting up Go Skype Bridge bridging (optional)
2022-06-12 23:29:43 +02:00
2024-10-18 19:32:11 +02:00
The playbook can install and configure [go-skype-bridge ](https://github.com/kelaresg/go-skype-bridge ) for you.
2022-06-12 23:29:43 +02:00
See the project page to learn what it does and why it might be useful to you.
2024-10-12 13:48:24 +02:00
## Adjusting the playbook configuration
2022-06-12 23:29:43 +02:00
2024-10-17 15:17:56 +02:00
To enable the [Skype ](https://www.skype.com/ ) bridge, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:
2022-06-12 23:29:43 +02:00
```yaml
matrix_go_skype_bridge_enabled: true
```
2024-10-12 20:03:46 +02:00
## Installing
2024-12-01 08:42:30 +01:00
After configuring the playbook, run it with [playbook tags ](playbook-tags.md ) as below:
<!-- NOTE: let this conservative command run (instead of install - all) to make it clear that failure of the command means something is clearly broken. -->
```sh
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start
```
**Notes**:
- The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account.
Edit installing instructions (#3844)
* Replace "just run-tags install-all/setup-all,start" with "just install-all/setup-all"
Thanks to the tip by Slavi that the overhead of ensure-matrix-users-created is negligible.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Edit installing instructions
- Move the anchor links to docs/just.md
- Add note about running "ensure-matrix-users-created" tags, if ansible-playbook's tags not "setup-all,ensure-matrix-users-created,start", ie. either "setup-all,start", "setup-email2matrix,start", "setup-aux-files,setup-corporal,start", or "setup-matrix-user-verification-service,start"
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update descriptions about installation
- Introduce the most conservative and stable raw ansible-playbook command.
- Introduce the just commands on installing.md and maintenance-upgrading-services.md, not on quick-start.md, since it is too early for quick start guide readers who are just starting to climb learning curve to use the shortcuts.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/configuring-playbook-etherpad.md: remove the note about ensure-matrix-users-created
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
---------
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
Co-authored-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-12-01 16:04:54 +01:00
- The shortcut commands with the [`just` program ](just.md ) are also available: `just install-all` or `just setup-all`
2024-12-01 08:42:30 +01:00
2024-12-02 06:29:44 +01:00
`just install-all` is useful for maintaining your setup quickly ([2x-5x faster](../CHANGELOG.md#2x-5x-performance-improvements-in-playbook-runtime) than `just setup-all` ) when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all` , or these components will still remain installed.
2022-06-12 23:29:43 +02:00
## Usage
2024-10-18 19:32:11 +02:00
Once the bot is enabled, you need to start a chat with `Skype bridge bot` with the handle `@skypebridgebot:example.com` (where `example.com` is your base domain, not the `matrix.` domain).
2022-06-12 23:29:43 +02:00
Send `help` to the bot to see the commands available.