2024-10-22 17:36:24 +00:00
|
|
|
# Setting up Matrix SMS bridging (optional)
|
2020-05-23 11:14:24 +00:00
|
|
|
|
2020-11-23 11:30:39 +00:00
|
|
|
The playbook can install and configure [matrix-sms-bridge](https://github.com/benkuly/matrix-sms-bridge) for you.
|
2020-05-23 11:14:24 +00:00
|
|
|
|
|
|
|
|
See the project page to learn what it does and why it might be useful to you.
|
|
|
|
|
|
2020-11-25 14:39:14 +00:00
|
|
|
**The bridge uses [android-sms-gateway-server](https://github.com/RebekkaMa/android-sms-gateway-server). You need to configure it first.**
|
2020-06-02 06:39:30 +00:00
|
|
|
|
2024-10-12 11:48:24 +00:00
|
|
|
## Adjusting the playbook configuration
|
2020-05-23 11:14:24 +00:00
|
|
|
|
2024-10-17 13:17:56 +00:00
|
|
|
To enable the bridge, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:
|
2020-05-23 11:14:24 +00:00
|
|
|
|
|
|
|
|
```yaml
|
|
|
|
|
matrix_sms_bridge_enabled: true
|
2020-11-23 11:30:39 +00:00
|
|
|
|
2024-10-15 17:24:34 +00:00
|
|
|
# (optional but recommended) a room ID to a default room
|
2024-10-12 11:48:24 +00:00
|
|
|
matrix_sms_bridge_default_room: ""
|
2020-11-23 11:30:39 +00:00
|
|
|
|
|
|
|
|
# (optional but recommended) configure your server location
|
|
|
|
|
matrix_sms_bridge_default_region: DE
|
|
|
|
|
matrix_sms_bridge_default_timezone: Europe/Berlin
|
|
|
|
|
|
|
|
|
|
# Settings to connect to android-sms-gateway-server
|
|
|
|
|
matrix_sms_bridge_provider_android_baseurl: https://192.168.24.24:9090
|
|
|
|
|
matrix_sms_bridge_provider_android_username: admin
|
|
|
|
|
matrix_sms_bridge_provider_android_password: supeSecretPassword
|
|
|
|
|
|
2020-11-23 11:38:17 +00:00
|
|
|
# (optional) if your android-sms-gateway-server uses a self signed vertificate, the bridge needs a "truststore". This can be the certificate itself.
|
2020-11-23 11:30:39 +00:00
|
|
|
matrix_sms_bridge_provider_android_truststore_local_path: android-sms-gateway-server.p12
|
|
|
|
|
matrix_sms_bridge_provider_android_truststore_password: 123
|
|
|
|
|
|
2020-05-23 11:14:24 +00:00
|
|
|
```
|
|
|
|
|
|
2024-10-12 18:03:46 +00:00
|
|
|
## Installing
|
|
|
|
|
|
|
|
|
|
After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all`
|
2020-05-23 11:14:24 +00:00
|
|
|
|
|
|
|
|
## Usage
|
|
|
|
|
|
|
|
|
|
Read the [user guide](https://github.com/benkuly/matrix-sms-bridge/blob/master/README.md#user-guide) to see how this bridge works.
|
