Skip to content

Commit 40ef348

Browse files
author
Suguru Hirahara
committed
Update docs: Move "(optional)" on headers to the end of the line
Signed-off-by: Suguru Hirahara <[email protected]>
1 parent 362d9ca commit 40ef348

File tree

3 files changed

+10
-10
lines changed

3 files changed

+10
-10
lines changed

docs/configuring-playbook-jitsi.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ Once you've decided on the domain and path, **you may need to adjust your DNS**
4040

4141
By default, you will need to create a CNAME record for `jitsi`. See [Configuring DNS](configuring-dns.md) for details about DNS changes.
4242

43-
## (Optional) Configure Jitsi authentication and guests mode
43+
## Configure Jitsi authentication and guests mode (optional)
4444

4545
By default the Jitsi Meet instance does not require any kind of login and is open to use for anyone without registration.
4646

@@ -112,7 +112,7 @@ jitsi_ldap_start_tls: false
112112

113113
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.
114114

115-
## (Optional) Making your Jitsi server work on a LAN
115+
## Making your Jitsi server work on a LAN (optional)
116116

117117
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.
118118

@@ -127,7 +127,7 @@ jitsi_jvb_container_extra_arguments:
127127
- '--env "JVB_ADVERTISE_IPS=<Local IP address of the host>"'
128128
```
129129

130-
## (Optional) Fine tune Jitsi
130+
## Fine tune Jitsi (optional)
131131

132132
Sample **additional** `inventory/host_vars/matrix.example.com/vars.yml` configuration to save up resources (explained below):
133133

@@ -152,7 +152,7 @@ You may want to **limit the number of video feeds forwarded to each client**, to
152152

153153
You may want to **limit the maximum video resolution**, to save up resources on both server and clients.
154154

155-
## (Optional) Specify a Max number of participants on a Jitsi conference
155+
## Specify a Max number of participants on a Jitsi conference (optional)
156156

157157
The playbook allows a user to set a max number of participants allowed to join a Jitsi conference. By default there is no limit.
158158

@@ -162,7 +162,7 @@ In order to set the max number of participants use the following **additional**
162162
jitsi_prosody_max_participants: 4 # example value
163163
```
164164

165-
## (Optional) Additional JVBs
165+
## Additional JVBs (optional)
166166

167167
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.
168168

@@ -253,7 +253,7 @@ traefik_provider_configuration_extension_yaml: |
253253
{% endfor %}
254254
```
255255

256-
## (Optional) Enable Gravatar
256+
## Enable Gravatar (optional)
257257

258258
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.
259259

docs/configuring-playbook-user-verification-service.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ You are required to specify an access token (belonging to this new user) for UVS
5353
matrix_user_verification_service_uvs_access_token: "YOUR ACCESS TOKEN HERE"
5454
```
5555

56-
### (Optional) Custom Auth Token
56+
### Custom Auth Token (optional)
5757

5858
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"
5959

@@ -67,15 +67,15 @@ matrix_user_verification_service_uvs_auth_token: "TOKEN"
6767

6868
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.
6969

70-
### (Optional) Disable Auth
70+
### Disable Auth (optional)
7171

7272
Authorization is enabled by default. To disable it, add the following configuration to your `vars.yml` file:
7373

7474
```yaml
7575
matrix_user_verification_service_uvs_require_auth: false
7676
```
7777

78-
### (Optional) Federation
78+
### Federation (optional)
7979

8080
In theory (however currently untested), UVS can handle federation. To enable it, add the following configuration to your `vars.yml` file:
8181

docs/configuring-well-known.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ As [per the Client-Server specification](https://matrix.org/docs/spec/client_ser
3434

3535
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.
3636

37-
### (Optional) Support Service Discovery
37+
### Support Service Discovery (optional)
3838

3939
[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.
4040

0 commit comments

Comments
 (0)