diff --git a/openvidu-server/deployments/pro/docker-compose/mono-node/.env b/openvidu-server/deployments/pro/docker-compose/mono-node/.env new file mode 100644 index 00000000..85d0bc20 --- /dev/null +++ b/openvidu-server/deployments/pro/docker-compose/mono-node/.env @@ -0,0 +1,311 @@ +# OpenVidu configuration +# ---------------------- +# Documentation: https://docs.openvidu.io/en/stable/reference-docs/openvidu-config/ + +# NOTE: This file doesn't need to quote assignment values, like most shells do. +# All values are stored as-is, even if they contain spaces, so don't quote them. + +# Domain name. If you do not have one, the public IP of the machine. +# For example: 198.51.100.1, or openvidu.example.com +DOMAIN_OR_PUBLIC_IP= + +# OpenVidu Pro License +OPENVIDU_PRO_LICENSE= + +# OpenVidu SECRET used for apps to connect to OpenVidu server and users to access to OpenVidu Dashboard +OPENVIDU_SECRET= + +# OpenVidu edition to use. Can be "pro" or "enterprise" +OPENVIDU_EDITION=pro + +# Certificate type: +# - selfsigned: Self signed certificate. Not recommended for production use. +# Users will see an ERROR when connected to web page. +# - owncert: Valid certificate purchased in a Internet services company. +# Please put the certificates files inside folder ./owncert +# with names certificate.key and certificate.cert +# - letsencrypt: Generate a new certificate using letsencrypt. Please set the +# required contact email for Let's Encrypt in LETSENCRYPT_EMAIL +# variable. +CERTIFICATE_TYPE=selfsigned + +# If CERTIFICATE_TYPE=letsencrypt, you need to configure a valid email for notifications +LETSENCRYPT_EMAIL=user@example.com + +# Proxy configuration +# If you want to change the ports on which openvidu listens, uncomment the following lines + +# Allows any request to http://DOMAIN_OR_PUBLIC_IP:HTTP_PORT/ to be automatically +# redirected to https://DOMAIN_OR_PUBLIC_IP:HTTPS_PORT/. +# WARNING: the default port 80 cannot be changed during the first boot +# if you have chosen to deploy with the option CERTIFICATE_TYPE=letsencrypt +# HTTP_PORT=80 + +# Changes the port of all services exposed by OpenVidu. +# SDKs, REST clients and browsers will have to connect to this port +# HTTPS_PORT=443 + +# Old paths are considered now deprecated, but still supported by default. +# OpenVidu Server will log a WARN message every time a deprecated path is called, indicating +# the new path that should be used instead. You can set property SUPPORT_DEPRECATED_API=false +# to stop allowing the use of old paths. +# Default value is true +# SUPPORT_DEPRECATED_API=false + +# If true request to with www will be redirected to non-www requests +# Default value is false +# REDIRECT_WWW=false + +# How many workers to configure in nginx proxy. +# The more workers, the more requests will be handled +# Default value is 10240 +# WORKER_CONNECTIONS=10240 + +# Access restrictions +# In this section you will be able to restrict the IPs from which you can access to +# Openvidu API and the Administration Panel +# WARNING! If you touch this configuration you can lose access to the platform from some IPs. +# Use it carefully. + +# This section limits access to the /dashboard (OpenVidu CE) and /inspector (OpenVidu Pro) pages. +# The form for a single IP or an IP range is: +# ALLOWED_ACCESS_TO_DASHBOARD=198.51.100.1 and ALLOWED_ACCESS_TO_DASHBOARD=198.51.100.0/24 +# To limit multiple IPs or IP ranges, separate by commas like this: +# ALLOWED_ACCESS_TO_DASHBOARD=198.51.100.1, 198.51.100.0/24 +# ALLOWED_ACCESS_TO_DASHBOARD= + +# This section limits access to the Openvidu REST API. +# The form for a single IP or an IP range is: +# ALLOWED_ACCESS_TO_RESTAPI=198.51.100.1 and ALLOWED_ACCESS_TO_RESTAPI=198.51.100.0/24 +# To limit multiple IPs or or IP ranges, separate by commas like this: +# ALLOWED_ACCESS_TO_RESTAPI=198.51.100.1, 198.51.100.0/24 +# ALLOWED_ACCESS_TO_RESTAPI= + +# Mode of cluster management. Can be auto (OpenVidu manages Media Nodes on its own. +# Parameter KMS_URIS is ignored) or manual (user must manage Media Nodes. Parameter +# KMS_URIS is used: if any uri is provided it must be valid) +OPENVIDU_PRO_CLUSTER_MODE=manual + +# Which environment are you using +# Possibles values: aws, on_premise +OPENVIDU_PRO_CLUSTER_ENVIRONMENT=on_premise + +# Unique identifier of your cluster. Each OpenVidu Server Pro instance corresponds to one cluster. +# You can launch as many clusters as you want with your license key. +# Cluster ID will always be stored to disk so restarting OpenVidu Server Pro will keep the same previous cluster ID +# if this configuration parameter is not given a distinct value. +# OPENVIDU_PRO_CLUSTER_ID= + +# What parameter should be used to distribute the creation of new sessions +# (and therefore distribution of load) among all available Media Nodes +OPENVIDU_PRO_CLUSTER_LOAD_STRATEGY=streams + +# Whether to enable or disable Network Quality API. You can monitor and +# warn users about the quality of their networks with this feature +# OPENVIDU_PRO_NETWORK_QUALITY=false + +# If OPENVIDU_PRO_NETWORK_QUALITY=true, how often the network quality +# algorithm will be invoked for each user, in seconds +# OPENVIDU_PRO_NETWORK_QUALITY_INTERVAL=5 + +# Max days until delete indexes in state of rollover on Elasticsearch +# Type number >= 0 +# Default Value is 7 +# OPENVIDU_PRO_ELASTICSEARCH_MAX_DAYS_DELETE= + +# If you have an external Elasticsearch and Kibana already running, put here the url to elasticsearch and kibana services. +# It is very important that both url have the port specified in the url. +# If you want to use the deployed Elasticsearch and Kibana locally, keep these variables commented. +#OPENVIDU_PRO_ELASTICSEARCH_HOST= +#OPENVIDU_PRO_KIBANA_HOST= + +# Where to store recording files. Can be 'local' (local storage) or 's3' (AWS bucket). +# You will need to define a OPENVIDU_PRO_AWS_S3_BUCKET if you use it. +#OPENVIDU_PRO_RECORDING_STORAGE= + +# S3 Bucket where to store recording files. May include paths to allow navigating +# folder structures inside the bucket. This property is only taken into account +# if OPENVIDU_PRO_RECORDING_STORAGE=s3 +#OPENVIDU_PRO_AWS_S3_BUCKET= + +# If OPENVIDU_PRO_RECORDING_STORAGE=s3, the collection of HTTP header values that the internal AWS client will use during +# the upload process. The property is a key-value map of strings, following the format of a JSON object. For example, for applying +# server-side encryption with AES-256, this header is mandatory: {"x-amz-server-side-encryption":"AES256"}. +# The list of available headers can be found here: https://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/com/amazonaws/services/s3/Headers.html +# This property is only taken into account if OPENVIDU_PRO_RECORDING_STORAGE=s3 +#OPENVIDU_PRO_AWS_S3_HEADERS= + +# If you're instance has a role which has access to read +# and write into the s3 bucket, you don't need this parameter +# OPENVIDU_PRO_AWS_ACCESS_KEY= + +# AWS credentials secret key from OPENVIDU_PRO_AWS_ACCESS_KEY. This property is only +# taken into account if OPENVIDU_PRO_RECORDING_STORAGE=s3 +# If you're instance has a role which has access to read +# and write into the s3 bucket, you don't need this parameter +# OPENVIDU_PRO_AWS_SECRET_KEY= + +# AWS region in which the S3 bucket is located (e.g. eu-west-1). If not provided, +# the region will try to be discovered automatically, although this is not always possible. +# This property is only taken into account if OPENVIDU_PRO_RECORDING_STORAGE=s3 +#OPENVIDU_PRO_AWS_REGION= + +# Whether to enable recording module or not +OPENVIDU_RECORDING=false + +# Use recording module with debug mode. +OPENVIDU_RECORDING_DEBUG=false + +# Openvidu Folder Record used for save the openvidu recording videos. Change it +# with the folder you want to use from your host. +OPENVIDU_RECORDING_PATH=/opt/openvidu/recordings + +# System path where OpenVidu Server should look for custom recording layouts +OPENVIDU_RECORDING_CUSTOM_LAYOUT=/opt/openvidu/custom-layout + +# if true any client can connect to +# https://OPENVIDU_SERVER_IP:OPENVIDU_PORT/recordings/any_session_file.mp4 +# and access any recorded video file. If false this path will be secured with +# OPENVIDU_SECRET param just as OpenVidu Server dashboard at +# https://OPENVIDU_SERVER_IP:OPENVIDU_PORT +# Values: true | false +OPENVIDU_RECORDING_PUBLIC_ACCESS=false + +# Which users should receive the recording events in the client side +# (recordingStarted, recordingStopped). Can be all (every user connected to +# the session), publisher_moderator (users with role 'PUBLISHER' or +# 'MODERATOR'), moderator (only users with role 'MODERATOR') or none +# (no user will receive these events) +OPENVIDU_RECORDING_NOTIFICATION=publisher_moderator + +# Timeout in seconds for recordings to automatically stop (and the session involved to be closed) +# when conditions are met: a session recording is started but no user is publishing to it or a session +# is being recorded and last user disconnects. If a user publishes within the timeout in either case, +# the automatic stop of the recording is cancelled +# 0 means no timeout +OPENVIDU_RECORDING_AUTOSTOP_TIMEOUT=120 + +# Maximum video bandwidth sent from clients to OpenVidu Server, in kbps. +# 0 means unconstrained +OPENVIDU_STREAMS_VIDEO_MAX_RECV_BANDWIDTH=1000 + +# Minimum video bandwidth sent from clients to OpenVidu Server, in kbps. +# 0 means unconstrained +OPENVIDU_STREAMS_VIDEO_MIN_RECV_BANDWIDTH=300 + +# Maximum video bandwidth sent from OpenVidu Server to clients, in kbps. +# 0 means unconstrained +OPENVIDU_STREAMS_VIDEO_MAX_SEND_BANDWIDTH=1000 + +# Minimum video bandwidth sent from OpenVidu Server to clients, in kbps. +# 0 means unconstrained +OPENVIDU_STREAMS_VIDEO_MIN_SEND_BANDWIDTH=300 + +# All sessions of OpenVidu will try to force this codec. If OPENVIDU_STREAMS_ALLOW_TRANSCODING=true +# when a codec can not be forced, transcoding will be allowed +# Values: MEDIA_SERVER_PREFERRED, NONE, VP8, VP9, H264 +# Default value is MEDIA_SERVER_PREFERRED +# OPENVIDU_STREAMS_FORCED_VIDEO_CODEC=MEDIA_SERVER_PREFERRED + +# Allow transcoding if codec specified in OPENVIDU_STREAMS_FORCED_VIDEO_CODEC can not be applied +# Values: true | false +# Default value is false +# OPENVIDU_STREAMS_ALLOW_TRANSCODING=false + +# Use Simulcast video on WebRTC Publishers. +# Senders will encode duplicate video streams with different qualities, +# so the media server is able to select the most appropriate quality stream +# for each Subscriber. +# This setting is honored only if OpenVidu Server was configured to use the +# mediasoup media server. Otherwise, Simulcast will be disabled. +# Values: true | false +# Default: false +#OPENVIDU_WEBRTC_SIMULCAST=false + +# Send openvidu-browser logs of clients to Elasticsearch +# Possible values: +# - disabled: Don't send logs. (default) +# - debug: Send all openvidu-browser logs +# - debug_app: Send openvidu-browser logs and frontend app logs +# OPENVIDU_BROWSER_LOGS=disabled + +# true to enable OpenVidu Webhook service. false' otherwise +# Values: true | false +OPENVIDU_WEBHOOK=false + +# HTTP endpoint where OpenVidu Server will send Webhook HTTP POST messages +# Must be a valid URL: http(s)://ENDPOINT +#OPENVIDU_WEBHOOK_ENDPOINT= + +# List of headers that OpenVidu Webhook service will attach to HTTP POST messages +#OPENVIDU_WEBHOOK_HEADERS= + +# List of events that will be sent by OpenVidu Webhook service +# Default value is all available events +OPENVIDU_WEBHOOK_EVENTS=[sessionCreated,sessionDestroyed,participantJoined,participantLeft,webrtcConnectionCreated,webrtcConnectionDestroyed,recordingStatusChanged,filterEventDispatched,mediaNodeStatusChanged,nodeCrashed,nodeRecovered] + +# How often the garbage collector of non active sessions runs. +# This helps cleaning up sessions that have been initialized through +# REST API (and maybe tokens have been created for them) but have had no users connected. +# Default to 900s (15 mins). 0 to disable non active sessions garbage collector +OPENVIDU_SESSIONS_GARBAGE_INTERVAL=900 + +# Minimum time in seconds that a non active session must have been in existence +# for the garbage collector of non active sessions to remove it. Default to 3600s (1 hour). +# If non active sessions garbage collector is disabled +# (property 'OPENVIDU_SESSIONS_GARBAGE_INTERVAL' to 0) this property is ignored +OPENVIDU_SESSIONS_GARBAGE_THRESHOLD=3600 + +# Call Detail Record enabled +# Whether to enable Call Detail Record or not +# Values: true | false +OPENVIDU_CDR=false + +# Path where the cdr log files are hosted +OPENVIDU_CDR_PATH=/opt/openvidu/cdr + +# Openvidu Server Level logs +# -------------------------- +# Uncomment the next line and define this variable to change +# the verbosity level of the logs of Openvidu Service +# RECOMENDED VALUES: INFO for normal logs DEBUG for more verbose logs +# OV_CE_DEBUG_LEVEL=INFO + +# OpenVidu Java Options +# -------------------------- +# Uncomment the next line and define this to add options to java command +# Documentation: https://docs.oracle.com/cd/E37116_01/install.111210/e23737/configuring_jvm.htm#OUDIG00058 +# JAVA_OPTIONS=-Xms2048m -Xmx4096m + +# ElasticSearch Java Options +# -------------------------- +# Uncomment the next line and define this to add options to java command of Elasticsearch +# Documentation: https://docs.oracle.com/cd/E37116_01/install.111210/e23737/configuring_jvm.htm#OUDIG00058 +# By default ElasticSearch is configured to use "-Xms2g -Xmx2g" as Java Min and Max memory heap allocation +# ES_JAVA_OPTS=-Xms2048m -Xmx4096m + +# Kibana And ElasticSearch Credentials Configuration +# -------------------------- +# Kibana And ElasticSearch Basic Auth configuration (Credentials) +# This credentials will aso be valid for Kibana dashboard +ELASTICSEARCH_USERNAME=elasticadmin +ELASTICSEARCH_PASSWORD= + +# Media Node Configuration +# -------------------------- +# You can add any KMS environment variable as described in the +# documentation of the docker image: https://hub.docker.com/r/kurento/kurento-media-server +# If you want to add an environment variable to KMS, you must add a variable using this prefix: 'KMS_DOCKER_ENV_', +# followed by the environment variable you want to setup. +# For example if you want to setup KMS_MIN_PORT to 50000, it would be KMS_DOCKER_ENV_KMS_MIN_PORT=50000 + +# Docker hub kurento media server: https://hub.docker.com/r/kurento/kurento-media-server +# Uncomment the next line and define this variable with KMS image that you want use +# By default, KMS_IMAGE is defined in media nodes and it does not need to be specified unless +# you want to use a specific version of KMS +# KMS_IMAGE=kurento/kurento-media-server:6.18.0 + +# Uncomment the next line and define this variable to change +# the verbosity level of the logs of KMS +# Documentation: https://doc-kurento.readthedocs.io/en/stable/features/logging.html +# KMS_DOCKER_ENV_GST_DEBUG= diff --git a/openvidu-server/deployments/pro/docker-compose/mono-node/beats/filebeat.yml b/openvidu-server/deployments/pro/docker-compose/mono-node/beats/filebeat.yml new file mode 100644 index 00000000..2e2824b7 --- /dev/null +++ b/openvidu-server/deployments/pro/docker-compose/mono-node/beats/filebeat.yml @@ -0,0 +1,88 @@ +filebeat.inputs: + - type: container + paths: + - '/var/lib/docker/containers/*/*.log' + - type: log + paths: + - /opt/openvidu/kurento-logs/*.log + fields: + kurento-media-server: true + ip: ${MEDIA_NODE_IP} + cluster_id: ${CLUSTER_ID} + node_id: ${NODE_ID} + node_role: medianode + fields_under_root: true + - type: container + paths: + - '/var/lib/docker/containers/*/*.log' + fields: + cluster_id: ${OPENVIDU_PRO_CLUSTER_ID:${DOMAIN_OR_PUBLIC_IP:undefined}} + node_id: master_${AWS_INSTANCE_ID:${OPENVIDU_PRO_CLUSTER_ID:${DOMAIN_OR_PUBLIC_IP:undefined}}} + node_role: masternode + fields_under_root: true + +processors: + - add_docker_metadata: + host: "unix:///var/run/docker.sock" + - add_host_metadata: + netinfo.enabled: true + + - decode_json_fields: + fields: ["message"] + target: "json" + overwrite_keys: true + - drop_event: + when.or: + - contains: + container.image.name: docker.elastic.co/beats/filebeat-oss + - contains: + container.image.name: docker.elastic.co/beats/metricbeat-oss + - contains: + container.image.name: openvidu/openvidu-coturn + - contains: + container.image.name: docker.elastic.co/elasticsearch/elasticsearch + - contains: + container.image.name: docker.elastic.co/kibana/kibana + - contains: + container.image.name: docker.elastic.co/beats/filebeat-oss + - contains: + container.image.name: docker.elastic.co/beats/metricbeat-oss + - contains: + container.image.name: openvidu/openvidu-server-pro + +output: + elasticsearch: + indices: + - index: "filebeat-kurento-%{+yyyy.MM.dd}" + when.or: + - equals: + kurento-media-server: true + - index: "filebeat-mediasoup-%{+yyyy.MM.dd}" + when.or: + - contains: + container.image.name: openvidu/mediasoup-controller + - index: "filebeat-media-node-controller-%{+yyyy.MM.dd}" + when.or: + - contains: + container.image.name: openvidu/media-node-controller + - index: "filebeat-openvidu-recording-%{+yyyy.MM.dd}" + when.or: + - contains: + container.image.name: openvidu/openvidu-recording + - index: "filebeat-nginx-%{+yyyy.MM.dd}" + when.or: + - contains: + container.image.name: openvidu/openvidu-proxy + - index: "filebeat-openvidu-recording-%{+yyyy.MM.dd}" + when.or: + - contains: + container.image.name: openvidu/openvidu-recording + pipelines: + - pipeline: kurento-pipeline + when.or: + - equals: + kurento-media-server: true + +logging.json: true +logging.metrics.enabled: false +setup.ilm.enabled: false diff --git a/openvidu-server/deployments/pro/docker-compose/mono-node/beats/metricbeat-elasticsearch.yml b/openvidu-server/deployments/pro/docker-compose/mono-node/beats/metricbeat-elasticsearch.yml new file mode 100644 index 00000000..87554e5c --- /dev/null +++ b/openvidu-server/deployments/pro/docker-compose/mono-node/beats/metricbeat-elasticsearch.yml @@ -0,0 +1,44 @@ +metricbeat.modules: + - module: nginx + metricsets: ["stubstatus"] + enabled: true + period: ${OPENVIDU_PRO_STATS_MONITORING_INTERVAL}s + hosts: ["http://127.0.0.1"] + server_status_path: "nginx_status" + - module: system + metricsets: + - cpu + - diskio + - memory + - network + - filesystem + - fsstat + #- process + - process_summary + - uptime + filesystem.ignore_types: [nfs, smbfs, autofs, devtmpfs, devpts, hugetlbfs, tmpfs, sysfs, securityfs, cgroup2, cgroup, pstore, debugfs, configfs, fusectl, proc, fuse.lxcfs, squashfs] + processes: ['.*'] + # process.include_top_n: + # by_cpu: 2 + # by_memory: 2 + processors: + - drop_event: + when: + or: + - regexp: + system.network.name: '^(veth|lo|docker|br-)($|)' + - regexp: + system.filesystem.mount_point: '^/(sys|cgroup|proc|dev|etc|host)($|/)' + - regexp: + system.filesystem.mount_point: '^/hostfs/(sys|cgroup|proc|dev|etc|host)($|/)' + enabled: true + period: ${OPENVIDU_PRO_STATS_MONITORING_INTERVAL}s + cpu.metrics: [normalized_percentages] +fields: + ip: "${MEDIA_NODE_IP}" + cluster_id: ${OPENVIDU_PRO_CLUSTER_ID:${DOMAIN_OR_PUBLIC_IP:undefined}} + node_id: master_${AWS_INSTANCE_ID:${OPENVIDU_PRO_CLUSTER_ID:${DOMAIN_OR_PUBLIC_IP:undefined}}} + node_role: masternode +pipeline: + queue.mem.events: 0 +setup.ilm.enabled: false diff --git a/openvidu-server/deployments/pro/docker-compose/mono-node/docker-compose.override.yml b/openvidu-server/deployments/pro/docker-compose/mono-node/docker-compose.override.yml new file mode 100644 index 00000000..cfc25001 --- /dev/null +++ b/openvidu-server/deployments/pro/docker-compose/mono-node/docker-compose.override.yml @@ -0,0 +1,26 @@ +version: '3.1' + +services: + # -------------------------------------------------------------- + # + # Change this if your want use your own application. + # It's very important expose your application in port 5442 + # and use the http protocol. + # + # Default Application + # + # Openvidu-Call Version: 2.23.0 + # + # -------------------------------------------------------------- + app: + image: openvidu/openvidu-call:2.23.0 + restart: on-failure + network_mode: host + environment: + - SERVER_PORT=5442 + - OPENVIDU_URL=http://localhost:5443 + - OPENVIDU_SECRET=${OPENVIDU_SECRET} + - CALL_OPENVIDU_CERTTYPE=${CERTIFICATE_TYPE} + logging: + options: + max-size: "${DOCKER_LOGS_MAX_SIZE:-100M}" diff --git a/openvidu-server/deployments/pro/docker-compose/mono-node/docker-compose.yml b/openvidu-server/deployments/pro/docker-compose/mono-node/docker-compose.yml new file mode 100644 index 00000000..bc79d312 --- /dev/null +++ b/openvidu-server/deployments/pro/docker-compose/mono-node/docker-compose.yml @@ -0,0 +1,148 @@ +# ------------------------------------------------------------------------------ +# +# DO NOT MODIFY THIS FILE !!! +# +# Configuration properties should be specified in .env file +# +# Application based on OpenVidu should be specified in +# docker-compose.override.yml file +# +# This docker-compose file coordinates all services of OpenVidu Pro Platform +# +# This file will be overridden when update OpenVidu Platform +# +# Openvidu Version: 2.23.0 +# +# Installation Mode: OpenVidu PRO On Premises - Mono Node +# +# ------------------------------------------------------------------------------ + +version: '3.1' + +services: + + openvidu-server: + image: openvidu/openvidu-server-pro:2.23.0 + restart: on-failure + network_mode: host + entrypoint: ['/usr/local/bin/entrypoint.sh'] + volumes: + - ./coturn:/run/secrets/coturn + - /var/run/docker.sock:/var/run/docker.sock + - ${OPENVIDU_RECORDING_PATH}:${OPENVIDU_RECORDING_PATH} + - ${OPENVIDU_RECORDING_CUSTOM_LAYOUT}:${OPENVIDU_RECORDING_CUSTOM_LAYOUT} + - ${OPENVIDU_CDR_PATH}:${OPENVIDU_CDR_PATH} + - ./cluster:/opt/openvidu/cluster + - .env:${PWD}/.env + env_file: + - .env + environment: + - SERVER_SSL_ENABLED=false + - SERVER_PORT=5443 + - KMS_URIS=[] + - COTURN_IP=${COTURN_IP:-auto-ipv4} + - COTURN_PORT=${COTURN_PORT:-3478} + - OPENVIDU_PRO_CLUSTER=true + - OPENVIDU_PRO_KIBANA_HOST=${OPENVIDU_PRO_KIBANA_HOST:-http://127.0.0.1/kibana} + - OPENVIDU_PRO_ELASTICSEARCH_HOST=${OPENVIDU_PRO_ELASTICSEARCH_HOST:-http://127.0.0.1:9200} + - WAIT_KIBANA_URL=${OPENVIDU_PRO_KIBANA_HOST:-http://127.0.0.1/kibana} + - DOTENV_PATH=${PWD} + - OPENVIDU_PRO_COTURN_IN_MEDIA_NODES=${OPENVIDU_PRO_COTURN_IN_MEDIA_NODES:-false} + - OPENVIDU_PRO_COTURN_PORT_MEDIA_NODES=${OPENVIDU_PRO_COTURN_PORT_MEDIA_NODES:-443} + - OPENVIDU_PRO_MEDIA_NODE_PUBLIC_IP_AUTODISCOVER=${OPENVIDU_PRO_MEDIA_NODE_PUBLIC_IP_AUTODISCOVER:-auto-ipv4} + - COTURN_INTERNAL_RELAY=true + - KMS_URIS=["ws://127.0.0.1:8888/kurento"] + logging: + options: + max-size: "${DOCKER_LOGS_MAX_SIZE:-100M}" + + nginx: + image: openvidu/openvidu-proxy:2.23.0 + restart: always + network_mode: host + volumes: + - ./certificates:/etc/letsencrypt + - ./owncert:/owncert + - ./custom-nginx-vhosts:/etc/nginx/vhost.d/ + - ./custom-nginx-locations:/custom-nginx-locations + - ${OPENVIDU_RECORDING_CUSTOM_LAYOUT}:/opt/openvidu/custom-layout + environment: + - DOMAIN_OR_PUBLIC_IP=${DOMAIN_OR_PUBLIC_IP} + - CERTIFICATE_TYPE=${CERTIFICATE_TYPE} + - LETSENCRYPT_EMAIL=${LETSENCRYPT_EMAIL} + - PROXY_HTTP_PORT=${HTTP_PORT:-} + - PROXY_HTTPS_PORT=${HTTPS_PORT:-} + - PROXY_HTTPS_PROTOCOLS=${HTTPS_PROTOCOLS:-} + - PROXY_HTTPS_CIPHERS=${HTTPS_CIPHERS:-} + - PROXY_HTTPS_HSTS=${HTTPS_HSTS:-} + - ALLOWED_ACCESS_TO_DASHBOARD=${ALLOWED_ACCESS_TO_DASHBOARD:-} + - ALLOWED_ACCESS_TO_RESTAPI=${ALLOWED_ACCESS_TO_RESTAPI:-} + - PROXY_MODE=PRO + - WITH_APP=true + - SUPPORT_DEPRECATED_API=${SUPPORT_DEPRECATED_API:-false} + - REDIRECT_WWW=${REDIRECT_WWW:-false} + - WORKER_CONNECTIONS=${WORKER_CONNECTIONS:-10240} + - PUBLIC_IP=${PROXY_PUBLIC_IP:-auto-ipv4} + logging: + options: + max-size: "${DOCKER_LOGS_MAX_SIZE:-100M}" + + + elasticsearch: + image: openvidu/openvidu-elasticsearch:7.8.0 + restart: always + environment: + - discovery.type=single-node + - xpack.security.enabled=true + - "ES_JAVA_OPTS=${ES_JAVA_OPTS:--Xms2g -Xmx2g}" + ports: + - 9200:9200 + volumes: + - ./elasticsearch:/usr/share/elasticsearch/data + command: > + /bin/bash -c "elasticsearch-users useradd ${ELASTICSEARCH_USERNAME} + -p ${ELASTICSEARCH_PASSWORD} -r superuser; + elasticsearch-users passwd ${ELASTICSEARCH_USERNAME} -p ${ELASTICSEARCH_PASSWORD}; + docker-entrypoint.sh" + logging: + options: + max-size: "${DOCKER_LOGS_MAX_SIZE:-100M}" + + kibana: + image: docker.elastic.co/kibana/kibana:7.8.0 + restart: always + environment: + - SERVER_BASEPATH="/kibana" + - xpack.security.enabled=true + - ELASTICSEARCH_USERNAME=${ELASTICSEARCH_USERNAME} + - ELASTICSEARCH_PASSWORD=${ELASTICSEARCH_PASSWORD} + ports: + - 5601:5601 + logging: + options: + max-size: "${DOCKER_LOGS_MAX_SIZE:-100M}" + + media-node-controller: + image: openvidu/media-node-controller:2.23.0 + restart: always + ulimits: + core: -1 + environment: + - KMS_IMAGE=kurento/kurento-media-server:6.18.0 + - MEDIASOUP_IMAGE=openvidu/mediasoup-controller:2.23.0 + - METRICBEAT_IMAGE=docker.elastic.co/beats/metricbeat-oss:7.8.0 + - FILEBEAT_IMAGE=docker.elastic.co/beats/filebeat-oss:7.8.0 + - OPENVIDU_RECORDING_IMAGE=openvidu/openvidu-recording:2.23.0 + - COTURN_IMAGE=openvidu/openvidu-coturn:2.23.0 + - NO_COLOR=true + ports: + - 3000:3000 + volumes: + - /opt/openvidu/recordings:/opt/openvidu/recordings + - /opt/openvidu/beats:/opt/openvidu/beats + - /var/run/docker.sock:/var/run/docker.sock + - /opt/openvidu/kurento-logs:/opt/openvidu/kurento-logs + - ./beats:/beats + logging: + options: + max-size: "100M" diff --git a/openvidu-server/deployments/pro/docker-compose/mono-node/install_openvidu_pro_mono_node.sh b/openvidu-server/deployments/pro/docker-compose/mono-node/install_openvidu_pro_mono_node.sh new file mode 100755 index 00000000..38d6622a --- /dev/null +++ b/openvidu-server/deployments/pro/docker-compose/mono-node/install_openvidu_pro_mono_node.sh @@ -0,0 +1,407 @@ +#!/usr/bin/env bash + +# Global variables +OPENVIDU_FOLDER=openvidu +OPENVIDU_VERSION=master +OPENVIDU_UPGRADABLE_VERSION="2.23" +ELASTICSEARCH_FOLDER=${OPENVIDU_FOLDER}/elasticsearch +BEATS_FOLDER=${OPENVIDU_FOLDER}/beats +DOWNLOAD_URL=http://172.18.0.1:8888 +IMAGES_MEDIA_NODE_CONTROLLER=( + "kurento-media-server" + "docker.elastic.co/beats/filebeat" + "docker.elastic.co/beats/metricbeat" + "openvidu/mediasoup-controller" + "openvidu/openvidu-recording" +) + +# Support docker compose v1 and v2 +shopt -s expand_aliases +alias docker-compose='docker compose' +if ! docker compose version &> /dev/null; then + unalias docker-compose +fi + +# Change default http timeout for slow networks +export COMPOSE_HTTP_TIMEOUT=500 +export DOCKER_CLIENT_TIMEOUT=500 + +pull_images() { + OV_DIRECTORY="$1" + echo "Pulling images..." + for image in "${IMAGES_MEDIA_NODE_CONTROLLER[@]}"; do + IMAGE_PULL="$(grep "$image" "${OV_DIRECTORY}"/docker-compose.yml | cut -d "=" -f2)" + docker pull "$IMAGE_PULL" || fatal_error "Error: can not pull '${IMAGE_PULL}'" + done + grep "image:" "${OV_DIRECTORY}"/docker-compose.yml | while read -r image ; do + IMAGE_PULL=$(echo "$image" | xargs | cut -d" " -f2) + docker pull "$IMAGE_PULL" || fatal_error "Error: can not pull '${IMAGE_PULL}'" + done + grep "image:" "${OV_DIRECTORY}"/docker-compose.override.yml | while read -r image ; do + IMAGE_PULL=$(echo "$image" | xargs | cut -d" " -f2) + docker pull "$IMAGE_PULL" || fatal_error "Error: can not pull '${IMAGE_PULL}'" + done +} + +fatal_error() { + printf "\n =======¡ERROR!=======" + printf "\n %s" "$1" + printf "\n" + exit 1 +} + +new_ov_installation() { + printf '\n' + printf '\n =======================================' + printf '\n Install OpenVidu Pro %s' "${OPENVIDU_VERSION}" + printf '\n =======================================' + printf '\n' + + # Create folder openvidu-docker-compose + printf '\n => Creating folder '%s'...' "${OPENVIDU_FOLDER}" + mkdir "${OPENVIDU_FOLDER}" || fatal_error "Error while creating the folder '${OPENVIDU_FOLDER}'" + + # Create beats folder + printf "\n => Creating folder 'beats'..." + mkdir -p "${BEATS_FOLDER}" || fatal_error "Error while creating the folder 'beats'" + + # Create elasticsearch folder + printf "\n => Creating folder 'elasticsearch'..." + mkdir -p "${ELASTICSEARCH_FOLDER}" || fatal_error "Error while creating the folder 'elasticsearch'" + + printf "\n => Changing permission to 'elasticsearch' folder..." + chown 1000:1000 "${ELASTICSEARCH_FOLDER}" || fatal_error "Error while changing permission to 'elasticsearch' folder" + + # Download necessary files + printf '\n => Downloading OpenVidu Pro files:' + + curl --silent ${DOWNLOAD_URL}/openvidu-server/deployments/pro/docker-compose/mono-node/beats/filebeat.yml \ + --output "${BEATS_FOLDER}/filebeat.yml" || fatal_error "Error when downloading the file 'filebeat.yml'" + printf '\n - filebeat.yml' + + curl --silent ${DOWNLOAD_URL}/openvidu-server/deployments/pro/docker-compose/mono-node/beats/metricbeat-elasticsearch.yml \ + --output "${BEATS_FOLDER}/metricbeat-elasticsearch.yml" || fatal_error "Error when downloading the file 'metricbeat-elasticsearch.yml'" + printf '\n - metricbeat-elasticsearch.yml' + + curl --silent ${DOWNLOAD_URL}/openvidu-server/deployments/pro/docker-compose/mono-node/.env \ + --output "${OPENVIDU_FOLDER}/.env" || fatal_error "Error when downloading the file '.env'" + printf '\n - .env' + + curl --silent ${DOWNLOAD_URL}/openvidu-server/deployments/pro/docker-compose/mono-node/docker-compose.override.yml \ + --output "${OPENVIDU_FOLDER}/docker-compose.override.yml" || fatal_error "Error when downloading the file 'docker-compose.override.yml'" + printf '\n - docker-compose.override.yml' + + curl --silent ${DOWNLOAD_URL}/openvidu-server/deployments/pro/docker-compose/mono-node/docker-compose.yml \ + --output "${OPENVIDU_FOLDER}/docker-compose.yml" || fatal_error "Error when downloading the file 'docker-compose.yml'" + printf '\n - docker-compose.yml' + + curl --silent ${DOWNLOAD_URL}/openvidu-server/deployments/pro/docker-compose/mono-node/openvidu \ + --output "${OPENVIDU_FOLDER}/openvidu" || fatal_error "Error when downloading the file 'openvidu'" + printf '\n - openvidu' + + # Add execution permissions + printf "\n => Adding permission:" + + chmod +x "${OPENVIDU_FOLDER}/openvidu" || fatal_error "Error while adding permission to 'openvidu' program" + printf '\n - openvidu' + + # Change recording folder with all permissions + printf "\n => Adding permission to 'recordings' folder..." + mkdir -p "${OPENVIDU_FOLDER}/recordings" + + # Create own certificated folder + printf "\n => Creating folder 'owncert'..." + mkdir "${OPENVIDU_FOLDER}/owncert" || fatal_error "Error while creating the folder 'owncert'" + + # Create vhost nginx folder + printf "\n => Creating folder 'custom-nginx-vhosts'..." + mkdir "${OPENVIDU_FOLDER}/custom-nginx-vhosts" || fatal_error "Error while creating the folder 'custom-nginx-vhosts'" + + # Create vhost nginx folder + printf "\n => Creating folder 'custom-nginx-locations'..." + mkdir "${OPENVIDU_FOLDER}/custom-nginx-locations" || fatal_error "Error while creating the folder 'custom-nginx-locations'" + + # Pull all docker images + pull_images "${OPENVIDU_FOLDER}" + + # Ready to use + printf '\n' + printf '\n' + printf '\n =======================================' + printf '\n OpenVidu Pro successfully installed.' + printf '\n =======================================' + printf '\n' + printf '\n 1. Go to openvidu folder:' + printf '\n $ cd openvidu' + printf '\n' + printf '\n 2. Configure OPENVIDU_DOMAIN_OR_PUBLIC_IP, OPENVIDU_PRO_LICENSE, ' + printf '\n OPENVIDU_SECRET, and ELASTICSEARCH_PASSWORD in .env file:' + printf '\n $ nano .env' + printf '\n' + printf '\n 3. Start OpenVidu' + printf '\n $ ./openvidu start' + printf '\n' + printf "\n CAUTION: The folder 'openvidu/elasticsearch' use user and group 1000 permissions. " + printf "\n This folder is necessary for store elasticsearch data." + printf "\n For more information, check:" + printf '\n https://docs.openvidu.io/en/%s/openvidu-pro/deployment/on-premises/#deployment-instructions' "${OPENVIDU_VERSION//v}" + printf '\n' + printf '\n' + exit 0 +} + +get_previous_env_variable() { + local ENV_VARIABLE_NAME=$1 + echo "$(grep -E "${ENV_VARIABLE_NAME}=.*$" "${OPENVIDU_PREVIOUS_FOLDER}/.env" | cut -d'=' -f2)" +} + +replace_variable_in_new_env_file() { + local ENV_VARIABLE_NAME=$1 + local ENV_VARIABLE_VALUE=$2 + [[ -n "${ENV_VARIABLE_VALUE}" ]] && sed -i "s|#${ENV_VARIABLE_NAME}=|${ENV_VARIABLE_NAME}=${ENV_VARIABLE_VALUE}|" "${OPENVIDU_PREVIOUS_FOLDER}/.env-${OPENVIDU_VERSION}" +} + +upgrade_ov() { + # Search local Openvidu installation + printf '\n' + printf '\n ============================================' + printf '\n Search Previous Installation of Openvidu' + printf '\n ============================================' + printf '\n' + + SEARCH_IN_FOLDERS=( + "${PWD}" + "/opt/${OPENVIDU_FOLDER}" + ) + + for folder in "${SEARCH_IN_FOLDERS[@]}"; do + printf "\n => Searching in '%s' folder..." "${folder}" + + if [ -f "${folder}/docker-compose.yml" ]; then + OPENVIDU_PREVIOUS_FOLDER="${folder}" + + printf "\n => Found installation in folder '%s'" "${folder}" + break + fi + done + + [ -z "${OPENVIDU_PREVIOUS_FOLDER}" ] && fatal_error "No previous Openvidu installation found" + + # Upgrade Openvidu + OPENVIDU_PREVIOUS_VERSION=$(grep 'Openvidu Version:' "${OPENVIDU_PREVIOUS_FOLDER}/docker-compose.yml" | awk '{ print $4 }') + [ -z "${OPENVIDU_PREVIOUS_VERSION}" ] && fatal_error "Can't find previous OpenVidu version" + + # In this point using the variable 'OPENVIDU_PREVIOUS_VERSION' we can verify if the upgrade is + # posible or not. If it is not posible launch a warning and stop the upgrade. + if [[ "${OPENVIDU_PREVIOUS_VERSION}" != "${OPENVIDU_UPGRADABLE_VERSION}."* ]] && [[ "${OPENVIDU_PREVIOUS_VERSION}" != "${OPENVIDU_VERSION//v}"* ]]; then + fatal_error "You can't update from version ${OPENVIDU_PREVIOUS_VERSION} to ${OPENVIDU_VERSION}.\nNever upgrade across multiple major versions." + fi + + # Check installation is a valid OpenVidu edition + if grep -q '.*image:.*\/openvidu-server:.*' "${OPENVIDU_PREVIOUS_FOLDER}/docker-compose.yml"; then + fatal_error "You can't upgrade. Installed version is OpenVidu CE" + fi + if grep -q '.*image:.*\/replication-manager:.*' "${OPENVIDU_PREVIOUS_FOLDER}/docker-compose.yml"; then + fatal_error "You can't upgrade. Installed version is OpenVidu ENTERPRISE" + fi + + printf '\n' + printf '\n =======================================' + printf '\n Upgrade OpenVidu Pro %s to %s' "${OPENVIDU_PREVIOUS_VERSION}" "${OPENVIDU_VERSION}" + printf '\n =======================================' + printf '\n' + + ROLL_BACK_FOLDER="${OPENVIDU_PREVIOUS_FOLDER}/.old-${OPENVIDU_PREVIOUS_VERSION}" + TMP_FOLDER="${OPENVIDU_PREVIOUS_FOLDER}/tmp" + ACTUAL_FOLDER="${PWD}" + USE_OV_CALL=$(grep -E '^ image: openvidu/openvidu-call:.*$' "${OPENVIDU_PREVIOUS_FOLDER}/docker-compose.override.yml" | tr -d '[:space:]') + + printf "\n Creating rollback folder '%s'..." ".old-${OPENVIDU_PREVIOUS_VERSION}" + mkdir "${ROLL_BACK_FOLDER}" || fatal_error "Error while creating the folder '.old-${OPENVIDU_PREVIOUS_VERSION}'" + + printf "\n Creating temporal folder 'tmp'..." + mkdir "${TMP_FOLDER}" || fatal_error "Error while creating the folder 'temporal'" + + # Download necessary files + printf '\n => Downloading new OpenVidu Pro files:' + + curl --silent ${DOWNLOAD_URL}/openvidu-server/deployments/pro/docker-compose/mono-node/beats/filebeat.yml \ + --output "${TMP_FOLDER}/filebeat.yml" || fatal_error "Error when downloading the file 'filebeat.yml'" + printf '\n - filebeat.yml' + + curl --silent ${DOWNLOAD_URL}/openvidu-server/deployments/pro/docker-compose/mono-node/beats/metricbeat-elasticsearch.yml \ + --output "${TMP_FOLDER}/metricbeat-elasticsearch.yml" || fatal_error "Error when downloading the file 'metricbeat-elasticsearch.yml'" + printf '\n - metricbeat-elasticsearch.yml' + + curl --silent ${DOWNLOAD_URL}/openvidu-server/deployments/pro/docker-compose/mono-node/.env \ + --output "${TMP_FOLDER}/.env" || fatal_error "Error when downloading the file '.env'" + printf '\n - .env' + + curl --silent ${DOWNLOAD_URL}/openvidu-server/deployments/pro/docker-compose/mono-node/docker-compose.override.yml \ + --output "${TMP_FOLDER}/docker-compose.override.yml" || fatal_error "Error when downloading the file 'docker-compose.override.yml'" + printf '\n - docker-compose.override.yml' + + curl --silent ${DOWNLOAD_URL}/openvidu-server/deployments/pro/docker-compose/mono-node/docker-compose.yml \ + --output "${TMP_FOLDER}/docker-compose.yml" || fatal_error "Error when downloading the file 'docker-compose.yml'" + printf '\n - docker-compose.yml' + + curl --silent ${DOWNLOAD_URL}/openvidu-server/deployments/pro/docker-compose/mono-node/openvidu \ + --output "${TMP_FOLDER}/openvidu" || fatal_error "Error when downloading the file 'openvidu'" + printf '\n - openvidu' + + # Downloading new images and stopped actual Openvidu + printf '\n => Downloading new images...' + printf '\n' + sleep 1 + + printf "\n => Moving to 'tmp' folder..." + printf '\n' + cd "${TMP_FOLDER}" || fatal_error "Error when moving to 'tmp' folder" + printf '\n' + docker-compose pull || true + + printf '\n => Stopping Openvidu...' + printf '\n' + sleep 1 + + printf "\n => Moving to 'openvidu' folder..." + printf '\n' + cd "${OPENVIDU_PREVIOUS_FOLDER}" || fatal_error "Error when moving to 'openvidu' folder" + printf '\n' + docker-compose down || true + + printf '\n' + printf '\n => Moving to working dir...' + cd "${ACTUAL_FOLDER}" || fatal_error "Error when moving to working dir" + + # Move old files to rollback folder + printf '\n => Moving previous installation files to rollback folder:' + + mv "${OPENVIDU_PREVIOUS_FOLDER}/docker-compose.yml" "${ROLL_BACK_FOLDER}" || fatal_error "Error while moving previous 'docker-compose.yml'" + printf '\n - docker-compose.yml' + + if [ -n "${USE_OV_CALL}" ]; then + mv "${OPENVIDU_PREVIOUS_FOLDER}/docker-compose.override.yml" "${ROLL_BACK_FOLDER}" || fatal_error "Error while moving previous 'docker-compose.override.yml'" + printf '\n - docker-compose.override.yml' + fi + + mv "${OPENVIDU_PREVIOUS_FOLDER}/openvidu" "${ROLL_BACK_FOLDER}" || fatal_error "Error while moving previous 'openvidu'" + printf '\n - openvidu' + + mv "${OPENVIDU_PREVIOUS_FOLDER}/beats" "${ROLL_BACK_FOLDER}" || fatal_error "Error while moving previous 'beats'" + printf '\n - beats' + + cp "${OPENVIDU_PREVIOUS_FOLDER}/.env" "${ROLL_BACK_FOLDER}" || fatal_error "Error while moving previous '.env'" + printf '\n - .env' + + if [ -d "${OPENVIDU_PREVIOUS_FOLDER}/custom-nginx-vhosts" ]; then + mv "${OPENVIDU_PREVIOUS_FOLDER}/custom-nginx-vhosts" "${ROLL_BACK_FOLDER}" || fatal_error "Error while moving previous directory 'custom-nginx-vhosts'" + printf '\n - custom-nginx-vhosts' + fi + + if [ -d "${OPENVIDU_PREVIOUS_FOLDER}/custom-nginx-locations" ]; then + mv "${OPENVIDU_PREVIOUS_FOLDER}/custom-nginx-locations" "${ROLL_BACK_FOLDER}" || fatal_error "Error while moving previous directory 'custom-nginx-locations'" + printf '\n - custom-nginx-locations' + fi + + if [ -d "${OPENVIDU_PREVIOUS_FOLDER}/coturn" ]; then + mv "${OPENVIDU_PREVIOUS_FOLDER}/coturn" "${ROLL_BACK_FOLDER}" || fatal_error "Error while moving previous directory 'coturn'" + fi + + # Move tmp files to Openvidu + printf '\n => Updating files:' + + mv "${TMP_FOLDER}/docker-compose.yml" "${OPENVIDU_PREVIOUS_FOLDER}" || fatal_error "Error while updating 'docker-compose.yml'" + printf '\n - docker-compose.yml' + + if [ -n "${USE_OV_CALL}" ]; then + mv "${TMP_FOLDER}/docker-compose.override.yml" "${OPENVIDU_PREVIOUS_FOLDER}" || fatal_error "Error while updating 'docker-compose.override.yml'" + printf '\n - docker-compose.override.yml' + else + mv "${TMP_FOLDER}/docker-compose.override.yml" "${OPENVIDU_PREVIOUS_FOLDER}/docker-compose.override.yml-${OPENVIDU_VERSION}" || fatal_error "Error while updating 'docker-compose.override.yml'" + printf '\n - docker-compose.override.yml-%s' "${OPENVIDU_VERSION}" + fi + + mv "${TMP_FOLDER}/.env" "${OPENVIDU_PREVIOUS_FOLDER}/.env-${OPENVIDU_VERSION}" || fatal_error "Error while moving previous '.env'" + printf '\n - .env-%s' "${OPENVIDU_VERSION}" + + mv "${TMP_FOLDER}/openvidu" "${OPENVIDU_PREVIOUS_FOLDER}" || fatal_error "Error while updating 'openvidu'" + printf '\n - openvidu' + + mkdir "${OPENVIDU_PREVIOUS_FOLDER}/beats" || fatal_error "Error while creating the folder 'beats'" + + mv "${TMP_FOLDER}/filebeat.yml" "${OPENVIDU_PREVIOUS_FOLDER}/beats/filebeat.yml" || fatal_error "Error while updating 'filebeat.yml'" + printf '\n - beats/filebeat.yml' + + mv "${TMP_FOLDER}/metricbeat-elasticsearch.yml" "${OPENVIDU_PREVIOUS_FOLDER}/beats/metricbeat-elasticsearch.yml" || fatal_error "Error while updating 'metricbeat-elasticsearch.yml'" + printf '\n - beats/metricbeat-elasticsearch.yml' + + + printf "\n => Deleting 'tmp' folder" + rm -rf "${TMP_FOLDER}" || fatal_error "Error deleting 'tmp' folder" + + # Add execution permissions + printf "\n => Adding permission to 'openvidu' program..." + + chmod +x "${OPENVIDU_PREVIOUS_FOLDER}/openvidu" || fatal_error "Error while adding permission to 'openvidu' program" + printf '\n - openvidu' + + # Change recording folder with all permissions + printf "\n => Adding permission to 'recordings' folder..." + mkdir -p "${OPENVIDU_PREVIOUS_FOLDER}/recordings" + + # Define old mode: On Premise or Cloud Formation + OLD_MODE=$(grep -E "Installation Mode:.*$" "${ROLL_BACK_FOLDER}/docker-compose.yml" | awk '{ print $4,$5 }') + [ -n "${OLD_MODE}" ] && sed -i -r "s/Installation Mode:.+/Installation Mode: ${OLD_MODE}/" "${OPENVIDU_PREVIOUS_FOLDER}/docker-compose.yml" + + pull_images "${OPENVIDU_PREVIOUS_FOLDER}" + + # Ready to use + printf '\n' + printf '\n' + printf '\n ================================================' + printf "\n Openvidu successfully upgraded to version %s" "${OPENVIDU_VERSION}" + printf '\n ================================================' + printf '\n' + printf "\n 1. A new file 'docker-compose.yml' has been created with the new OpenVidu %s services" "${OPENVIDU_VERSION}" + printf '\n' + printf "\n 2. The previous file '.env' remains intact, but a new file '.env-%s' has been created." "${OPENVIDU_VERSION}" + printf "\n Transfer any configuration you wish to keep in the upgraded version from '.env' to '.env-%s'." "${OPENVIDU_VERSION}" + printf "\n When you are OK with it, rename and leave as the only '.env' file of the folder the new '.env-%s'." "${OPENVIDU_VERSION}" + printf '\n' + printf "\n 3. If you were using Openvidu Call application, it has been automatically updated in file 'docker-compose.override.yml'." + printf "\n However, if you were using your own application, a file called 'docker-compose.override.yml-%s'" "${OPENVIDU_VERSION}" + printf "\n has been created with the latest version of Openvidu Call. If you don't plan to use it you can delete it." + printf '\n' + printf '\n 4. Start new version of Openvidu' + printf '\n $ ./openvidu start' + printf '\n' + printf "\n If you want to rollback, all the files from the previous installation have been copied to folder '.old-%s'" "${OPENVIDU_PREVIOUS_VERSION}" + printf '\n' + printf '\n' + printf '\n' +} + +# Check docker and docker-compose installation +if ! command -v docker > /dev/null; then + echo "You don't have docker installed, please install it and re-run the command" + exit 0 +fi + +if ! command -v docker-compose > /dev/null; then + echo "You don't have docker-compose installed, please install it and re-run the command" + exit 0 +else + COMPOSE_VERSION=$(docker-compose version --short | sed "s/-rc[0-9]*//") + if ! printf '%s\n%s\n' "1.24" "$COMPOSE_VERSION" | sort -V -C; then + echo "You need a docker-compose version equal or higher than 1.24, please update your docker-compose and re-run the command"; \ + exit 0 + fi +fi + +# Check type of installation +if [[ -n "$1" && "$1" == "upgrade" ]]; then + upgrade_ov "$2" +else + new_ov_installation +fi diff --git a/openvidu-server/deployments/pro/docker-compose/mono-node/openvidu b/openvidu-server/deployments/pro/docker-compose/mono-node/openvidu new file mode 100755 index 00000000..0939779d --- /dev/null +++ b/openvidu-server/deployments/pro/docker-compose/mono-node/openvidu @@ -0,0 +1,324 @@ +#!/bin/bash + +# Support docker compose v1 and v2 +shopt -s expand_aliases +alias docker-compose='docker compose' +if ! docker compose version &> /dev/null; then + unalias docker-compose +fi + +# Change default http timeout for slow networks +export COMPOSE_HTTP_TIMEOUT=500 +export DOCKER_CLIENT_TIMEOUT=500 + +upgrade_ov() { + UPGRADE_SCRIPT_URL="https://s3-eu-west-1.amazonaws.com/aws.openvidu.io/install_openvidu_pro_OVVERSION.sh" + HTTP_STATUS=$(curl -s -o /dev/null -I -w "%{http_code}" ${UPGRADE_SCRIPT_URL//OVVERSION/$1}) + + printf " => Upgrading OpenVidu Pro to '%s' version" "$1" + + if [ "$HTTP_STATUS" == "200" ]; then + printf "\n => Downloading and upgrading new version" + printf "\n" + + curl --silent ${UPGRADE_SCRIPT_URL//OVVERSION/$1} | bash -s upgrade + else + printf "\n =======¡ERROR!=======" + printf "\n OpenVidu Pro Version '%s' not exist" "$1" + printf "\n" + exit 0 + fi +} + +collect_basic_information() { + LINUX_VERSION=$(lsb_release -d) + DOCKER_PS=$(docker ps) + DOCKER_VERSION=$(docker version --format '{{.Server.Version}}') + DOCKER_COMPOSE_VERSION=$(docker-compose version --short) + OV_FOLDER="${PWD}" + OV_VERSION=$(grep 'Openvidu Version:' "${OV_FOLDER}/docker-compose.yml" | awk '{ print $4 }') + CONTAINERS=$(docker ps | awk '{if(NR>1) print $NF}') + + if [ -n "$(grep -E '^ image: openvidu/openvidu-call:.*$' "${OV_FOLDER}/docker-compose.override.yml" | tr -d '[:space:]')" ]; then + OV_CALL_VERSION=$(grep -E 'Openvidu-Call Version:' "${OV_FOLDER}/docker-compose.override.yml" | awk '{ print $4 }') + fi + [ -z "${OV_CALL_VERSION}" ] && OV_CALL_VERSION="No present" + + OV_TYPE_INSTALLATION=$(grep 'Installation Mode:' "${OV_FOLDER}/docker-compose.yml" | awk '{ print $4,$5 }') + TREE_OV_DIRECTORY=$(find "." ! -path '*/0/*' | sed -e "s/[^-][^\/]*\// |/g" -e "s/|\([^ ]\)/|-\1/") +} + +version_ov() { + collect_basic_information + + printf '\nOpenvidu Information:' + printf '\n' + printf '\n Installation Type: %s' "${OV_TYPE_INSTALLATION}" + printf '\n Openvidu Version: %s' "${OV_VERSION}" + printf '\n Openvidu Call Version: %s' "${OV_CALL_VERSION}" + printf '\n' + printf '\nSystem Information:' + printf '\n' + printf '\n Linux Version:' + printf '\n - %s' "${LINUX_VERSION}" + printf '\n Docker Version: %s' "${DOCKER_VERSION}" + printf '\n Docker Compose Version: %s' "${DOCKER_COMPOSE_VERSION}" + printf '\n' + printf '\nInstallation Information:' + printf '\n' + printf '\n Installation Folder: %s' "${OV_FOLDER}" + printf '\n Installation Folder Tree:' + printf '\n%s' "$(echo "${TREE_OV_DIRECTORY}" | sed -e 's/.//' -e ':a' -e 'N;$!ba' -e 's/\n/\n\t/g')" + printf '\n' + printf '\nDocker Running Services:' + printf '\n' + printf '\n %s' "$(echo "${DOCKER_PS}" | sed -e ':a' -e 'N;$!ba' -e 's/\n/\n\t/g')" + printf '\n' +} + +generate_report() { + collect_basic_information + + REPORT_CREATION_DATE=$(date +"%d-%m-%Y") + REPORT_CREATION_TIME=$(date +"%H:%M:%S") + REPORT_NAME="openvidu-report-${REPORT_CREATION_DATE}-$(date +"%H-%M").txt" + REPORT_OUTPUT="${OV_FOLDER}/${REPORT_NAME}" + + { + printf "\n =======================================" + printf "\n = REPORT INFORMATION =" + printf "\n =======================================" + printf '\n' + printf '\n Creation Date: %s' "${REPORT_CREATION_DATE}" + printf '\n Creation Time: %s' "${REPORT_CREATION_TIME}" + printf '\n' + printf "\n =======================================" + printf "\n = OPENVIDU INFORMATION =" + printf "\n =======================================" + printf '\n' + printf '\n Installation Type: %s' "${OV_TYPE_INSTALLATION}" + printf '\n Openvidu Version: %s' "${OV_VERSION}" + printf '\n Openvidu Call Version: %s' "${OV_CALL_VERSION}" + printf '\n' + printf "\n =======================================" + printf "\n = SYSTEM INFORMATION =" + printf "\n =======================================" + printf '\n' + printf '\n Linux Version:' + printf '\n - %s' "${LINUX_VERSION}" + printf '\n Docker Version: %s' "${DOCKER_VERSION}" + printf '\n Docker Compose Version: %s' "${DOCKER_COMPOSE_VERSION}" + printf '\n' + printf "\n =======================================" + printf "\n = INSTALLATION INFORMATION =" + printf "\n =======================================" + printf '\n' + printf '\n Installation Folder: %s' "${OV_FOLDER}" + printf '\n Installation Folder Tree:' + printf '\n%s' "$(echo "${TREE_OV_DIRECTORY}" | sed -e 's/.//' -e ':a' -e 'N;$!ba' -e 's/\n/\n\t/g')" + printf '\n' + printf "\n =======================================" + printf "\n = DOCKER RUNNING SERVICES =" + printf "\n =======================================" + printf '\n' + printf '\n %s' "$(echo "${DOCKER_PS}" | sed -e ':a' -e 'N;$!ba' -e 's/\n/\n\t/g')" + printf '\n' + printf "\n =======================================" + printf "\n = CONFIGURATION FILES =" + printf "\n =======================================" + printf '\n' + printf '\n ================ .env =================' + printf '\n' + printf '\n' + + cat < "${OV_FOLDER}/.env" | sed -r -e "s/OPENVIDU_SECRET=.+/OPENVIDU_SECRET=****/" -e "s/OPENVIDU_PRO_LICENSE=.+/OPENVIDU_PRO_LICENSE=****/" -e "s/ELASTICSEARCH_PASSWORD=.+/ELASTICSEARCH_PASSWORD=****/" + + printf '\n' + printf '\n ========= docker-compose.yml ==========' + printf '\n' + printf '\n' + + cat "${OV_FOLDER}/docker-compose.yml" + + printf '\n' + printf '\n ==== docker-compose.override.yml ====' + printf '\n' + printf '\n' + + if [ -f "${OV_FOLDER}/docker-compose.override.yml" ]; then + cat < "${OV_FOLDER}/docker-compose.override.yml" + else + printf '\n The docker-compose.override.yml file is not present' + fi + + printf '\n' + printf '\n' + printf "\n =======================================" + printf "\n = LOGS =" + printf "\n =======================================" + + for CONTAINER in $CONTAINERS + do + printf '\n' + printf "\n ---------------------------------------" + printf "\n %s" "$CONTAINER" + printf "\n ---------------------------------------" + printf '\n' + docker logs "$CONTAINER" + printf "\n ---------------------------------------" + printf '\n' + printf '\n' + done + + printf "\n =======================================" + printf "\n = CONTAINER ENVS VARIABLES =" + printf "\n =======================================" + + for CONTAINER in $CONTAINERS + do + printf '\n' + printf "\n =======================================" + printf "\n %s" "$CONTAINER" + printf "\n ---------------------------------------" + printf '\n' + docker exec "$CONTAINER" env + printf "\n ---------------------------------------" + printf '\n' + printf '\n' + done + + } >> "${REPORT_OUTPUT}" 2>&1 + + printf "\n Generation of the report completed with success" + printf "\n You can get your report at path '%s'" "${REPORT_OUTPUT}" + printf "\n" +} + +is_external_url() { + local URL=$1 + if [[ -z "$URL" ]]; then + return 1 + fi + if [[ "${URL}" == *"localhost"* ]] || [[ "${URL}" == *"127.0.0.1"* ]] || [[ "${URL}" == *"::1"* ]]; then + return 1 + else + return 0 + fi +} + +start_openvidu() { + local RUN_LOCAL_ES + local RUN_LOCAL_KIBANA + local CONFIGURED_ELASTICSEARCH_HOST + local CONFIGURED_KIBANA_HOST + CONFIGURED_ELASTICSEARCH_HOST=$(grep -v '^#' .env | grep OPENVIDU_PRO_ELASTICSEARCH_HOST | cut -d '=' -f2) + CONFIGURED_KIBANA_HOST=$(grep -v '^#' .env | grep OPENVIDU_PRO_KIBANA_HOST | cut -d '=' -f2) + COTURN_IN_MEDIA_NODES=$(grep -v '^#' .env | grep COTURN_IN_MEDIA_NODES | cut -d '=' -f2) + RUN_LOCAL_ES=true + RUN_LOCAL_KIBANA=true + if [[ -z "${COTURN_IN_MEDIA_NODES}" ]]; then + COTURN_IN_MEDIA_NODES=false + fi + if is_external_url "${CONFIGURED_ELASTICSEARCH_HOST}"; then + printf "Configured external elasticsearch: %s" "${CONFIGURED_ELASTICSEARCH_HOST}" + printf "\n" + RUN_LOCAL_ES=false + fi + if is_external_url "${CONFIGURED_KIBANA_HOST}"; then + printf "Configured external kibana: %s" "${CONFIGURED_KIBANA_HOST}" + printf "\n" + RUN_LOCAL_KIBANA=false + fi + docker-compose up -d \ + $(if [ "${RUN_LOCAL_ES}" == "false" ]; then echo '--scale elasticsearch=0'; fi) \ + $(if [ "${RUN_LOCAL_KIBANA}" == "false" ]; then echo '--scale kibana=0'; fi) \ + $(if [ "${COTURN_IN_MEDIA_NODES}" == "true" ]; then echo '--scale coturn=0'; fi) +} + +usage() { + printf "Usage: \n\t openvidu [command]" + printf "\n\nAvailable Commands:" + printf "\n\tstart\t\t\tStart all services" + printf "\n\tstop\t\t\tStop all services" + printf "\n\trestart\t\t\tRestart all stopped and running services" + printf "\n\tlogs\t\t\tShow openvidu-server logs" + printf "\n\tupgrade\t\t\tUpgrade to the latest Openvidu version" + printf "\n\tupgrade [version]\tUpgrade to the specific Openvidu version" + printf "\n\tversion\t\t\tShow version of Openvidu Server" + printf "\n\treport\t\t\tGenerate a report with the current status of Openvidu" + printf "\n\thelp\t\t\tShow help for openvidu command" + printf "\n" +} + +[[ -z "${FOLLOW_OPENVIDU_LOGS}" ]] && FOLLOW_OPENVIDU_LOGS=true + +case $1 in + + start) + start_openvidu + if [[ "${FOLLOW_OPENVIDU_LOGS}" == "true" ]]; then + docker-compose logs -f --tail 10 openvidu-server + fi + ;; + + stop) + docker-compose down + ;; + + restart) + docker-compose down + start_openvidu + if [[ "${FOLLOW_OPENVIDU_LOGS}" == "true" ]]; then + docker-compose logs -f --tail 10 openvidu-server + fi + ;; + + logs) + case "${2-}" in + --follow|-f) + docker-compose logs -f --tail 10 openvidu-server + ;; + *) + docker-compose logs openvidu-server + ;; + esac + ;; + + upgrade) + if [ -z "$2" ]; then + UPGRADE_VERSION="latest" + else + UPGRADE_VERSION="$2" + fi + + read -r -p " You're about to update OpenVidu Pro to '${UPGRADE_VERSION}' version. Are you sure? [y/N]: " response + case "$response" in + [yY][eE][sS]|[yY]) + upgrade_ov "${UPGRADE_VERSION}" + ;; + *) + exit 0 + ;; + esac + ;; + + version) + version_ov + ;; + + report) + read -r -p " You are about to generate a report on the current status of Openvidu, this may take some time. Do you want to continue? [y/N]: " response + case "$response" in + [yY][eE][sS]|[yY]) + generate_report + ;; + *) + exit 0 + ;; + esac + ;; + + *) + usage + ;; +esac