From 19cdbe0aaafcd0dbdb7ceba8b9fdf4a949a57969 Mon Sep 17 00:00:00 2001
From: chandi <git@chandi.it>
Date: Thu, 11 Feb 2021 16:01:32 +0100
Subject: [PATCH] update README.md for bigbluebutton/docker

---
 README.md | 38 ++++++++++++++++++++++++--------------
 1 file changed, 24 insertions(+), 14 deletions(-)

diff --git a/README.md b/README.md
index 8ee43c9..7f1159f 100644
--- a/README.md
+++ b/README.md
@@ -1,14 +1,26 @@
-# BigBlueButton Docker
+# BigBlueButton 2.3 Docker
+
+not ready for production | [Changelog](CHANGELOG.md) | [Issues](https://github.com/bigbluebutton/docker/issues)
+
+## Important
+**This Repository - and BBB 2.3 itself - are still in an early state. Don't use it in production yet!** \
+Testing and further development welcome :)
+
+you can find a **stable bbb-docker release for 2.2** here: https://github.com/alangecker/bigbluebutton-docker
 
-[Changelog](CHANGELOG.md) | [Issues](https://github.com/alangecker/bigbluebutton-docker/issues)
 
 ## Features
 - Easy installation
 - Greenlight included
 - TURN server included
 - Fully automated HTTPS certificates
-- Runs on almost any major linux distributon (Debian, Ubuntu, CentOS,...)
 - Full IPv6 support
+- Runs on any major linux distributon (Debian, Ubuntu, CentOS,...)
+
+## What does not work
+- probably a lot - it's in an alpha state!
+- Load balancing of html5 meteor processes
+- bbb-lti
 
 ## Install
 1. Install docker-ce & docker-compose
@@ -19,22 +31,22 @@
         * Ubuntu: https://docs.docker.com/engine/install/ubuntu/
     2. Ensure docker works with `$ docker run hello-world`
     3. Install docker-compose: https://docs.docker.com/compose/install/
-    4. Ensure docker-compose works: `$ docker-compose --version`
-5. Clone this repository
+    4. Ensure docker-compose works and that you use a version ≥ 1.28 : `$ docker-compose --version`
+2. Clone this repository
    ```sh
-   $ git clone --recurse-submodules https://github.com/alangecker/bigbluebutton-docker.git bbb-docker
+   $ git clone --recurse-submodules https://github.com/bigbluebutton/docker.git bbb-docker
    $ cd bbb-docker
    ```
-6. Run setup:
+3. Run setup:
    ```bash
    $ ./scripts/setup
    ```
 4. (optional) Make additional configuration adjustments
-    ```bash
+   ```bash
    $ nano .env
    # always recreate the docker-compose.yml file after making any changes
    $ ./scripts/generate-compose
-    ```
+   ```
 5. Start containers:
     ```bash
     $ docker-compose up -d
@@ -44,11 +56,9 @@
     $ docker-compose exec greenlight bundle exec rake admin:create
     ```
 
-## How-To's
-- [Upgrade](docs/upgrading.md)
-- [Behind NAT](docs/behind-nat.md)
+## Further How-To's
+- [Upgrading](docs/upgrading.md)
+- [Running behind NAT](docs/behind-nat.md)
 - [BBB-Docker Development](docs/development.md)
 - [Integration into an existing web server](docs/existing-web-server.md)
 
-## Special thanks to
-- @dkrenn, whos dockerized version (bigbluebutton#8858)(https://github.com/bigbluebutton/bigbluebutton/pull/8858) helped me a lot in understand and some configs.