Update README.md

This commit is contained in:
Tiago D J 2019-12-09 14:44:19 -03:00 committed by GitHub
parent 78d9de9866
commit 7c38442658
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -1,6 +1,6 @@
# BigBlueButton Docker
## Dependencies
## 1. Install docker-ce
This container depends on docker-ce.
@ -31,15 +31,30 @@ sudo addgroup `whoami` docker
```
## Setting up the SSL
Generate a certificate to your container using letsencrypt and then copy your certificate to certs/ folder with the commands:
## 2. Clone this repository
```
mkdir -p ~/bbb/src/
cd ~/bbb/
git clone https://github.com/bigbluebutton/docker.git
cd docker
git checkout v2.2.x
```
## 3. Clone BBB sources repository (optional)
```
cd ~/bbb/src/
git clone https://github.com/bigbluebutton/bigbluebutton.git
```
## 4. Setup SSL certificate
Generate a certificate to your container (using letsencrypt or other solution) and then copy your certificate to certs/ folder with the commands:
```
mkdir certs/
cp fullchain.pem certs/
cp privkey.pem certs/
```
## Creating container
## 5. Creating container
In order to create the container you must specify the hostname of container and the domain name.
In this example your container will be acessible from https://bbb001.bbbvm.imdt.com.br :
@ -48,7 +63,7 @@ In this example your container will be acessible from https://bbb001.bbbvm.imdt.
docker-compose build bbb
NAME=bbb001 DOMAIN=bbbvm.imdt.com.br sh -c 'docker-compose run --name $NAME bbb'
```
## Defining an entry in your `/etc/hosts` file
## 6. Add an entry in your `/etc/hosts` file
In order to access the container, you need to get the IP address of container by running the following command:
@ -63,25 +78,30 @@ In this example, the line added on hosts file is:
172.20.0.2 bbb001.bbbvm.imdt.com.br
```
## Useful commands
## 7. Open the specified address in your browser:
### Start container (after host reboot)
http://bbb001.bbbvm.imdt.com.br
# Useful commands
## Start container (after host reboot)
```
docker start bbb001
docker attach bbb001
```
### Stop the container
## Stop the container
```
docker stop bbb001
```
### Kill the container (force exit)
## Kill the container (force exit)
```
docker kill bbb001
```
## MAC users
# MAC users
Docker for Mac OS doesn't allow direct access to container IP's.
In order to access the BBB container from your MAC os host, you can use openvpn: