Browse Source

doc: improve wording of README

Hans-Peter Jansen 5 years ago
parent
commit
3c07d76937
2 changed files with 16 additions and 15 deletions
  1. 8 8
      README.md
  2. 8 7
      env.example

+ 8 - 8
README.md

@@ -216,7 +216,7 @@ Variable | Description | Example
 For using multiple Jibri instances, you have to select different loopback interfces for each instance manually.
 
 <details>
-  <summary>Set interface you can in file `/home/jibri/.asoundrc` inside a docker container.</summary>
+  <summary>Set interface in file `/home/jibri/.asoundrc` inside a docker container.</summary>
 
   Default the first instance has:
 
@@ -330,7 +330,7 @@ Variable | Description | Example
 `JWT_AUTH_TYPE` | (Optional) Controls which module is used for processing incoming JWTs | token
 `JWT_TOKEN_AUTH_MODULE` | (Optional) Controls which module is used for validating JWTs | token_verification
 
-This can be tested using the [jwt.io] debugger. Use the following samople payload:
+This can be tested using the [jwt.io] debugger. Use the following sample payload:
 
 ```
 {
@@ -350,7 +350,7 @@ This can be tested using the [jwt.io] debugger. Use the following samople payloa
 
 ### Shared document editing using Etherpad
 
-You can collaboratively edit a document via [Etherpad]. In order to enable it, set the config options bellow and run
+You can collaboratively edit a document via [Etherpad]. In order to enable it, set the config options below and run
 Docker Compose with the additional config file `etherpad.yml`.
 
 Here are the required options:
@@ -373,7 +373,7 @@ Variable | Description | Example
 `GC_CLIENT_ID` | `client_id` from Google Cloud Credetials
 `GC_CLIENT_CERT_URL` | `client_x509_cert_url` from Google Cloud Credetials
 
-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.
+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.
 
 ### Advanced configuration
 
@@ -414,11 +414,11 @@ Variable | Description | Default value
 `JIGASI_SIP_KEEP_ALIVE_METHOD` | Keepalive method | OPTIONS
 `JIGASI_HEALTH_CHECK_SIP_URI` | Health-check extension. Jigasi will call it for healthcheck | keepalive
 `JIGASI_HEALTH_CHECK_INTERVAL` | Interval of healthcheck in milliseconds | 300000
-`JIGASI_TRANSCRIBER_RECORD_AUDIO` | Jigasi will recordord an audio when transcriber is on | true
+`JIGASI_TRANSCRIBER_RECORD_AUDIO` | Jigasi will record audio when transcriber is on | true
 `JIGASI_TRANSCRIBER_SEND_TXT` | Jigasi will send transcribed text to the chat when transcriber is on | true
-`JIGASI_TRANSCRIBER_ADVERTISE_URL` | Jigasi post to the chat an url with transcription file | true
-`DISABLE_HTTPS` | Disable HTTPS, this can be useful if TLS connections are going to be handled outside of this setup | 1
-`ENABLE_HTTP_REDIRECT` | Redirects HTTP traffic to HTTPS | 1
+`JIGASI_TRANSCRIBER_ADVERTISE_URL` | Jigasi will post an url to the chat with transcription file | true
+`DISABLE_HTTPS` | Handle TLS connections outside of this setup | 1
+`ENABLE_HTTP_REDIRECT` | Redirect HTTP traffic to HTTPS (necessary for Let's Encrypt) | 1
 `LOG_LEVEL` | Controls which logs are output from prosody and associated modules | info
 
 ### Running behind NAT or on a LAN environment

+ 8 - 7
env.example

@@ -17,8 +17,8 @@ TZ=Europe/Amsterdam
 # Public URL for the web service.
 #PUBLIC_URL=https://meet.example.com
 
-# IP address of the Docker host. See the "Running behind NAT or on a LAN environment" section
-# in the README.
+# IP address of the Docker host. 
+# See the "Running behind NAT or on a LAN environment" section in the README.
 #DOCKER_HOST_ADDRESS=192.168.1.1
 
 
@@ -237,17 +237,17 @@ JIGASI_PORT_MAX=20050
 # Enable Jigasi transcription.
 #ENABLE_TRANSCRIPTIONS=1
 
-# Jigasi will recordord an audio when transcriber is on. Default false.
+# Jigasi will record audio when transcriber is on. Default false.
 #JIGASI_TRANSCRIBER_RECORD_AUDIO=true
 
 # Jigasi will send transcribed text to the chat when transcriber is on. Default false.
 #JIGASI_TRANSCRIBER_SEND_TXT=true
 
-# Jigasi post to the chat an url with transcription file. Default false.
+# Jigasi will post an url to the chat with transcription file. Default false.
 #JIGASI_TRANSCRIBER_ADVERTISE_URL=true
 
 # Credentials for connect to Cloud Google API from Jigasi
-# Please read https://cloud.google.com/text-to-speech/docs/quickstart-protocol section "Before you begin" from 1 to 5 paragraph.
+# Please read https://cloud.google.com/text-to-speech/docs/quickstart-protocol section "Before you begin" paragraph 1 to 5.
 # Copy the values from the json to the related env vars
 #GC_PROJECT_ID=
 #GC_PRIVATE_KEY_ID=
@@ -299,8 +299,9 @@ JIBRI_STRIP_DOMAIN_JID=muc
 # Directory for logs inside Jibri container.
 JIBRI_LOGS_DIR=/config/logs
 
-# Disable HTTPS. This can be useful if TLS connections are going to be handled outside of this setup.
+# Disable HTTPS. Handle TLS connections outside of this setup.
 #DISABLE_HTTPS=1
 
-# Redirects HTTP traffic to HTTPS. Only works with the standard HTTPS port (443).
+# Redirect HTTP traffic to HTTPS.
+# Necessary for Let's Encrypt. Relies on standard HTTPS port (443).
 #ENABLE_HTTP_REDIRECT=1