Skip to content

Commit

Permalink
Adjust blank lines: add ones
Browse files Browse the repository at this point in the history
Signed-off-by: Suguru Hirahara <[email protected]>
  • Loading branch information
Suguru Hirahara committed Dec 1, 2024
1 parent dd5881f commit a31400e
Show file tree
Hide file tree
Showing 19 changed files with 30 additions and 2 deletions.
2 changes: 2 additions & 0 deletions docs/ansible.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,9 +92,11 @@ Finally, you execute `ansible-playbook ...` commands as per normal now.
If you don't use SSH keys for authentication, simply remove that whole line (`-v $HOME/.ssh/id_rsa:/root/.ssh/id_rsa:ro`).

To authenticate at your server using a password, you need to add a package. So, when you are in the shell of the ansible docker container (the previously used `docker run -it ...` command), run:

```sh
apk add sshpass
```

Then, to be asked for the password whenever running an `ansible-playbook` command add `--ask-pass` to the arguments of the command.

#### Resolve directory ownership issues
Expand Down
1 change: 1 addition & 0 deletions docs/configuring-captcha.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
(Adapted from the [upstream project](https://github.com/element-hq/synapse/blob/develop/docs/CAPTCHA_SETUP.md))

# Overview

Captcha can be enabled for this home server. This file explains how to do that.

The captcha mechanism used is Google's [ReCaptcha](https://www.google.com/recaptcha/). This requires API keys from Google. If your homeserver is Dendrite then [hCapcha](https://www.hcaptcha.com) can be used instead.
Expand Down
2 changes: 2 additions & 0 deletions docs/configuring-playbook-bridge-beeper-linkedin.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ matrix_beeper_linkedin_enabled: true
There are some additional things you may wish to configure about the bridge before you continue.
Encryption support is off by default. If you would like to enable encryption, add the following to your `vars.yml` file:

```yaml
matrix_beeper_linkedin_configuration_extension_yaml: |
bridge:
Expand All @@ -24,6 +25,7 @@ matrix_beeper_linkedin_configuration_extension_yaml: |
```

If you would like to be able to administrate the bridge from your account it can be configured like this:

```yaml
matrix_beeper_linkedin_configuration_extension_yaml: |
bridge:
Expand Down
2 changes: 2 additions & 0 deletions docs/configuring-playbook-bridge-hookshot.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,7 @@ The GitHub bridge requires you to install a private key file. This can be done i
- use the [`aux` role](https://github.com/mother-of-all-self-hosting/ansible-role-aux) to copy the file from an arbitrary path on your ansible client to the correct path on the server.

To use the `aux` role, make sure the `matrix_hookshot_github_private_key` variable is empty. Then add the following additional configuration:

```yaml
aux_file_definitions:
- dest: "{{ matrix_hookshot_base_path }}/{{ matrix_hookshot_github_private_key_file }}"
Expand All @@ -78,6 +79,7 @@ aux_file_definitions:
owner: "{{ matrix_user_username }}"
group: "{{ matrix_user_groupname }}"
```
For more information, see the documentation in the [default configuration of the aux role](https://github.com/mother-of-all-self-hosting/ansible-role-aux/blob/main/defaults/main.yml).
### Provisioning API
Expand Down
2 changes: 2 additions & 0 deletions docs/configuring-playbook-bridge-mautrix-facebook.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ matrix_mautrix_facebook_enabled: true
There are some additional things you may wish to configure about the bridge before you continue.
Encryption support is off by default. If you would like to enable encryption, add the following to your `vars.yml` file:

```yaml
matrix_mautrix_facebook_configuration_extension_yaml: |
bridge:
Expand All @@ -32,6 +33,7 @@ matrix_mautrix_facebook_configuration_extension_yaml: |
```

If you would like to be able to administrate the bridge from your account it can be configured like this:

```yaml
matrix_mautrix_facebook_configuration_extension_yaml: |
bridge:
Expand Down
2 changes: 2 additions & 0 deletions docs/configuring-playbook-bridge-mautrix-instagram.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ matrix_mautrix_instagram_enabled: true
There are some additional things you may wish to configure about the bridge before you continue.
Encryption support is off by default. If you would like to enable encryption, add the following to your `vars.yml` file:

```yaml
matrix_mautrix_instagram_configuration_extension_yaml: |
bridge:
Expand All @@ -26,6 +27,7 @@ matrix_mautrix_instagram_configuration_extension_yaml: |
```

If you would like to be able to administrate the bridge from your account it can be configured like this:

```yaml
# The easy way. The specified Matrix user ID will be made an admin of all bridges
matrix_admin: "@YOUR_USERNAME:{{ matrix_domain }}"
Expand Down
1 change: 1 addition & 0 deletions docs/configuring-playbook-bridge-mautrix-meta-instagram.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ Different levels of permission can be granted to users:
The permissions are following the sequence: nothing < `relay` < `user` < `admin`.

The default permissions are set via `matrix_mautrix_meta_instagram_bridge_permissions_default` and are somewhat like this:

```yaml
matrix_mautrix_meta_instagram_bridge_permissions_default:
'*': relay
Expand Down
1 change: 1 addition & 0 deletions docs/configuring-playbook-bridge-mautrix-meta-messenger.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@ Different levels of permission can be granted to users:
The permissions are following the sequence: nothing < `relay` < `user` < `admin`.

The default permissions are set via `matrix_mautrix_meta_messenger_bridge_permissions_default` and are somewhat like this:

```yaml
matrix_mautrix_meta_messenger_bridge_permissions_default:
'*': relay
Expand Down
3 changes: 3 additions & 0 deletions docs/configuring-playbook-bridge-mautrix-signal.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,13 +41,15 @@ Different levels of permission can be granted to users:
The permissions are following the sequence: nothing < relay < user < admin.
The default permissions are set as follows:
```yaml
permissions:
'*': relay
example.com: user
```
If you want to augment the preset permissions, you might want to set the additional permissions with the following settings in your `vars.yml` file:

```yaml
matrix_mautrix_signal_configuration_extension_yaml: |
bridge:
Expand All @@ -58,6 +60,7 @@ matrix_mautrix_signal_configuration_extension_yaml: |
This will add the admin permission to the specific user, while keeping the default permissions.

In case you want to replace the default permissions settings **completely**, populate the following item within your `vars.yml` file:

```yaml
matrix_mautrix_signal_bridge_permissions:
'@ADMIN:example.com': admin
Expand Down
2 changes: 2 additions & 0 deletions docs/configuring-playbook-bridge-mautrix-telegram.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ matrix_mautrix_telegram_configuration_extension_yaml: |
```
You might also want to give permissions to administrate the bot:
```yaml
matrix_mautrix_telegram_configuration_extension_yaml: |
bridge:
Expand All @@ -62,6 +63,7 @@ matrix_mautrix_telegram_configuration_extension_yaml: |
More details about permissions in this example: https://github.com/mautrix/telegram/blob/master/mautrix_telegram/example-config.yaml#L410
If you like to exclude all groups from syncing and use the Telgeram-Bridge only for direct chats, you can add the following additional playbook configuration:
```yaml
matrix_mautrix_telegram_filter_mode: whitelist
```
Expand Down
1 change: 1 addition & 0 deletions docs/configuring-playbook-email.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ exim_relay_relay_auth_password: "some-password"
**Note**: only the secure submission protocol (using `STARTTLS`, usually on port `587`) is supported. **SMTPS** (encrypted SMTP, usually on port `465`) **is not supported**.

### Configuations for sending emails using Sendgrid

An easy and free SMTP service to set up is [Sendgrid](https://sendgrid.com/), the free tier allows for up to 100 emails per day to be sent. In the settings below you can provide any email for `exim_relay_sender_address`.

The only other thing you need to change is the `exim_relay_relay_auth_password`, which you can generate at https://app.sendgrid.com/settings/api_keys. The API key password looks something like `SG.955oW1mLSfwds7i9Yd6IA5Q.q8GTaB8q9kGDzasegdG6u95fQ-6zkdwrPP8bOeuI`.
Expand Down
1 change: 1 addition & 0 deletions docs/configuring-playbook-jitsi.md
Original file line number Diff line number Diff line change
Expand Up @@ -169,6 +169,7 @@ By default, a single JVB ([Jitsi VideoBridge](https://github.com/jitsi/jitsi-vid
There is an ansible playbook that can be run with the following tag: `ansible-playbook -i inventory/hosts --limit jitsi_jvb_servers jitsi_jvb.yml --tags=common,setup-additional-jitsi-jvb,start`

For this role to work you will need an additional section in the ansible hosts file with the details of the JVB hosts, for example:

```INI
[jitsi_jvb_servers]
<your jvb hosts> ansible_host=<ip address of the jvb host>
Expand Down
1 change: 1 addition & 0 deletions docs/configuring-playbook-matrix-media-repo.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ By default, the media-repo will use the local filesystem for data storage. You c
## Configuring the media-repo

Additional common configuration options:

```yaml

# The postgres database pooling options
Expand Down
1 change: 1 addition & 0 deletions docs/configuring-playbook-prometheus-grafana.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,7 @@ Name | Description
If you are using workers (`matrix_synapse_workers_enabled: true`) and have enabled `matrix_synapse_metrics_proxying_enabled` as described above, the playbook will also automatically expose all Synapse worker threads' metrics to `https://matrix.example.com/metrics/synapse/worker/ID`, where `ID` corresponds to the worker `id` as exemplified in `matrix_synapse_workers_enabled_list`.

The playbook also generates an exemplary config file (`/matrix/synapse/external_prometheus.yml.template`) with all the correct paths which you can copy to your Prometheus server and adapt to your needs. Make sure to edit the specified `password_file` path and contents and path to your `synapse-v2.rules`. It will look a bit like this:

```yaml
scrape_configs:
- job_name: 'synapse'
Expand Down
2 changes: 2 additions & 0 deletions docs/configuring-playbook-user-verification-service.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,7 @@ matrix_user_verification_service_uvs_auth_token: "TOKEN"
In case Jitsi is also managed by this playbook and 'matrix' authentication in Jitsi is enabled, this collection will automatically configure Jitsi to use the configured auth token.

### (Optional) Disable Auth

Authorization is enabled by default. To disable set

```yaml
Expand Down Expand Up @@ -108,6 +109,7 @@ The configuration variable `UVS_LOG_LEVEL` can be set to:
- debug

## TLS Certificate Checking

If the Matrix Homeserver does not provide a valid TLS certificate, UVS will fail with the following error message:

> message: 'No response received: [object Object]',
Expand Down
2 changes: 2 additions & 0 deletions docs/importing-postgres.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ just run-tags import-postgres \
## Troubleshooting

### Table Ownership

A table ownership issue can occur if you are importing from a Synapse installation which was both:

- migrated from SQLite to Postgres, and
Expand Down Expand Up @@ -84,6 +85,7 @@ In this case you can use the command suggested in the import task to clear the d
Now on your local machine run `just run-tags setup-postgres` to prepare the database roles etc.

If not, you probably get this error. `synapse` is the correct table owner, but the role is missing in database.

```
"ERROR: role synapse does not exist"
```
Expand Down
1 change: 1 addition & 0 deletions docs/maintenance-and-troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
## How to see the current status of your services

You can check the status of your services by using `systemctl status`. Example:

```sh
sudo systemctl status matrix-synapse

Expand Down
3 changes: 1 addition & 2 deletions docs/maintenance-postgres.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,8 +88,7 @@ The auto-upgrade-backup directory stays around forever, until you **manually dec

As part of the upgrade, the database is dumped to `/tmp`, an upgraded and empty Postgres server is started, and then the dump is restored into the new server. To use a different directory for the dump, pass some extra flags to the command above, like this: `--extra-vars="postgres_dump_dir=/directory/to/dump/here"`

To save disk space in `/tmp`, the dump file is gzipped on the fly at the expense of CPU usage.
If you have plenty of space in `/tmp` and would rather avoid gzipping, you can explicitly pass a dump filename which doesn't end in `.gz`. Example: `--extra-vars="postgres_dump_name=matrix-postgres-dump.sql"`
To save disk space in `/tmp`, the dump file is gzipped on the fly at the expense of CPU usage. If you have plenty of space in `/tmp` and would rather avoid gzipping, you can explicitly pass a dump filename which doesn't end in `.gz`. Example: `--extra-vars="postgres_dump_name=matrix-postgres-dump.sql"`

**All databases, roles, etc. on the Postgres server are migrated**.

Expand Down
2 changes: 2 additions & 0 deletions docs/updating-users-passwords.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,9 @@ This requires an [access token](obtaining-access-tokens.md) from a server admin
If you didn't make your account a server admin when you created it, you can learn how to switch it now by reading about it in [Adding/Removing Administrator privileges to an existing user in Synapse](registering-users.md#addingremoving-administrator-privileges-to-an-existing-user-in-synapse).

### Example:

To set @user:example.com's password to `correct_horse_battery_staple` you could use this curl command:

```sh
curl -XPOST -d '{ "new_password": "correct_horse_battery_staple" }' "https://matrix.example.com/_matrix/client/r0/admin/reset_password/@user:example.com?access_token=MDA...this_is_my_access_token
```

0 comments on commit a31400e

Please sign in to comment.