diff --git a/docs/about-openvidu.md b/docs/about-openvidu.md index c1363aa..74b55d2 100644 --- a/docs/about-openvidu.md +++ b/docs/about-openvidu.md @@ -2,7 +2,7 @@ description: OpenVidu is a powerful platform to develop WebRTC real-time applications. Based on LiveKit and mediasoup, performant, fault-tolerant, scalable and observable. --- -[OpenVidu](https://openvidu.io){target=\_blank} is a powerful platform to develop WebRTC real-time applications. With it you can add real-time audio and video capabilities to your application: build any kind of videoconference experience, serve ultra-low latency livestreams to thousands of users, manage real-time videos from your drones or camera feeds and record them... The possibilities are truly endless! +[OpenVidu](https://openvidu.io?utm_source=livekit-tutorials&utm_medium=referral&utm_campaign=about-openvidu-page){target=\_blank} is a powerful platform to develop WebRTC real-time applications. With it you can add real-time audio and video capabilities to your application: build any kind of videoconference experience, serve ultra-low latency livestreams to thousands of users, manage real-time videos from your drones or camera feeds and record them... The possibilities are truly endless! It is based on [LiveKit](https://livekit.io/){target=\_blank} and [mediasoup](https://mediasoup.org/){target=\_blank}, bringing the best of both worlds to provide a performant, fault-tolerant, scalable and observable solution. @@ -42,7 +42,7 @@ d="M4,1H20A1,1 0 0,1 21,2V6A1,1 0 0,1 20,7H4A1,1 0 0,1 3,6V2A1,1 0 0,1 4,1M4,9H2

On-Premises

-OpenVidu is provided as a software that you install on your own +OpenVidu is provided as a software that you install on your own servers. You can easily deploy and manage a fully fledged live-video solution in your own infrastructure, including the most popular cloud providers.

@@ -59,7 +59,7 @@ in your own infrastructure, including the most popular cloud providers.

OpenVidu is built to be incredibly powerful. It uses LiveKit at its core, but it goes much further -providing up to 2x performance of LiveKit. You can +providing up to 2x performance of LiveKit. You can host double the users in your video rooms just by using OpenVidu.

@@ -77,7 +77,7 @@ d="M21 8C19.5 8 18.7 9.4 19.1 10.5L15.5 14.1C15.2 14 14.8 14 14.5 14.1L11.9 11.5

OpenVidu has been designed from the outset with scalability +href="https://openvidu.io/latest/docs/self-hosting/production-ready/scalability/?utm_source=livekit-tutorials&utm_medium=referral&utm_campaign=about-openvidu-page" target="_blank">scalability in mind. Add nodes to increase the capacity of your cluster when necessary and remove them when no longer needed to optimize your resources.

@@ -95,7 +95,7 @@ d="M18 12C19 12 20 12.2 20.9 12.7C21 12.1 21 11.6 21 11V5L12 1L3 5V11C3 16.5 6.8

Fault Tolerant

-OpenVidu offers fault tolerance in all its +OpenVidu offers fault tolerance in all its components. Deploy a reliable cluster knowing that if one of your node goes down, others will be able to continue working with no downtime.

@@ -112,7 +112,7 @@ d="M9.46,6.28L11.05,9C8.47,9.26 6.5,11.41 6.5,14A5,5 0 0,0 11.5,19C13.55,19 15.3

OpenVidu provides different tools and APIs to monitor +href="https://openvidu.io/latest/docs/self-hosting/production-ready/observability/?utm_source=livekit-tutorials&utm_medium=referral&utm_campaign=about-openvidu-page" target="_blank">monitor the status, health, performance and history of your deployment. It automatically collects logs and metrics and offers a dashboard to visualize them. @@ -128,6 +128,6 @@ OpenVidu is available in two editions: - **OpenVidu** COMMUNITY: free to use. It is a single-server deployment and provides a custom LiveKit distribution with Egress, Ingress, S3 storage and monitoring. Ideal for development and testing, but also for small-scale production deployments. You can host hundreds of simultaneous participants in your rooms by running OpenVidu Community in a sufficiently powerful server! - **OpenVidu** PRO: OpenVidu commercial edition. It is a multi-server deployment with all the features of OpenVidu Community plus 2x performance, scalability, fault tolerance and improved monitoring and observability. Ideal for large-scale production deployments with heavy traffic that require the highest standards. You can start with OpenVidu Community and upgrade to OpenVidu Pro when needed. -Visit [openvidu.io](https://openvidu.io) to learn more about what OpenVidu has to offer. +Visit [openvidu.io](https://openvidu.io?utm_source=livekit-tutorials&utm_medium=referral&utm_campaign=about-openvidu-page) to learn more about what OpenVidu has to offer.
diff --git a/docs/index.md b/docs/index.md index 9df3024..1f2207f 100644 --- a/docs/index.md +++ b/docs/index.md @@ -73,7 +73,7 @@ Every application client below is interchangeable with the others, because: Every application server below has two specific purposes: - Generate LiveKit tokens on demand for any [application client](#application-client-tutorials). -- Receive LiveKit [webhook events](https://docs.livekit.io/home/server/webhooks/){target=\_blank}. +- Receive LiveKit [webhook events](https://openvidu.io/latest/docs/reference/webhooks/){target=\_blank}. To do so they all define two REST endpoints: diff --git a/docs/openvidu-vs-livekit.md b/docs/openvidu-vs-livekit.md index 0dea731..29e2aed 100644 --- a/docs/openvidu-vs-livekit.md +++ b/docs/openvidu-vs-livekit.md @@ -20,13 +20,13 @@ Whenever you are ready to deploy your real-time application, OpenVidu for produc ## Egress and Ingress out of the box -LiveKit allows you to export media from a Room (for example recording it) or import media into a Room (for example ingesting a video file), using [Egress](https://docs.livekit.io/home/egress/overview/){target="_blank"} and [Ingress](https://docs.livekit.io/home/ingress/overview/){target="_blank"} services respectively. These modules are independent of LiveKit Server and must be correctly configured and connected via a shared Redis. +LiveKit allows you to export media from a Room (for example recording it) or import media into a Room (for example ingesting a video file), using [Egress](https://openvidu.io/latest/docs/reference/egress/?utm_source=livekit-tutorials&utm_medium=referral&utm_campaign=comparison-page){target="_blank"} and [Ingress](https://openvidu.io/latest/docs/reference/ingress/?utm_source=livekit-tutorials&utm_medium=referral&utm_campaign=comparison-page){target="_blank"} services respectively. These modules are independent of LiveKit Server and must be correctly configured and connected via a shared Redis. When running OpenVidu locally you will have all these services properly integrated, so you can focus on developing your app without worrying about anything else. ## S3 compatible storage -If you are planning to make use of the [Egress](https://docs.livekit.io/home/egress/overview/){target="_blank"} service to export media out of your Rooms, you will need an S3 compatible bucket to store the generated files, and configure your LiveKit deployment to use it. +If you are planning to make use of the [Egress](https://openvidu.io/latest/docs/reference/egress/?utm_source=livekit-tutorials&utm_medium=referral&utm_campaign=comparison-page){target="_blank"} service to export media out of your Rooms, you will need an S3 compatible bucket to store the generated files, and configure your LiveKit deployment to use it. When running OpenVidu locally you will have an S3 compatible storage available right away ([MinIO](https://min.io/){target="_blank"}). @@ -60,7 +60,7 @@ This setup is straightforward, but what if you need to test your app from multip 1. LiveKit Server open source does not natively support HTTPS. You'll need a reverse proxy to serve LiveKit Server over HTTPS. 2. Even with HTTPS, your SSL certificate might not be valid for local network addresses. You'll need to accept it in the browser for web apps, and install it on mobile devices. -[OpenVidu Local Deployment](https://openvidu.io/latest/docs/self-hosting/local/){:target="\_blank"} addresses these issues by providing a magic domain name `openvidu-local.dev` that resolves to any IP specified as a subdomain and provides a valid wildcard certificate for HTTPS. This is similar to services like [nip.io](https://nip.io){:target="\_blank"}, [traefik.me](https://traefik.me){:target="\_blank"}, or [localtls](https://github.com/Corollarium/localtls){:target="\_blank}. +[OpenVidu Local Deployment](https://openvidu.io/latest/docs/self-hosting/local/?utm_source=livekit-tutorials&utm_medium=referral&utm_campaign=comparison-page){:target="\_blank"} addresses these issues by providing a magic domain name `openvidu-local.dev` that resolves to any IP specified as a subdomain and provides a valid wildcard certificate for HTTPS. This is similar to services like [nip.io](https://nip.io){:target="\_blank"}, [traefik.me](https://traefik.me){:target="\_blank"}, or [localtls](https://github.com/Corollarium/localtls){:target="\_blank}. When using OpenVidu Local Deployment, you can access OpenVidu Server (which is 100% LiveKit compatible) and your app from any device on your local network with a valid HTTPS certificate. The following table shows the URLs to access the deployment and your application locally and from other devices on your network: @@ -99,4 +99,4 @@ This setup simplifies the configuration of local OpenVidu deployments with SSL, The HTTPS offered by `openvidu-local.dev` is intended for development or testing purposes with the only goal of making your local devices trust your application (which is mandatory in WebRTC applications). For any other use case, it should be treated with the same security considerations as plain HTTP. -For production deployments, you should follow the [official OpenVidu installation guide](https://openvidu.io/latest/docs/self-hosting/deployment-types/){target="_blank"}. +For production deployments, you should follow the [official OpenVidu installation guide](https://openvidu.io/latest/docs/self-hosting/deployment-types/?utm_source=livekit-tutorials&utm_medium=referral&utm_campaign=comparison-page){target="_blank"}. diff --git a/docs/overrides/main.html b/docs/overrides/main.html index 3c0e75b..8036fec 100644 --- a/docs/overrides/main.html +++ b/docs/overrides/main.html @@ -1,6 +1,12 @@ {% extends "base.html" %} +{% block announce %} + + These are vanilla LiveKit tutorials. Want the same LiveKit-compatible API, self-hosted and production-ready out of the box? Try OpenVidu → + +{% endblock %} + {% block libs %} {{ super() }} @@ -63,6 +69,7 @@ {% block extrahead %} {{ super() }} +{% include "partials/json-ld.html" %} {% endblock %} diff --git a/docs/overrides/partials/footer.html b/docs/overrides/partials/footer.html index 5537509..c725079 100644 --- a/docs/overrides/partials/footer.html +++ b/docs/overrides/partials/footer.html @@ -92,11 +92,19 @@

-
+
+
+ What is OpenVidu? · + OpenVidu vs LiveKit · + openvidu.io +
+
+ +
{% include "partials/social.html" %}
-
+
Privacy policy @@ -110,7 +118,7 @@
-
+
{% include "partials/copyright.html" %}
diff --git a/docs/overrides/partials/json-ld.html b/docs/overrides/partials/json-ld.html new file mode 100644 index 0000000..5953f08 --- /dev/null +++ b/docs/overrides/partials/json-ld.html @@ -0,0 +1,65 @@ +{#- + JSON-LD structured data (schema.org) for search engines and AI crawlers. + + Emits Organization + WebSite + WebPage on every page. The Organization + node deliberately reuses the exact same @id, name, description, logo, + sameAs and contactPoint as the main openvidu.io site's own JSON-LD + (docs/overrides/partials/json-ld.html there) rather than declaring a + separate one for this subdomain — the whole point is that this LiveKit + tutorial content gets attributed to the same publisher as openvidu.io, + not read as an unrelated LiveKit fan site (openvidu-marketing issue #39). + + Per-page-type richness (TechArticle/HowTo step markup, BreadcrumbList, + FAQPage) is a deliberate follow-up, not attempted here. +-#} + +{%- if page and page.canonical_url %} + +{%- endif %} diff --git a/docs/tutorials/advanced-features/recording-basic.md b/docs/tutorials/advanced-features/recording-basic.md index c685aa6..42ca761 100644 --- a/docs/tutorials/advanced-features/recording-basic.md +++ b/docs/tutorials/advanced-features/recording-basic.md @@ -127,7 +127,7 @@ There are three new environment variables: Besides, the `index.js` file configures the server to serve static files from the `public` directory. -It also initializes the `EgressClient`, which will help interacting with [Egress API](https://docs.livekit.io/home/egress/api/){:target="\_blank"} to manage recordings, and the `S3Service`, which will help interacting with the S3 bucket: +It also initializes the `EgressClient`, which will help interacting with [Egress API](https://openvidu.io/latest/docs/reference/egress/){:target="\_blank"} to manage recordings, and the `S3Service`, which will help interacting with the S3 bucket: ```javascript title="index.js" linenums="34" const egressClient = new EgressClient( diff --git a/docs/tutorials/application-server/dotnet.md b/docs/tutorials/application-server/dotnet.md index f3d01a2..7807da9 100644 --- a/docs/tutorials/application-server/dotnet.md +++ b/docs/tutorials/application-server/dotnet.md @@ -10,7 +10,7 @@ description: Learn how to build a minimal .NET application server with ASP.NET t This is a minimal server application built for .NET with [ASP.NET Core Minimal APIs](https://learn.microsoft.com/en-us/aspnet/core/tutorials/min-web-api?view=aspnetcore-6.0&tabs=visual-studio){:target="\_blank"} that allows: - Generating LiveKit tokens on demand for any [application client](../application-client/index.md). -- Receiving LiveKit [webhook events](https://docs.livekit.io/home/server/webhooks/){target=\_blank}. +- Receiving LiveKit [webhook events](https://openvidu.io/latest/docs/reference/webhooks/){target=\_blank}. It internally uses the [LiveKit .NET SDK](https://github.com/pabloFuente/livekit-server-sdk-dotnet){:target="\_blank"}. @@ -147,12 +147,12 @@ app.MapPost( 1. The endpoint obtains a Dictionary from the body request, and check if fields `roomName` and `participantName` are available. 2. A new `AccessToken` is created providing the `LIVEKIT_API_KEY` and `LIVEKIT_API_SECRET`. 3. We set participant's name and identity in the AccessToken. -4. We set the video grants in the AccessToken. `RoomJoin` allows the user to join a room and `RoomName` determines the specific room. Check out all [Video Grants](https://docs.livekit.io/home/get-started/authentication/#Video-grant){:target="\_blank"}. +4. We set the video grants in the AccessToken. `RoomJoin` allows the user to join a room and `RoomName` determines the specific room. Check out all [Video Grants](https://openvidu.io/latest/docs/reference/access-tokens/#video-grants){:target="\_blank"}. 5. Obtain the JWT string from the AccessToken. 6. Return the token to the client. 7. Return a `400` error if required fields are not available. -The endpoint obtains a Dictionary from the body request, and check if fields `roomName` and `participantName` are available. If not, it returns a `400` error. If required fields are available, a new `AccessToken` is created with the proper participant's identity, name and video grants. The `RoomJoin` grant allows the user to join a room and the `Room` grant determines the specific room. Check out all [Video Grants](https://docs.livekit.io/home/get-started/authentication/#Video-grant){:target="\_blank"}. +The endpoint obtains a Dictionary from the body request, and check if fields `roomName` and `participantName` are available. If not, it returns a `400` error. If required fields are available, a new `AccessToken` is created with the proper participant's identity, name and video grants. The `RoomJoin` grant allows the user to join a room and the `Room` grant determines the specific room. Check out all [Video Grants](https://openvidu.io/latest/docs/reference/access-tokens/#video-grants){:target="\_blank"}. Finally, the returned token is sent back to the client. @@ -160,7 +160,7 @@ Finally, the returned token is sent back to the client. #### Receive webhook -The endpoint `/livekit/webhook` accepts `POST` requests with a payload of type `application/webhook+json`. This is the endpoint where LiveKit Server will send [webhook events](https://docs.livekit.io/home/server/webhooks/#Events){:target="\_blank"}. +The endpoint `/livekit/webhook` accepts `POST` requests with a payload of type `application/webhook+json`. This is the endpoint where LiveKit Server will send [webhook events](https://openvidu.io/latest/docs/reference/webhooks/#events){:target="\_blank"}. ```cs title="Program.cs" linenums="70" app.MapPost( @@ -191,7 +191,7 @@ app.MapPost( ); ``` -1. Initialize the WebhookReceiver using the `LIVEKIT_API_KEY` and `LIVEKIT_API_SECRET`. It will help validating and decoding incoming [webhook events](https://docs.livekit.io/home/server/webhooks/){target=\_blank}. +1. Initialize the WebhookReceiver using the `LIVEKIT_API_KEY` and `LIVEKIT_API_SECRET`. It will help validating and decoding incoming [webhook events](https://openvidu.io/latest/docs/reference/webhooks/){target=\_blank}. 2. The raw string body of the request contains the webhook event. 3. The `Authorization` header is required to validate the webhook event. 4. Obtain the `WebhookEvent` object using the `WebhookReceiver#Receive` method. It takes the raw body as a String and the Authorization header of the request. diff --git a/docs/tutorials/application-server/go.md b/docs/tutorials/application-server/go.md index bf08733..55026bd 100644 --- a/docs/tutorials/application-server/go.md +++ b/docs/tutorials/application-server/go.md @@ -10,7 +10,7 @@ description: Learn how to build a minimal Go application server with Gin to gene This is a minimal server application built for Go with [Gin](https://gin-gonic.com/){:target="\_blank"} that allows: - Generating LiveKit tokens on demand for any [application client](../application-client/index.md). -- Receiving LiveKit [webhook events](https://docs.livekit.io/home/server/webhooks/){target=\_blank}. +- Receiving LiveKit [webhook events](https://openvidu.io/latest/docs/reference/webhooks/){target=\_blank}. It internally uses the [LiveKit Go SDK](https://pkg.go.dev/github.com/livekit/server-sdk-go){:target="\_blank"}. @@ -123,7 +123,7 @@ func createToken(context *gin.Context) { ``` 1. A new `AccessToken` is created providing the `LIVEKIT_API_KEY` and `LIVEKIT_API_SECRET`. -2. We set the video grants and identity of the participant in the AccessToken. `RoomJoin` allows the user to join a room and `Room` determines the specific room. Check out all [Video Grants](https://docs.livekit.io/home/get-started/authentication/#Video-grant){:target="\_blank"}. +2. We set the video grants and identity of the participant in the AccessToken. `RoomJoin` allows the user to join a room and `Room` determines the specific room. Check out all [Video Grants](https://openvidu.io/latest/docs/reference/access-tokens/#video-grants){:target="\_blank"}. 3. We convert the AccessToken to a JWT token. 4. Finally, the token is sent back to the client. @@ -132,7 +132,7 @@ We first load the request body into a struct with `roomName` and `participantNam If required fields are available, a new JWT token is created. For that we use the [LiveKit Go SDK](https://pkg.go.dev/github.com/livekit/server-sdk-go){:target="\_blank"}: 1. A new `AccessToken` is created providing the `LIVEKIT_API_KEY` and `LIVEKIT_API_SECRET`. -2. We set the video grants and identity of the participant in the AccessToken. `RoomJoin` allows the user to join a room and `Room` determines the specific room. Check out all [Video Grants](https://docs.livekit.io/home/get-started/authentication/#Video-grant){:target="\_blank"}. +2. We set the video grants and identity of the participant in the AccessToken. `RoomJoin` allows the user to join a room and `Room` determines the specific room. Check out all [Video Grants](https://openvidu.io/latest/docs/reference/access-tokens/#video-grants){:target="\_blank"}. 3. We convert the AccessToken to a JWT token and return it to the client. 4. Finally, the token is sent back to the client. @@ -140,7 +140,7 @@ If required fields are available, a new JWT token is created. For that we use th ### Receive webhook -The endpoint `/livekit/webhook` accepts `POST` requests with a payload of type `application/webhook+json`. This is the endpoint where LiveKit Server will send [webhook events](https://docs.livekit.io/home/server/webhooks/#Events){:target="\_blank"}. +The endpoint `/livekit/webhook` accepts `POST` requests with a payload of type `application/webhook+json`. This is the endpoint where LiveKit Server will send [webhook events](https://openvidu.io/latest/docs/reference/webhooks/#events){:target="\_blank"}. ```go title="main.go" linenums="51" func receiveWebhook(context *gin.Context) { @@ -157,13 +157,13 @@ func receiveWebhook(context *gin.Context) { ``` 1. Create a `SimpleKeyProvider` with the `LIVEKIT_API_KEY` and `LIVEKIT_API`. -2. Receive the webhook event providing the `http.Request` in the Gin context and the `SimpleKeyProvider` we just created. This will validate and decode the incoming [webhook event](https://docs.livekit.io/home/server/webhooks/){:target="\_blank"}. +2. Receive the webhook event providing the `http.Request` in the Gin context and the `SimpleKeyProvider` we just created. This will validate and decode the incoming [webhook event](https://openvidu.io/latest/docs/reference/webhooks/){:target="\_blank"}. 3. Consume the event as you whish. 1. Create a `SimpleKeyProvider` with the `LIVEKIT_API_KEY` and `LIVEKIT_API`. -2. Receive the webhook event providing the `http.Request` in the Gin context and the `SimpleKeyProvider` we just created. This will validate and decode the incoming [webhook event](https://docs.livekit.io/home/server/webhooks/){:target="\_blank"}. +2. Receive the webhook event providing the `http.Request` in the Gin context and the `SimpleKeyProvider` we just created. This will validate and decode the incoming [webhook event](https://openvidu.io/latest/docs/reference/webhooks/){:target="\_blank"}. 3. Consume the event as you whish. --8<-- "shared/webhook-local-server.md" diff --git a/docs/tutorials/application-server/index.md b/docs/tutorials/application-server/index.md index b1862d4..4274b63 100644 --- a/docs/tutorials/application-server/index.md +++ b/docs/tutorials/application-server/index.md @@ -8,7 +8,7 @@ description: Learn how to build an application server that generates LiveKit tok Every application server below has two specific purposes: - Generate LiveKit tokens on demand for any [application client](../application-client/index.md). -- Receive LiveKit [webhook events](https://docs.livekit.io/home/server/webhooks/){target=\_blank}. +- Receive LiveKit [webhook events](https://openvidu.io/latest/docs/reference/webhooks/){target=\_blank}. To do so they all define two REST endpoints: diff --git a/docs/tutorials/application-server/java.md b/docs/tutorials/application-server/java.md index e8d87e1..1d4cf52 100644 --- a/docs/tutorials/application-server/java.md +++ b/docs/tutorials/application-server/java.md @@ -10,7 +10,7 @@ description: Learn how to build a minimal Java application server with Spring Bo This is a minimal server application built for Java with [Spring Boot](https://spring.io/){:target="\_blank"} that allows: - Generating LiveKit tokens on demand for any [application client](../application-client/index.md). -- Receiving LiveKit [webhook events](https://docs.livekit.io/home/server/webhooks/){target=\_blank}. +- Receiving LiveKit [webhook events](https://openvidu.io/latest/docs/reference/webhooks/){target=\_blank}. It internally uses [LiveKit Kotlin SDK](https://github.com/livekit/server-sdk-kotlin){:target="\_blank"}. @@ -103,7 +103,7 @@ public ResponseEntity> createToken(@RequestBody Map receiveWebhook(@RequestHeader("Authorization") Str ``` 1. We need the 'Authorization' header and the raw body of the HTTP request. -2. Initialize the WebhookReceiver using the `LIVEKIT_API_KEY` and `LIVEKIT_API_SECRET`. It will help validating and decoding incoming [webhook events](https://docs.livekit.io/home/server/webhooks/){target=\_blank}. +2. Initialize the WebhookReceiver using the `LIVEKIT_API_KEY` and `LIVEKIT_API_SECRET`. It will help validating and decoding incoming [webhook events](https://openvidu.io/latest/docs/reference/webhooks/){target=\_blank}. 3. Obtain the `WebhookEvent` object using the `WebhookReceiver#receive` method. It takes the raw body as a String and the Authorization header of the request. 4. Consume the event as you whish. diff --git a/docs/tutorials/application-server/node.md b/docs/tutorials/application-server/node.md index a311aaf..c35cc79 100644 --- a/docs/tutorials/application-server/node.md +++ b/docs/tutorials/application-server/node.md @@ -10,7 +10,7 @@ description: Learn how to build a minimal Node.js server with Express to generat This is a minimal server application built for Node.js with [Express](https://expressjs.com/){:target="\_blank"} that allows: - Generating LiveKit tokens on demand for any [application client](../application-client/index.md). -- Receiving LiveKit [webhook events](https://docs.livekit.io/home/server/webhooks/){target=\_blank}. +- Receiving LiveKit [webhook events](https://openvidu.io/latest/docs/reference/webhooks/){target=\_blank}. It internally uses [LiveKit JS SDK](https://docs.livekit.io/server-sdk-js){:target="\_blank"}. @@ -106,7 +106,7 @@ app.post("/token", async (req, res) => { ``` 1. A new `AccessToken` is created providing the `LIVEKIT_API_KEY`, `LIVEKIT_API_SECRET` and setting the participant's identity. -2. We set the video grants in the AccessToken. `roomJoin` allows the user to join a room and `room` determines the specific room. Check out all [Video Grants](https://docs.livekit.io/home/get-started/authentication/#Video-grant){:target="\_blank"}. +2. We set the video grants in the AccessToken. `roomJoin` allows the user to join a room and `room` determines the specific room. Check out all [Video Grants](https://openvidu.io/latest/docs/reference/access-tokens/#video-grants){:target="\_blank"}. 3. We convert the AccessToken to a JWT token. 4. Finally, the token is sent back to the client. @@ -115,7 +115,7 @@ The endpoint first obtains the `roomName` and `participantName` parameters from If required fields are available, a new JWT token is created. For that we use the [LiveKit JS SDK](https://docs.livekit.io/server-sdk-js){:target="\_blank"}: 1. A new `AccessToken` is created providing the `LIVEKIT_API_KEY`, `LIVEKIT_API_SECRET` and setting the participant's identity. -2. We set the video grants in the AccessToken. `roomJoin` allows the user to join a room and `room` determines the specific room. Check out all [Video Grants](https://docs.livekit.io/home/get-started/authentication/#Video-grant){:target="\_blank"}. +2. We set the video grants in the AccessToken. `roomJoin` allows the user to join a room and `room` determines the specific room. Check out all [Video Grants](https://openvidu.io/latest/docs/reference/access-tokens/#video-grants){:target="\_blank"}. 3. We convert the AccessToken to a JWT token. 4. Finally, the token is sent back to the client. @@ -123,7 +123,7 @@ If required fields are available, a new JWT token is created. For that we use th #### Receive webhook -The endpoint `/livekit/webhook` accepts `POST` requests with a payload of type `application/webhook+json`. This is the endpoint where LiveKit Server will send [webhook events](https://docs.livekit.io/home/server/webhooks/#Events){:target="\_blank"}. +The endpoint `/livekit/webhook` accepts `POST` requests with a payload of type `application/webhook+json`. This is the endpoint where LiveKit Server will send [webhook events](https://openvidu.io/latest/docs/reference/webhooks/#events){:target="\_blank"}. ```javascript title="index.js" linenums="33" const webhookReceiver = new WebhookReceiver( // (1)! @@ -145,7 +145,7 @@ app.post("/livekit/webhook", async (req, res) => { }); ``` -1. Initialize the WebhookReceiver using the `LIVEKIT_API_KEY` and `LIVEKIT_API_SECRET`. It will help validating and decoding incoming [webhook events](https://docs.livekit.io/home/server/webhooks/){target=\_blank}. +1. Initialize the WebhookReceiver using the `LIVEKIT_API_KEY` and `LIVEKIT_API_SECRET`. It will help validating and decoding incoming [webhook events](https://openvidu.io/latest/docs/reference/webhooks/){target=\_blank}. 2. The body of the HTTP request. 3. The `Authorization` header of the HTTP request. 4. Consume the event as you whish. diff --git a/docs/tutorials/application-server/php.md b/docs/tutorials/application-server/php.md index 91011c0..01fa90e 100644 --- a/docs/tutorials/application-server/php.md +++ b/docs/tutorials/application-server/php.md @@ -10,7 +10,7 @@ description: Learn how to build a minimal PHP server to generate LiveKit tokens This is a minimal server application built for PHP that allows: - Generating LiveKit tokens on demand for any [application client](../application-client/index.md). -- Receiving LiveKit [webhook events](https://docs.livekit.io/home/server/webhooks/){target=\_blank}. +- Receiving LiveKit [webhook events](https://openvidu.io/latest/docs/reference/webhooks/){target=\_blank}. It internally uses [LiveKit PHP SDK](https://github.com/agence104/livekit-server-sdk-php){:target="\_blank"}. @@ -112,7 +112,7 @@ if (isset($_SERVER["REQUEST_METHOD"]) && $_SERVER["REQUEST_METHOD"] === "POST" & ``` 1. Create an `AccessTokenOptions` object with the participant's identity. -2. Create a `VideoGrant` object setting the necessary video grants options. `setRoomJoin` allows the user to join a room and `setRoomName` determines the specific room. Check out all [Video Grants](https://docs.livekit.io/home/get-started/authentication/#Video-grant){:target="\_blank"}. +2. Create a `VideoGrant` object setting the necessary video grants options. `setRoomJoin` allows the user to join a room and `setRoomName` determines the specific room. Check out all [Video Grants](https://openvidu.io/latest/docs/reference/access-tokens/#video-grants){:target="\_blank"}. 3. We create the `AccessToken` providing the `LIVEKIT_API_KEY` and `LIVEKIT_API_SECRET`, initialize it with the token options, set the video grants and generate the JWT token. 4. Finally, the token is sent back to the client. @@ -121,7 +121,7 @@ The endpoint first obtains the `roomName` and `participantName` parameters from If required fields are available, a new JWT token is created. For that we use the [LiveKit PHP SDK](https://github.com/agence104/livekit-server-sdk-php){:target="\_blank"}: 1. Create an `AccessTokenOptions` object with the participant's identity. -2. Create a `VideoGrant` object setting the necessary video grants options. `setRoomJoin` allows the user to join a room and `setRoomName` determines the specific room. Check out all [Video Grants](https://docs.livekit.io/home/get-started/authentication/#Video-grant){:target="\_blank"}. +2. Create a `VideoGrant` object setting the necessary video grants options. `setRoomJoin` allows the user to join a room and `setRoomName` determines the specific room. Check out all [Video Grants](https://openvidu.io/latest/docs/reference/access-tokens/#video-grants){:target="\_blank"}. 3. We create the `AccessToken` providing the `LIVEKIT_API_KEY` and `LIVEKIT_API_SECRET`, initialize it with the token options, set the video grants and generate the JWT token. 4. Finally, the token is sent back to the client. @@ -129,7 +129,7 @@ If required fields are available, a new JWT token is created. For that we use th #### Receive webhook -The endpoint `/livekit/webhook` accepts `POST` requests with a payload of type `application/webhook+json`. This is the endpoint where LiveKit Server will send [webhook events](https://docs.livekit.io/home/server/webhooks/#Events){:target="\_blank"}. +The endpoint `/livekit/webhook` accepts `POST` requests with a payload of type `application/webhook+json`. This is the endpoint where LiveKit Server will send [webhook events](https://openvidu.io/latest/docs/reference/webhooks/#events){:target="\_blank"}. ```php title="index.php" linenums="44" app.py" linenums="34" token_verifier = TokenVerifier(LIVEKIT_API_KEY, LIVEKIT_API_SECRET) # (1)! @@ -145,7 +145,7 @@ def receive_webhook(): ``` 1. Initialize a `TokenVerifier` using the `LIVEKIT_API_KEY` and `LIVEKIT_API_SECRET`. -2. Initialize a `WebhookReceiver` using the `TokenVerifier`. It will help validating and decoding incoming [webhook events](https://docs.livekit.io/home/server/webhooks/){target=\_blank}. +2. Initialize a `WebhookReceiver` using the `TokenVerifier`. It will help validating and decoding incoming [webhook events](https://openvidu.io/latest/docs/reference/webhooks/){target=\_blank}. 3. Get the 'Authorization' header from the HTTP request. 4. Obtain the webhook event using the `WebhookReceiver#receive` method. It expects the raw body of the request and the 'Authorization' header. 5. Consume the event as you whish. diff --git a/docs/tutorials/application-server/ruby.md b/docs/tutorials/application-server/ruby.md index d39516a..ea2e61d 100644 --- a/docs/tutorials/application-server/ruby.md +++ b/docs/tutorials/application-server/ruby.md @@ -10,7 +10,7 @@ description: Learn how to build a minimal Ruby application server with Sinatra t This is a minimal server application built for Ruby with [Sinatra](https://sinatrarb.com/){:target="\_blank"} that allows: - Generating LiveKit tokens on demand for any [application client](../application-client/index.md). -- Receiving LiveKit [webhook events](https://docs.livekit.io/home/server/webhooks/){target=\_blank}. +- Receiving LiveKit [webhook events](https://openvidu.io/latest/docs/reference/webhooks/){target=\_blank}. It internally uses [LiveKit Ruby SDK](https://github.com/livekit/server-sdk-ruby){:target="\_blank"}. @@ -110,7 +110,7 @@ end 1. A new `AccessToken` is created providing the `LIVEKIT_API_KEY` and `LIVEKIT_API_SECRET`. 2. We set participant's identity in the AccessToken. -3. We set the video grants in the AccessToken. `roomJoin` allows the user to join a room and `room` determines the specific room. Check out all [Video Grants](https://docs.livekit.io/home/get-started/authentication/#Video-grant){:target="\_blank"}. +3. We set the video grants in the AccessToken. `roomJoin` allows the user to join a room and `room` determines the specific room. Check out all [Video Grants](https://openvidu.io/latest/docs/reference/access-tokens/#video-grants){:target="\_blank"}. 4. Finally, we convert the AccessToken to a JWT token and send it back to the client. The endpoint first obtains the `roomName` and `participantName` parameters from the request body. If they are not available, it returns a `400` error. @@ -119,14 +119,14 @@ If required fields are available, a new JWT token is created. For that we use th 1. A new `AccessToken` is created providing the `LIVEKIT_API_KEY` and `LIVEKIT_API_SECRET`. 2. We set participant's identity in the AccessToken. -3. We set the video grants in the AccessToken. `roomJoin` allows the user to join a room and `room` determines the specific room. Check out all [Video Grants](https://docs.livekit.io/home/get-started/authentication/#Video-grant){:target="\_blank"}. +3. We set the video grants in the AccessToken. `roomJoin` allows the user to join a room and `room` determines the specific room. Check out all [Video Grants](https://openvidu.io/latest/docs/reference/access-tokens/#video-grants){:target="\_blank"}. 4. Finally, we convert the AccessToken to a JWT token and send it back to the client. --- #### Receive webhook -The endpoint `/livekit/webhook` accepts `POST` requests with a payload of type `application/webhook+json`. This is the endpoint where LiveKit Server will send [webhook events](https://docs.livekit.io/home/server/webhooks/#Events){:target="\_blank"}. +The endpoint `/livekit/webhook` accepts `POST` requests with a payload of type `application/webhook+json`. This is the endpoint where LiveKit Server will send [webhook events](https://openvidu.io/latest/docs/reference/webhooks/#events){:target="\_blank"}. ```ruby title="app.rb" linenums="36" post '/livekit/webhook' do diff --git a/docs/tutorials/application-server/rust.md b/docs/tutorials/application-server/rust.md index a86eb2c..f9c5271 100644 --- a/docs/tutorials/application-server/rust.md +++ b/docs/tutorials/application-server/rust.md @@ -10,7 +10,7 @@ description: Learn how to build a minimal Rust application server with Axum to g This is a minimal server application built for Rust with [Axum](https://github.com/tokio-rs/axum){:target="\_blank"} that allows: - Generating LiveKit tokens on demand for any [application client](../application-client/index.md). -- Receiving LiveKit [webhook events](https://docs.livekit.io/home/server/webhooks/){target=\_blank}. +- Receiving LiveKit [webhook events](https://openvidu.io/latest/docs/reference/webhooks/){target=\_blank}. It internally uses the [LiveKit Rust SDK](https://github.com/livekit/rust-sdks){:target="\_blank"}. @@ -161,7 +161,7 @@ async fn create_token(payload: Option>) -> (StatusCode, Json) 1. A new `AccessToken` is created providing the `LIVEKIT_API_KEY` and `LIVEKIT_API_SECRET`. 2. We set participant's name and identity in the AccessToken. -3. We set the video grants in the AccessToken. `room_join` allows the user to join a room and `room` determines the specific room. Check out all [Video Grants](https://docs.livekit.io/home/get-started/authentication/#Video-grant){:target="\_blank"}. +3. We set the video grants in the AccessToken. `room_join` allows the user to join a room and `room` determines the specific room. Check out all [Video Grants](https://openvidu.io/latest/docs/reference/access-tokens/#video-grants){:target="\_blank"}. 4. We convert the AccessToken to a JWT token. 5. Finally, the token is sent back to the client. @@ -171,7 +171,7 @@ If required fields are available, a new JWT token is created. For that we use th 1. A new `AccessToken` is created providing the `LIVEKIT_API_KEY` and `LIVEKIT_API_SECRET`. 2. We set participant's name and identity in the AccessToken. -3. We set the video grants in the AccessToken. `room_join` allows the user to join a room and `room` determines the specific room. Check out all [Video Grants](https://docs.livekit.io/home/get-started/authentication/#Video-grant){:target="\_blank"}. +3. We set the video grants in the AccessToken. `room_join` allows the user to join a room and `room` determines the specific room. Check out all [Video Grants](https://openvidu.io/latest/docs/reference/access-tokens/#video-grants){:target="\_blank"}. 4. We convert the AccessToken to a JWT token. 5. Finally, the token is sent back to the client. @@ -179,7 +179,7 @@ If required fields are available, a new JWT token is created. For that we use th #### Receive webhook -The endpoint `/livekit/webhook` accepts `POST` requests with a payload of type `application/webhook+json`. This is the endpoint where LiveKit Server will send [webhook events](https://docs.livekit.io/home/server/webhooks/#Events){:target="\_blank"}. +The endpoint `/livekit/webhook` accepts `POST` requests with a payload of type `application/webhook+json`. This is the endpoint where LiveKit Server will send [webhook events](https://openvidu.io/latest/docs/reference/webhooks/#events){:target="\_blank"}. ```rust title="main.rs" linenums="90" async fn receive_webhook(headers: HeaderMap, body: String) -> (StatusCode, String) { diff --git a/mkdocs.yml b/mkdocs.yml index f9c5323..d1c4f0c 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -6,6 +6,8 @@ repo_url: https://github.com/openvidu/openvidu-livekit-tutorials nav: - index.md + - What is OpenVidu?: about-openvidu.md + - OpenVidu vs LiveKit: openvidu-vs-livekit.md - Application Client: - tutorials/application-client/index.md - JavaScript: tutorials/application-client/javascript.md @@ -30,8 +32,6 @@ nav: - tutorials/advanced-features/index.md - Recording Basic: tutorials/advanced-features/recording-basic.md - Recording Advanced: tutorials/advanced-features/recording-advanced.md - - What is OpenVidu?: about-openvidu.md - - OpenVidu vs LiveKit: openvidu-vs-livekit.md validation: omitted_files: warn @@ -43,6 +43,7 @@ theme: custom_dir: docs/overrides language: en features: + - announce.dismiss - content.code.copy - content.code.annotate - content.tabs.link diff --git a/shared/run-livekit-server-and-egress.md b/shared/run-livekit-server-and-egress.md index be0ed4b..070b711 100644 --- a/shared/run-livekit-server-and-egress.md +++ b/shared/run-livekit-server-and-egress.md @@ -8,11 +8,11 @@ Alternatively, you can use OpenVidu, which is a fully compatible LiveKit distrib === "Deploy OpenVidu" - To use a production-ready OpenVidu deployment, visit the official [OpenVidu deployment guide](https://openvidu.io/latest/docs/self-hosting/deployment-types/){target="_blank"}. + To use a production-ready OpenVidu deployment, visit the official [OpenVidu deployment guide](https://openvidu.io/latest/docs/self-hosting/deployment-types/?utm_source=livekit-tutorials&utm_medium=referral&utm_campaign=deploy-step){target="_blank"}. !!! info "Configure Webhooks" - This tutorial have an endpoint to receive webhooks from LiveKit. For this reason, when using a production deployment you need to configure webhooks to point to your local application server in order to make it work. Check the [Send Webhooks to a Local Application Server](http://openvidu.io/latest/docs/self-hosting/how-to-guides/enable-webhooks/#send-webhooks-to-a-local-application-server){:target="\_blank"} section for more information. + This tutorial have an endpoint to receive webhooks from LiveKit. For this reason, when using a production deployment you need to configure webhooks to point to your local application server in order to make it work. Check the [Send Webhooks to a Local Application Server](http://openvidu.io/latest/docs/self-hosting/how-to-guides/enable-webhooks/?utm_source=livekit-tutorials&utm_medium=referral&utm_campaign=deploy-step#send-webhooks-to-a-local-application-server){:target="\_blank"} section for more information. === "Run LiveKit locally" @@ -20,7 +20,7 @@ Alternatively, you can use OpenVidu, which is a fully compatible LiveKit distrib !!! info "Configure Webhooks" - This tutorial have an endpoint to receive webhooks from LiveKit. For this reason, when using LiveKit locally you need to configure webhooks to point to your application server in order to make it work. Check the [Webhooks](https://docs.livekit.io/home/server/webhooks/){target="\_blank"} section from the official documentation and follow the instructions to configure webhooks. + This tutorial have an endpoint to receive webhooks from LiveKit. For this reason, when using LiveKit locally you need to configure webhooks to point to your application server in order to make it work. Check the [Webhooks](https://openvidu.io/latest/docs/reference/webhooks/){target="\_blank"} section from the official documentation and follow the instructions to configure webhooks. === "Use LiveKit Cloud" @@ -28,7 +28,7 @@ Alternatively, you can use OpenVidu, which is a fully compatible LiveKit distrib !!! info "Configure Webhooks" - This tutorial have an endpoint to receive webhooks from LiveKit. For this reason, when using LiveKit Cloud you need to configure webhooks to point to your local application server in order to make it work. Check the [Webhooks](https://docs.livekit.io/home/server/webhooks/){target="\_blank"} section from the official documentation and follow the instructions to configure webhooks. + This tutorial have an endpoint to receive webhooks from LiveKit. For this reason, when using LiveKit Cloud you need to configure webhooks to point to your local application server in order to make it work. Check the [Webhooks](https://openvidu.io/latest/docs/reference/webhooks/){target="\_blank"} section from the official documentation and follow the instructions to configure webhooks. !!! warning "Expose your local application server" diff --git a/shared/run-livekit-server.md b/shared/run-livekit-server.md index 0b48177..2da1007 100644 --- a/shared/run-livekit-server.md +++ b/shared/run-livekit-server.md @@ -8,11 +8,11 @@ Alternatively, you can use OpenVidu, which is a fully compatible LiveKit distrib === "Deploy OpenVidu" - To use a production-ready OpenVidu deployment, visit the official [OpenVidu deployment guide](https://openvidu.io/latest/docs/self-hosting/deployment-types/){target="_blank"}. + To use a production-ready OpenVidu deployment, visit the official [OpenVidu deployment guide](https://openvidu.io/latest/docs/self-hosting/deployment-types/?utm_source=livekit-tutorials&utm_medium=referral&utm_campaign=deploy-step){target="_blank"}. !!! info "Configure Webhooks" - All [application servers](../application-server/index.md){:target="\_blank"} have an endpoint to receive webhooks from LiveKit. For this reason, when using a production deployment you need to configure webhooks to point to your local application server in order to make it work. Check the [Send Webhooks to a Local Application Server](http://openvidu.io/latest/docs/self-hosting/how-to-guides/enable-webhooks/#send-webhooks-to-a-local-application-server){:target="\_blank"} section for more information. + All [application servers](../application-server/index.md){:target="\_blank"} have an endpoint to receive webhooks from LiveKit. For this reason, when using a production deployment you need to configure webhooks to point to your local application server in order to make it work. Check the [Send Webhooks to a Local Application Server](http://openvidu.io/latest/docs/self-hosting/how-to-guides/enable-webhooks/?utm_source=livekit-tutorials&utm_medium=referral&utm_campaign=deploy-step#send-webhooks-to-a-local-application-server){:target="\_blank"} section for more information. === "Run LiveKit locally" @@ -20,7 +20,7 @@ Alternatively, you can use OpenVidu, which is a fully compatible LiveKit distrib !!! info "Configure Webhooks" - All [application servers](../application-server/index.md){:target="\_blank"} have an endpoint to receive webhooks from LiveKit. For this reason, when using LiveKit locally you need to configure webhooks to point to your application server in order to make it work. Check the [Webhooks](https://docs.livekit.io/home/server/webhooks/){target="\_blank"} section from the official documentation and follow the instructions to configure webhooks. + All [application servers](../application-server/index.md){:target="\_blank"} have an endpoint to receive webhooks from LiveKit. For this reason, when using LiveKit locally you need to configure webhooks to point to your application server in order to make it work. Check the [Webhooks](https://openvidu.io/latest/docs/reference/webhooks/){target="\_blank"} section from the official documentation and follow the instructions to configure webhooks. === "Use LiveKit Cloud" @@ -28,7 +28,7 @@ Alternatively, you can use OpenVidu, which is a fully compatible LiveKit distrib !!! info "Configure Webhooks" - All [application servers](../application-server/index.md){:target="\_blank"} have an endpoint to receive webhooks from LiveKit. For this reason, when using LiveKit Cloud you need to configure webhooks to point to your local application server in order to make it work. Check the [Webhooks](https://docs.livekit.io/home/server/webhooks/){target="\_blank"} section from the official documentation and follow the instructions to configure webhooks. + All [application servers](../application-server/index.md){:target="\_blank"} have an endpoint to receive webhooks from LiveKit. For this reason, when using LiveKit Cloud you need to configure webhooks to point to your local application server in order to make it work. Check the [Webhooks](https://openvidu.io/latest/docs/reference/webhooks/){target="\_blank"} section from the official documentation and follow the instructions to configure webhooks. !!! warning "Expose your local application server"