Skip to content

Commit

Permalink
Update links so they all follow the same convention
Browse files Browse the repository at this point in the history
  • Loading branch information
juancarmore committed Dec 20, 2024
1 parent b2b1d3a commit 6d11852
Show file tree
Hide file tree
Showing 21 changed files with 98 additions and 98 deletions.
2 changes: 1 addition & 1 deletion .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -40,4 +40,4 @@
"WEBM",
"WebRTC"
]
}
}
6 changes: 3 additions & 3 deletions docs/blog/posts/openvidu-3.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,8 +58,8 @@ These are the general steps to migrate an application from OpenVidu 2 to OpenVid
This includes any client application built with **JavaScript**, **Angular**, **Vue**, **React**, **React Native**, **Ionic** and **Electron**. Just update:

- Dependency `openvidu-browser` to version 3.0.0 in your package.json.
- Dependency `openvidu-angular` to version 3.0.0 in your package.json, if you use [OpenVidu Components](https://docs.openvidu.io/en/latest/components/){target="_blank"}.
- Dependency `openvidu-react-native-adapter` to version 3.0.0 in your package.json, if you use [React Native](https://docs.openvidu.io/en/latest/tutorials/openvidu-react-native/){target="_blank"}.
- Dependency `openvidu-angular` to version 3.0.0 in your package.json, if you use [OpenVidu Components](https://docs.openvidu.io/en/stable/components/){target="_blank"}.
- Dependency `openvidu-react-native-adapter` to version 3.0.0 in your package.json, if you use [React Native](https://docs.openvidu.io/en/stable/tutorials/openvidu-react-native/){target="_blank"}.
- File `openvidu-browser.js` to `openvidu-browser-3.0.0.js` if you are using a [local copy of the library](https://github.com/OpenVidu/openvidu/releases){target="_blank"}.

#### For applications built for native Android or iOS
Expand All @@ -71,7 +71,7 @@ As OpenVidu 2 did not provide native SDKs for Android or iOS, it is necessary to

### 2. Deploy OpenVidu 3

An OpenVidu 2 deployment is *NOT* directly upgradable to an OpenVidu 3 deployment. You will have to deploy OpenVidu 3 completely from scratch. Just follow the [official instructions](https://openvidu.io/docs/self-hosting/).
An OpenVidu 2 deployment is *NOT* directly upgradable to an OpenVidu 3 deployment. You will have to deploy OpenVidu 3 completely from scratch. Just follow the [official instructions](../../docs/self-hosting/deployment-types.md).

### 3. Point your server application to your new OpenVidu 3 deployment

Expand Down
6 changes: 3 additions & 3 deletions docs/docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -124,12 +124,12 @@ With these three concepts you can build any kind of real-time application you ca

OpenVidu is available in two editions:

- **OpenVidu** <a href="/pricing#openvidu-community"><span class="openvidu-tag openvidu-community-tag">COMMUNITY</span></a>: 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 medium-scale production deployments. You can host hundreds of simultaneous participants in your rooms by running OpenVidu Community in a sufficiently powerful server!
- **OpenVidu** <a href="/pricing#openvidu-pro"><span class="openvidu-tag openvidu-pro-tag">PRO</span></a>: 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.
- **OpenVidu** <a href="/pricing/#openvidu-community"><span class="openvidu-tag openvidu-community-tag">COMMUNITY</span></a>: 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 medium-scale production deployments. You can host hundreds of simultaneous participants in your rooms by running OpenVidu Community in a sufficiently powerful server!
- **OpenVidu** <a href="/pricing/#openvidu-pro"><span class="openvidu-tag openvidu-pro-tag">PRO</span></a>: 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.

<br>

| Type of deployment | <a href="/docs/self-hosting/deployment-types/#openvidu-local-development"><strong>OpenVidu<br><span class="no-break">Local (development)</span></strong> | <a href="/docs/self-hosting/deployment-types/#openvidu-single-node"><strong>OpenVidu<br><span class="no-break">Single Node</span></strong></a> | <a href="/docs/self-hosting/deployment-types/#openvidu-elastic"><strong>OpenVidu<br><span class="no-break">Elastic</span></strong></a> | <a href="/docs/self-hosting/deployment-types/#openvidu-high-availability"><strong>OpenVidu<br><span class="no-break">High Availability</span></strong></a> |
| Type of deployment | <a href="../self-hosting/deployment-types/#openvidu-local-development"><strong>OpenVidu<br><span class="no-break">Local (development)</span></strong> | <a href="../self-hosting/deployment-types/#openvidu-single-node"><strong>OpenVidu<br><span class="no-break">Single Node</span></strong></a> | <a href="../self-hosting/deployment-types/#openvidu-elastic"><strong>OpenVidu<br><span class="no-break">Elastic</span></strong></a> | <a href="../self-hosting/deployment-types/#openvidu-high-availability"><strong>OpenVidu<br><span class="no-break">High Availability</span></strong></a> |
| ------------------------- | ------------------------------------ | -------------------- | ---------------- | -------------------------- |
| **OpenVidu Edition** | <span class="openvidu-tag openvidu-community-tag">COMMUNITY</span> <span class="openvidu-tag openvidu-pro-tag">PRO</span> | <span class="openvidu-tag openvidu-community-tag">COMMUNITY</span> | <span class="openvidu-tag openvidu-pro-tag">PRO</span> | <span class="openvidu-tag openvidu-pro-tag">PRO</span> |
| **Suitability** | For local development in your laptop | For applications with medium user load | For applications with dynamic user load that require scalability | For applications where both scalability and fault tolerance are critical |
Expand Down
32 changes: 16 additions & 16 deletions docs/docs/releases.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

### Known limitations

- When using [mediasoup](../self-hosting/production-ready/performance/):
- When using [mediasoup](self-hosting/production-ready/performance.md):
- No `ConnectionQualityChanged` event ([LiveKit reference](https://docs.livekit.io/realtime/client/events/#Events){target="\_blank"}).
- No `TrackStreamStateChanged` event ([LiveKit reference](https://docs.livekit.io/realtime/client/events/#Events){target="\_blank"}).
- Limitted [ingress](https://docs.livekit.io/home/ingress/overview/){target="\_blank"} support: non-simulcast video tracks are not supported. Firefox may experience issues when subscribing to ingress video.
Expand All @@ -32,27 +32,27 @@

### Changelog

- Centralized configuration: OpenVidu now automatically manages and synchronizes the configuration of all its components. This means that updating any configuration parameter in multi-node deployments ([OpenVidu Elastic](../self-hosting/deployment-types/#openvidu-elastic) and [OpenVidu High Availability](../self-hosting/deployment-types/#openvidu-high-availability)) is as simple as updating the required file in a single node. OpenVidu handles the distribution and restart of the affected services across all nodes. See how easily you can change the configuration [here](../self-hosting/configuration/changing-config/).
- [mediasoup](../self-hosting/production-ready/performance/) support:
- Centralized configuration: OpenVidu now automatically manages and synchronizes the configuration of all its components. This means that updating any configuration parameter in multi-node deployments ([OpenVidu Elastic](self-hosting/deployment-types.md#openvidu-elastic) and [OpenVidu High Availability](self-hosting/deployment-types.md#openvidu-high-availability)) is as simple as updating the required file in a single node. OpenVidu handles the distribution and restart of the affected services across all nodes. See how easily you can change the configuration [here](self-hosting/configuration/changing-config.md).
- [mediasoup](self-hosting/production-ready/performance.md) support:
- Dynacast is now supported ([LiveKit reference](https://docs.livekit.io/home/client/tracks/publish/#Dynamic-broadcasting){target="\_blank"}).
- Adaptive Streaming is now supported ([LiveKit reference](https://docs.livekit.io/home/client/tracks/subscribe/#Adaptive-stream){target="\_blank"}).
- Speaker Detection events ([LiveKit reference](https://docs.livekit.io/home/client/tracks/subscribe/#Speaker-detection){target="\_blank"}).
- Server API method `MutePublishTrack` ([LiveKit reference](https://docs.livekit.io/reference/server/server-apis/#MutePublishedTrack){target="\_blank"}).
- Client API method `RemoteTrackPublication.setEnabled` ([LiveKit JS reference](https://docs.livekit.io/client-sdk-js/classes/RemoteTrackPublication.html#setEnabled){target="\_blank"}).
- [OpenVidu Call](../openvidu-call/docs/#run-openvidu-locally):
- When using it against an [OpenVidu Local Deployment](../self-hosting/local/), recordings couldn't be accessed from the application's frontend. This is now fixed and OpenVidu Call is able to access recordings.
- [OpenVidu Call](openvidu-call/docs.md#run-openvidu-locally):
- When using it against an [OpenVidu Local Deployment](self-hosting/local.md), recordings couldn't be accessed from the application's frontend. This is now fixed and OpenVidu Call is able to access recordings.
- There was an error when applying Virtual Backgrounds ("No camera tracks found. Cannot apply background"). This is now fixed.
- Docker image [openvidu/openvidu-call](https://hub.docker.com/r/openvidu/openvidu-call){target="\_blank"} is now 50% smaller.
- [OpenVidu v2 compatibility](https://docs.openvidu.io/en/stable/openvidu3/#updating-from-openvidu-v2-to-openvidu-v3){target="\_blank"}:
- There was a race condition when multiple participants connected to the Session at the same time that could cause remote [`streamCreated`](https://docs.openvidu.io/en/latest/api/openvidu-browser/classes/StreamEvent.html){target="\_blank"} events to not be triggered. This is now fixed.
- There was a race condition when multiple participants connected to the Session at the same time that could cause remote [`streamCreated`](https://docs.openvidu.io/en/stable/api/openvidu-browser/classes/StreamEvent.html){target="\_blank"} events to not be triggered. This is now fixed.
- Configuration parameter `V2COMPAT_OPENVIDU_PRO_AWS_S3_BUCKET` did not allow configuring subbuckets ("openvidu" worked fine, but "openvidu/subbucket" did not). Now it is possible to do so.
- The operation to list recordings (available for [REST API](https://docs.openvidu.io/en/latest/reference-docs/REST-API/#get-all-recordings){target="\_blank"}, [openvidu-java-client](https://docs.openvidu.io/en/latest/api/openvidu-java-client/io/openvidu/java/client/OpenVidu.html#listRecordings()){target="\_blank"}, [openvidu-node-client](https://docs.openvidu.io/en/latest/api/openvidu-node-client/classes/OpenVidu.html#listRecordings){target="\_blank"}) was limited to 1000 recordings. This is now fixed and all recordings are always returned.
- The operation to list recordings (available for [REST API](https://docs.openvidu.io/en/stable/reference-docs/REST-API/#get-all-recordings){target="\_blank"}, [openvidu-java-client](https://docs.openvidu.io/en/stable/api/openvidu-java-client/io/openvidu/java/client/OpenVidu.html#listRecordings()){target="\_blank"}, [openvidu-node-client](https://docs.openvidu.io/en/stable/api/openvidu-node-client/classes/OpenVidu.html#listRecordings){target="\_blank"}) was limited to 1000 recordings. This is now fixed and all recordings are always returned.
- AWS deployments: all secrets are now synchronized with [AWS Secrets Manager](https://console.aws.amazon.com/secretsmanager){target="\_blank"}. You can update any secret from the AWS console and restart your cluster for them to have immediate effect in all your nodes. This is also true in reverse: you can update any secret inside your node and after a restart of the cluster, the values in AWS Secrets Manager will be properly synchronized.
- New application tutorials available: [iOS](../tutorials/application-client/ios), [Android](../tutorials/application-client/android), [Recording](../tutorials/advanced-features).
- New application tutorials available: [iOS](tutorials/application-client/ios.md), [Android](tutorials/application-client/android.md), [Recording](tutorials/advanced-features/index.md).

### Known limitations

- When using [mediasoup](../self-hosting/production-ready/performance/):
- When using [mediasoup](self-hosting/production-ready/performance.md):
- No `ConnectionQualityChanged` event ([LiveKit reference](https://docs.livekit.io/realtime/client/events/#Events){target="\_blank"}).
- No `TrackStreamStateChanged` event ([LiveKit reference](https://docs.livekit.io/realtime/client/events/#Events){target="\_blank"}).

Expand All @@ -77,24 +77,24 @@

### Changelog

- Improved [mediasoup](../self-hosting/production-ready/performance/) support:
- Improved [mediasoup](self-hosting/production-ready/performance.md) support:
- Data messages work ([LiveKit reference](https://docs.livekit.io/realtime/client/data-messages/#Data-messages){:target="\_blank"}).
- Ingress supported ([LiveKit reference](https://docs.livekit.io/realtime/ingress/overview/){:target="\_blank"}).
- Improved [OpenVidu Local Deployment](../self-hosting/local/):
- Improved [OpenVidu Local Deployment](self-hosting/local.md):
- Fixed Room Composite Egress ([LiveKit reference](https://docs.livekit.io/realtime/egress/room-composite/){:target="\_blank"}) support when using mediasoup.
- WebHooks ([LiveKit reference](https://docs.livekit.io/realtime/server/webhooks/){:target="\_blank"}) supported against a local [OpenVidu Call](../openvidu-call/docs/#run-openvidu-locally).
- WebHooks ([LiveKit reference](https://docs.livekit.io/realtime/server/webhooks/){:target="\_blank"}) supported against a local [OpenVidu Call](openvidu-call/docs.md#run-openvidu-locally).
- Production deployments have a better private IP discovery process when there are multiple valid private IPs in the same host. This will make work more deployments out-of-the-box without the need of manual intervention.
- [OpenVidu PRO Evaluation Mode](../self-hosting/local/#openvidu-pro) improved. Before a maximum a 2 Rooms of 8 Participants each could be created. Now the upper limit of Participants still apply, but the number of Rooms is unlimited. For example you can have 4 Rooms of 2 Participants each, or 1 Room of 8 Participants.
- Minor bug fixes related to [OpenVidu Call](../openvidu-call/).
- [OpenVidu PRO Evaluation Mode](self-hosting/local.md#openvidu-pro) improved. Before a maximum a 2 Rooms of 8 Participants each could be created. Now the upper limit of Participants still apply, but the number of Rooms is unlimited. For example you can have 4 Rooms of 2 Participants each, or 1 Room of 8 Participants.
- Minor bug fixes related to [OpenVidu Call](openvidu-call/index.md).

### Known limitations

- When using [mediasoup](../self-hosting/production-ready/performance/):
- When using [mediasoup](self-hosting/production-ready/performance.md):
- No support for Speaker Detection events ([LiveKit reference](https://docs.livekit.io/home/client/tracks/subscribe/#Speaker-detection){target="\_blank"}).
- No `ConnectionQualityChanged` event ([LiveKit reference](https://docs.livekit.io/realtime/client/events/#Events){target="\_blank"}).
- No support for Dynacast ([LiveKit reference](https://docs.livekit.io/home/client/tracks/publish/#Dynamic-broadcasting){target="\_blank"}).
- No support for Adaptive Streaming ([LiveKit reference](https://docs.livekit.io/home/client/tracks/subscribe/#Adaptive-stream){target="\_blank"}).
- When using [OpenVidu Call](../openvidu-call/docs/#run-openvidu-locally) against an [OpenVidu Local Deployment](../self-hosting/local/), recordings cannot be accessed.
- When using [OpenVidu Call](openvidu-call/docs.md#run-openvidu-locally) against an [OpenVidu Local Deployment](self-hosting/local.md), recordings cannot be accessed.

### Version table

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/self-hosting/deployment-types.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ OpenVidu offers **user-friendly installers** that facilitate quick **on-premises

There are different deployment options available, depending on your needs:

| Type of deployment | <a href="/docs/self-hosting/deployment-types/#openvidu-local-development"><strong>OpenVidu<br><span class="no-break">Local (development)</span></strong> | <a href="/docs/self-hosting/deployment-types/#openvidu-single-node"><strong>OpenVidu<br><span class="no-break">Single Node</span></strong></a> | <a href="/docs/self-hosting/deployment-types/#openvidu-elastic"><strong>OpenVidu<br><span class="no-break">Elastic</span></strong></a> | <a href="/docs/self-hosting/deployment-types/#openvidu-high-availability"><strong>OpenVidu<br><span class="no-break">High Availability</span></strong></a> |
| Type of deployment | <a href="#openvidu-local-development"><strong>OpenVidu<br><span class="no-break">Local (development)</span></strong> | <a href="#openvidu-single-node"><strong>OpenVidu<br><span class="no-break">Single Node</span></strong></a> | <a href="#openvidu-elastic"><strong>OpenVidu<br><span class="no-break">Elastic</span></strong></a> | <a href="#openvidu-high-availability"><strong>OpenVidu<br><span class="no-break">High Availability</span></strong></a> |
| ------------------------- | ------------------------------------ | -------------------- | ---------------- | -------------------------- |
| **OpenVidu Edition** | <span class="openvidu-tag openvidu-community-tag">COMMUNITY</span> <span class="openvidu-tag openvidu-pro-tag">PRO</span> | <span class="openvidu-tag openvidu-community-tag">COMMUNITY</span> | <span class="openvidu-tag openvidu-pro-tag">PRO</span> | <span class="openvidu-tag openvidu-pro-tag">PRO</span> |
| **Suitability** | For local development in your laptop | For applications with medium user load | For applications with dynamic user load that require scalability | For applications where both scalability and fault tolerance are critical |
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/self-hosting/ha/aws/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -218,7 +218,7 @@ Your authentication credentials and URL to point your applications would be:

--8<-- "docs/docs/self-hosting/shared/aws-troubleshooting.md"

4. If everything seems fine, check the [status](../on-premises/admin.md/#checking-the-status-of-services) and the [logs](../on-premises/admin.md/#checking-logs) of the installed OpenVidu services in all the Master Nodes and Media Nodes.
4. If everything seems fine, check the [status](../on-premises/admin.md#checking-the-status-of-services) and the [logs](../on-premises/admin.md#checking-logs) of the installed OpenVidu services in all the Master Nodes and Media Nodes.

## Configuration and administration

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/self-hosting/ha/on-premises/admin.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ Depending on the node type, you will see different services running.

## Adding Media Nodes

To add a new Media Node, simply spin up a new VM and run the OpenVidu installer script to integrate it into the existing cluster. Run the [installation command](../on-premises/install-nlb.md/#media-node) on the new Media Node.
To add a new Media Node, simply spin up a new VM and run the OpenVidu installer script to integrate it into the existing cluster. Run the [installation command](../on-premises/install-nlb.md#media-node) on the new Media Node.

--8<-- "docs/docs/self-hosting/shared/openvidu-pro-removing-media-nodes.md"

Expand Down
Loading

0 comments on commit 6d11852

Please sign in to comment.