# openvidu-recording-server-endpoint

**Repository Path**: jiajinliu/openvidu-recording-server-endpoint

## Basic Information

- **Project Name**: openvidu-recording-server-endpoint
- **Description**: 这是一个 Spring Boot 应用程序，旨在提供一个 HTTP 端点，用于从浏览器上传 / 下载视频录制内容。它旨在与 OpenVidu 浏览器库及其本地录制器 API 配合使用
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-04-15
- **Last Updated**: 2025-04-15

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# openvidu-recording-server-endpoint

This is a Spring Boot application aimed to offer an HTTP endpoint for uploading/dowloading video recordings from browsers. It is meant to be used alongside [openvidu-browser](https://www.npmjs.com/package/openvidu-browser) library and its **LocalRecorder** API.

## Demo

Provided as a [Docker](https://store.docker.com/search?type=edition&offering=community) image:

```
docker run -p 5443:5443 openvidu/openvidu-recording-server-endpoint
```

<p align="center"><img src="https://github.com/OpenVidu/openvidu-recording-server-endpoint/blob/master/readme-images/demo.gif?raw=true"/></p>

## Docs

- **Frontend**: LocalRecorder object in *openvidu-browser-1.8.0.js* is used to record a media stream and to upload it to certain endpoint.
- **Backend**: A Java Spring Boot app exposing 3 HTTP REST endpoints:
  - `POST /recording`: receives a recording as a MultiPart file and stores it locally.
  - `GET /recording/{recordingName}`: serves one recording with certain name.
  - `GET /recording/all`: returns an array with all the recording names for which the user has permissions.

A simple security protocol is implemented in the backend. All REST methods are secured under Basic Authentication, and 2 users are predefined:

- `user:pass`
- `admin:admin`

Any authenticated user can perform uploads. For downloads, user `admin` has the highest level of granted permissions, and therefore has access to all video recordings. User `user` has access to their own recorded videos only.