Skip to content

Commit 3c07d76

Browse files
authored
doc: improve wording of README
1 parent ed410d9 commit 3c07d76

File tree

2 files changed

+16
-15
lines changed

2 files changed

+16
-15
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -216,7 +216,7 @@ Variable | Description | Example
216216
For using multiple Jibri instances, you have to select different loopback interfces for each instance manually.
217217

218218
<details>
219-
<summary>Set interface you can in file `/home/jibri/.asoundrc` inside a docker container.</summary>
219+
<summary>Set interface in file `/home/jibri/.asoundrc` inside a docker container.</summary>
220220

221221
Default the first instance has:
222222

@@ -330,7 +330,7 @@ Variable | Description | Example
330330
`JWT_AUTH_TYPE` | (Optional) Controls which module is used for processing incoming JWTs | token
331331
`JWT_TOKEN_AUTH_MODULE` | (Optional) Controls which module is used for validating JWTs | token_verification
332332

333-
This can be tested using the [jwt.io] debugger. Use the following samople payload:
333+
This can be tested using the [jwt.io] debugger. Use the following sample payload:
334334

335335
```
336336
{
@@ -350,7 +350,7 @@ This can be tested using the [jwt.io] debugger. Use the following samople payloa
350350

351351
### Shared document editing using Etherpad
352352

353-
You can collaboratively edit a document via [Etherpad]. In order to enable it, set the config options bellow and run
353+
You can collaboratively edit a document via [Etherpad]. In order to enable it, set the config options below and run
354354
Docker Compose with the additional config file `etherpad.yml`.
355355

356356
Here are the required options:
@@ -373,7 +373,7 @@ Variable | Description | Example
373373
`GC_CLIENT_ID` | `client_id` from Google Cloud Credetials
374374
`GC_CLIENT_CERT_URL` | `client_x509_cert_url` from Google Cloud Credetials
375375

376-
For setting the Google Cloud Credentials please read https://cloud.google.com/text-to-speech/docs/quickstart-protocol section "Before you begin" from 1 to 5 paragraph.
376+
For setting the Google Cloud Credentials please read https://cloud.google.com/text-to-speech/docs/quickstart-protocol section "Before you begin" paragraph 1 to 5.
377377

378378
### Advanced configuration
379379

@@ -414,11 +414,11 @@ Variable | Description | Default value
414414
`JIGASI_SIP_KEEP_ALIVE_METHOD` | Keepalive method | OPTIONS
415415
`JIGASI_HEALTH_CHECK_SIP_URI` | Health-check extension. Jigasi will call it for healthcheck | keepalive
416416
`JIGASI_HEALTH_CHECK_INTERVAL` | Interval of healthcheck in milliseconds | 300000
417-
`JIGASI_TRANSCRIBER_RECORD_AUDIO` | Jigasi will recordord an audio when transcriber is on | true
417+
`JIGASI_TRANSCRIBER_RECORD_AUDIO` | Jigasi will record audio when transcriber is on | true
418418
`JIGASI_TRANSCRIBER_SEND_TXT` | Jigasi will send transcribed text to the chat when transcriber is on | true
419-
`JIGASI_TRANSCRIBER_ADVERTISE_URL` | Jigasi post to the chat an url with transcription file | true
420-
`DISABLE_HTTPS` | Disable HTTPS, this can be useful if TLS connections are going to be handled outside of this setup | 1
421-
`ENABLE_HTTP_REDIRECT` | Redirects HTTP traffic to HTTPS | 1
419+
`JIGASI_TRANSCRIBER_ADVERTISE_URL` | Jigasi will post an url to the chat with transcription file | true
420+
`DISABLE_HTTPS` | Handle TLS connections outside of this setup | 1
421+
`ENABLE_HTTP_REDIRECT` | Redirect HTTP traffic to HTTPS (necessary for Let's Encrypt) | 1
422422
`LOG_LEVEL` | Controls which logs are output from prosody and associated modules | info
423423

424424
### Running behind NAT or on a LAN environment

env.example

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ TZ=Europe/Amsterdam
1717
# Public URL for the web service.
1818
#PUBLIC_URL=https://meet.example.com
1919

20-
# IP address of the Docker host. See the "Running behind NAT or on a LAN environment" section
21-
# in the README.
20+
# IP address of the Docker host.
21+
# See the "Running behind NAT or on a LAN environment" section in the README.
2222
#DOCKER_HOST_ADDRESS=192.168.1.1
2323

2424

@@ -237,17 +237,17 @@ JIGASI_PORT_MAX=20050
237237
# Enable Jigasi transcription.
238238
#ENABLE_TRANSCRIPTIONS=1
239239

240-
# Jigasi will recordord an audio when transcriber is on. Default false.
240+
# Jigasi will record audio when transcriber is on. Default false.
241241
#JIGASI_TRANSCRIBER_RECORD_AUDIO=true
242242

243243
# Jigasi will send transcribed text to the chat when transcriber is on. Default false.
244244
#JIGASI_TRANSCRIBER_SEND_TXT=true
245245

246-
# Jigasi post to the chat an url with transcription file. Default false.
246+
# Jigasi will post an url to the chat with transcription file. Default false.
247247
#JIGASI_TRANSCRIBER_ADVERTISE_URL=true
248248

249249
# Credentials for connect to Cloud Google API from Jigasi
250-
# Please read https://cloud.google.com/text-to-speech/docs/quickstart-protocol section "Before you begin" from 1 to 5 paragraph.
250+
# Please read https://cloud.google.com/text-to-speech/docs/quickstart-protocol section "Before you begin" paragraph 1 to 5.
251251
# Copy the values from the json to the related env vars
252252
#GC_PROJECT_ID=
253253
#GC_PRIVATE_KEY_ID=
@@ -299,8 +299,9 @@ JIBRI_STRIP_DOMAIN_JID=muc
299299
# Directory for logs inside Jibri container.
300300
JIBRI_LOGS_DIR=/config/logs
301301

302-
# Disable HTTPS. This can be useful if TLS connections are going to be handled outside of this setup.
302+
# Disable HTTPS. Handle TLS connections outside of this setup.
303303
#DISABLE_HTTPS=1
304304

305-
# Redirects HTTP traffic to HTTPS. Only works with the standard HTTPS port (443).
305+
# Redirect HTTP traffic to HTTPS.
306+
# Necessary for Let's Encrypt. Relies on standard HTTPS port (443).
306307
#ENABLE_HTTP_REDIRECT=1

0 commit comments

Comments
 (0)