Add descriptions and unique titles to all pages

OpenVidu · Jan 1, 2025 · bf66b98 · bf66b98
1 parent d262dfa
commit bf66b98
Show file tree

Hide file tree

Showing 95 changed files with 493 additions and 96 deletions.
diff --git a/docs/account.md b/docs/account.md
@@ -1,5 +1,6 @@
 ---
 title: Account
+description: Create an account in OpenVidu Pro or log in to your existing account.
 hide:
   - navigation
   - toc

diff --git a/docs/conditions/cookie-policy.md b/docs/conditions/cookie-policy.md
@@ -1,5 +1,6 @@
 ---
 title: Cookie Policy
+description: TIKAL TECHNOLOGIES SL website uses cookies for functionality and analytics to improve user experience. Learn how to manage or disable cookies here.
 hide:
   - navigation
   - toc

diff --git a/docs/conditions/privacy-policy.md b/docs/conditions/privacy-policy.md
@@ -1,5 +1,6 @@
 ---
 title: Privacy Policy
+description: Learn how TIKAL TECHNOLOGIES SL handles your personal data in compliance with EU regulations.
 hide:
   - navigation
   - toc

diff --git a/docs/conditions/terms-of-service.md b/docs/conditions/terms-of-service.md
@@ -1,5 +1,6 @@
 ---
 title: Terms of Service
+description: Review the terms of service for using TIKAL TECHNOLOGIES SL's website and services, including rights, obligations and privacy guidelines.
 hide:
   - navigation
   - toc

diff --git a/docs/docs/comparing-openvidu.md b/docs/docs/comparing-openvidu.md
@@ -1,3 +1,7 @@
+---
+description: Compare OpenVidu with LiveKit, SaaS solutions, SFUs and more to understand its advantages, unique features and benefits over other video conferencing tools.
+---
+
 This section compares OpenVidu to other videoconference/streaming solutions, to better understand what it is, what it is not, and what advantages and disadvantages it may have over them.
 
 ## OpenVidu vs LiveKit

diff --git a/docs/docs/developing-your-openvidu-app/how-to.md b/docs/docs/developing-your-openvidu-app/how-to.md
@@ -1,4 +1,9 @@
-# How to
+---
+title: How to develop your OpenVidu app
+description: Explore common OpenVidu operations for developing your application, from managing rooms to publishing tracks.
+---
+
+# How to develop your OpenVidu application
 
 This page is a collection of the most common operations you may want to perform in your application while integrating OpenVidu. Depending on the scope of the operation, these operations will be performed on the client side using a LiveKit Client SDK, or on the server side using a LiveKit Server SDK (or directly using the HTTP server API). Consider the architecture of an OpenVidu application:
 

diff --git a/docs/docs/developing-your-openvidu-app/index.md b/docs/docs/developing-your-openvidu-app/index.md
@@ -1,3 +1,8 @@
+---
+title: Developing your OpenVidu app
+description: Learn how to build and deploy your OpenVidu application.
+---
+
 # Developing your OpenVidu application
 
 Here's a high-level overview of the steps involved in building an OpenVidu application:
@@ -24,13 +29,13 @@ There are also other optional tasks that you can perform from your application s
 - **Manage your Rooms and Participants**: although most of your application logic will be in the frontend, you can also manage the logic of your Rooms and Participants from the security of your application backend. You can list, create, update and destroy Rooms and Participants. This is the official LiveKit documentation with all the available methods of the **[`RoomServiceClient`](https://docs.livekit.io/reference/server/server-apis/#RoomService-APIs){target="\_blank"}** exposed by the Server API. These methods are also available in all LiveKit Server SDKs.
 - **Manage Egress and Ingress**: if your application needs some kind of recording, broadcasting or media ingestion, this operations must all be performed by your application server.
 - **Receive Webhook events**: you can also listen to Webhook events in your application backend. In this way you can react to events happening in your Rooms: a Room has started, a Room has finished, a Participant has joined a Room, a Track has been published... Visit the official documentation about [Webhooks](https://docs.livekit.io/home/server/webhooks/){target="\_blank"}.
-- **Publish Tracks from your backend**: this is only for advanced applications that require server-side media publishing. Publishing media from your backend is possible by using [LiveKit CLI](https://github.com/livekit/livekit-cli){target="\_blank"}, [Python SDK](https://github.com/livekit/python-sdks){target="\_blank"}, [Go SDK](https://pkg.go.dev/github.com/livekit/server-sdk-go){target="\_blank"}, [Node SDK](https://github.com/livekit/node-sdks){target="\_blank"} or [Rust SDK](https://github.com/livekit/rust-sdks){target="\_blank"}.
+- **Publish Tracks from your backend**: this is only for advanced applications that require server-side media publishing. Publishing media from your backend is possible by using [LiveKit CLI](https://github.com/livekit/livekit-cli){target="\_blank"}, [Python SDK](https://github.com/livekit/python-sdks){target="\_blank"}, [Go SDK](https://pkg.go.dev/github.com/livekit/server-sdk-go){target="\_blank"}, [Node.js SDK](https://github.com/livekit/node-sdks){target="\_blank"} or [Rust SDK](https://github.com/livekit/rust-sdks){target="\_blank"}.
 
 To get you started, here is a list of all available LiveKit Server SDKs and an application server tutorial using them. These tutorials are all set up to **generate access tokens** and **receive webhook events**, so they are perfect starting points for your application server.
 
-=== ":simple-nodedotjs:{.icon .lg-icon .tab-icon} Node"
+=== ":simple-nodedotjs:{.icon .lg-icon .tab-icon} Node.js"
 
-    [:octicons-arrow-right-24: Node Tutorial](../tutorials/application-server/node.md)
+    [:octicons-arrow-right-24: Node.js Tutorial](../tutorials/application-server/node.md)
 
     [:octicons-arrow-right-24: Reference Docs](https://docs.livekit.io/server-sdk-js/){target="\_blank"}
 

diff --git a/docs/docs/getting-started.md b/docs/docs/getting-started.md
@@ -1,3 +1,7 @@
+---
+description: Learn how to get started with OpenVidu, a powerful platform for building real-time applications, including video conferencing, live streaming and robotics.
+---
+
 ## What is OpenVidu?
 
 OpenVidu is a platform that allows you to implement real-time applications. You can build your brand new OpenVidu app from scratch, but it is also very easy to integrate OpenVidu in your already existing application.

diff --git a/docs/docs/openvidu-call/docs.md b/docs/docs/openvidu-call/docs.md
@@ -1,4 +1,9 @@
-# openvidu-call
+---
+title: OpenVidu Call Docs
+description: Learn how to run, deploy and customize OpenVidu Call, the premier videoconference application built with OpenVidu Components.
+---
+
+# OpenVidu Call Documentation
 
 [Source code :simple-github:](https://github.com/OpenVidu/openvidu-call){ .md-button target=\_blank }
 

diff --git a/docs/docs/openvidu-call/index.md b/docs/docs/openvidu-call/index.md
@@ -1,4 +1,6 @@
 ---
+title: OpenVidu Call
+description: The videoconference application built on top of OpenVidu. It offers all the features you need to quickly build your perfect real-time application.
 hide:
   - toc
   - footer

diff --git a/docs/docs/releases.md b/docs/docs/releases.md
@@ -1,3 +1,7 @@
+---
+description: Explore the latest OpenVidu releases, including new features, updates and bug fixes for each version of the platform.
+---
+
 ## 3.0.0
 
 ### Changelog

diff --git a/docs/docs/self-hosting/configuration/changing-config.md b/docs/docs/self-hosting/configuration/changing-config.md
@@ -1,3 +1,8 @@
+---
+title: Changing configuration
+description: Learn how to modify OpenVidu configuration files across different deployment types, including single node, elastic and high availability setups.
+---
+
 # How to change OpenVidu configuration
 
 The following steps are valid to change any configuration file in any deployment type. Simply just go to one of your Master Nodes, or the only Node in your deployment, and follow these steps:

diff --git a/docs/docs/self-hosting/configuration/in-depth.md b/docs/docs/self-hosting/configuration/in-depth.md
@@ -1,4 +1,9 @@
-# OpenVidu Configuration In depth
+---
+title: Configuration system in depth
+description: Explore OpenVidu's flexible configuration system, including global and service file settings, variable interpolation, and how to manage clusters efficiently.
+---
+
+# OpenVidu configuration system in depth
 
 OpenVidu utilizes a powerful and flexible system for configuring services by expanding global parameters defined in the configuration files. This mechanism ensures consistency and simplifies management by allowing global settings to be referenced across multiple service configurations. The variable expansion follows the same interpolation rules as Docker Compose, providing a familiar syntax for those accustomed to Docker.
 

diff --git a/docs/docs/self-hosting/configuration/reference.md b/docs/docs/self-hosting/configuration/reference.md
@@ -1,4 +1,9 @@
-# Configuration Reference
+---
+title: Configuration reference
+description: Reference for the configuration files used in all different OpenVidu deployments.
+---
+
+# Configuration reference
 
 ## `openvidu.env`:
 

diff --git a/docs/docs/self-hosting/deployment-types.md b/docs/docs/self-hosting/deployment-types.md
@@ -1,3 +1,9 @@
+---
+description: Discover OpenVidu deployment options. Local setup for development, single node for medium load, elastic scalability and high availability clusters.
+---
+
+# Deployment types
+
 OpenVidu offers **user-friendly installers** that facilitate quick **on-premises deployments**, so you can self-host your real-time solution in your own infrastructure or any cloud provider.
 
 There are different deployment options available, depending on your needs:
@@ -12,7 +18,7 @@ There are different deployment options available, depending on your needs:
 
 <br>
 
-### OpenVidu Local (development)
+## OpenVidu Local (development)
 
 To run OpenVidu in your local machine, this is the quickest option. It is a Docker Compose setup that includes all the necessary services to run OpenVidu in your LAN, including automated SSL certificates that will be valid across all devices in your network.
 
@@ -21,7 +27,7 @@ To run OpenVidu in your local machine, this is the quickest option. It is a Dock
   <figcaption>OpenVidu Local (development)</figcaption>
 </figure>
 
-### OpenVidu Single Node
+## OpenVidu Single Node
 
 This is the simplest production-ready OpenVidu deployment available. It provides all the features you need, but lacks scalability and fault tolerance. But make no mistake about it: it is perfectly suitable for medium-scale production deployments. For most projects OpenVidu Single Node will be enough, at least until your user load gets serious. You can host hundreds of simultaneous participants in your rooms by running OpenVidu Community on a sufficiently powerful server!
 
@@ -32,7 +38,7 @@ It is composed of a single OpenVidu Node hosting all the necessary services in a
   <figcaption>OpenVidu Single Node</figcaption>
 </figure>
 
-### OpenVidu Elastic
+## OpenVidu Elastic
 
 This is the intermediate OpenVidu deployment. It provides **scalability** for your video rooms. Suitable for applications with dynamic load in the media plane that require scalability.
 
@@ -46,7 +52,7 @@ It is composed of two different types of nodes, one of them running on a cluster
   <figcaption>OpenVidu Elastic</figcaption>
 </figure>
 
-### OpenVidu High Availability
+## OpenVidu High Availability
 
 This is the most complete OpenVidu deployment. It provides **scalability** for your video rooms and **fault tolerance** in all its services. Suitable for applications where both scalability and availability are critical.
 

diff --git a/docs/docs/self-hosting/elastic/aws/admin.md b/docs/docs/self-hosting/elastic/aws/admin.md
@@ -1,4 +1,9 @@
-# OpenVidu Elastic: AWS Administration
+---
+title: OpenVidu Elastic administration on AWS
+description: Learn how to perform administrative tasks on an AWS OpenVidu Elastic deployment
+---
+
+# OpenVidu Elastic Administration: AWS
 
 The deployment of OpenVidu Elastic on AWS is automated using AWS CloudFormation, with Media Nodes managed within an [Auto Scaling Group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/auto-scaling-groups.html){:target=_blank}. This group dynamically adjusts the number of instances based on a target average CPU utilization. Internally, the AWS deployment mirrors the on-premises setup, allowing you to follow the same administration and configuration guidelines provided in the [On Premises Elastic](../on-premises/admin.md) documentation. However, there are specific considerations unique to the AWS environment that are worth taking into account.
 

diff --git a/docs/docs/self-hosting/elastic/aws/install.md b/docs/docs/self-hosting/elastic/aws/install.md
@@ -1,3 +1,8 @@
+---
+title: OpenVidu Elastic installation on AWS
+description: Learn how to deploy OpenVidu Elastic on AWS using CloudFormation
+---
+
 # OpenVidu Elastic Installation: AWS
 
 !!! info

diff --git a/docs/docs/self-hosting/elastic/index.md b/docs/docs/self-hosting/elastic/index.md
@@ -1,3 +1,8 @@
+---
+title: OpenVidu Elastic
+description: Learn how to install OpenVidu Elastic on-premises or on AWS, with configuration and management guides for each deployment option.
+---
+
 # OpenVidu Elastic installation
 
 OpenVidu Elastic is part of the <span style="font-size: 12px;" class="openvidu-tag openvidu-pro-tag">PRO</span> edition of OpenVidu. You have the following deployment options:

diff --git a/docs/docs/self-hosting/elastic/on-premises/admin.md b/docs/docs/self-hosting/elastic/on-premises/admin.md
@@ -1,4 +1,9 @@
-# OpenVidu Elastic: Administration
+---
+title: OpenVidu Elastic administration on-premises
+description: Learn how to perform administrative tasks on an on-premises OpenVidu Elastic deployment
+---
+
+# OpenVidu Elastic Administration: On-premises
 
 The OpenVidu installer offers an easy way to deploy OpenVidu Elastic on-premises. However, once the deployment is complete, you may need to perform administrative tasks based on your specific requirements, such as changing passwords, specifying custom configurations, and starting or stopping services.
 

diff --git a/docs/docs/self-hosting/elastic/on-premises/install.md b/docs/docs/self-hosting/elastic/on-premises/install.md
@@ -1,3 +1,8 @@
+---
+title: OpenVidu Elastic installation on-premises
+description: Learn how to deploy OpenVidu Elastic on-premises
+---
+
 # OpenVidu Elastic Installation: On-premises
 
 !!! info

diff --git a/docs/docs/self-hosting/faq.md b/docs/docs/self-hosting/faq.md
@@ -1,3 +1,7 @@
+---
+description: Frequently Asked Questions about installing, configuring and using OpenVidu.
+---
+
 # Installation FAQs
 
 ## Common issues

diff --git a/docs/docs/self-hosting/ha/aws/admin.md b/docs/docs/self-hosting/ha/aws/admin.md
@@ -1,4 +1,9 @@
-# OpenVidu High Availability: AWS Administration
+---
+title: OpenVidu High Availability administration on AWS
+description: Learn how to perform administrative tasks on an AWS OpenVidu High Availability deployment
+---
+
+# OpenVidu High Availability Administration: AWS
 
 The deployment of OpenVidu High Availability on AWS is automated using AWS CloudFormation, with 4 EC2 Instances as Master Nodes and any number of Media Nodes managed within an [Auto Scaling Group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/auto-scaling-groups.html){:target=_blank}. The Auto Scaling Group of Media Nodes is configured to scale based on the target average CPU utilization.
 

diff --git a/docs/docs/self-hosting/ha/aws/install.md b/docs/docs/self-hosting/ha/aws/install.md
@@ -1,3 +1,8 @@
+---
+title: OpenVidu High Availability installation on AWS
+description: Learn how to deploy OpenVidu High Availability on AWS using CloudFormation
+---
+
 # OpenVidu High Availability Installation: AWS
 
 !!! info

diff --git a/docs/docs/self-hosting/ha/index.md b/docs/docs/self-hosting/ha/index.md
@@ -1,3 +1,8 @@
+---
+title: OpenVidu High Availability
+description: Learn how to install OpenVidu High Availability on-premises or on AWS, with configuration and management guides for each deployment option.
+---
+
 # OpenVidu High Availability installation
 
 OpenVidu High Availability is part of the <span style="font-size: 12px;" class="openvidu-tag openvidu-pro-tag">PRO</span> edition of OpenVidu. You have the following deployment options:

diff --git a/docs/docs/self-hosting/ha/on-premises/admin.md b/docs/docs/self-hosting/ha/on-premises/admin.md
@@ -1,4 +1,9 @@
-# OpenVidu High Availability: On-premises Administration
+---
+title: OpenVidu High Availability administration on-premises
+description: Learn how to perform administrative tasks on an on-premises OpenVidu High Availability deployment
+---
+
+# OpenVidu High Availability Administration: On-premises
 
 The OpenVidu installer offers an easy way to deploy OpenVidu High Availability on-premises. However, once the deployment is complete, you may need to perform administrative tasks based on your specific requirements, such as changing passwords, specifying custom configurations, and starting or stopping services.
 

diff --git a/docs/docs/self-hosting/ha/on-premises/install-dlb.md b/docs/docs/self-hosting/ha/on-premises/install-dlb.md
@@ -1,3 +1,8 @@
+---
+title: OpenVidu Elastic installation on-premises with DNS Load Balancing
+description: Learn how to deploy OpenVidu Elastic on-premises with DNS Load Balancing
+---
+
 # OpenVidu High Availability Installation: On-premises with DNS Load Balancing
 
 !!! info

diff --git a/docs/docs/self-hosting/ha/on-premises/install-nlb.md b/docs/docs/self-hosting/ha/on-premises/install-nlb.md
@@ -1,3 +1,8 @@
+---
+title: OpenVidu Elastic installation on-premises with Network Load Balancer
+description: Learn how to deploy OpenVidu Elastic on-premises with Network Load Balancer
+---
+
 # OpenVidu High Availability Installation: On-premises with Network Load Balancer
 
 !!! info

diff --git a/docs/docs/self-hosting/how-to-guides/create-configure-AWS-certificate.md b/docs/docs/self-hosting/how-to-guides/create-configure-AWS-certificate.md
@@ -1,4 +1,9 @@
-# Create AWS certificate for HA deployment
+---
+title: Create AWS certificate for HA deployment
+description: Learn how to create an AWS certificate for OpenVidu HA deployment, including domain setup, CNAME record creation and Load Balancer configuration
+---
+
+# Create AWS certificate for OpenVidu HA deployment
 
 You will need this certificate to be able to deploy the High Availability deployment. This guide is meant to show you how to do it.
 

diff --git a/docs/docs/self-hosting/how-to-guides/enable-disable-modules.md b/docs/docs/self-hosting/how-to-guides/enable-disable-modules.md
@@ -1,4 +1,8 @@
-# Enable and Disable modules
+---
+description: Learn how to enable or disable OpenVidu modules to customize your deployment configuration.
+---
+
+# Enable and disable modules
 
 OpenVidu allows you to enable or disable modules to customize your deployment. These modules are:
 

diff --git a/docs/docs/self-hosting/how-to-guides/enable-webhooks.md b/docs/docs/self-hosting/how-to-guides/enable-webhooks.md
@@ -1,3 +1,7 @@
+---
+description: Learn how to enable webhooks in OpenVidu to integrate with other services and receive event notifications from your deployment.
+---
+
 # Enable Webhooks
 
 If you need to integrate OpenVidu with other services, you can use webhooks to send notifications about events that occur in your OpenVidu deployment. This guide explains how to enable webhooks.

diff --git a/docs/docs/self-hosting/how-to-guides/external-s3.md b/docs/docs/self-hosting/how-to-guides/external-s3.md
@@ -1,4 +1,9 @@
-# Configuring External S3 for OpenVidu Recordings
+---
+title: Configuring external S3 for OpenVidu recordings
+description: Learn how to configure OpenVidu with an external S3 provider for recording storage.
+---
+
+# Configuring external S3 for OpenVidu recordings
 
 OpenVidu, by default, utilizes MinIO for recording storage, but it can be configured to use an external S3 provider instead. This guide provides the necessary steps to configure OpenVidu with an external S3 provider for your deployment.
 

diff --git a/docs/docs/self-hosting/how-to-guides/force-443-tls.md b/docs/docs/self-hosting/how-to-guides/force-443-tls.md
@@ -1,3 +1,8 @@
+---
+title: Force traffic through 443 with TLS
+description: Learn how to force all OpenVidu traffic, including WebRTC, through port 443 with TLS for enhanced security and compatibility with restrictive networks.
+---
+
 # Force all traffic including WebRTC to go through 443 with TLS
 
 In certain scenarios, users may be behind restrictive firewalls or network policies that only permit traffic through port 443 using TLS. By default, OpenVidu is configured to allow traffic through port 443 with TLS if a TURN domain name is specified during the installation process. However, users in less restrictive environments can still utilize other ports to establish WebRTC connections.

diff --git a/docs/docs/self-hosting/how-to-guides/index.md b/docs/docs/self-hosting/how-to-guides/index.md
@@ -1,3 +1,8 @@
+---
+title: How To Guides
+description: Explore step-by-step guides to customize your OpenVidu deployment for specific use cases
+---
+
 # How To Guides
 
 OpenVidu deployments are installed with sane defaults, but you may want to customize your deployment to suit your needs. This section contains guides on how to configure OpenVidu for specific use cases, so you can get the most out of your deployment.

diff --git a/docs/docs/self-hosting/local.md b/docs/docs/self-hosting/local.md
@@ -1,4 +1,9 @@
-# Local installation (Development)
+---
+title: OpenVidu Local Installation
+description: Learn how to install OpenVidu locally for development with Docker Compose. Quickly set up a secure environment to test and build your applications.
+---
+
+# OpenVidu Local Installation (Development)
 
 For development purposes, we provide an [easy to install local deployment](https://github.com/OpenVidu/openvidu-local-deployment){:target="\_blank"} based on Docker Compose which will automatically configure all the necessary services for OpenVidu to develop and test your applications seamlessly.
 

diff --git a/docs/docs/self-hosting/production-ready/fault-tolerance.md b/docs/docs/self-hosting/production-ready/fault-tolerance.md
@@ -1,3 +1,7 @@
+---
+description: Ensure seamless real-time media experiences with OpenVidu's fault tolerance. Handle node failures effortlessly with Elastic and High Availability deployments.
+---
+
 # Fault Tolerance :material-shield-refresh:
 
 Real-time media is particularly sensitive to downtime events, as they directly affect the user experience in a very disruptive way. OpenVidu is designed from the ground up to be fault tolerant in all its services in case of node downtime, especially in its High Availability deployment.

diff --git a/docs/docs/self-hosting/production-ready/index.md b/docs/docs/self-hosting/production-ready/index.md
@@ -1,3 +1,8 @@
+---
+title: Production ready
+description: OpenVidu offers a self-hosted, production-ready live-video platform with advanced capabilities, including performance, scalability, fault tolerance and observability.
+---
+
 # Production ready
 
 OpenVidu is designed to be **self-hosted**, whether it is on premises or in a cloud provider. It brings to your own managed service advanced capabilities usually reserved only for SaaS solutions. There are two main reasons why you may need to self-host the real-time solution yourself:

diff --git a/docs/docs/self-hosting/production-ready/observability/grafana-stack.md b/docs/docs/self-hosting/production-ready/observability/grafana-stack.md
@@ -1,4 +1,8 @@
-## Grafana Stack
+---
+description: Monitor OpenVidu Server metrics and cluster logs with Grafana's powerful dashboards, integrating Prometheus, Mimir and Loki for complete observability.
+---
+
+# Grafana Stack
 
 OpenVidu also provides different **Grafana dashboards** to monitor **metrics** from **OpenVidu Server** and **logs** from your **cluster**.