sxzz / free-hls-live

Free live streaming with Free-HLS (Free HLS 直播姬)

Free HLS Live

Free live streaming with Free-HLS.

Read this in other languages: English | 简体中文

This project is for learning and communication purposes only, and we are not responsible for any losses caused to you or others during use.

Requirements

• Node.js
• Yarn
• Aliyun OSS / TencentCloud COS

Installation

git clone https://github.com/sxzz/free-hls-live.git
cd free-hls-live
yarn install

Usage

First, you need to write an Uploader by yourself, see sxyazi/free-hls#19

Configure Storage

Because the m3u8 file is constantly changing, it cannot be implemented with the image bed

You need to have a service that can store files and can be accessed by the public network, such as servers, Aliyun OSS, TencentCloud COS, etc. And you need to configure CORS cross-domain. The m3u8 file is generally small and cost less.

Copy config.example.yml to config.yml

Via OBS

1. In the settings dialog go to Advanced and set the recording filename. The default includes the current time. Choose something without any special % time values. You also need to enable Overwrite if file exists.
2. In the Settings Dialog go to Output, set output mode to Advanced and go to the recording tab. Here you set type to "Custom Output (ffmpeg)" and set container format to "hls". Set the file path to a folder.

# config-path: configuration file path
# [steaming-folder]: the path of the live video directory.
# [uploader-name]: uploader file path
yarn start [steaming-folder] -c <config-path> [-u uploader-name]

Play live stream

Use the web player public/player.html to play

Related

• sxzz/free-hls.js HLS upload tool (Written in Node.js)
• sxyazi/free-hls A free HLS video solution

Reference

• How to do HLS streaming in OBS (Open Broadcast Studio)

Sponsors

License

AGPL-3.0 License © 2020-PRESENT 三咲智子

free-hls-live's Issues

Dependency Dashboard

This issue provides visibility into Renovate updates and their statuses. Learn more

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• chore(deps): update all non-major dependencies (@sxzz/eslint-config-prettier, @sxzz/eslint-config-ts, commander, cos-nodejs-sdk-v5, esbuild, eslint, eslint-define-config, esno, got, tsup, typescript)
• chore(deps): update dependency tsup to v6

Detected dependencies

npm

package.json

• chokidar ^3.5.3
• colorette ^2.0.16
• commander ^9.1.0
• cos-nodejs-sdk-v5 ^2.11.6
• esbuild ^0.14.34
• esbuild-register ^3.3.2
• m3u8-parser ^4.7.1
• toml ^3.0.0
• @sxzz/eslint-config-prettier ^2.1.0
• @sxzz/eslint-config-ts ^2.1.0
• @types/node *
• escape-string-regexp ^5.0.0
• eslint ^8.13.0
• eslint-define-config ^1.3.0
• esno ^0.14.1
• fast-glob ^3.2.11
• formdata-node ^4.3.2
• got ^12.0.3
• prettier ^2.6.2
• tsup ^5.12.4
• typescript ^4.6.3

---

• Check this box to trigger a request for Renovate to run again on this repository

Action Required: Fix Renovate Configuration

There is an error with this repository's Renovate configuration that needs to be fixed. As a precaution, Renovate will stop PRs until it is resolved.

Location: .github/renovate.json5
Error type: The renovate configuration file contains some invalid settings
Message: Invalid configuration option: node