From 8c0409fa5348ebd37a678ae002a0c3062ee46372 Mon Sep 17 00:00:00 2001
From: chandi <git@chandi.it>
Date: Fri, 8 Dec 2023 12:32:50 +0100
Subject: [PATCH] README: remove docker-compose version check, repeat
 requirements again, more links on top

---
 README.md | 22 ++++++++++------------
 1 file changed, 10 insertions(+), 12 deletions(-)

diff --git a/README.md b/README.md
index 0a0ebf4..e8ad7bb 100644
--- a/README.md
+++ b/README.md
@@ -3,7 +3,7 @@
 
 # 📦 BigBlueButton 2.7 Docker
 
-Version: 2.7.3 | [Changelog](CHANGELOG.md) | [Issues](https://github.com/bigbluebutton/docker/issues)
+Version: 2.7.3 | [Changelog](CHANGELOG.md) | [Issues](https://github.com/bigbluebutton/docker/issues) | [Upgrading](docs/upgrading.md) | [Development](docs/development.md)
 
 ## Features
 - Easy installation
@@ -15,7 +15,7 @@ Version: 2.7.3 | [Changelog](CHANGELOG.md) | [Issues](https://github.com/bigblue
 
 ## Requirements
 - 4GB of RAM
-- Linux (it will not work under WSL)
+- Linux (it will not work under Windows/WSL)
 - Root access (bbb-docker uses host networking, so it won't work with Kubernetes, any "CaaS"-Service, etc.)
 - Public IPv4 (expect issues with a firewall / NAT)
 
@@ -23,16 +23,16 @@ Version: 2.7.3 | [Changelog](CHANGELOG.md) | [Issues](https://github.com/bigblue
 - bbb-lti
 
 ## Install
-1. Install docker-ce & docker-compose-plugin
+1. Ensure the requirements above are fulfilled (it really doesn't work without them)
+2. Install docker-ce & docker-compose-plugin
     1. follow instructions
         * Debian: https://docs.docker.com/engine/install/debian/
         * CentOS: https://docs.docker.com/engine/install/centos/
         * Fedora: https://docs.docker.com/engine/install/fedora/
         * Ubuntu: https://docs.docker.com/engine/install/ubuntu/
     2. Ensure docker works with `$ docker run hello-world`
-    3. Install docker compose V2: https://docs.docker.com/compose/install/
-    4. Ensure docker compose works and that you use a version ≥ 1.28 : `$ docker compose --version`
-2. Clone this repository
+    3. Ensure you use a docker version ≥ 23.0 : `$ docker --version`
+3. Clone this repository
    ```sh
    $ git clone https://github.com/bigbluebutton/docker.git bbb-docker
    $ cd bbb-docker
@@ -40,28 +40,26 @@ Version: 2.7.3 | [Changelog](CHANGELOG.md) | [Issues](https://github.com/bigblue
    # use the more stable main branch (sometimes older)
    $ git checkout main 
    ```
-3. Run setup:
+4. Run setup:
    ```bash
    $ ./scripts/setup
    ```
-4. (optional) Make additional configuration adjustments
+5. (optional) Make additional configuration adjustments
    ```bash
    $ nano .env
    # always recreate the docker-compose.yml file after making any changes
    $ ./scripts/generate-compose
    ```
-5. Start containers:
+6. Start containers:
     ```bash
     $ docker compose up -d --no-build
     ```
-6. If you use greenlight, you can create an admin account with:
+7. If you use greenlight, you can create an admin account with:
     ```bash
     $ docker compose exec greenlight bundle exec rake admin:create
     ```
 
 ## 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)