mirror of
https://github.com/spantaleev/matrix-docker-ansible-deploy.git
synced 2025-01-24 08:54:53 +01:00
Merge pull request #3597 from luixxiul/fix
Use common sentences on documentation regarding installation
This commit is contained in:
Slavi Pantaleev
GitHub
commit
74b80d46a5
@ -63,7 +63,7 @@ Steps 3 and 4 need to be done for each new room you'd like the bot to deliver al
|
||||
|
||||
## Installation
|
||||
|
||||
Now that you've [prepared the bot account and room](#account-and-room-preparation) and have [configured the playbook](#configuration), you can re-run the [installation](./installing.md) process (`just install-all`).
|
||||
Now that you've [prepared the bot account and room](#account-and-room-preparation) and have [configured the playbook](#configuration), you can run the [installation](installing.md) command: `just install-all`
|
||||
|
||||
Then, you can proceed to [Usage](#usage).
|
||||
|
||||
|
||||
@ -14,4 +14,10 @@ To enable the Appservice Double Puppet service, add the following configuration
|
||||
matrix_appservice_double_puppet_enabled: true
|
||||
```
|
||||
|
||||
## Installing
|
||||
|
||||
After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all`
|
||||
|
||||
## Usage
|
||||
|
||||
When enabled, double puppeting will automatically be enabled for all bridges that support double puppeting via the appservice method.
|
||||
|
||||
@ -68,7 +68,7 @@ Check the [backup_borg role](https://github.com/mother-of-all-self-hosting/ansib
|
||||
|
||||
## Installing
|
||||
|
||||
After configuring the playbook, run the [installation](installing.md) command again:
|
||||
After configuring the playbook, run the [installation](installing.md) command:
|
||||
|
||||
```
|
||||
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start
|
||||
|
||||
@ -376,7 +376,7 @@ matrix_bot_baibot_config_initial_global_config_handler_image_generation: null
|
||||
|
||||
## Installing
|
||||
|
||||
After configuring the playbook, run the [installation](installing.md) command again:
|
||||
After configuring the playbook, run the [installation](installing.md) command:
|
||||
|
||||
```sh
|
||||
just run-tags install-all,ensure-matrix-users-created,start
|
||||
|
||||
@ -56,7 +56,7 @@ matrix_bot_buscarron_spamlist: [] # (optional) list of emails/domains/hosts (wit
|
||||
|
||||
## Installing
|
||||
|
||||
After configuring the playbook, run the [installation](installing.md) command again:
|
||||
After configuring the playbook, run the [installation](installing.md) command:
|
||||
|
||||
```sh
|
||||
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start
|
||||
|
||||
@ -57,7 +57,7 @@ You will need to get tokens for ChatGPT.
|
||||
|
||||
## 4. Installing
|
||||
|
||||
After configuring the playbook, run the [installation](installing.md) command again:
|
||||
After configuring the playbook, run the [installation](installing.md) command:
|
||||
|
||||
```sh
|
||||
ansible-playbook -i inventory/hosts setup.yml --tags=install-all,start
|
||||
|
||||
@ -31,7 +31,7 @@ matrix_bot_honoroit_roomid: "!yourRoomID:DOMAIN"
|
||||
|
||||
## Installing
|
||||
|
||||
After configuring the playbook, run the [installation](installing.md) command again:
|
||||
After configuring the playbook, run the [installation](installing.md) command:
|
||||
|
||||
```sh
|
||||
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start
|
||||
|
||||
@ -34,7 +34,7 @@ The bot account will be created automatically.
|
||||
|
||||
## Installing
|
||||
|
||||
After configuring the playbook, re-run the [installation](installing.md) command again: `just install-all` or `just setup-all`
|
||||
After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all`
|
||||
|
||||
## Usage
|
||||
|
||||
|
||||
@ -27,7 +27,7 @@ matrix_bot_matrix_reminder_bot_reminders_timezone: Europe/London
|
||||
|
||||
## Installing
|
||||
|
||||
After configuring the playbook, run the [installation](installing.md) command again:
|
||||
After configuring the playbook, run the [installation](installing.md) command:
|
||||
|
||||
```sh
|
||||
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start
|
||||
|
||||
@ -30,7 +30,7 @@ You can add multiple admins. The admin accounts are only used to access the maub
|
||||
|
||||
## Installing
|
||||
|
||||
After configuring the playbook, run the [installation](installing.md) command again (`just install-all`):
|
||||
After configuring the playbook, run the [installation](installing.md) command: `just install-all`
|
||||
|
||||
**Notes**:
|
||||
|
||||
|
||||
@ -54,7 +54,7 @@ See [Configuring DNS](configuring-dns.md).
|
||||
|
||||
## Installing
|
||||
|
||||
After configuring the playbook, run the [installation](installing.md) command again:
|
||||
After configuring the playbook, run the [installation](installing.md) command:
|
||||
|
||||
```sh
|
||||
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start
|
||||
|
||||
@ -60,4 +60,10 @@ matrix_appservice_irc_ircService_servers:
|
||||
lineLimit: 3
|
||||
```
|
||||
|
||||
## Installing
|
||||
|
||||
After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all`
|
||||
|
||||
## Usage
|
||||
|
||||
You then need to start a chat with `@irc_bot:YOUR_DOMAIN` (where `YOUR_DOMAIN` is your base domain, not the `matrix.` domain).
|
||||
|
||||
@ -17,7 +17,13 @@ matrix_appservice_kakaotalk_enabled: true
|
||||
|
||||
You may optionally wish to add some [Additional configuration](#additional-configuration), or to [prepare for double-puppeting](#set-up-double-puppeting) before the initial installation.
|
||||
|
||||
After adjusting your `vars.yml` file, re-run the playbook and restart all services: `ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start`
|
||||
## Installing
|
||||
|
||||
After configuring the playbook, run the [installation](installing.md) command:
|
||||
|
||||
```
|
||||
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start
|
||||
```
|
||||
|
||||
To make use of the Kakaotalk bridge, see [Usage](#usage) below.
|
||||
|
||||
|
||||
@ -33,6 +33,9 @@ matrix_beeper_linkedin_configuration_extension_yaml: |
|
||||
|
||||
You may wish to look at `roles/custom/matrix-bridge-beeper-linkedin/templates/config.yaml.j2` to find other things you would like to configure.
|
||||
|
||||
## Installing
|
||||
|
||||
After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all`
|
||||
|
||||
## Set up Double Puppeting by enabling Appservice Double Puppet or Shared Secret Auth
|
||||
|
||||
|
||||
@ -13,6 +13,9 @@ To enable the [Skype](https://www.skype.com/) bridge, add the following configur
|
||||
matrix_go_skype_bridge_enabled: true
|
||||
```
|
||||
|
||||
## Installing
|
||||
|
||||
After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all`
|
||||
|
||||
## Usage
|
||||
|
||||
|
||||
@ -29,6 +29,10 @@ That's it! A registration file is automatically generated during the setup phase
|
||||
Setting the owner is optional as the first local user to DM `@heisenbridge:your-homeserver` will be made the owner.
|
||||
If you are not using a local user you must set it as otherwise you can't DM it at all.
|
||||
|
||||
## Installing
|
||||
|
||||
After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all`
|
||||
|
||||
## Usage
|
||||
|
||||
After the bridge is successfully running just DM `@heisenbridge:your-homeserver` to start setting it up.
|
||||
|
||||
@ -31,6 +31,9 @@ matrix_sms_bridge_provider_android_truststore_password: 123
|
||||
|
||||
```
|
||||
|
||||
## Installing
|
||||
|
||||
After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all`
|
||||
|
||||
## Usage
|
||||
|
||||
|
||||
@ -25,7 +25,13 @@ matrix_mautrix_discord_enabled: true
|
||||
|
||||
You may optionally wish to add some [Additional configuration](#additional-configuration), or to [prepare for double-puppeting](#set-up-double-puppeting) before the initial installation.
|
||||
|
||||
After adjusting your `vars.yml` file, re-run the playbook and restart all services: `ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start`
|
||||
## Installing
|
||||
|
||||
After configuring the playbook, run the [installation](installing.md) command:
|
||||
|
||||
```
|
||||
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start
|
||||
```
|
||||
|
||||
To make use of the bridge, see [Usage](#usage) below.
|
||||
|
||||
|
||||
@ -47,6 +47,9 @@ matrix_mautrix_facebook_configuration_extension_yaml: |
|
||||
|
||||
You may wish to look at `roles/custom/matrix-bridge-mautrix-facebook/templates/config.yaml.j2` and `roles/custom/matrix-bridge-mautrix-facebook/defaults/main.yml` to find other things you would like to configure.
|
||||
|
||||
## Installing
|
||||
|
||||
After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all`
|
||||
|
||||
## Set up Double Puppeting
|
||||
|
||||
|
||||
@ -12,6 +12,10 @@ To enable the bridge, add the following configuration to your `inventory/host_va
|
||||
matrix_mautrix_gmessages_enabled: true
|
||||
```
|
||||
|
||||
## Installing
|
||||
|
||||
After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all`
|
||||
|
||||
## Set up Double Puppeting
|
||||
|
||||
If you'd like to use [Double Puppeting](https://docs.mau.fi/bridges/general/double-puppeting.html) (hint: you most likely do), you have 2 ways of going about it.
|
||||
|
||||
@ -12,6 +12,9 @@ To enable the [Google Chat](https://chat.google.com/) bridge, add the following
|
||||
matrix_mautrix_googlechat_enabled: true
|
||||
```
|
||||
|
||||
## Installing
|
||||
|
||||
After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all`
|
||||
|
||||
## Set up Double Puppeting
|
||||
|
||||
|
||||
@ -14,6 +14,9 @@ To enable the [Google Hangouts](https://hangouts.google.com/) bridge, add the fo
|
||||
matrix_mautrix_hangouts_enabled: true
|
||||
```
|
||||
|
||||
## Installing
|
||||
|
||||
After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all`
|
||||
|
||||
## Set up Double Puppeting
|
||||
|
||||
|
||||
@ -40,6 +40,9 @@ matrix_mautrix_instagram_configuration_extension_yaml: |
|
||||
|
||||
You may wish to look at `roles/custom/matrix-bridge-mautrix-instagram/templates/config.yaml.j2` and `roles/custom/matrix-bridge-mautrix-instagram/defaults/main.yml` to find other things you would like to configure.
|
||||
|
||||
## Installing
|
||||
|
||||
After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all`
|
||||
|
||||
## Usage
|
||||
|
||||
|
||||
@ -62,6 +62,10 @@ matrix_mautrix_meta_instagram_bridge_permissions_custom:
|
||||
|
||||
You may wish to look at `roles/custom/matrix-bridge-mautrix-meta-instagram/templates/config.yaml.j2` to find more information on the permissions settings and other options you would like to configure.
|
||||
|
||||
## Installing
|
||||
|
||||
After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all`
|
||||
|
||||
## Set up Double Puppeting
|
||||
|
||||
If you'd like to use [Double Puppeting](https://docs.mau.fi/bridges/general/double-puppeting.html) (hint: you most likely do), you have 2 ways of going about it.
|
||||
|
||||
@ -72,6 +72,10 @@ matrix_mautrix_meta_messenger_bridge_permissions_custom:
|
||||
|
||||
You may wish to look at `roles/custom/matrix-bridge-mautrix-meta-messenger/templates/config.yaml.j2` to find more information on the permissions settings and other options you would like to configure.
|
||||
|
||||
## Installing
|
||||
|
||||
After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all`
|
||||
|
||||
## Set up Double Puppeting
|
||||
|
||||
If you'd like to use [Double Puppeting](https://docs.mau.fi/bridges/general/double-puppeting.html) (hint: you most likely do), you have 2 ways of going about it.
|
||||
|
||||
@ -54,6 +54,10 @@ matrix_mautrix_signal_bridge_permissions:
|
||||
|
||||
You may wish to look at `roles/custom/matrix-bridge-mautrix-signal/templates/config.yaml.j2` to find more information on the permissions settings and other options you would like to configure.
|
||||
|
||||
## Installing
|
||||
|
||||
After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all`
|
||||
|
||||
## Set up Double Puppeting
|
||||
|
||||
If you'd like to use [Double Puppeting](https://docs.mau.fi/bridges/general/double-puppeting.html) (hint: you most likely do), you have 2 ways of going about it.
|
||||
|
||||
@ -28,7 +28,13 @@ matrix_mautrix_slack_enabled: true
|
||||
|
||||
You may optionally wish to add some [Additional configuration](#additional-configuration), or to [prepare for double-puppeting](#set-up-double-puppeting) before the initial installation.
|
||||
|
||||
After adjusting your `vars.yml` file, re-run the playbook and restart all services: `ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start`
|
||||
## Installing
|
||||
|
||||
After configuring the playbook, run the [installation](installing.md) command:
|
||||
|
||||
```
|
||||
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start
|
||||
```
|
||||
|
||||
To make use of the bridge, see [Usage](#usage) below.
|
||||
|
||||
|
||||
@ -14,6 +14,10 @@ matrix_mautrix_telegram_api_id: YOUR_TELEGRAM_APP_ID
|
||||
matrix_mautrix_telegram_api_hash: YOUR_TELEGRAM_API_HASH
|
||||
```
|
||||
|
||||
## Installing
|
||||
|
||||
After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all`
|
||||
|
||||
## Set up Double Puppeting
|
||||
|
||||
If you'd like to use [Double Puppeting](https://docs.mau.fi/bridges/general/double-puppeting.html) (hint: you most likely do), you have 2 ways of going about it.
|
||||
|
||||
@ -14,6 +14,9 @@ To enable the bridge, add the following configuration to your `inventory/host_va
|
||||
matrix_mautrix_twitter_enabled: true
|
||||
```
|
||||
|
||||
## Installing
|
||||
|
||||
After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all`
|
||||
|
||||
## Set up Double Puppeting
|
||||
|
||||
|
||||
@ -27,6 +27,10 @@ matrix_mautrix_whatsapp_bridge_relay_admin_only: false
|
||||
If you want to activate the relay bot in a room, use `!wa set-relay`.
|
||||
Use `!wa unset-relay` to deactivate.
|
||||
|
||||
## Installing
|
||||
|
||||
After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all`
|
||||
|
||||
## Set up Double Puppeting
|
||||
|
||||
If you'd like to use [Double Puppeting](https://docs.mau.fi/bridges/general/double-puppeting.html) (hint: you most likely do), you have 2 ways of going about it.
|
||||
|
||||
@ -26,6 +26,9 @@ matrix_mautrix_wsproxy_syncproxy_shared_secret: 'secret token from bridge'
|
||||
|
||||
Note that the tokens must match what is compiled into the [mautrix-imessage](https://github.com/mautrix/imessage) bridge running on your Mac or Android device.
|
||||
|
||||
## Installing
|
||||
|
||||
After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all`
|
||||
|
||||
## Usage
|
||||
|
||||
|
||||
@ -19,6 +19,9 @@ To enable the [Discord](https://discordapp.com/) bridge, add the following confi
|
||||
matrix_mx_puppet_discord_enabled: true
|
||||
```
|
||||
|
||||
## Installing
|
||||
|
||||
After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all`
|
||||
|
||||
## Usage
|
||||
|
||||
|
||||
@ -13,6 +13,9 @@ To enable the [GroupMe](https://groupme.com/) bridge, add the following configur
|
||||
matrix_mx_puppet_groupme_enabled: true
|
||||
```
|
||||
|
||||
## Installing
|
||||
|
||||
After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all`
|
||||
|
||||
## Usage
|
||||
|
||||
|
||||
@ -13,6 +13,9 @@ To enable the [Instagram](https://www.instagram.com/) bridge, add the following
|
||||
matrix_mx_puppet_instagram_enabled: true
|
||||
```
|
||||
|
||||
## Installing
|
||||
|
||||
After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all`
|
||||
|
||||
## Usage
|
||||
|
||||
|
||||
@ -13,6 +13,9 @@ To enable the [Steam](https://steampowered.com/) bridge, add the following confi
|
||||
matrix_mx_puppet_steam_enabled: true
|
||||
```
|
||||
|
||||
## Installing
|
||||
|
||||
After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all`
|
||||
|
||||
## Usage
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ matrix_mx_puppet_twitter_access_token_secret: ''
|
||||
matrix_mx_puppet_twitter_environment: ''
|
||||
```
|
||||
|
||||
## Installing
|
||||
|
||||
After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all`
|
||||
|
||||
## Usage
|
||||
|
||||
|
||||
@ -12,6 +12,10 @@ To enable the bridge, add the following configuration to your `inventory/host_va
|
||||
matrix_wechat_enabled: true
|
||||
```
|
||||
|
||||
## Installing
|
||||
|
||||
After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all`
|
||||
|
||||
## Usage
|
||||
|
||||
Once the bridge is installed, start a chat with `@wechatbot:YOUR_DOMAIN` (where `YOUR_DOMAIN` is your base domain, not the `matrix.` domain).
|
||||
|
||||
@ -46,8 +46,7 @@ matrix_cactus_comments_client_enabled: true
|
||||
|
||||
## Installing
|
||||
|
||||
After configuring the playbook, run the [installation](installing.md) command again.
|
||||
|
||||
After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all`
|
||||
|
||||
## Usage
|
||||
|
||||
|
||||
@ -4,18 +4,26 @@ This playbook can install the [cinny](https://github.com/ajbura/cinny) Matrix we
|
||||
Cinny is a web client focusing primarily on simple, elegant and secure interface.
|
||||
Cinny can be installed alongside or instead of Element.
|
||||
|
||||
If you'd like Cinny to be installed, add the following to your configuration file (`inventory/host_vars/matrix.<your-domain>/vars.yml`):
|
||||
## DNS
|
||||
|
||||
You need to add a `cinny.DOMAIN` DNS record so that Cinny can be accessed.
|
||||
By default Cinny will use https://cinny.DOMAIN so you will need to create an CNAME record
|
||||
for `cinny`. See [Configuring DNS](configuring-dns.md).
|
||||
|
||||
If you would like to use a different domain, add the following configuration to your `inventory/host_vars/matrix.DOMAIN/vars.yml` file (changing it to use your preferred domain):
|
||||
|
||||
```yaml
|
||||
matrix_server_fqn_cinny: "app.{{ matrix_domain }}"
|
||||
```
|
||||
|
||||
## Adjusting the playbook configuration
|
||||
|
||||
To enable Cinny, add the following configuration to your `inventory/host_vars/matrix.DOMAIN/vars.yml` file:
|
||||
|
||||
```yaml
|
||||
matrix_client_cinny_enabled: true
|
||||
```
|
||||
|
||||
You will also need to add a DNS record so that Cinny can be accessed.
|
||||
By default Cinny will use https://cinny.DOMAIN so you will need to create an CNAME record
|
||||
for `cinny`. See [Configuring DNS](configuring-dns.md).
|
||||
## Installing
|
||||
|
||||
If you would like to use a different domain, add the following to your configuration file (changing it to use your preferred domain):
|
||||
|
||||
```yaml
|
||||
matrix_server_fqn_cinny: "app.{{ matrix_domain }}"
|
||||
```
|
||||
After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all`
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
# Configuring Element (optional)
|
||||
|
||||
By default, this playbook installs the [Element](https://github.com/element-hq/element-web) Matrix client web application.
|
||||
By default, this playbook installs the [Element](https://github.com/element-hq/element-web) Matrix web client for you.
|
||||
If that's okay, you can skip this document.
|
||||
|
||||
|
||||
|
||||
@ -4,18 +4,26 @@ This playbook can install the [Hydrogen](https://github.com/element-hq/hydrogen-
|
||||
Hydrogen is a lightweight web client that supports mobile and legacy web browsers.
|
||||
Hydrogen can be installed alongside or instead of Element.
|
||||
|
||||
If you'd like Hydrogen to be installed, add the following to your configuration file (`inventory/host_vars/matrix.<your-domain>/vars.yml`):
|
||||
## DNS
|
||||
|
||||
You need to add a `hydrogen.DOMAIN` DNS record so that Hydrogen can be accessed.
|
||||
By default Hydrogen will use https://hydrogen.DOMAIN so you will need to create an CNAME record
|
||||
for `hydrogen`. See [Configuring DNS](configuring-dns.md).
|
||||
|
||||
If you would like to use a different domain, add the following configuration to your `inventory/host_vars/matrix.DOMAIN/vars.yml` file (changing it to use your preferred domain):
|
||||
|
||||
```yaml
|
||||
matrix_server_fqn_hydrogen: "helium.{{ matrix_domain }}"
|
||||
```
|
||||
|
||||
## Adjusting the playbook configuration
|
||||
|
||||
To enable Hydrogen, add the following configuration to your `inventory/host_vars/matrix.DOMAIN/vars.yml` file:
|
||||
|
||||
```yaml
|
||||
matrix_client_hydrogen_enabled: true
|
||||
```
|
||||
|
||||
You will also need to add a DNS record so that Hydrogen can be accessed.
|
||||
By default Hydrogen will use https://hydrogen.DOMAIN so you will need to create an CNAME record
|
||||
for `hydrogen`. See [Configuring DNS](configuring-dns.md).
|
||||
## Installing
|
||||
|
||||
If you would like to use a different domain, add the following to your configuration file (changing it to use your preferred domain):
|
||||
|
||||
```yaml
|
||||
matrix_server_fqn_hydrogen: "helium.{{ matrix_domain }}"
|
||||
```
|
||||
After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all`
|
||||
|
||||
@ -1,21 +1,31 @@
|
||||
# Configuring SchildiChat (optional)
|
||||
|
||||
By default, this playbook does not install the [SchildiChat](https://github.com/SchildiChat/schildichat-desktop) Matrix client web application.
|
||||
This playbook can install the [SchildiChat](https://github.com/SchildiChat/schildichat-desktop) Matrix web client for you.
|
||||
SchildiChat is a feature-rich messenger for Matrix based on Element with some extras and tweaks.
|
||||
SchildiChat can be installed alongside or instead of Element.
|
||||
|
||||
**WARNING**: SchildiChat Web is based on Element-web, but its releases are lagging behind. As an example (from 2024-02-26), SchildiChat Web is 22 releases behind (it being based on element-web `v1.11.36`, while element-web is now on `v1.11.58`). Element-web frequently suffers from security issues, so running something based on an ancient Element-web release is **dangerous**. Use SchildiChat Web at your own risk!
|
||||
|
||||
## DNS
|
||||
|
||||
## Enabling SchildiChat
|
||||
You need to add a `schildichat.DOMAIN` DNS record so that SchildiChat can be accessed.
|
||||
By default SchildiChat will use https://schildichat.DOMAIN so you will need to create an CNAME record
|
||||
for `schildichat`. See [Configuring DNS](configuring-dns.md).
|
||||
|
||||
If you'd like for the playbook to install SchildiChat, you can enable it in your configuration file (`inventory/host_vars/matrix.<your-domain>/vars.yml`):
|
||||
If you would like to use a different domain, add the following configuration to your `inventory/host_vars/matrix.DOMAIN/vars.yml` file (changing it to use your preferred domain):
|
||||
|
||||
```yaml
|
||||
matrix_server_fqn_schildichat: "sc.{{ matrix_domain }}"
|
||||
```
|
||||
|
||||
## Adjusting the playbook configuration
|
||||
|
||||
To enable SchildiChat, add the following configuration to your `inventory/host_vars/matrix.DOMAIN/vars.yml` file:
|
||||
|
||||
```yaml
|
||||
matrix_client_schildichat_enabled: true
|
||||
```
|
||||
|
||||
|
||||
## Configuring SchildiChat settings
|
||||
|
||||
The playbook provides some customization variables you could use to change schildichat's settings.
|
||||
|
||||
Their defaults are defined in [`roles/custom/matrix-client-schildichat/defaults/main.yml`](../roles/custom/matrix-client-schildichat/defaults/main.yml) and they ultimately end up in the generated `/matrix/schildichat/config.json` file (on the server). This file is generated from the [`roles/custom/matrix-client-schildichat/templates/config.json.j2`](../roles/custom/matrix-client-schildichat/templates/config.json.j2) template.
|
||||
@ -30,8 +40,7 @@ Alternatively, **if there is no pre-defined variable** for an schildichat settin
|
||||
|
||||
- or, if extending the configuration is still not powerful enough for your needs, you can **override the configuration completely** using `matrix_client_schildichat_configuration_default` (or `matrix_client_schildichat_configuration`). You can find information about this in [`roles/custom/matrix-client-schildichat/defaults/main.yml`](../roles/custom/matrix-client-schildichat/defaults/main.yml).
|
||||
|
||||
|
||||
## Themes
|
||||
### Themes
|
||||
|
||||
To change the look of schildichat, you can define your own themes manually by using the `matrix_client_schildichat_setting_defaults_custom_themes` setting.
|
||||
|
||||
@ -40,3 +49,7 @@ Or better yet, you can automatically pull it all themes provided by the [aaronra
|
||||
If you make your own theme, we encourage you to submit it to the **aaronraimist/element-themes** project, so that the whole community could easily enjoy it.
|
||||
|
||||
Note that for a custom theme to work well, all schildichat instances that you use must have the same theme installed.
|
||||
|
||||
## Installing
|
||||
|
||||
After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all`
|
||||
|
||||
@ -40,8 +40,9 @@ etherpad_enabled: true
|
||||
# etherpad_admin_password: some-password
|
||||
```
|
||||
|
||||
Then, [run the installation process](installing.md) again (e.g. `just install-all`).
|
||||
## Installing
|
||||
|
||||
After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all`
|
||||
|
||||
## Usage
|
||||
|
||||
|
||||
@ -17,7 +17,7 @@ You may also need to open the following ports to your server:
|
||||
- `10000/udp` - RTP media over UDP. Depending on your firewall/NAT setup, incoming RTP packets on port `10000` may have the external IP of your firewall as destination address, due to the usage of STUN in JVB (see [`jitsi_jvb_stun_servers`](https://github.com/mother-of-all-self-hosting/ansible-role-jitsi/blob/main/defaults/main.yml)).
|
||||
|
||||
|
||||
## Installation
|
||||
## Adjusting the playbook configuration
|
||||
|
||||
Add the following configuration to your `inventory/host_vars/matrix.DOMAIN/vars.yml` file:
|
||||
|
||||
@ -271,10 +271,13 @@ jitsi_disable_gravatar: false
|
||||
**Beware:** This leaks information to a third party, namely the Gravatar-Service (unless configured otherwise: gravatar.com).
|
||||
Besides metadata, this includes the matrix user_id and possibly the room identifier (via `referrer` header).
|
||||
|
||||
## Apply changes
|
||||
## Installing
|
||||
|
||||
Then re-run the playbook: `ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start`
|
||||
After configuring the playbook, run the [installation](installing.md) command:
|
||||
|
||||
```
|
||||
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
|
||||
@ -35,6 +35,9 @@ matrix_ma1sd_matrixorg_forwarding_enabled: true
|
||||
If you'd like to change the default email templates used by ma1sd, take a look at the `matrix_ma1sd_threepid_medium_email_custom_` variables
|
||||
(in the `roles/custom/matrix-ma1sd/defaults/main.yml` file.
|
||||
|
||||
## Installing
|
||||
|
||||
After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all`
|
||||
|
||||
## ma1sd-controlled Registration
|
||||
|
||||
|
||||
@ -115,7 +115,9 @@ aux_file_definitions:
|
||||
|
||||
To learn more about what the policy configuration, see the matrix-corporal documentation on [policy](https://github.com/devture/matrix-corporal/blob/master/docs/policy.md).
|
||||
|
||||
Each time you update the policy in your `vars.yml` file, you'd need to re-run the playbook and restart matrix-corporal (`--tags=setup-all,start` or `--tags=setup-aux-files,setup-corporal,start`).
|
||||
## Installing
|
||||
|
||||
After configuring the playbook, run the [installation](installing.md) command (`--tags=setup-all,start` or `--tags=setup-aux-files,setup-corporal,start`).
|
||||
|
||||
|
||||
## Matrix Corporal files
|
||||
|
||||
@ -34,3 +34,6 @@ matrix_ldap_registration_proxy_systemd_wanted_services_list_custom:
|
||||
- matrix-synapse.service
|
||||
```
|
||||
|
||||
## Installing
|
||||
|
||||
After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all`
|
||||
|
||||
@ -17,9 +17,9 @@ Use matrix-registration to **create unique registration links**, which people ca
|
||||
- **a user registration page**, where people can use these registration tokens. By default, exposed at `https://matrix.DOMAIN/matrix-registration`
|
||||
|
||||
|
||||
## Installing
|
||||
## Adjusting the playbook configuration
|
||||
|
||||
Adjust your playbook configuration (your `inventory/host_vars/matrix.DOMAIN/vars.yml` file):
|
||||
Add the following configuration to your `inventory/host_vars/matrix.DOMAIN/vars.yml` file:
|
||||
|
||||
```yaml
|
||||
matrix_registration_enabled: true
|
||||
@ -28,7 +28,9 @@ matrix_registration_enabled: true
|
||||
matrix_registration_admin_secret: "ENTER_SOME_SECRET_HERE"
|
||||
```
|
||||
|
||||
Then, run the [installation](installing.md) command again:
|
||||
## Installing
|
||||
|
||||
After configuring the playbook, run the [installation](installing.md) command:
|
||||
|
||||
```
|
||||
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start
|
||||
|
||||
@ -92,6 +92,9 @@ Can be used to set the username for the bridge.
|
||||
|
||||
You may wish to look at `roles/custom/matrix-bridge-mautrix-SERVICENAME/templates/config.yaml.j2` and `roles/custom/matrix-bridge-mautrix-SERVICENAME/defaults/main.yml` to find other things you would like to configure.
|
||||
|
||||
## Installing
|
||||
|
||||
After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all`
|
||||
|
||||
## Set up Double Puppeting
|
||||
|
||||
|
||||
@ -38,7 +38,7 @@ For a complete list of ntfy config options that you could put in `ntfy_configura
|
||||
|
||||
Don't forget to add `ntfy.<your-domain>` to DNS as described in [Configuring DNS](configuring-dns.md) before running the playbook.
|
||||
|
||||
After configuring the playbook, run the [installation](installing.md) command again:
|
||||
After configuring the playbook, run the [installation](installing.md) command:
|
||||
|
||||
```
|
||||
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start
|
||||
|
||||
@ -18,4 +18,4 @@ The default configuration should suffice. For advanced configuration, you can ov
|
||||
|
||||
## 2. Installing
|
||||
|
||||
After configuring the playbook, run the [installation](installing.md) command.
|
||||
After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all`
|
||||
|
||||
@ -29,7 +29,7 @@ Refer to the table below for additional configuration variables and their defaul
|
||||
|
||||
## Installing
|
||||
|
||||
After configuring the playbook, run the [installation](installing.md) command again:
|
||||
After configuring the playbook, run the [installation](installing.md) command:
|
||||
|
||||
```
|
||||
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start
|
||||
|
||||
@ -20,7 +20,9 @@ Add the following configuration to your `inventory/host_vars/matrix.DOMAIN/vars.
|
||||
matrix_prometheus_nginxlog_exporter_enabled: true
|
||||
```
|
||||
|
||||
Then, re-run the playbook. See [installation](./installing.md).
|
||||
## Installing
|
||||
|
||||
After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all`
|
||||
|
||||
## Docker Image Compatibility
|
||||
|
||||
|
||||
@ -10,6 +10,10 @@ To enable the postgres exporter, add the following configuration to your `invent
|
||||
prometheus_postgres_exporter_enabled: true
|
||||
```
|
||||
|
||||
## Installing
|
||||
|
||||
After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all`
|
||||
|
||||
## What does it do?
|
||||
|
||||
Name | Description
|
||||
|
||||
@ -51,7 +51,7 @@ matrix_rageshake_configuration_extension_yaml: |
|
||||
|
||||
## Installing
|
||||
|
||||
After configuring the playbook, run the [installation](installing.md) command again:
|
||||
After configuring the playbook, run the [installation](installing.md) command:
|
||||
|
||||
```
|
||||
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start
|
||||
|
||||
@ -23,3 +23,7 @@ If you wish for users to **authenticate only against configured password provide
|
||||
```yaml
|
||||
matrix_synapse_password_config_localdb_enabled: false
|
||||
```
|
||||
|
||||
## Installing
|
||||
|
||||
After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all`
|
||||
|
||||
@ -30,5 +30,4 @@ There are a few options for handling this:
|
||||
|
||||
### Re-running the playbook
|
||||
|
||||
As always, after making the necessary DNS and configuration adjustments, [re-run the playbook](./installing.md) to apply the changes.
|
||||
```
|
||||
After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all`
|
||||
|
||||
@ -23,3 +23,7 @@ If you wish for users to **authenticate only against configured password provide
|
||||
```yaml
|
||||
matrix_synapse_password_config_localdb_enabled: false
|
||||
```
|
||||
|
||||
## Installing
|
||||
|
||||
After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all`
|
||||
|
||||
@ -25,7 +25,7 @@ By default, synapse-admin installation will be [restricted to only work with one
|
||||
|
||||
## Installing
|
||||
|
||||
After configuring the playbook, run the [installation](installing.md) command again (`just install-all`).
|
||||
After configuring the playbook, run the [installation](installing.md) command: `just install-all`
|
||||
|
||||
|
||||
## Usage
|
||||
|
||||
@ -18,7 +18,7 @@ matrix_synapse_auto_compressor_enabled: true
|
||||
|
||||
## Installing
|
||||
|
||||
After configuring the playbook, run the [installation](installing.md) command again:
|
||||
After configuring the playbook, run the [installation](installing.md) command:
|
||||
|
||||
```
|
||||
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user