mirror of
https://github.com/bigbluebutton/docker.git
synced 2025-06-19 19:29:02 +02:00
update docs for 3.0
This commit is contained in:
parent
b61e8c8a17
commit
70d9b0166d
22
README.md
22
README.md
@ -13,6 +13,11 @@ Version: 3.0.1 | [Changelog](CHANGELOG.md) | [Issues](https://github.com/bigblue
|
||||
- Full IPv6 support
|
||||
- Runs on any major linux distributon (Debian, Ubuntu, CentOS,...)
|
||||
|
||||
## currently missing / broken
|
||||
- NAT support
|
||||
- bbb-transcription-controller
|
||||
- livekit
|
||||
|
||||
## Requirements
|
||||
- 4GB of RAM
|
||||
- Linux (it will not work under Windows/WSL)
|
||||
@ -20,7 +25,7 @@ Version: 3.0.1 | [Changelog](CHANGELOG.md) | [Issues](https://github.com/bigblue
|
||||
- Public IPv4 (expect issues with a firewall / NAT)
|
||||
- firewall allows internal networking (e.g. for ufw: `ufw allow 10.7.7.0/24`)
|
||||
|
||||
## Install
|
||||
## Install production server
|
||||
1. Ensure the requirements above are fulfilled (it really doesn't work without them)
|
||||
2. Install docker-ce & docker-compose-plugin
|
||||
1. follow instructions
|
||||
@ -57,7 +62,20 @@ Version: 3.0.1 | [Changelog](CHANGELOG.md) | [Issues](https://github.com/bigblue
|
||||
$ docker compose exec greenlight bundle exec rake admin:create
|
||||
```
|
||||
|
||||
## Development setup
|
||||
1. Clone this repository
|
||||
```sh
|
||||
$ git clone --recurse-submodules https://github.com/bigbluebutton/docker.git bbb-dev
|
||||
```
|
||||
2. Start dev server
|
||||
```sh
|
||||
$ cd bbb-dev
|
||||
$ ./scripts/dev
|
||||
```
|
||||
3. Use API Mate with the link presented in the console to create & join a conference
|
||||
|
||||
|
||||
## Further How-To's
|
||||
- [Running behind NAT](docs/behind-nat.md)
|
||||
<!-- - [Running behind NAT](docs/behind-nat.md) -->
|
||||
- [Integration into an existing web server](docs/existing-web-server.md)
|
||||
|
||||
|
@ -15,6 +15,8 @@ you can now run bbb-docker locally by simply starting
|
||||
$ ./scripts/dev
|
||||
```
|
||||
|
||||
Use the API Mate with the link presented in the console to create & join a conference.
|
||||
|
||||
### Hints
|
||||
- the html5 component will watch and automatically reload on any changes 🚀
|
||||
- if you change anything in the other components, you need to
|
||||
@ -26,10 +28,7 @@ $ ./scripts/dev
|
||||
`$ ./scripts/generate-compose`
|
||||
- view the logs with \
|
||||
`$ 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)"_
|
||||
|
||||
- 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)"_
|
||||
|
||||
## Notes
|
||||
- Due to the self signed ssl certificate it is currently not possible to notify greenlight about recordings in dev mode
|
||||
|
@ -1,29 +1,27 @@
|
||||
# How To Upgrade bbb-docker
|
||||
|
||||
### Upgrading from `v2.6.x`
|
||||
- **Breaking change:** We use now Docker Compose V2
|
||||
### Breaking changes `v2.7.x` -> `v3.0.x`
|
||||
- **A setup behind NAT does currently not work!**
|
||||
- on every SIP Profiles the extension field needs to be set to "DIALIN"
|
||||
|
||||
### Breaking changes `v2.6.x` -> `v2.7.x`
|
||||
- We use now Docker Compose V2
|
||||
* make sure you have docker ≥ 23.0 installed (`$ docker -v`)
|
||||
* update all usages of `docker-compose` to `docker compose` in your scripts
|
||||
|
||||
apart from that follow the guide (_within v2.7.x_) below.
|
||||
|
||||
### Upgrading from `v2.5.x`
|
||||
|
||||
- **Breaking change:** Greenlight got fully rewritten
|
||||
### Breaking changes `v2.5.x` -> `v2.6.x`
|
||||
- Greenlight got fully rewritten
|
||||
* it is starting as a fresh installation. you can migrate your data with `./scripts/greenlight-migrate-v2-v3`
|
||||
* some greenlight settings under `.env` have changed. compare your version with `sample.env`
|
||||
* it is now served directly under `/` and not in `/b`. If you use an reverse proxy not included in this repo, ensure to update your config accordingly!
|
||||
|
||||
apart from that follow the guide below.
|
||||
|
||||
### within `v2.7.x`
|
||||
#### Backup
|
||||
### Backup
|
||||
if you use greenlight, create a database backup first
|
||||
```bash
|
||||
docker exec -t docker_postgres_1 pg_dumpall -c -U postgres > /root/greenlight_`date +%d-%m-%Y"_"%H_%M_%S`.sql
|
||||
```
|
||||
|
||||
#### Upgrading
|
||||
### Upgrading
|
||||
```bash
|
||||
# upgrade!
|
||||
./scripts/upgrade
|
||||
|
Loading…
x
Reference in New Issue
Block a user