Use common sentences on documentation regarding installation

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
This commit is contained in:
Suguru Hirahara 2024-10-13 03:03:46 +09:00
parent 5268df9a8b
commit 282e8be07d
No known key found for this signature in database
GPG Key ID: E4F9743DAB4B7B75
47 changed files with 156 additions and 23 deletions

View File

@ -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).

View File

@ -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.

View File

@ -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, re-run the [installation](installing.md) command: `just install-all` or `just setup-all`
## Usage

View File

@ -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 again: `just install-all`
**Notes**:

View File

@ -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).

View File

@ -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.

View File

@ -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

View File

@ -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

View File

@ -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, re-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.

View File

@ -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

View File

@ -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.

View File

@ -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

View File

@ -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.

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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.

View File

@ -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.

View File

@ -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.

View File

@ -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.

View File

@ -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.

View File

@ -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

View File

@ -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.

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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).

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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, re-run the [installation](installing.md) command again (`--tags=setup-all,start` or `--tags=setup-aux-files,setup-corporal,start`).
## Matrix Corporal files

View File

@ -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`

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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`

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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`

View File

@ -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`

View File

@ -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`

View File

@ -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 again: `just install-all`
## Usage