Changes in documentation

pull/431/head
OscarSotoSanchez 2020-03-27 16:09:32 +01:00
parent 86ffec9bfe
commit 45c75a54c1
4 changed files with 37 additions and 7 deletions

View File

@ -6,7 +6,7 @@
OPENVIDU_SECRET=MY_SECRET OPENVIDU_SECRET=MY_SECRET
# Domain name. If you do not have one, the public IP of the machine. # Domain name. If you do not have one, the public IP of the machine.
DOMAIN_OR_PUBLIC_IP=openvidu.example.com DOMAIN_OR_PUBLIC_IP=192.168.1.66
# Openvidu Folder Record used for save the openvidu recording videos. Change it # Openvidu Folder Record used for save the openvidu recording videos. Change it
# with the folder you want to use from your host. # with the folder you want to use from your host.
@ -26,3 +26,9 @@ CERTIFICATE_TYPE=selfsigned
# If CERTIFICATE_TYPE=letsencrypt, you need to configure a valid email for # If CERTIFICATE_TYPE=letsencrypt, you need to configure a valid email for
# notifications # notifications
LETSENCRYPT_EMAIL=user@example.com LETSENCRYPT_EMAIL=user@example.com
# Kurento Media Server image
# --------------------------
# Docker hub kurento media server: https://hub.docker.com/r/kurento/kurento-media-server-dev
# Uncomment the next line and write the KMS image that you want use
# KMS_IMAGE=kurento-media-server-dev:6.13

View File

@ -1,6 +1,9 @@
version: '3.1' version: '3.1'
services: services:
# Change this if your want use your own application.
# It's very important expose your application in port 5443
# and use the http protocol.
app: app:
image: openvidu/openvidu-call:2.13.0-beta1 image: openvidu/openvidu-call:2.13.0-beta1
restart: on-failure restart: on-failure

View File

@ -1,6 +1,9 @@
version: '3.1' version: '3.1'
services: services:
# In this docker-compose are deployed the Openvidu services.
# This file not necessary change, you only need change
# the .env file with the necessaries variables.
openvidu-server: openvidu-server:
image: openvidu/openvidu-server:2.13.0-beta1 image: openvidu/openvidu-server:2.13.0-beta1
entrypoint: ["java", "-jar", "/openvidu-server.jar"] entrypoint: ["java", "-jar", "/openvidu-server.jar"]
@ -21,7 +24,7 @@ services:
- COTURN_REDIS_IP=127.0.0.1 - COTURN_REDIS_IP=127.0.0.1
kms: kms:
image: kurento/kurento-media-server-dev:6.13 image: kurento/${KMS_IMAGE:-kurento-media-server-dev:6.13}
restart: on-failure restart: on-failure
network_mode: host network_mode: host
environment: environment:

View File

@ -11,12 +11,14 @@ This docker-compose running in Ubuntu 16.04 or Ubuntu 18.04. We need have a dock
We need open the next ports in the host: We need open the next ports in the host:
- 443 TCP (OpenVidu Inspector is served on port 443 by default) - 80 TCP (Letsencrypt getting certificated by default in this port)
- 4443 TCP (OpenVidu Server Pro REST API endpoint listens on port 4443 by default) - 443 TCP (OpenVidu Server and Openvidu Call view Services section for more information)
- 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 - 57000 UDP (Kurento Media Server listens on this ports)
- 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) - 40000 - 57000 UDP (Kurento Media Server listens on this ports)
- 57001 - 65535 UDP (WebRTC connections with clients may be established using a random port inside this range)
- 57001 - 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 ## 2. Deploy
@ -40,8 +42,24 @@ Open the file `.env` and configure the following variables:
- 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. - 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 - LETSENCRYPT_EMAIL: If you use letsencrypt certificated you need configurate a valid email for this propuse
### Deployment application
The application Openvidu Call is deployment by default in this docker-compose. The configuration of this application can will see in the file `docker-compose.override.yml`.
If your want deploy your own application change the `app` service in the `docker-compose.override.yml`. Just keep in mind expose your own application in the port `5442` and use `http`.
### Run the application ### Run the application
For to start the application exec this command: For to start the application exec this command:
`docker-compose up` `docker-compose up`
When you see the message in console `OPENVIDU SERVER IP` the page is ready for enjoy it
### Stop the application
For to stop the application exec this command:
`docker-compose down`