openvidu/README.md

97 lines
5.9 KiB
Markdown
Raw Normal View History

[![Backers on Open Collective](https://opencollective.com/openvidu/backers/badge.svg)](#backers) [![Sponsors on Open Collective](https://opencollective.com/openvidu/sponsors/badge.svg)](#sponsors)
[![License badge](https://img.shields.io/badge/license-Apache2-orange.svg)](http://www.apache.org/licenses/LICENSE-2.0)
docs(readme): correct the self-hosting claim, refresh 2.x badges, define Meet and Platform The README is the page AI assistants read first when asked about OpenVidu, and they repeat what it says. Measured in the 2026-09 AI-visibility probe: ChatGPT's branded answer reports "Cloud offering: Yes" for OpenVidu (most plausible source: the "or use it as a managed service" bullet below) and says "Historically, OpenVidu was built around Kurento" (the badges advertised OpenVidu 2.x). - Remove the "managed service" wording: OpenVidu is self-hosted only, PRO is a paid self-hosted edition, and support/consultancy is the commercial offering. - Replace the OpenVidu 2.x badges: the removed openvidu-ce-test.yml workflow -> openvidu-integration-tests.yml, npm openvidu-browser (2.32.2) -> openvidu-components-angular (3.8.0), the Read the Docs badge for docs.openvidu.io/en/stable (2.x) -> a docs badge linking to openvidu.io/latest/docs, and Docker openvidu/openvidu-server-kms (last pushed 2022) -> openvidu/openvidu-server. - Rewrite "What is OpenVidu?" so each product is defined in one unambiguous sentence and linked to its landing page: OpenVidu Meet (ready-to-use, self-hosted video conferencing app) -> openvidu.io/latest/meet, OpenVidu Platform (programmable client/server SDKs) -> openvidu.io/latest/docs. - Add a screenshot of OpenVidu Meet embedded in a host application, served from openvidu.io. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01YNJWZkfxohu1sYpPSwp1kS
2026-09-16 12:40:03 +02:00
[![OpenVidu integration tests](https://github.com/OpenVidu/openvidu/actions/workflows/openvidu-integration-tests.yml/badge.svg)](https://github.com/OpenVidu/openvidu/actions/workflows/openvidu-integration-tests.yml)
2020-08-19 11:22:15 +02:00
docs(readme): correct the self-hosting claim, refresh 2.x badges, define Meet and Platform The README is the page AI assistants read first when asked about OpenVidu, and they repeat what it says. Measured in the 2026-09 AI-visibility probe: ChatGPT's branded answer reports "Cloud offering: Yes" for OpenVidu (most plausible source: the "or use it as a managed service" bullet below) and says "Historically, OpenVidu was built around Kurento" (the badges advertised OpenVidu 2.x). - Remove the "managed service" wording: OpenVidu is self-hosted only, PRO is a paid self-hosted edition, and support/consultancy is the commercial offering. - Replace the OpenVidu 2.x badges: the removed openvidu-ce-test.yml workflow -> openvidu-integration-tests.yml, npm openvidu-browser (2.32.2) -> openvidu-components-angular (3.8.0), the Read the Docs badge for docs.openvidu.io/en/stable (2.x) -> a docs badge linking to openvidu.io/latest/docs, and Docker openvidu/openvidu-server-kms (last pushed 2022) -> openvidu/openvidu-server. - Rewrite "What is OpenVidu?" so each product is defined in one unambiguous sentence and linked to its landing page: OpenVidu Meet (ready-to-use, self-hosted video conferencing app) -> openvidu.io/latest/meet, OpenVidu Platform (programmable client/server SDKs) -> openvidu.io/latest/docs. - Add a screenshot of OpenVidu Meet embedded in a host application, served from openvidu.io. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01YNJWZkfxohu1sYpPSwp1kS
2026-09-16 12:40:03 +02:00
[![Documentation](https://img.shields.io/badge/docs-openvidu.io-blue)](https://openvidu.io/latest/docs/)
[![openvidu-server version](https://img.shields.io/docker/v/openvidu/openvidu-server?sort=semver&label=openvidu-server)](https://hub.docker.com/r/openvidu/openvidu-server/tags)
docs(readme): correct the self-hosting claim, refresh 2.x badges, define Meet and Platform The README is the page AI assistants read first when asked about OpenVidu, and they repeat what it says. Measured in the 2026-09 AI-visibility probe: ChatGPT's branded answer reports "Cloud offering: Yes" for OpenVidu (most plausible source: the "or use it as a managed service" bullet below) and says "Historically, OpenVidu was built around Kurento" (the badges advertised OpenVidu 2.x). - Remove the "managed service" wording: OpenVidu is self-hosted only, PRO is a paid self-hosted edition, and support/consultancy is the commercial offering. - Replace the OpenVidu 2.x badges: the removed openvidu-ce-test.yml workflow -> openvidu-integration-tests.yml, npm openvidu-browser (2.32.2) -> openvidu-components-angular (3.8.0), the Read the Docs badge for docs.openvidu.io/en/stable (2.x) -> a docs badge linking to openvidu.io/latest/docs, and Docker openvidu/openvidu-server-kms (last pushed 2022) -> openvidu/openvidu-server. - Rewrite "What is OpenVidu?" so each product is defined in one unambiguous sentence and linked to its landing page: OpenVidu Meet (ready-to-use, self-hosted video conferencing app) -> openvidu.io/latest/meet, OpenVidu Platform (programmable client/server SDKs) -> openvidu.io/latest/docs. - Add a screenshot of OpenVidu Meet embedded in a host application, served from openvidu.io. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01YNJWZkfxohu1sYpPSwp1kS
2026-09-16 12:40:03 +02:00
[![Docker badge](https://img.shields.io/docker/pulls/openvidu/openvidu-server.svg)](https://hub.docker.com/r/openvidu/openvidu-server)
2021-03-09 12:33:49 +01:00
[![Support badge](https://img.shields.io/badge/support-sof-yellowgreen.svg)](https://openvidu.discourse.group/)
2019-02-25 10:12:22 +01:00
[![Twitter Follow](https://img.shields.io/twitter/follow/openvidu.svg?style=social)](https://twitter.com/openvidu)
2017-09-19 10:51:19 +02:00
[![][OpenViduLogo]](https://openvidu.io)
2017-09-19 10:51:19 +02:00
openvidu
===
Visit [openvidu.io](https://openvidu.io)
2017-09-19 10:51:19 +02:00
## What is OpenVidu?
docs(readme): correct the self-hosting claim, refresh 2.x badges, define Meet and Platform The README is the page AI assistants read first when asked about OpenVidu, and they repeat what it says. Measured in the 2026-09 AI-visibility probe: ChatGPT's branded answer reports "Cloud offering: Yes" for OpenVidu (most plausible source: the "or use it as a managed service" bullet below) and says "Historically, OpenVidu was built around Kurento" (the badges advertised OpenVidu 2.x). - Remove the "managed service" wording: OpenVidu is self-hosted only, PRO is a paid self-hosted edition, and support/consultancy is the commercial offering. - Replace the OpenVidu 2.x badges: the removed openvidu-ce-test.yml workflow -> openvidu-integration-tests.yml, npm openvidu-browser (2.32.2) -> openvidu-components-angular (3.8.0), the Read the Docs badge for docs.openvidu.io/en/stable (2.x) -> a docs badge linking to openvidu.io/latest/docs, and Docker openvidu/openvidu-server-kms (last pushed 2022) -> openvidu/openvidu-server. - Rewrite "What is OpenVidu?" so each product is defined in one unambiguous sentence and linked to its landing page: OpenVidu Meet (ready-to-use, self-hosted video conferencing app) -> openvidu.io/latest/meet, OpenVidu Platform (programmable client/server SDKs) -> openvidu.io/latest/docs. - Add a screenshot of OpenVidu Meet embedded in a host application, served from openvidu.io. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01YNJWZkfxohu1sYpPSwp1kS
2026-09-16 12:40:03 +02:00
OpenVidu is a self-hosted real-time video and audio stack, built on top of
[LiveKit](https://livekit.io) and [mediasoup](https://mediasoup.org), and developed by a team
with over a decade of experience building WebRTC systems. It ships as two products:
docs(readme): correct the self-hosting claim, refresh 2.x badges, define Meet and Platform The README is the page AI assistants read first when asked about OpenVidu, and they repeat what it says. Measured in the 2026-09 AI-visibility probe: ChatGPT's branded answer reports "Cloud offering: Yes" for OpenVidu (most plausible source: the "or use it as a managed service" bullet below) and says "Historically, OpenVidu was built around Kurento" (the badges advertised OpenVidu 2.x). - Remove the "managed service" wording: OpenVidu is self-hosted only, PRO is a paid self-hosted edition, and support/consultancy is the commercial offering. - Replace the OpenVidu 2.x badges: the removed openvidu-ce-test.yml workflow -> openvidu-integration-tests.yml, npm openvidu-browser (2.32.2) -> openvidu-components-angular (3.8.0), the Read the Docs badge for docs.openvidu.io/en/stable (2.x) -> a docs badge linking to openvidu.io/latest/docs, and Docker openvidu/openvidu-server-kms (last pushed 2022) -> openvidu/openvidu-server. - Rewrite "What is OpenVidu?" so each product is defined in one unambiguous sentence and linked to its landing page: OpenVidu Meet (ready-to-use, self-hosted video conferencing app) -> openvidu.io/latest/meet, OpenVidu Platform (programmable client/server SDKs) -> openvidu.io/latest/docs. - Add a screenshot of OpenVidu Meet embedded in a host application, served from openvidu.io. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01YNJWZkfxohu1sYpPSwp1kS
2026-09-16 12:40:03 +02:00
### OpenVidu Meet
**[OpenVidu Meet](https://openvidu.io/latest/meet/)** is a ready-to-use, self-hosted video
conferencing application: an open-source alternative to Zoom, Google Meet and Jitsi Meet that
needs no code to deploy, and that you can embed in your own product through a web component,
a REST API and webhooks.
<a href="https://openvidu.io/latest/meet/"><img src="https://openvidu.io/latest/assets/images/meet/embedded/use-cases/support-meeting.png" alt="OpenVidu Meet running inside a customer support web application: a two-participant video call with recording, screen sharing, chat and call controls" width="560"></a>
docs(readme): correct the self-hosting claim, refresh 2.x badges, define Meet and Platform The README is the page AI assistants read first when asked about OpenVidu, and they repeat what it says. Measured in the 2026-09 AI-visibility probe: ChatGPT's branded answer reports "Cloud offering: Yes" for OpenVidu (most plausible source: the "or use it as a managed service" bullet below) and says "Historically, OpenVidu was built around Kurento" (the badges advertised OpenVidu 2.x). - Remove the "managed service" wording: OpenVidu is self-hosted only, PRO is a paid self-hosted edition, and support/consultancy is the commercial offering. - Replace the OpenVidu 2.x badges: the removed openvidu-ce-test.yml workflow -> openvidu-integration-tests.yml, npm openvidu-browser (2.32.2) -> openvidu-components-angular (3.8.0), the Read the Docs badge for docs.openvidu.io/en/stable (2.x) -> a docs badge linking to openvidu.io/latest/docs, and Docker openvidu/openvidu-server-kms (last pushed 2022) -> openvidu/openvidu-server. - Rewrite "What is OpenVidu?" so each product is defined in one unambiguous sentence and linked to its landing page: OpenVidu Meet (ready-to-use, self-hosted video conferencing app) -> openvidu.io/latest/meet, OpenVidu Platform (programmable client/server SDKs) -> openvidu.io/latest/docs. - Add a screenshot of OpenVidu Meet embedded in a host application, served from openvidu.io. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01YNJWZkfxohu1sYpPSwp1kS
2026-09-16 12:40:03 +02:00
### OpenVidu Platform
**[OpenVidu Platform](https://openvidu.io/latest/docs/)** is the programmable client and server
SDKs for building custom WebRTC applications with low-level control over media, on top of
LiveKit and mediasoup. It is **API-compatible with LiveKit**: any LiveKit client/server SDK
works unchanged.
### Both products
- **Self-hosted only**: deploy them on your own infrastructure (AWS, GCP, Azure, Oracle,
DigitalOcean, on-premises). There is no hosted/SaaS tier: OpenVidu PRO is a paid, self-hosted
edition, and the OpenVidu team offers
[support and consultancy](https://openvidu.io/support/).
- Advanced media features: recording, RTMP/streaming egress, AI agents (transcription,
translation), virtual backgrounds, and more.
## Getting started
- 📖 [Documentation](https://openvidu.io/latest/docs/)
- 🚀 [Try it locally](https://github.com/OpenVidu/openvidu-local-deployment)
- 💻 [Tutorials](https://github.com/OpenVidu/openvidu-tutorials)
docs(readme): correct the self-hosting claim, refresh 2.x badges, define Meet and Platform The README is the page AI assistants read first when asked about OpenVidu, and they repeat what it says. Measured in the 2026-09 AI-visibility probe: ChatGPT's branded answer reports "Cloud offering: Yes" for OpenVidu (most plausible source: the "or use it as a managed service" bullet below) and says "Historically, OpenVidu was built around Kurento" (the badges advertised OpenVidu 2.x). - Remove the "managed service" wording: OpenVidu is self-hosted only, PRO is a paid self-hosted edition, and support/consultancy is the commercial offering. - Replace the OpenVidu 2.x badges: the removed openvidu-ce-test.yml workflow -> openvidu-integration-tests.yml, npm openvidu-browser (2.32.2) -> openvidu-components-angular (3.8.0), the Read the Docs badge for docs.openvidu.io/en/stable (2.x) -> a docs badge linking to openvidu.io/latest/docs, and Docker openvidu/openvidu-server-kms (last pushed 2022) -> openvidu/openvidu-server. - Rewrite "What is OpenVidu?" so each product is defined in one unambiguous sentence and linked to its landing page: OpenVidu Meet (ready-to-use, self-hosted video conferencing app) -> openvidu.io/latest/meet, OpenVidu Platform (programmable client/server SDKs) -> openvidu.io/latest/docs. - Add a screenshot of OpenVidu Meet embedded in a host application, served from openvidu.io. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01YNJWZkfxohu1sYpPSwp1kS
2026-09-16 12:40:03 +02:00
- 🎥 [OpenVidu Meet](https://openvidu.io/latest/meet/) — the ready-to-use video conferencing app ([source](https://github.com/OpenVidu/openvidu-meet))
2021-03-03 16:37:37 +01:00
## Community Forum
Visit [OpenVidu Community Forum](https://openvidu.discourse.group/)
2017-09-19 10:51:19 +02:00
[OpenViduLogo]: https://secure.gravatar.com/avatar/5daba1d43042f2e4e85849733c8e5702?s=120
## Contributors
This project exists thanks to all the people who contribute.
2020-11-09 04:11:47 +01:00
<a href="https://github.com/OpenVidu/openvidu/contributors"><img src="https://opencollective.com/openvidu/contributors.svg?width=890&button=false" /></a>
## Backers
Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/openvidu#backer)]
<a href="https://opencollective.com/openvidu#backers" target="_blank"><img src="https://opencollective.com/openvidu/backers.svg?width=890"></a>
2024-03-02 17:04:33 +01:00
## Acknowledgments
OpenVidu has been supported under project "CPP2021-008720 NewGenVidu: An elastic, user-friendly and privacy-friendly videoconferencing platform", funded by MCIN/AEI/10.13039/501100011033 and by the European Union-NextGenerationEU/PRTR.
<img height="75px" src="https://docs.openvidu.io/en/stable/img/logos/support.jpg">
## Sponsors
Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/openvidu#sponsor)]
<a href="https://opencollective.com/openvidu/sponsor/0/website" target="_blank"><img src="https://opencollective.com/openvidu/sponsor/0/avatar.svg"></a>
<a href="https://opencollective.com/openvidu/sponsor/1/website" target="_blank"><img src="https://opencollective.com/openvidu/sponsor/1/avatar.svg"></a>
<a href="https://opencollective.com/openvidu/sponsor/2/website" target="_blank"><img src="https://opencollective.com/openvidu/sponsor/2/avatar.svg"></a>
<a href="https://opencollective.com/openvidu/sponsor/3/website" target="_blank"><img src="https://opencollective.com/openvidu/sponsor/3/avatar.svg"></a>
<a href="https://opencollective.com/openvidu/sponsor/4/website" target="_blank"><img src="https://opencollective.com/openvidu/sponsor/4/avatar.svg"></a>
<a href="https://opencollective.com/openvidu/sponsor/5/website" target="_blank"><img src="https://opencollective.com/openvidu/sponsor/5/avatar.svg"></a>
<a href="https://opencollective.com/openvidu/sponsor/6/website" target="_blank"><img src="https://opencollective.com/openvidu/sponsor/6/avatar.svg"></a>
<a href="https://opencollective.com/openvidu/sponsor/7/website" target="_blank"><img src="https://opencollective.com/openvidu/sponsor/7/avatar.svg"></a>
<a href="https://opencollective.com/openvidu/sponsor/8/website" target="_blank"><img src="https://opencollective.com/openvidu/sponsor/8/avatar.svg"></a>
<a href="https://opencollective.com/openvidu/sponsor/9/website" target="_blank"><img src="https://opencollective.com/openvidu/sponsor/9/avatar.svg"></a>