openvidu-admin-dashboard 🔗

Check it on GitHub

The openvidu-admin-dashboard tutorial demonstrates how to integrate an administration dashboard to your OpenVidu Components based application. In this case, our custom component will display a list to manage the recordings of your OpenVidu deployment: search, order by, play, download, delete.

Running this tutorial 🔗

To run the tutorial you need the three components stated in OpenVidu application architecture: an OpenVidu deployment, your server application and your client application. In this order:

1. Run OpenVidu deployment 🔗

Using Docker Engine:

# WARNING: this container is not suitable for production deployments of OpenVidu
# Visit

docker run -p 4443:4443 --rm -e OPENVIDU_SECRET=MY_SECRET openvidu/openvidu-dev:2.22.0

2. Run your preferred server application sample 🔗

For more information visit Application server.

3. Run the client application tutorial 🔗

You need NPM and Angular CLI to serve the application. Check them with the following command:

npm -v
ng v

To serve the tutorial:

# Using the same repository openvidu-tutorials from step 2

cd openvidu-tutorials/openvidu-components/openvidu-admin-dashboard
npm install
ng serve

Go to http://localhost:4200 to test the app once the server is running.

To test the application with other devices in your network, visit this FAQ

Understanding the code 🔗

This is an Angular project generated with Angular CLI tool, and therefore you will see lots of configuration files and other stuff that doesn't really matter to us. We will focus on the following files under src/app/ folder:

We are using a very basic server application which does not include any recording and authentication logic.
As AdminLoginComponent and AdminDashboardComponent need an application server with user control and recording support respectively, we have simulated the admin authentication for educational purposes. You must include authentication logic in your server application to have a properly secured admin dashboard.

First, we need to install the openvidu-angular library. You can check how to do that here.

The AdminLoginComponent emits an event when the login button is clicked. Listening to onLoginButtonClicked event we will be able to authenticate to gain access to the admin dashboard. As said above, we have simulated this authentication for educational purposes.


Once you are logged as an admin user, we can show the AdminDashboardComponent. This component needs a recording list so the administrator can review all the recordings, preview them, download them or delete them. Just with a couple of clicks.

In this tutorial, the recordingsList will be empty because there is not recording support in the basic server application. Also, the AdminDashboardComponent provides multiple events for the recording management as onRefreshRecordingsClicked or onDeleteRecordingClicked and it also provides a way to listen when you click the logout button with the onLogoutClicked event.


app.component.ts declares the following properties and methods:

logged: boolean = false;
recordings: RecordingInfo[] = [];

constructor() {}

onLoginClicked(password: string) {
    console.log(`Loggin button clicked ${password}`);
     * WARNING! This code is developed for didactic purposes only.
     * The authentication process should be done in the server side.
    this.logged = true;

onLogoutClicked() {
    console.log("Logout button clicked");
     * WARNING! This code is developed for didactic purposes only.
     * The authentication process should be done in the server side.
    this.logged = false;

onRefreshRecordingsClicked() {
    console.log("Refresh recording clicked");

onDeleteRecordingClicked(recordingId: string) {
    console.log(`Delete recording clicked ${recordingId}`);


  • logged: boolean variable where auth state is stored.
  • constructor: method with dependency injection.
  • onLoginClicked: method invoked when AdminLoginComponent fires the onLoginClicked event.
  • onLogoutClicked: method invoked when AdminDashboardComponent fires the onLogoutClicked event.
  • onRefreshRecordingsClicked: method invoked when AdminDashboardComponent fires the onRefreshRecordingsClicked event.
  • onDeleteRecordingClicked: method invoked when AdminDashboardComponent fires the onDeleteRecordingClicked event.