From 124ba5731f629f2b15c120c95fb045403f6ef7f9 Mon Sep 17 00:00:00 2001 From: chandi Date: Thu, 11 Feb 2021 15:34:57 +0100 Subject: [PATCH] update docs for new template-based docker-compose.yml file --- README.md | 14 ++++++++++---- docs/development.md | 12 ++++++++---- 2 files changed, 18 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 1727a6d..8ee43c9 100644 --- a/README.md +++ b/README.md @@ -29,13 +29,19 @@ ```bash $ ./scripts/setup ``` -7. Start containers: +4. (optional) Make additional configuration adjustments ```bash - $ ./scripts/compose up -d + $ nano .env + # always recreate the docker-compose.yml file after making any changes + $ ./scripts/generate-compose ``` -8. If you use greenlight, you can create an admin account with: +5. Start containers: ```bash - $ ./scripts/compose exec greenlight bundle exec rake admin:create + $ docker-compose up -d + ``` +6. If you use greenlight, you can create an admin account with: + ```bash + $ docker-compose exec greenlight bundle exec rake admin:create ``` ## How-To's diff --git a/docs/development.md b/docs/development.md index 7d1624f..020814f 100644 --- a/docs/development.md +++ b/docs/development.md @@ -31,10 +31,12 @@ RAILS_SECRET=SuperRailsSecret [... add rest of sample.env here ...] ``` +- regenerate `docker-compose.yml` \ + `$ ./scripts/generate-compose` - you can than start it with \ - `$ ./scripts/compose up -d` + `$ docker-compose up -d` - view the logs with \ - `$ ./scripts/compose logs -f` + `$ docker-compose logs -f` - and access the API via \ https://mconf.github.io/api-mate/#server=https://10.7.7.1/bigbluebutton/api&sharedSecret=SuperSecret * At some point your browser will warn you about an invalid certificate, but you can press _"Accept the Risk and Continue" / "Proceed to 10.7.7.1 (unsafe)"_ @@ -44,7 +46,9 @@ RAILS_SECRET=SuperRailsSecret ## Changes - After doing some changes you usually must... + - recreate `docker-compose.yml` \ + `$ ./scripts/generate-compose` * rebuild the image(s): \ - `$ ./scripts/compose build [containername]` + `$ docker-compose build [containername]` * restart changes image(s): \ - `$ ./scripts/compose up -d` \ No newline at end of file + `$ docker-compose up -d` \ No newline at end of file