ambiser
/
openvidu
mirror of https://github.com/OpenVidu/openvidu.git
8
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update readme

pull/431/head
OscarSotoSanchez 2020-03-26 16:24:09 +01:00
parent 974d87ea5c
commit ffeb867109
1 changed files with 32 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
openvidu-server/docker/openvidu-docker-compose/readme.md
View File

@ -9,9 +9,39 @@ This docker-compose running in Ubuntu 16.04 or Ubuntu 18.04. We need have a dock
- [Install Docker](https://docs.docker.com/install/linux/docker-ce/ubuntu/) - [Install Docker](https://docs.docker.com/install/linux/docker-ce/ubuntu/)
- [Install Docker Compose](https://docs.docker.com/compose/install/) - [Install Docker Compose](https://docs.docker.com/compose/install/)
We need open the next ports: We need open the next ports in the host:
- 443 TCP (OpenVidu Inspector is served on port 443 by default) - 443 TCP (OpenVidu Inspector is served on port 443 by default)
- 4443 TCP (OpenVidu Server Pro REST API endpoint listens on port 4443 by default) - 4443 TCP (OpenVidu Server Pro REST API endpoint listens on port 4443 by default)
- 3478 TCP (coturn listens on port 3478 by default) - 3478 TCP (coturn listens on port 3478 by default)
- 3478 UDP (opening also UDP port has been proved to facilitate connections with certain type of clients) - 3478 UDP (opening also UDP port has been proved to facilitate connections with certain type of clients)
- 40000 - 65535 UDP (WebRTC connections with clients may be established using a random port inside this range)
- 40000 - 65535 TCP (WebRTC connections with clients may be established using a random port inside this range, if UDP can't be used because client network is blocking it)
## 2. Deploy
### Clone Repository
First clone this repository:
`$ git clone https://github.com/OpenVidu/openvidu.git`
Change to this directory:
`cd openvidu/openvidu-server/docker/openvidu-docker-compose`
### Configure enviroment variables
Open the file `.env` and configure the following variables:
- OPENVIDU_SECRET: Used for apps and to acces to the inspector. Change it with yout secret
- DOMAIN_OR_PUBLIC_IP: Used for access the application, write the ip if you don't have a dns name or use your dns name if you have one
- OPENVIDU_RECORDING_FOLDER: Used for openvidu server recorder, select a valid folder for your host
- CERTIFICATE_TYPE: Only used if you have a dns name. Choose selfsigned for generate autfirmated certificated, this option will show a error menssage. Choose owncert if you have a certificateds or choose letsencrypt for auto generate certificated using letsencrypt.
- LETSENCRYPT_EMAIL: If you use letsencrypt certificated you need configurate a valid email for this propuse
### Run the application
For to start the application exec this command:
`docker-compose up`