Update docs: Move "(optional)" on headers to the end of the line

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
This commit is contained in:
Suguru Hirahara 2024-12-24 00:11:00 +09:00
parent 362d9cabd8
commit 40ef348c48
No known key found for this signature in database
GPG Key ID: E4F9743DAB4B7B75
3 changed files with 10 additions and 10 deletions

View File

@ -40,7 +40,7 @@ Once you've decided on the domain and path, **you may need to adjust your DNS**
By default, you will need to create a CNAME record for `jitsi`. See [Configuring DNS](configuring-dns.md) for details about DNS changes.
## (Optional) Configure Jitsi authentication and guests mode
## Configure Jitsi authentication and guests mode (optional)
By default the Jitsi Meet instance does not require any kind of login and is open to use for anyone without registration.
@ -112,7 +112,7 @@ jitsi_ldap_start_tls: false
For more information refer to the [docker-jitsi-meet](https://github.com/jitsi/docker-jitsi-meet#authentication-using-ldap) and the [saslauthd `LDAP_SASLAUTHD`](https://github.com/winlibs/cyrus-sasl/blob/master/saslauthd/LDAP_SASLAUTHD) documentation.
## (Optional) Making your Jitsi server work on a LAN
## Making your Jitsi server work on a LAN (optional)
By default the Jitsi Meet instance does not work with a client in LAN (Local Area Network), even if others are connected from WAN. There are no video and audio. In the case of WAN to WAN everything is ok.
@ -127,7 +127,7 @@ jitsi_jvb_container_extra_arguments:
- '--env "JVB_ADVERTISE_IPS=<Local IP address of the host>"'
```
## (Optional) Fine tune Jitsi
## Fine tune Jitsi (optional)
Sample **additional** `inventory/host_vars/matrix.example.com/vars.yml` configuration to save up resources (explained below):
@ -152,7 +152,7 @@ You may want to **limit the number of video feeds forwarded to each client**, to
You may want to **limit the maximum video resolution**, to save up resources on both server and clients.
## (Optional) Specify a Max number of participants on a Jitsi conference
## Specify a Max number of participants on a Jitsi conference (optional)
The playbook allows a user to set a max number of participants allowed to join a Jitsi conference. By default there is no limit.
@ -162,7 +162,7 @@ In order to set the max number of participants use the following **additional**
jitsi_prosody_max_participants: 4 # example value
```
## (Optional) Additional JVBs
## Additional JVBs (optional)
By default, a single JVB ([Jitsi VideoBridge](https://github.com/jitsi/jitsi-videobridge)) is deployed on the same host as the Matrix server. To allow more video-conferences to happen at the same time, you may need to provision additional JVB services on other hosts.
@ -253,7 +253,7 @@ traefik_provider_configuration_extension_yaml: |
{% endfor %}
```
## (Optional) Enable Gravatar
## Enable Gravatar (optional)
In the default Jisti Meet configuration, gravatar.com is enabled as an avatar service. This results in third party request leaking data to gravatar. Since Element clients already send the url of configured Matrix avatars to Jitsi, we disabled gravatar.

View File

@ -53,7 +53,7 @@ You are required to specify an access token (belonging to this new user) for UVS
matrix_user_verification_service_uvs_access_token: "YOUR ACCESS TOKEN HERE"
```
### (Optional) Custom Auth Token
### Custom Auth Token (optional)
It is possible to set an API Auth Token to restrict access to the UVS. If this is enabled, anyone making a request to UVS must provide it via the header "Authorization: Bearer TOKEN"
@ -67,7 +67,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
### Disable Auth (optional)
Authorization is enabled by default. To disable it, add the following configuration to your `vars.yml` file:
@ -75,7 +75,7 @@ Authorization is enabled by default. To disable it, add the following configurat
matrix_user_verification_service_uvs_require_auth: false
```
### (Optional) Federation
### Federation (optional)
In theory (however currently untested), UVS can handle federation. To enable it, add the following configuration to your `vars.yml` file:

View File

@ -34,7 +34,7 @@ As [per the Client-Server specification](https://matrix.org/docs/spec/client_ser
However, this playbook installs your Matrix server on another domain (e.g. `matrix.example.com`) and not on the base domain (e.g. `example.com`), so it takes a little extra manual effort to set up the file.
### (Optional) Support Service Discovery
### Support Service Discovery (optional)
[MSC 1929](https://github.com/matrix-org/matrix-spec-proposals/pull/1929), which was added to [Matrix Specification version v1.10](https://spec.matrix.org/v1.10/client-server-api/#getwell-knownmatrixsupport), specifies a way to add contact details of admins, as well as a link to a support page for users who are having issues with the service. Automated services may also index this information and use it for abuse reports, etc.