matrix-docker-ansible-deploy/docs/configuring-playbook-bridge-go-skype-bridge.md

53 lines
3.4 KiB
Markdown
Raw Normal View History

# Setting up Go Skype Bridge bridging (optional)
Update docs for mautrix bridges (follow-up) (#3924) * Update docs/configuring-playbook-bridge-mautrix-telegram.md - Add a link to the official documentation on authentication - Create subsections in the section "Usage" - Update the usage based on https://github.com/mautrix/docs/blob/d33701428d36f9a4867cbd3199e525c5455e8d44/bridges/python/telegram/authentication.md Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook-bridge-mautrix-twitter.md - Remove a duplicated "optional" label - Replace the instruction with a link to the official documentation on authentication Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook-bridge-appservice-kakaotalk.md - Adopt a common introduction - Move the warning message down Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook-bridge-mautrix-discord.md As our instruction on usage has been outdated compared to the latest one (cf. https://github.com/mautrix/docs/blob/d33701428d36f9a4867cbd3199e525c5455e8d44/bridges/go/discord/authentication.md), let alone confusing in the first place as our instruction on logging in and bridging have been mixed, this commit updates our instruction based on the latest official one. Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook-bridge-mautrix-gmessages.md: add a link to the official documentation on authentication Based on https://github.com/mautrix/docs/blob/d33701428d36f9a4867cbd3199e525c5455e8d44/bridges/go/gmessages/authentication.md Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs for mautrix-meta bridges: add links to the official documentation on authentication Based on https://github.com/mautrix/docs/blob/d33701428d36f9a4867cbd3199e525c5455e8d44/bridges/go/meta/authentication.md Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook-bridge-mautrix-signal.md: add a link to the official documentation on authentication Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook-bridge-mautrix-slack.md Based on https://github.com/mautrix/docs/blame/d33701428d36f9a4867cbd3199e525c5455e8d44/bridges/go/slack/authentication.md The instruction has been obsolete since https://github.com/mautrix/docs/commit/25b4006035d2cff7a8abcbc2ba1d8c1a10937674 Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook-bridge-mautrix-googlechat.md Based on https://github.com/mautrix/docs/blob/d33701428d36f9a4867cbd3199e525c5455e8d44/bridges/python/googlechat/authentication.md Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook-bridge-mautrix-bridges.md: add information about troubleshooting Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs for mautrix bridges: add descriptions for each mautrix bridge about the bridges behavior after logging in Based on https://github.com/mautrix/docs/tree/d33701428d36f9a4867cbd3199e525c5455e8d44 Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs for mautrix bridges: add instruction for sending "help" to the bot to the common guide Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook-bridge-mautrix-hangouts.md: adopt a common description about usage Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook-bridge-mautrix-whatsapp.md - Update the note about linked devices that they will be logged out if the phone is not used over two weeks: the note has been obsolete since https://github.com/mautrix/docs/commit/0860109d05defdb952eaf872a6c24b30aef5a76d - Adopt a common description about usage Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs for mautrix bridges: fix the internal anchor link Regression by 4b2e066a6159d8a368cfbab3d46e91dca3549bb4 Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook-bridge-mautrix-bridges.md: add a note about the official docs Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook-bridge-go-skype-bridge.md: adopt the common description As the bridge was created based on mautrix-whatsapp, this commit adopts the common descriptions for mautrix bridges and ones based on them such as matrix-appservice-kakaotalk and beeper-linkedin 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>
2025-01-10 16:36:27 +09:00
The playbook can install and configure [go-skype-bridge](https://github.com/kelaresg/go-skype-bridge) for you, for bridging to [Skype](https://www.skype.com/). This bridge was created based on [mautrix-whatsapp](https://github.com/mautrix/whatsapp) and can be configured in a similar way to it.
See the project's [documentation](https://github.com/kelaresg/go-skype-bridge/blob/master/README.md) to learn what it does and why it might be useful to you.
Update docs for mautrix bridges (follow-up) (#3924) * Update docs/configuring-playbook-bridge-mautrix-telegram.md - Add a link to the official documentation on authentication - Create subsections in the section "Usage" - Update the usage based on https://github.com/mautrix/docs/blob/d33701428d36f9a4867cbd3199e525c5455e8d44/bridges/python/telegram/authentication.md Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook-bridge-mautrix-twitter.md - Remove a duplicated "optional" label - Replace the instruction with a link to the official documentation on authentication Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook-bridge-appservice-kakaotalk.md - Adopt a common introduction - Move the warning message down Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook-bridge-mautrix-discord.md As our instruction on usage has been outdated compared to the latest one (cf. https://github.com/mautrix/docs/blob/d33701428d36f9a4867cbd3199e525c5455e8d44/bridges/go/discord/authentication.md), let alone confusing in the first place as our instruction on logging in and bridging have been mixed, this commit updates our instruction based on the latest official one. Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook-bridge-mautrix-gmessages.md: add a link to the official documentation on authentication Based on https://github.com/mautrix/docs/blob/d33701428d36f9a4867cbd3199e525c5455e8d44/bridges/go/gmessages/authentication.md Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs for mautrix-meta bridges: add links to the official documentation on authentication Based on https://github.com/mautrix/docs/blob/d33701428d36f9a4867cbd3199e525c5455e8d44/bridges/go/meta/authentication.md Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook-bridge-mautrix-signal.md: add a link to the official documentation on authentication Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook-bridge-mautrix-slack.md Based on https://github.com/mautrix/docs/blame/d33701428d36f9a4867cbd3199e525c5455e8d44/bridges/go/slack/authentication.md The instruction has been obsolete since https://github.com/mautrix/docs/commit/25b4006035d2cff7a8abcbc2ba1d8c1a10937674 Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook-bridge-mautrix-googlechat.md Based on https://github.com/mautrix/docs/blob/d33701428d36f9a4867cbd3199e525c5455e8d44/bridges/python/googlechat/authentication.md Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook-bridge-mautrix-bridges.md: add information about troubleshooting Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs for mautrix bridges: add descriptions for each mautrix bridge about the bridges behavior after logging in Based on https://github.com/mautrix/docs/tree/d33701428d36f9a4867cbd3199e525c5455e8d44 Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs for mautrix bridges: add instruction for sending "help" to the bot to the common guide Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook-bridge-mautrix-hangouts.md: adopt a common description about usage Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook-bridge-mautrix-whatsapp.md - Update the note about linked devices that they will be logged out if the phone is not used over two weeks: the note has been obsolete since https://github.com/mautrix/docs/commit/0860109d05defdb952eaf872a6c24b30aef5a76d - Adopt a common description about usage Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs for mautrix bridges: fix the internal anchor link Regression by 4b2e066a6159d8a368cfbab3d46e91dca3549bb4 Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook-bridge-mautrix-bridges.md: add a note about the official docs Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook-bridge-go-skype-bridge.md: adopt the common description As the bridge was created based on mautrix-whatsapp, this commit adopts the common descriptions for mautrix bridges and ones based on them such as matrix-appservice-kakaotalk and beeper-linkedin 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>
2025-01-10 16:36:27 +09:00
## Prerequisite (optional)
### Enable Shared Secret Auth
If you want to set up [Double Puppeting](https://docs.mau.fi/bridges/general/double-puppeting.html) (hint: you most likely do) for this bridge automatically, you need to have enabled [Shared Secret Auth](configuring-playbook-shared-secret-auth.md) for this playbook.
See [this section](configuring-playbook-bridge-mautrix-bridges.md#set-up-double-puppeting-optional) on the [common guide for configuring mautrix bridges](configuring-playbook-bridge-mautrix-bridges.md) for details about setting up Double Puppeting.
**Note**: double puppeting with the Shared Secret Auth works at the time of writing, but is deprecated and will stop working in the future.
## Adjusting the playbook configuration
Update docs for mautrix bridges (follow-up) (#3924) * Update docs/configuring-playbook-bridge-mautrix-telegram.md - Add a link to the official documentation on authentication - Create subsections in the section "Usage" - Update the usage based on https://github.com/mautrix/docs/blob/d33701428d36f9a4867cbd3199e525c5455e8d44/bridges/python/telegram/authentication.md Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook-bridge-mautrix-twitter.md - Remove a duplicated "optional" label - Replace the instruction with a link to the official documentation on authentication Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook-bridge-appservice-kakaotalk.md - Adopt a common introduction - Move the warning message down Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook-bridge-mautrix-discord.md As our instruction on usage has been outdated compared to the latest one (cf. https://github.com/mautrix/docs/blob/d33701428d36f9a4867cbd3199e525c5455e8d44/bridges/go/discord/authentication.md), let alone confusing in the first place as our instruction on logging in and bridging have been mixed, this commit updates our instruction based on the latest official one. Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook-bridge-mautrix-gmessages.md: add a link to the official documentation on authentication Based on https://github.com/mautrix/docs/blob/d33701428d36f9a4867cbd3199e525c5455e8d44/bridges/go/gmessages/authentication.md Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs for mautrix-meta bridges: add links to the official documentation on authentication Based on https://github.com/mautrix/docs/blob/d33701428d36f9a4867cbd3199e525c5455e8d44/bridges/go/meta/authentication.md Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook-bridge-mautrix-signal.md: add a link to the official documentation on authentication Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook-bridge-mautrix-slack.md Based on https://github.com/mautrix/docs/blame/d33701428d36f9a4867cbd3199e525c5455e8d44/bridges/go/slack/authentication.md The instruction has been obsolete since https://github.com/mautrix/docs/commit/25b4006035d2cff7a8abcbc2ba1d8c1a10937674 Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook-bridge-mautrix-googlechat.md Based on https://github.com/mautrix/docs/blob/d33701428d36f9a4867cbd3199e525c5455e8d44/bridges/python/googlechat/authentication.md Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook-bridge-mautrix-bridges.md: add information about troubleshooting Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs for mautrix bridges: add descriptions for each mautrix bridge about the bridges behavior after logging in Based on https://github.com/mautrix/docs/tree/d33701428d36f9a4867cbd3199e525c5455e8d44 Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs for mautrix bridges: add instruction for sending "help" to the bot to the common guide Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook-bridge-mautrix-hangouts.md: adopt a common description about usage Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook-bridge-mautrix-whatsapp.md - Update the note about linked devices that they will be logged out if the phone is not used over two weeks: the note has been obsolete since https://github.com/mautrix/docs/commit/0860109d05defdb952eaf872a6c24b30aef5a76d - Adopt a common description about usage Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs for mautrix bridges: fix the internal anchor link Regression by 4b2e066a6159d8a368cfbab3d46e91dca3549bb4 Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook-bridge-mautrix-bridges.md: add a note about the official docs Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook-bridge-go-skype-bridge.md: adopt the common description As the bridge was created based on mautrix-whatsapp, this commit adopts the common descriptions for mautrix bridges and ones based on them such as matrix-appservice-kakaotalk and beeper-linkedin 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>
2025-01-10 16:36:27 +09:00
To enable the bridge, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:
```yaml
matrix_go_skype_bridge_enabled: true
```
Update docs for mautrix bridges (follow-up) (#3924) * Update docs/configuring-playbook-bridge-mautrix-telegram.md - Add a link to the official documentation on authentication - Create subsections in the section "Usage" - Update the usage based on https://github.com/mautrix/docs/blob/d33701428d36f9a4867cbd3199e525c5455e8d44/bridges/python/telegram/authentication.md Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook-bridge-mautrix-twitter.md - Remove a duplicated "optional" label - Replace the instruction with a link to the official documentation on authentication Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook-bridge-appservice-kakaotalk.md - Adopt a common introduction - Move the warning message down Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook-bridge-mautrix-discord.md As our instruction on usage has been outdated compared to the latest one (cf. https://github.com/mautrix/docs/blob/d33701428d36f9a4867cbd3199e525c5455e8d44/bridges/go/discord/authentication.md), let alone confusing in the first place as our instruction on logging in and bridging have been mixed, this commit updates our instruction based on the latest official one. Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook-bridge-mautrix-gmessages.md: add a link to the official documentation on authentication Based on https://github.com/mautrix/docs/blob/d33701428d36f9a4867cbd3199e525c5455e8d44/bridges/go/gmessages/authentication.md Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs for mautrix-meta bridges: add links to the official documentation on authentication Based on https://github.com/mautrix/docs/blob/d33701428d36f9a4867cbd3199e525c5455e8d44/bridges/go/meta/authentication.md Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook-bridge-mautrix-signal.md: add a link to the official documentation on authentication Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook-bridge-mautrix-slack.md Based on https://github.com/mautrix/docs/blame/d33701428d36f9a4867cbd3199e525c5455e8d44/bridges/go/slack/authentication.md The instruction has been obsolete since https://github.com/mautrix/docs/commit/25b4006035d2cff7a8abcbc2ba1d8c1a10937674 Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook-bridge-mautrix-googlechat.md Based on https://github.com/mautrix/docs/blob/d33701428d36f9a4867cbd3199e525c5455e8d44/bridges/python/googlechat/authentication.md Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook-bridge-mautrix-bridges.md: add information about troubleshooting Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs for mautrix bridges: add descriptions for each mautrix bridge about the bridges behavior after logging in Based on https://github.com/mautrix/docs/tree/d33701428d36f9a4867cbd3199e525c5455e8d44 Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs for mautrix bridges: add instruction for sending "help" to the bot to the common guide Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook-bridge-mautrix-hangouts.md: adopt a common description about usage Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook-bridge-mautrix-whatsapp.md - Update the note about linked devices that they will be logged out if the phone is not used over two weeks: the note has been obsolete since https://github.com/mautrix/docs/commit/0860109d05defdb952eaf872a6c24b30aef5a76d - Adopt a common description about usage Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs for mautrix bridges: fix the internal anchor link Regression by 4b2e066a6159d8a368cfbab3d46e91dca3549bb4 Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook-bridge-mautrix-bridges.md: add a note about the official docs Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook-bridge-go-skype-bridge.md: adopt the common description As the bridge was created based on mautrix-whatsapp, this commit adopts the common descriptions for mautrix bridges and ones based on them such as matrix-appservice-kakaotalk and beeper-linkedin 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>
2025-01-10 16:36:27 +09:00
### Extending the configuration
There are some additional things you may wish to configure about the bridge.
See [this section](configuring-playbook-bridge-mautrix-bridges.md#extending-the-configuration) on the [common guide for configuring mautrix bridges](configuring-playbook-bridge-mautrix-bridges.md) for details about variables that you can customize and the bridge's default configuration, including [bridge permissions](configuring-playbook-bridge-mautrix-bridges.md#configure-bridge-permissions-optional), [encryption support](configuring-playbook-bridge-mautrix-bridges.md#enable-encryption-optional), [relay mode](configuring-playbook-bridge-mautrix-bridges.md#enable-relay-mode-optional), [bot's username](configuring-playbook-bridge-mautrix-bridges.md#set-the-bots-username-optional), etc.
**Note**: when following the guide to configure the bridge, make sure to replace `_mautrix_SERVICENAME_` in the variable names with `_go_skype_bridge_`.
## Installing
Edit descriptions about installation of components (#3842) * Replace installation command shortcut for the "just" program with the most conservative raw ansible-playbook command This commit replaces installation command shortcut ("recipe") for the "just" program with the raw ansible-playbook command, so that the shortcut will be added to it later. The command is so conservative that failure of the command will mean something is clearly broken. Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Add comments about using setup-all instead of install-all Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Add description about shortcut command with the "just" program to the ansible-playbook command with "setup-all" and "start" tags It also explains difference between "just install-all" and "just setup-all" recipes. The explanation is based on docs/playbook-tags.md Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update raw ansible-playbook command to have it do what "just install-all" or "just setup-all" does Since "just install-all" or "just setup-all" invokes "ensure-matrix-users-created" as well, it needs adding to the raw ansible-playbook command. Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Remove "ensure-matrix-users-created" from the raw ansible-playbook command which does not need it Also: update the "just" recipes accordingly. "just install-all" and "just setup-all" run "ensure-matrix-users-created" tag as well, therefore they need to be replaced with "run-tags" recipes to skip "ensure-matrix-users-created" Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook-etherpad.md: add ensure-matrix-users-created to the raw ansible-playbook Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Add description about "ensure-matrix-users-created" and create a list with description about shortcut commands with "just" This commit also fixes list item capitalization and punctuation. Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Add notes bullet lists Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook-matrix-corporal.md and docs/configuring-playbook-email2matrix.md: adopt common instructions Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Replace "run the installation command" with "run the playbook with tags" Now that shortcut commands for the "just" program are displayed along with the existing "installation command", this commit replaces "run the installation command" with "run the playbook with tags" in order to prevent misunderstanding and confusion. Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Add notes about changing passwords of users specified on vars.yml Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook-synapse-admin.md: add the playbook command and just recipes Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Remove redundant blank lines Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook-alertmanager-receiver.md: remove the direction to proceed to Usage Such a kind of direction is not used on other documentation, so it should be fine to just remove it. Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/importing-synapse-media-store.md: code block for ansible-playbook 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:42:30 +09: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.
- The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`
Edit descriptions about installation of components (#3842) * Replace installation command shortcut for the "just" program with the most conservative raw ansible-playbook command This commit replaces installation command shortcut ("recipe") for the "just" program with the raw ansible-playbook command, so that the shortcut will be added to it later. The command is so conservative that failure of the command will mean something is clearly broken. Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Add comments about using setup-all instead of install-all Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Add description about shortcut command with the "just" program to the ansible-playbook command with "setup-all" and "start" tags It also explains difference between "just install-all" and "just setup-all" recipes. The explanation is based on docs/playbook-tags.md Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update raw ansible-playbook command to have it do what "just install-all" or "just setup-all" does Since "just install-all" or "just setup-all" invokes "ensure-matrix-users-created" as well, it needs adding to the raw ansible-playbook command. Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Remove "ensure-matrix-users-created" from the raw ansible-playbook command which does not need it Also: update the "just" recipes accordingly. "just install-all" and "just setup-all" run "ensure-matrix-users-created" tag as well, therefore they need to be replaced with "run-tags" recipes to skip "ensure-matrix-users-created" Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook-etherpad.md: add ensure-matrix-users-created to the raw ansible-playbook Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Add description about "ensure-matrix-users-created" and create a list with description about shortcut commands with "just" This commit also fixes list item capitalization and punctuation. Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Add notes bullet lists Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook-matrix-corporal.md and docs/configuring-playbook-email2matrix.md: adopt common instructions Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Replace "run the installation command" with "run the playbook with tags" Now that shortcut commands for the "just" program are displayed along with the existing "installation command", this commit replaces "run the installation command" with "run the playbook with tags" in order to prevent misunderstanding and confusion. Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Add notes about changing passwords of users specified on vars.yml Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook-synapse-admin.md: add the playbook command and just recipes Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Remove redundant blank lines Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook-alertmanager-receiver.md: remove the direction to proceed to Usage Such a kind of direction is not used on other documentation, so it should be fine to just remove it. Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/importing-synapse-media-store.md: code block for ansible-playbook 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:42:30 +09: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.
## Usage
Update docs for mautrix bridges (follow-up) (#3924) * Update docs/configuring-playbook-bridge-mautrix-telegram.md - Add a link to the official documentation on authentication - Create subsections in the section "Usage" - Update the usage based on https://github.com/mautrix/docs/blob/d33701428d36f9a4867cbd3199e525c5455e8d44/bridges/python/telegram/authentication.md Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook-bridge-mautrix-twitter.md - Remove a duplicated "optional" label - Replace the instruction with a link to the official documentation on authentication Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook-bridge-appservice-kakaotalk.md - Adopt a common introduction - Move the warning message down Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook-bridge-mautrix-discord.md As our instruction on usage has been outdated compared to the latest one (cf. https://github.com/mautrix/docs/blob/d33701428d36f9a4867cbd3199e525c5455e8d44/bridges/go/discord/authentication.md), let alone confusing in the first place as our instruction on logging in and bridging have been mixed, this commit updates our instruction based on the latest official one. Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook-bridge-mautrix-gmessages.md: add a link to the official documentation on authentication Based on https://github.com/mautrix/docs/blob/d33701428d36f9a4867cbd3199e525c5455e8d44/bridges/go/gmessages/authentication.md Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs for mautrix-meta bridges: add links to the official documentation on authentication Based on https://github.com/mautrix/docs/blob/d33701428d36f9a4867cbd3199e525c5455e8d44/bridges/go/meta/authentication.md Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook-bridge-mautrix-signal.md: add a link to the official documentation on authentication Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook-bridge-mautrix-slack.md Based on https://github.com/mautrix/docs/blame/d33701428d36f9a4867cbd3199e525c5455e8d44/bridges/go/slack/authentication.md The instruction has been obsolete since https://github.com/mautrix/docs/commit/25b4006035d2cff7a8abcbc2ba1d8c1a10937674 Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook-bridge-mautrix-googlechat.md Based on https://github.com/mautrix/docs/blob/d33701428d36f9a4867cbd3199e525c5455e8d44/bridges/python/googlechat/authentication.md Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook-bridge-mautrix-bridges.md: add information about troubleshooting Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs for mautrix bridges: add descriptions for each mautrix bridge about the bridges behavior after logging in Based on https://github.com/mautrix/docs/tree/d33701428d36f9a4867cbd3199e525c5455e8d44 Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs for mautrix bridges: add instruction for sending "help" to the bot to the common guide Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook-bridge-mautrix-hangouts.md: adopt a common description about usage Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook-bridge-mautrix-whatsapp.md - Update the note about linked devices that they will be logged out if the phone is not used over two weeks: the note has been obsolete since https://github.com/mautrix/docs/commit/0860109d05defdb952eaf872a6c24b30aef5a76d - Adopt a common description about usage Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs for mautrix bridges: fix the internal anchor link Regression by 4b2e066a6159d8a368cfbab3d46e91dca3549bb4 Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook-bridge-mautrix-bridges.md: add a note about the official docs Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook-bridge-go-skype-bridge.md: adopt the common description As the bridge was created based on mautrix-whatsapp, this commit adopts the common descriptions for mautrix bridges and ones based on them such as matrix-appservice-kakaotalk and beeper-linkedin 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>
2025-01-10 16:36:27 +09:00
To use the bridge, you need to start a chat with `@skypebridgebot:example.com` (where `example.com` is your base domain, not the `matrix.` domain).