8000 Merge branch 'master' into fix_default_config · invisiblecoder99/livego@256f2e0 · GitHub
[go: up one dir, main page]
Skip to content

Commit 256f2e0

Browse files
GNURubGNURub
committed
Merge branch 'master' into fix_default_config
2 parents 22714df + 2b9df25 commit 256f2e0

File tree

3 files changed

+80
-9
lines changed

3 files changed

+80
-9
lines changed

‎.github/workflows/release.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: release
1+
name: Release
22
on:
33
release:
44
types: [published]

‎README.md

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,10 @@
22
<img src='./logo.png' width='200px' height='80px'/>
33
</p>
44

5+
[中文](./README_cn.md)
6+
57
[![Test](https://github.com/gwuhaolin/livego/workflows/Test/badge.svg)](https://github.com/gwuhaolin/livego/actions?query=workflow%3ATest)
8+
[![Release](https://github.com/gwuhaolin/livego/workflows/Release/badge.svg)](https://github.com/gwuhaolin/livego/actions?query=workflow%3ARelease)
69

710
Simple and efficient live broadcast server:
811
- Very simple to install and use;
@@ -28,13 +31,22 @@ Simple and efficient live broadcast server:
2831
After directly downloading the compiled [binary file](https://github.com/gwuhaolin/livego/releases), execute it on the command line.
2932

3033
#### Boot from Docker
31-
Run `docker run -p 1935:1935 -p 7001:7001 -p 7002:7002 -d --name livego gwuhaolin/livego` to start
34+
Run `docker run -p 1935:1935 -p 7001:7001 -p 7002:7002 -p 8090:8090 -d gwuhaolin/livego` to start
3235

3336
#### Compile from source
3437
1. Download the source code `git clone https://github.com/gwuhaolin/livego.git`
3538
2. Go to the livego directory and execute `go build` or `make build`
3639

3740
## Use
41+
1. Start the service: execute the livego binary file or `make run` to start the livego service;
42+
2. Get a channelkey from `http://localhost:8090/control/get?room=movie` and copy data like your channelkey.
43+
3. Upstream push: Push the video stream to `rtmp://localhost:1935/{appname}/{channelkey}` through the` RTMP` protocol(default appname is `live`), for example, use `ffmpeg -re -i demo.flv -c copy -f flv rtmp://localhost:1935/{appname}/{channelkey}` push;
44+
4. Downstream playback: The following three playback protocols are supported, and the playback address is as follows:
45+
- `RTMP`:`rtmp://localhost:1935/{appname}/{channelkey}`
46+
- `FLV`:`http://127.0.0.1:7001/{appname}/{channelkey}.flv`
47+
- `HLS`:`http://127.0.0.1:7002/{appname}/{channelkey}.m3u8`
48+
49+
all options:
3850
```bash
3951
./livego -h
4052
Usage of ./livego:
@@ -49,13 +61,6 @@ Usage of ./livego:
4961
--rtmp_addr string RTMP server listen address (default ":1935")
5062
--write_timeout int write time out (default 10)
5163
```
52-
2. Start the service: execute the livego binary file or `make run` to start the livego service;
53-
3. Get a channelkey `curl http://localhost:8090/control/get?room=movie` and copy data like your channelkey.
54-
4. Upstream push: Push the video stream to `rtmp://localhost:1935/live/movie`(`rtmp://localhost:1935/{appname}/{channelkey}`) through the` RTMP` protocol, for example, use `ffmpeg -re -i demo.flv -c copy -f flv rtmp://localhost:1935/live/movie` push;
55-
5. Downstream playback: The following three playback protocols are supported, and the playback address is as follows:
56-
-`RTMP`:`rtmp://localhost:1935/live/movie`
57-
-`FLV`:`http://127.0.0.1:7001/live/movie.flv`
58-
-`HLS`:`http://127.0.0.1:7002/live/movie.m3u8`
5964

6065
### [Use with flv.js](https://github.com/gwuhaolin/blog/issues/3)
6166

‎README_cn.md

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
<p align='center'>
2+
<img src='./logo.png' width='200px' height='80px'/>
3+
</p>
4+
5+
[![Test](https://github.com/gwuhaolin/livego/workflows/Test/badge.svg)](https://github.com/gwuhaolin/livego/actions?query=workflow%3ATest)
6+
[![Release](https://github.com/gwuhaolin/livego/workflows/Release/badge.svg)](https://github.com/gwuhaolin/livego/actions?query=workflow%3ARelease)
7+
8+
简单高效的直播服务器：
9+
- 安装和使用非常简单；
10+
- 纯 Golang 编写，性能高，跨平台；
11+
- 支持常用的传输协议、文件格式、编码格式；
12+
13+
#### 支持的传输协议
14+
- RTMP
15+
- AMF
16+
- HLS
17+
- HTTP-FLV
18+
19+
#### 支持的容器格式
20+
- FLV
21+
- TS
22+
23+
#### 支持的编码格式
24+
- H264
25+
- AAC
26+
- MP3
27+
28+
## 安装
29+
直接下载编译好的[二进制文件](https://github.com/gwuhaolin/livego/releases)后，在命令行中执行。
30+
31+
#### 从 Docker 启动
32+
执行`docker run -p 1935:1935 -p 7001:7001 -p 7002:7002 -p 8090:8090 -d gwuhaolin/livego`启动
33+
34+
#### 从源码编译
35+
1. 下载源码 `git clone https://github.com/gwuhaolin/livego.git`
36+
2. 去 livego 目录中 执行 `go build`
37+
38+
## 使用
39+
1. 启动服务：执行 `livego` 二进制文件启动 livego 服务；
40+
2. 访问 `http://localhost:8090/control/get?room=movie` 获取一个房间的 channelkey.
41+
3. 推流: 通过`RTMP`协议推送视频流到地址 `rtmp://localhost:1935/{appname}/{channelkey}` (appname默认是`live`), 例如： 使用 `ffmpeg -re -i demo.flv -c copy -f flv rtmp://localhost:1935/{appname}/{channelkey}< 628C span class="pl-s">` 推流;
42+
4. 播放: 支持多种播放协议，播放地址如下:
43+
- `RTMP`:`rtmp://localhost:1935/{appname}/{channelkey}`
44+
- `FLV`:`http://127.0.0.1:7001/{appname}/{channelkey}.flv`
45+
- `HLS`:`http://127.0.0.1:7002/{appname}/{channelkey}.m3u8`
46+
47+
所有配置项:
48+
```bash
49+
./livego -h
50+
Usage of ./livego:
51+
--api_addr string HTTP管理访问监听地址 (default ":8090")
52+
--config_file string 配置文件路径 (默认 "livego.yaml")
53+
--flv_dir string 输出的 flv 文件路径 flvDir/APP/KEY_TIME.flv (默认 "tmp")
54+
--gop_num int gop 数量 (default 1)
55+
--hls_addr string HLS 服务监听地址 (默认 ":7002")
56+
--httpflv_addr string HTTP-FLV server listen address (默认 ":7001")
57+
--level string 日志等级 (默认 "info")
58+
--read_timeout int 读超时时间 (默认 10)
59+
--rtmp_addr string RTMP 服务监听地址 (默认 ":1935")
60+
--write_timeout int 写超时时间 (默认 10)
61+
```
62+
63+
### [和 flv.js 搭配使用](https://github.com/gwuhaolin/blog/issues/3)
64+
65+
对Golang感兴趣？请看[Golang 中文学习资料汇总](http://go.wuhaolin.cn/)
66+

0 commit comments

Comments
 (0)
0