From 0940605669754c31381139253fa3bc5ae6ea4eab Mon Sep 17 00:00:00 2001 From: Paul Lessing Date: Wed, 15 Apr 2020 10:52:06 +0100 Subject: [PATCH] doc: fix typos and minor grammar issues in README --- README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 06ff077..ebcba36 100644 --- a/README.md +++ b/README.md @@ -55,12 +55,12 @@ or to use jigasi too: ``docker-compose -f docker-compose.yml -f jigasi.yml -f ji ### Security note -This setup used to have default passwords for intetrnal accounts used across components. In order to make the default setup +This setup used to have default passwords for internal accounts used across components. In order to make the default setup secure by default these have been removed and the respective containers won't start without having a password set. -Strong passwordds may be generated as follows: `./gen-passwords.sh` +Strong passwords may be generated as follows: `./gen-passwords.sh` This will modify your `.env` file (a backup is saved in `.env.bak`) and set strong passwords for each of the -require options. Passwords are generated using `openssl rand -hex 16` . +required options. Passwords are generated using `openssl rand -hex 16` . DO NOT reuse any of the passwords. @@ -142,8 +142,8 @@ Variable | Description | Example `DOCKER_HOST_ADDRESS` | IP address of the Docker host, needed for LAN environments | 192.168.1.1 `PUBLIC_URL` | Public URL for the web service | https://meet.example.com -**NOTE**: The mobile apps won't work with self-signed certificates (the default) -see below for instructions on how to obtain a proper certificate with Let's Encrypt. +**NOTE**: The mobile apps won't work with self-signed certificates (the default). +See below for instructions on how to obtain a proper certificate with Let's Encrypt. ### Let's Encrypt configuration @@ -202,8 +202,8 @@ echo "snd-aloop" >> /etc/modules lsmod | grep snd_aloop ``` -NOTE: if you are running on AWS you may need to reboot your machine to use the generic kernel instead -of the "aws" kernel. If after reboot, your machine is still using the "aws" kernel, you'll need to manually update the grub file. So just run +NOTE: If you are running on AWS you may need to reboot your machine to use the generic kernel instead +of the "aws" kernel. If after reboot, your machine is still using the "aws" kernel, you'll need to manually update the grub file. So just run: ``` # open the grub file in editor nano /etc/default/grub @@ -256,7 +256,7 @@ For using multiple Jibri instances, you have to select different loopback interf ... ``` - For setup the second instance, run container with changed `/home/jibri/.asoundrc`: + To setup the second instance, run container with changed `/home/jibri/.asoundrc`: ``` ...