From 630ed5cf3665347cbc3735392e44fbb9d5d50f2a Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Sa=C3=BAl=20Ibarra=20Corretg=C3=A9?= <s@saghul.net>
Date: Mon, 25 Jun 2018 08:13:45 +0200
Subject: [PATCH] doc: updated README

---
 README.md           | 39 ++++++++++++++++++++++++++++++++++++---
 base-java/README.md |  5 -----
 base/README.md      | 20 --------------------
 3 files changed, 36 insertions(+), 28 deletions(-)
 delete mode 100644 base-java/README.md
 delete mode 100644 base/README.md

diff --git a/README.md b/README.md
index 6a324df..217fdb1 100644
--- a/README.md
+++ b/README.md
@@ -11,6 +11,19 @@ This repository contains the necessary tools to run a Jitsi Meet stack on [Docke
 
 **NOTE: This setup is experimental.**
 
+## Table of contents
+
+* [Quick start](#quick-start)
+* [Architecture](#architecture)
+  - [Images](#images)
+  - [Design considerations](#design-considerations)
+* [Configurations](#configuration)
+  - [Advanced configuration](#advanced-configuration)
+  - [Running on a LAN environment](#running-on-a-lan-environment)
+* [Limitations](#limitations)
+
+<hr />
+
 ## Quick start
 
 In order to quickly run Jitsi Meet on a machine running Docker and Docker Compose,
@@ -66,8 +79,29 @@ project.
 ## Configuration
 
 The configuration is performed via environment variables contained in a ``.env`` file. You
-can copy the provided ``env.example`` file as a reference, which contains documentation
-for all options.
+can copy the provided ``env.example`` file as a reference.
+
+Variable | Description | Example
+--- | --- | ---
+`CONFIG` | Directory where all configuration will be stored | /opt/jitsi-meet-cfg
+`TZ` | System Time Zone | Europe/Amsterdam
+`JVB_COMPONENT_SECRET` | XMPP component password for Jitsi Videobridge | s3cr3t
+`JVB_STUN_SERVERS` | STUN servers used to discover the server's public IP | stun.l.google.com:19302, stun1.l.google.com:19302, stun2.l.google.com:19302
+`JICOFO_COMPONENT_SECRET` | XMPP component password for Jicofo | s3cr37
+`JICOFO_AUTH_PASSWORD` | XMPP password for Jicofo client connections | passw0rd
+`DOCKER_HOST_ADDRESS` | IP addrss of the Docker host, needed for LAN environments | 192.168.1.1
+
+### Advanced configuration
+
+These configuration options are already set and generally don't need to be changed.
+
+Variable | Description | Default value
+--- | --- | ---
+`XMPP_DOMAIN` | Internal XMPP domain | meet.jitsi
+`XMPP_AUTH_DOMAIN` | Internal XMPP domain for authenticated services | auth.meet.jitsi
+`XMPP_BOSH_URL_BASE` | Base URL for XMPP BOSH connections | http://xmpp.meet.jitsi:5280
+`XMPP_MUC_DOMAIN` | XMPP domain for the MUC | muc.meet.jitsi
+`JICOFO_AUTH_USER` | XMPP user for Jicofo client connections | focus
 
 ### Running on a LAN environment
 
@@ -98,4 +132,3 @@ option.
 [Jitsi Videobridge]: https://github.com/jitsi/jitsi-videobridge
 [ICE]: https://en.wikipedia.org/wiki/Interactive_Connectivity_Establishment
 [STUN]: https://en.wikipedia.org/wiki/STUN
-
diff --git a/base-java/README.md b/base-java/README.md
deleted file mode 100644
index b8590cd..0000000
--- a/base-java/README.md
+++ /dev/null
@@ -1,5 +0,0 @@
-# jitsi/base-java
-
-A base image extending ``jitsi/base`` which includes OpenJDK. It's used as the base
-for all containers depending on Java, such as Jicofo or the Jitsi Videobridge.
-
diff --git a/base/README.md b/base/README.md
deleted file mode 100644
index a14634c..0000000
--- a/base/README.md
+++ /dev/null
@@ -1,20 +0,0 @@
-# jitsi/base
-
-This is a base Debian image with the [S6 Overlay](https://github.com/just-containers/s6-overlay). The
-image is used as the base for all the containers composing a Jitsi Meet installation.
-
-## Usage
-
-```
-docker run -it --rm \
-    -e TZ=Europe/Amsterdam \
-    jitsi/base \
-    /bin/bash
-```
-
-### Parameters
-
-These can be set using environment variables:
-
-* ``TZ``: system time zone.
-