mirror of https://github.com/q191201771/lal.git
You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
113 lines
4.4 KiB
Markdown
113 lines
4.4 KiB
Markdown
# LAL
|
|
|
|
[](https://github.com/q191201771/lal)
|
|
[](https://github.com/q191201771/lal/releases)
|
|
[](https://github.com/q191201771/lal/actions/workflows/ci.yml)
|
|
[](https://goreportcard.com/report/github.com/q191201771/lal)
|
|
|
|
|
|
|
|
[中文文档](https://pengrl.com/lal/#/)
|
|
|
|
LAL is an audio/video live streaming broadcast server written in Go. It's sort of like `nginx-rtmp-module`, but easier to use and with more features, e.g RTMP, RTSP(RTP/RTCP), HLS, HTTP[S]/WebSocket[s]-FLV/TS, GB28181, H264/H265/AAC, relay, cluster, record, HTTP API/Notify, GOP cache.
|
|
|
|
## Install
|
|
|
|
There are 3 ways of installing lal:
|
|
|
|
### 1. Building from source
|
|
|
|
First, make sure that Go version >= 1.14
|
|
|
|
For Linux/macOS user:
|
|
|
|
```shell
|
|
$git clone https://github.com/q191201771/lal.git
|
|
$cd lal
|
|
$make build
|
|
```
|
|
|
|
Then all binaries go into the `./bin/` directory. That's it.
|
|
|
|
For an experienced gopher(and Windows user), the only thing you should be concern is that `the main function` is under the `./app/lalserver` directory. So you can also:
|
|
|
|
```shell
|
|
$git clone https://github.com/q191201771/lal.git
|
|
$cd lal/app/lalserver
|
|
$go build
|
|
```
|
|
|
|
Or using whatever IDEs you'd like.
|
|
|
|
So far, the only direct and indirect **dependency** of lal is [naza(A basic Go utility library)](https://github.com/q191201771/lal.git) which is also written by myself. This leads to less dependency or version manager issues.
|
|
|
|
### 2. Prebuilt binaries
|
|
|
|
Prebuilt binaries for Linux, macOS(Darwin), Windows are available in the [lal github releases page](https://github.com/q191201771/lal/releases). Naturally, using [the latest release binary](https://github.com/q191201771/lal/releases/latest) is the recommended way. The naming format is `lal_<version>_<platform>.zip`, e.g. `lal_v0.20.0_linux.zip`
|
|
|
|
LAL could also be built from the source wherever the Go compiler toolchain can run, e.g. for other architectures including arm32 and mipsle which have been tested by the community.
|
|
|
|
### 3. Docker
|
|
|
|
option 1, using prebuilt image at docker hub, so just run:
|
|
|
|
```
|
|
$docker run -it -p 1935:1935 -p 8080:8080 -p 4433:4433 -p 5544:5544 -p 8083:8083 -p 8084:8084 -p 30000-30100:30000-30100/udp q191201771/lal /lal/bin/lalserver -c /lal/conf/lalserver.conf.json
|
|
```
|
|
|
|
option 2, build from local source with Dockerfile, and run:
|
|
|
|
```
|
|
$git clone https://github.com/q191201771/lal.git
|
|
$cd lal
|
|
$docker build -t lal .
|
|
$docker run -it -p 1935:1935 -p 8080:8080 -p 4433:4433 -p 5544:5544 -p 8083:8083 -p 8084:8084 -p 30000-30100:30000-30100/udp lal /lal/bin/lalserver -c /lal/conf/lalserver.conf.json
|
|
```
|
|
|
|
## Using
|
|
|
|
Running lalserver:
|
|
|
|
```
|
|
$./bin/lalserver -c ./conf/lalserver.conf.json
|
|
```
|
|
|
|
Using whatever clients you are familiar with to interact with lalserver.
|
|
|
|
For instance, publish rtmp stream to lalserver via ffmpeg:
|
|
|
|
```shell
|
|
$ffmpeg -re -i demo.flv -c:a copy -c:v copy -f flv rtmp://127.0.0.1:1935/live/test110
|
|
```
|
|
|
|
Play multi protocol stream from lalserver via ffplay:
|
|
|
|
```shell
|
|
$ffplay rtmp://127.0.0.1/live/test110
|
|
$ffplay rtsp://127.0.0.1:5544/live/test110
|
|
$ffplay http://127.0.0.1:8080/live/test110.flv
|
|
$ffplay http://127.0.0.1:8080/hls/test110/playlist.m3u8
|
|
$ffplay http://127.0.0.1:8080/hls/test110/record.m3u8
|
|
$ffplay http://127.0.0.1:8080/hls/test110.m3u8
|
|
$ffplay http://127.0.0.1:8080/live/test110.ts
|
|
```
|
|
|
|
## More than a server, act as package and client
|
|
|
|
Besides a live stream broadcast server which named `lalserver` precisely, `project lal` even provides many other applications, e.g. push/pull/remux stream clients, bench tools, examples. Each subdirectory under the `./app/demo` directory represents a tiny demo.
|
|
|
|
Our goals are not only a production server but also a simple package with a well-defined, user-facing API, so that users can build their own applications on it.
|
|
|
|
`LAL` stands for `Live And Live` if you may wonder.
|
|
|
|
|
|
## Contact
|
|
|
|
Bugs, questions, suggestions, anything related or not, feel free to contact me with [lal github issues](https://github.com/q191201771/lal/issues).
|
|
|
|
## License
|
|
|
|
MIT, see [License](https://github.com/q191201771/lal/blob/master/LICENSE).
|
|
|
|
this note updated by yoko, 202209
|