Skip to content

Commit

Permalink
Release 3.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
pabloFuente committed Dec 2, 2024
1 parent dfc7d24 commit d5d1119
Show file tree
Hide file tree
Showing 56 changed files with 123 additions and 128 deletions.
2 changes: 1 addition & 1 deletion docs/docs/openvidu-call/docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Introducing **OpenVidu Call**, the premier videoconference application that show
#### 2. Download OpenVidu Call code

```bash
git clone https://github.com/OpenVidu/openvidu-call.git -b 3.0.0-beta3
git clone https://github.com/OpenVidu/openvidu-call.git -b 3.0.0
```

#### 3. Run the OpenVidu Call backend
Expand Down

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -210,7 +210,7 @@ <h3>Description</h3>
</code></pre></div><!--ovActivitiesPanel-end-tutorial-->

<p>For a step-by-step tutorial on how to replace the activities template with just a few lines of code,
check out our comprehensive guide: <a href="https://docs.openvidu.io/en/3.0.0-beta3/components/openvidu-custom-activities-panel">Customizing the Activities Panel</a>.</p>
check out our comprehensive guide: <a href="https://docs.openvidu.io/en/3.0.0/components/openvidu-custom-activities-panel">Customizing the Activities Panel</a>.</p>

</p>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -280,7 +280,7 @@ <h3>Description</h3>
}
</code></pre></div><!--ovAdditionalPanels-end-tutorial-->

<p>For detailed instructions, refer to the tutorial available <a href="https://docs.openvidu.io/en/3.0.0-beta3/components/openvidu-additional-panels">here</a>.</p>
<p>For detailed instructions, refer to the tutorial available <a href="https://docs.openvidu.io/en/3.0.0/components/openvidu-additional-panels">here</a>.</p>

</p>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -272,7 +272,7 @@ <h3>Description</h3>


<p>For a step-by-step tutorial on how to replace the chat template with just a few lines of code,
check out our comprehensive guide: <a href="https://docs.openvidu.io/en/3.0.0-beta3/components/openvidu-custom-chat-panel">Customizing the Chat Panel</a>.</p>
check out our comprehensive guide: <a href="https://docs.openvidu.io/en/3.0.0/components/openvidu-custom-chat-panel">Customizing the Chat Panel</a>.</p>

</p>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -292,7 +292,7 @@ <h3>Description</h3>
</code></pre></div><!--ovLayout-end-tutorial-->


<p>For a comprehensive guide on implementing custom layouts, please refer to the associated tutorial <a href="https://docs.openvidu.io/en/3.0.0-beta3/components/openvidu-custom-layout">here</a>.</p>
<p>For a comprehensive guide on implementing custom layouts, please refer to the associated tutorial <a href="https://docs.openvidu.io/en/3.0.0/components/openvidu-custom-layout">here</a>.</p>

</p>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -244,7 +244,7 @@ <h3>Description</h3>
</code></pre></div><!--ovPanel-end-tutorial-->


<p>For a comprehensive tutorial on implementing custom panels, please refer to the associated guide <a href="https://docs.openvidu.io/en/3.0.0-beta3/components/openvidu-custom-panels">here</a>.</p>
<p>For a comprehensive tutorial on implementing custom panels, please refer to the associated guide <a href="https://docs.openvidu.io/en/3.0.0/components/openvidu-custom-panels">here</a>.</p>

</p>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -233,7 +233,7 @@ <h3>Description</h3>
}
</code></pre></div><!--ovParticipantPanelItem-end-tutorial-->

<p>For a detailed tutorial on customizing participant panel items, please visit <a href="https://docs.openvidu.io/en/3.0.0-beta3/components/openvidu-custom-participant-panel-item">this link</a>.</p>
<p>For a detailed tutorial on customizing participant panel items, please visit <a href="https://docs.openvidu.io/en/3.0.0/components/openvidu-custom-participant-panel-item">this link</a>.</p>

</p>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -238,7 +238,7 @@ <h3>Description</h3>
}
</code></pre></div><!--ovParticipantPanelItemElements-end-tutorial-->

<p>For a comprehensive tutorial on adding elements to participant panel items, please visit <a href="https://docs.openvidu.io/en/3.0.0-beta3/components/openvidu-custom-participant-panel-item-elements">this link</a>.</p>
<p>For a comprehensive tutorial on adding elements to participant panel items, please visit <a href="https://docs.openvidu.io/en/3.0.0/components/openvidu-custom-participant-panel-item-elements">this link</a>.</p>

</p>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -268,7 +268,7 @@ <h3>Description</h3>
}
</code></pre></div><!--ovParticipantsPanel-end-tutorial-->

<p>For a comprehensive tutorial on customizing the participants panel, please visit <a href="https://docs.openvidu.io/en/3.0.0-beta3/components/openvidu-custom-participants-panel">this link</a>.</p>
<p>For a comprehensive tutorial on customizing the participants panel, please visit <a href="https://docs.openvidu.io/en/3.0.0/components/openvidu-custom-participants-panel">this link</a>.</p>

</p>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -227,7 +227,7 @@ <h3>Description</h3>
}
</code></pre></div><!--ovStream-end-tutorial-->

<p>For a detailed tutorial on customizing the stream component, please visit <a href="https://docs.openvidu.io/en/3.0.0-beta3/components/openvidu-custom-stream">this link</a>.</p>
<p>For a detailed tutorial on customizing the stream component, please visit <a href="https://docs.openvidu.io/en/3.0.0/components/openvidu-custom-stream">this link</a>.</p>

</p>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -233,7 +233,7 @@ <h3>Description</h3>
}
</code></pre></div><!--ovToolbarAdditionalButtons-end-tutorial-->

<p>To follow a step-by-step tutorial on this feature, please visit <a href="https://docs.openvidu.io/en/3.0.0-beta3/components/openvidu-toolbar-buttons">this link</a>.</p>
<p>To follow a step-by-step tutorial on this feature, please visit <a href="https://docs.openvidu.io/en/3.0.0/components/openvidu-toolbar-buttons">this link</a>.</p>

</p>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -218,7 +218,7 @@ <h3>Description</h3>
}
</code></pre></div><!--ovToolbarAdditionalPanelButtons-end-tutorial-->

<p>You can run the associated tutorial <a href="https://docs.openvidu.io/en/3.0.0-beta3/components/openvidu-toolbar-panel-buttons">here</a>.</p>
<p>You can run the associated tutorial <a href="https://docs.openvidu.io/en/3.0.0/components/openvidu-toolbar-panel-buttons">here</a>.</p>

</p>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -226,7 +226,7 @@ <h3>Description</h3>
}
</code></pre></div><!--ovToolbar-end-tutorial-->

<p>You can run the associated tutorial <a href="https://docs.openvidu.io/en/3.0.0-beta3/components/openvidu-custom-toolbar">here</a>.</p>
<p>You can run the associated tutorial <a href="https://docs.openvidu.io/en/3.0.0/components/openvidu-custom-toolbar">here</a>.</p>

</p>

Expand Down
40 changes: 22 additions & 18 deletions docs/docs/reference-docs/openvidu-components-angular/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -116,24 +116,28 @@ <h2>Getting Started</h2>
</ol>
<p>You can also customize the styles in your <code>styles.scss</code> file:</p>
<b>Example :</b><div><pre class="line-numbers"><code class="language-scss">:root {
--ov-primary-color: #303030;
--ov-secondary-color: #3e3f3f;
--ov-tertiary-color: #598eff;
--ov-warn-color: #eb5144;
--ov-accent-color: #ffae35;
--ov-light-color: #e6e6e6;

--ov-logo-background-color: #3a3d3d;

--ov-text-color: #ffffff;

--ov-panel-text-color: #1d1d1d;
--ov-panel-background: #ffffff;

--ov-buttons-radius: 50%;
--ov-leave-button-radius: 10px;
--ov-video-radius: 5px;
--ov-panel-radius: 5px;
/* Basic colors */
--ov-background-color: #303030; // Background color
--ov-surface-color: #ffffff; // Surfaces colors (panels, dialogs)

/* Text colors */
--ov-text-primary-color: #ffffff; // Text color over primary background
--ov-text-surface-color: #1d1d1d; // Text color over surface background

/* Action colors */
--ov-primary-action-color: #273235; // Primary color for buttons, etc.
--ov-secondary-action-color: #f1f1f1; // Secondary color for buttons, etc.
--ov-accent-action-color: #0089ab; // Color for highlighted elements

/* Status colors */
--ov-error-color: #eb5144; // Error color
--ov-warn-color: #ffba53; // Warning color

/* Radius */
--ov-toolbar-buttons-radius: 50%; // Radius for toolbar buttons
--ov-leave-button-radius: 10px; // Radius for leave button
--ov-video-radius: 5px; // Radius for video elements
--ov-surface-radius: 5px; // Radius for surface elements
}</code></pre></div><h2>Usage</h2>
<b>Example :</b><div><pre class="line-numbers"><code class="language-html">&lt;ov-videoconference
[token]=&quot;token&quot;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -140,9 +140,6 @@ <h6><b>Methods</b></h6>
<li>
<a href="#getRoom" >getRoom</a>
</li>
<li>
<a href="#getRoomMetadata" >getRoomMetadata</a>
</li>
<li>
<a href="#getRoomName" >getRoomName</a>
</li>
Expand Down Expand Up @@ -272,42 +269,6 @@ <h3 id="methods">
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="getRoomMetadata"></a>
<span class="name">
<span ><b>getRoomMetadata</b></span>
<a href="#getRoomMetadata"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>getRoomMetadata()</code>
</td>
</tr>




<tr>
<td class="col-md-4">
<div class="io-description"><p>Returns the room metadata from the token</p>
</div>

<div class="io-description">
<b>Returns : </b> <code>literal type</code>

</div>
<div class="io-description">

</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
Expand Down

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@
</ol>
<ul class="properties-list">
<li>
<b>Version</b> : 3.0.0-beta3</li>
<b>Version</b> : 3.0.0</li>
</ul>


Expand Down
32 changes: 31 additions & 1 deletion docs/docs/releases.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,33 @@
## 3.0.0

### Changelog

- **General Availability of OpenVidu 3**, which is considered now stable and production-ready. Beta versions of OpenVidu 3 are preparing to be discontinued (including [3.0.0-beta1](#300-beta1), [3.0.0-beta2](#300-beta2) and [3.0.0-beta3](#300-beta3)).

### Known limitations

- When using [mediasoup](../self-hosting/production-ready/performance/):
- 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.

### Version table

| Artifact | Version | Info | Link |
| ---------------------- | ------- | ---- | ---------- |
| livekit/livekit-server | v1.8.0 | :material-information-outline:{ title="Version of livekit-server in which OpenVidu is based on" } | [:octicons-link-24:](https://github.com/livekit/livekit/releases/tag/v1.8.0){:target="\_blank"} |
| mediasoup | 3.12.16 | :material-information-outline:{ title="Version of mediasoup in which OpenVidu is based on" } | [:octicons-link-24:](https://github.com/versatica/mediasoup/releases/tag/3.12.16){:target="\_blank"} |
| livekit/egress | v1.8.4 | :material-information-outline:{ title="Egress version used by OpenVidu deployments. Used to export media from a Room (for example, recordings or RTMP broadcasting)" } | [:octicons-link-24:](https://github.com/livekit/egress/releases/tag/v1.8.4){:target="\_blank"} |
| livekit/ingress | v1.4.2 | :material-information-outline:{ title="Ingress version used by OpenVidu deployments. Used to import media into a Room (for example, an MP4 video or an RTSP stream)" } | [:octicons-link-24:](https://github.com/livekit/ingress/releases/tag/v1.4.2){:target="\_blank"} |
| MinIO | 2024.10.13 | :material-information-outline:{ title="Version of S3 MinIO used by OpenVidu deployments. Used to store recordings and common node configurations. In <i>OpenVidu High Availability</i> this is an instance of a <i>Minio Multi-Node</i>" } | [:octicons-link-24:](https://github.com/minio/minio/releases/tag/RELEASE.2024-10-13T13-34-11Z){:target="\_blank"} |
| Caddy | 2.8.4 | :material-information-outline:{ title="Version of Caddy used by OpenVidu deployments. It is a reverse proxy used as a loadbalancer to distribute client connections across your nodes and automatically manage your TLS certificate" } | [:octicons-link-24:](https://github.com/caddyserver/caddy/releases/tag/v2.8.4){:target="\_blank"}|
| MongoDB | 7.0.15 | :material-information-outline:{ title="Version of MongoDB used by OpenVidu deployments. Used to store analytics and monitoring persistent data. In <i>OpenVidu High Availability</i> this is an instance of a <i>MongoDB Replica Set</i>" } | [:octicons-link-24:](https://www.mongodb.com/docs/manual/release-notes/7.0-changelog/#std-label-7.0.15-changelog){:target="\_blank"} |
| Redis | 7.4.1 | :material-information-outline:{ title="Version of Redis used by OpenVidu deployments. Used to share transient information between Media Nodes and coordinate them. In <i>OpenVidu High Availability</i> this is an instance of a <i>Redis Cluster</i>" } | [:octicons-link-24:](https://github.com/redis/redis/releases/tag/7.4.1){:target="\_blank"} |
| Grafana | 11.3.0 | :material-information-outline:{ title="Version of Grafana used by OpenVidu deployments. Observability module used to query and visualize logs and metrics in dashboards" } | [:octicons-link-24:](https://github.com/grafana/grafana/releases/tag/v11.3.0){:target="\_blank"} |
| Prometheus | 2.55.0 | :material-information-outline:{ title="Version of Prometheus used by OpenVidu deployments. Observability module from Grafana stack, used to collect metrics from Media Nodes and send them to Mimir" } | [:octicons-link-24:](https://github.com/prometheus/prometheus/releases/tag/v2.55.0){:target="\_blank"} |
| Promtail / Loki | 3.2.1 | :material-information-outline:{ title="Version of loki and promtail used by OpenVidu deployments. Observability modules from Grafana stack, used to collect logs from all services (Promtail) and stored them (Loki)" } | [:octicons-link-24:](https://github.com/grafana/loki/releases/tag/v3.2.1){:target="\_blank"} |
| Mimir | 2.14.1 | :material-information-outline:{ title="Version of Mimir used by OpenVidu deployments. Observability module from Grafana stack, used to store metrics from Prometheus" } | [:octicons-link-24:](https://github.com/grafana/mimir/releases/tag/mimir-2.14.1){:target="\_blank"} |

## 3.0.0-beta3

### Changelog
Expand Down Expand Up @@ -35,7 +65,7 @@
| livekit/egress | v1.8.2 | :material-information-outline:{ title="Egress version used by OpenVidu deployments. Used to export media from a Room (for example, recordings or RTMP broadcasting)" } | [:octicons-link-24:](https://github.com/livekit/egress/releases/tag/v1.8.2){:target="\_blank"} |
| livekit/ingress | v1.4.2 | :material-information-outline:{ title="Ingress version used by OpenVidu deployments. Used to import media into a Room (for example, an MP4 video or an RTSP stream)" } | [:octicons-link-24:](https://github.com/livekit/ingress/releases/tag/v1.4.2){:target="\_blank"} |
| MinIO | 2024.6.13 | :material-information-outline:{ title="Version of S3 MinIO used by OpenVidu deployments. Used to store recordings and common node configurations. In <i>OpenVidu High Availability</i> this is an instance of a <i>Minio Multi-Node</i>" } | [:octicons-link-24:](https://github.com/minio/minio/releases/tag/RELEASE.2024-06-13T22-53-53Z){:target="\_blank"} |
| Caddy | 2.8.4 | :material-information-outline:{ title="Version of Caddy used by OpenVidu deployments. It is a reverse proxy used as a loadbalancer to distribute client connections across your nodes and automatically manage your TLS certificate" } | [:octicons-link-24:](https://github.com/caddyserver/caddy/releases/tag/v2.7.6){:target="\_blank"}|
| Caddy | 2.8.4 | :material-information-outline:{ title="Version of Caddy used by OpenVidu deployments. It is a reverse proxy used as a loadbalancer to distribute client connections across your nodes and automatically manage your TLS certificate" } | [:octicons-link-24:](https://github.com/caddyserver/caddy/releases/tag/v2.8.4){:target="\_blank"}|
| MongoDB | 7.0.11 | :material-information-outline:{ title="Version of MongoDB used by OpenVidu deployments. Used to store analytics and monitoring persistent data. In <i>OpenVidu High Availability</i> this is an instance of a <i>MongoDB Replica Set</i>" } | [:octicons-link-24:](https://www.mongodb.com/docs/manual/release-notes/7.0-changelog/#std-label-7.0.11-changelog){:target="\_blank"} |
| Redis | 7.2.5 | :material-information-outline:{ title="Version of Redis used by OpenVidu deployments. Used to share transient information between Media Nodes and coordinate them. In <i>OpenVidu High Availability</i> this is an instance of a <i>Redis Cluster</i>" } | [:octicons-link-24:](https://github.com/redis/redis/releases/tag/7.2.5){:target="\_blank"} |
| Grafana | 10.3.3 | :material-information-outline:{ title="Version of Grafana used by OpenVidu deployments. Observability module used to query and visualize logs and metrics in dashboards" } | [:octicons-link-24:](https://github.com/grafana/grafana/releases/tag/v10.3.3){:target="\_blank"} |
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/self-hosting/local.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ To install OpenVidu locally, follow these steps:
1. Clone the following repository:

```bash
git clone https://github.com/OpenVidu/openvidu-local-deployment -b 3.0.0-beta3
git clone https://github.com/OpenVidu/openvidu-local-deployment -b 3.0.0
```

!!!info
Expand Down Expand Up @@ -68,7 +68,7 @@ To install OpenVidu locally, follow these steps:
1. Clone the following repository:

```bash
git clone https://github.com/OpenVidu/openvidu-local-deployment -b 3.0.0-beta3
git clone https://github.com/OpenVidu/openvidu-local-deployment -b 3.0.0
```

!!!info
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ This tutorial improves the [basic recording tutorial](./recording-basic.md){targ
### 2. Download the tutorial code

```bash
git clone https://github.com/OpenVidu/openvidu-livekit-tutorials.git -b 3.0.0-beta3
git clone https://github.com/OpenVidu/openvidu-livekit-tutorials.git -b 3.0.0
```

### 3. Run the application
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/tutorials/advanced-features/recording-basic.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ This tutorial is a simple video-call application, built upon [Node.js server](..
### 2. Download the tutorial code

```bash
git clone https://github.com/OpenVidu/openvidu-livekit-tutorials.git -b 3.0.0-beta3
git clone https://github.com/OpenVidu/openvidu-livekit-tutorials.git -b 3.0.0
```

### 3. Run the application
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@ This tutorial combines the use of the **ToolbarAdditionalPanelButtonsDirective**
#### 2. Download the tutorial code

```bash
git clone https://github.com/OpenVidu/openvidu-livekit-tutorials.git -b 3.0.0-beta3
git clone https://github.com/OpenVidu/openvidu-tutorials.git -b 3.0.0-beta3
git clone https://github.com/OpenVidu/openvidu-livekit-tutorials.git -b 3.0.0
git clone https://github.com/OpenVidu/openvidu-tutorials.git -b 3.0.0
```

#### 3. Run a server application
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@ The **openvidu-admin-dashboard** tutorial demonstrates how to create an admin da
#### 2. Download the tutorial code

```bash
git clone https://github.com/OpenVidu/openvidu-livekit-tutorials.git -b 3.0.0-beta3
git clone https://github.com/OpenVidu/openvidu-tutorials.git -b 3.0.0-beta3
git clone https://github.com/OpenVidu/openvidu-livekit-tutorials.git -b 3.0.0
git clone https://github.com/OpenVidu/openvidu-tutorials.git -b 3.0.0
```

#### 3. Run a server application
Expand Down
Loading

0 comments on commit d5d1119

Please sign in to comment.