OpenVidu configuration


This page lists all available configuration properties for OpenVidu Server, as well as their possible values and the default ones.
These properties may be set:

  • In any official production deployment of OpenVidu: in the .env config file at OpenVidu installation path (default /opt/openvidu).
  • In the official development OpenVidu docker container: passing them as environment variables with flag -e PROPERTY=value


Configuration parameters for OpenVidu 🔗

Parameter Description Default value
DOMAIN_OR_PUBLIC_IP
Before OPENVIDU_DOMAIN_OR_PUBLIC_IP
Domain name where OpenVidu Server will be available). If you do not have one, the public IP of the machine. Clients will use this to connect to OpenVidu Server. For example:
openvidu.example.com
198.51.100.1
OPENVIDU_SECRET Secret used to connect to OpenVidu Server. This value is required when using the REST API or any server client (openvidu-java-client, openvidu-node-client), as well as when connecting to openvidu-server dashboard
CERTIFICATE_TYPE Which type of certificate you want to use in your OpenVidu deployment. Can be:
selfsigned
owncert
letsencrypt
selfsigned
HTTPS_PORT Secure port where OpenVidu Server will listen. All of OpenVidu services will be available at this port. Any client or SDK will have to connect to OpenVidu through this port 443
HTTP_PORT Insecure port from which OpenVidu will automatically redirect any request to the secure port. For example, if property HTTP_PORT=80 and property HTTPS_PORT=443, a request to http://DOMAIN_OR_PUBLIC_IP/ will be automatically redirected to https://DOMAIN_OR_PUBLIC_IP/.
WARNING: if you have set CERTIFICATE_TYPE=letsencrypt you cannot change the default 80 value, as Let's Encrypt needs this port opened to generate your certificate. This applies at least for the first time you execute OpenVidu, when your certificate is generated. You should be able to change this value once Let's Encrypt has successfully run the first time
80
OPENVIDU_CDR Whether to enable Call Detail Record or not (check Call Detail Record) false
OPENVIDU_RECORDING Whether to enable recording module or not (check Recording) false
OPENVIDU_RECORDING_PATH System path where to store the video files of recorded sessions. WARNING: for OpenVidu Pro 2.13.0 this property does not support other than the default value /opt/openvidu/recordings
OPENVIDU_RECORDING_PUBLIC_ACCESS Whether to allow free http access to recorded sessions or not. If true system folder OPENVIDU_RECORDING_PATH will be publicly accessible through path /recordings. That means any client can connect to
https://DOMAIN_OR_PUBLIC_IP/recordings/RECORDING_ID/RECORDING_NAME.EXTENSION
and access the recorded video file.
If false this path will be secured with Basic Auth the same way the REST API is secured (OPENVIDUAPP:OPENVIDU_SECRET)
For example, for OpenVidu Server configured with DOMAIN_OR_PUBLIC_IP=my.url.com
OPENVIDU_RECORDING=true
OPENVIDU_RECORDING_PATH=/my/path
OPENVIDU_RECORDING_PUBLIC_ACCESS=true
A session with id foo that has been recorded may generate a video file locally stored in the host machine under /my/path/foo/foo.mp4 and accessible by any client connecting to https://my.url.com/recordings/foo/foo.mp4
false
OPENVIDU_RECORDING_NOTIFICATION 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) publisher_moderator
OPENVIDU_RECORDING_CUSTOM_LAYOUT System path where OpenVidu Server should look for custom recording layouts /opt/openvidu/custom-layout
OPENVIDU_RECORDING_AUTOSTOP_TIMEOUT Timeout in seconds for recordings to automatically stop (and the session involved to be closed) when conditions are met. See Automatic stop of recordings to learn more 120
OPENVIDU_WEBHOOK Whether to enable webhook service or not (check OpenVidu Webhook) false
OPENVIDU_WEBHOOK_ENDPOINT HTTP endpoint where OpenVidu Server will send the POST messages with webhook events
OPENVIDU_WEBHOOK_HEADERS Array of strings with the HTTP headers that OpenVidu Server will append to each POST message of webhook events. For example, you may configure a Basic Auth header name:pass setting this property to [\"Authorization:\ Basic\ bmFtZTpwYXNz\"] [ ]
OPENVIDU_WEBHOOK_EVENTS Array of strings with the type of events you want OpenVidu Server to send to your webhook ["sessionCreated","sessionDestroyed","participantJoined","participantLeft","webrtcConnectionCreated","webrtcConnectionDestroyed","recordingStatusChanged"]
(all available events)
OPENVIDU_STREAMS_VIDEO_MAX_RECV_BANDWIDTH Maximum video bandwidth sent from clients to OpenVidu Server, in kbps. 0 means unconstrained 1000
OPENVIDU_STREAMS_VIDEO_MIN_RECV_BANDWIDTH Minimum video bandwidth sent from clients to OpenVidu Server, in kbps. 0 means unconstrained 300
OPENVIDU_STREAMS_VIDEO_MAX_SEND_BANDWIDTH Maximum video bandwidth sent from OpenVidu Server to clients, in kbps. 0 means unconstrained 1000
OPENVIDU_STREAMS_VIDEO_MIN_SEND_BANDWIDTH Minimum video bandwidth sent from OpenVidu Server to clients, in kbps. 0 means unconstrained 300
OPENVIDU_SESSIONS_GARBAGE_INTERVAL 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 the non active sessions garbage collector 900
OPENVIDU_SESSIONS_GARBAGE_THRESHOLD 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 is set to 0) this property is ignored 3600



Special conditions of OpenVidu development container 🔗

When using the official development OpenVidu docker container to develop your app in your LAN network, there are some properties that you can't make use of. In the development container these configuration properties won't have effect, or may have unwanted side effects if declared. Avoid declaring them:

  • HTTP_PORT: in LAN networks redirects or Let's Encrypt don't make sense.
  • CERTIFICATE_TYPE: in LAN networks certificates don't make sense.

Also, take into account that these configuration properties have different default values in the development container:

  • DOMAIN_OR_PUBLIC_IP: default to localhost in the dev container. Container won't fail to start if you don't provide a value to it.
  • OPENVIDU_SECRET: default to MY_SECRET in the dev container. Container won't fail to start if you don't provide a value to it.
  • HTTPS_PORT: default to 4443 in the dev container.