Skip to content

Commit ba18c6a

Browse files
author
吴浩麟
committed
docs: 补充中文文档
1 parent 480ac49 commit ba18c6a

File tree

2 files changed

+78
-7
lines changed

2 files changed

+78
-7
lines changed

Diff for: ‎README.md

+11-7
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44

55
[![Test](https://github.com/gwuhaolin/livego/workflows/Test/badge.svg)](https://github.com/gwuhaolin/livego/actions?query=workflow%3ATest)
66

7+
[中文](./README_cn.md)
8+
79
Simple and efficient live broadcast server:
810
- Very simple to install and use;
911
- Pure Golang, high performance, cross-platform;
@@ -35,6 +37,15 @@ Run `docker run -p 1935:1935 -p 7001:7001 -p 7002:7002 -d --name livego gwuhaoli
3537
2. Go to the livego directory and execute `go build` or `make build`
3638

3739
## Use
40+
1. Start the service: execute the livego binary file or `make run` to start the livego service;
41+
2. Get a channelkey `curl http://localhost:8090/control/get?room=movie` and copy data like your channelkey.
42+
3. Upstream push: Push the video stream to `rtmp://localhost:1935/{appname}/{channelkey}` through the` RTMP` protocol, for example, use `ffmpeg -re -i demo.flv -c copy -f flv rtmp://localhost:1935/{appname}/{channelkey}` push;
43+
4. Downstream playback: The following three playback protocols are supported, and the playback address is as follows:
44+
-`RTMP`:`rtmp://localhost:1935/{appname}/{channelkey}`
45+
-`FLV`:`http://127.0.0.1:7001/{appname}/{channelkey}.flv`
46+
-`HLS`:`http://127.0.0.1:7002/{appname}/{channelkey}.m3u8`
47+
48+
all options:
3849
```bash
3950
./livego -h
4051
Usage of ./livego:
@@ -49,13 +60,6 @@ Usage of ./livego:
4960
--rtmp_addr string RTMP server listen address (default ":1935")
5061
--write_timeout int write time out (default 10)
5162
```
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`
5963

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

Diff for: ‎README_cn.md

+67
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
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+
7+
简单高效的直播服务器：
8+
- 安装和使用非常简单；
9+
- 纯 Golang 编写，性能高，跨平台；
10+
- 支持常用的传输协议、文件格式、编码格式；
11+
12+
#### 支持的传输协议
13+
- RTMP
14+
- AMF
15+
- HLS
16+
- HTTP-FLV
17+
18+
#### 支持的容器格式
19+
- FLV
20+
- TS
21+
22+
#### 支持的编码格式
23+
- H264
24+
- AAC
25+
- MP3
26+
27+
## 安装
28+
直接下载编译好的[二进制文件](https://github.com/gwuhaolin/livego/releases)后，在命令行中执行。
29+
## Installation
30+
After directly downloading the compiled [binary file] (https://github.com/gwuhaolin/livego/releases), execute it on the command line.
31+
32+
#### 从 Docker 启动
33+
执行`docker run -p 1935:1935 -p 7001:7001 -p 7002:7002 -d --name livego gwuhaolin/livego`启动
34+
35+
#### 从源码编译
36+
1. 下载源码 `git clone https://github.com/gwuhaolin/livego.git`
37+
2. 去 livego 目录中 执行 `go build`
38+
39+
## 使用
40+
1. 启动服务：执行 `livego` 二进制文件启动 livego 服务；
41+
2. 访问 `http://localhost:8090/control/get?room=movie` 获取一个房间的key.
42+
3. 推流: 通过`RTMP`协议推送视频流到地址 `rtmp://localhost:1935/{appname}/{channelkey}`, 例如： 使用 `ffmpeg -re -i demo.flv -c copy -f flv rtmp://localhost:1935/{appname}/{channelkey}` 推流;
43+
4. 播放: 支持多种播放协议，播放地址如下:
44+
-`RTMP`:`rtmp://localhost:1935/{appname}/{channelkey}`
45+
-`FLV`:`http://127.0.0.1:7001/{appname}/{channelkey}.flv`
46+
-`HLS`:`http://127.0.0.1:7002/{appname}/{channelkey}.m3u8`
47+
48+
所有配置项:
49+
```bash
50+
./livego -h
51+
Usage of ./livego:
52+
--api_addr string HTTP manage interface server listen address (default ":8090")
53+
--config_file string configure filename (default "livego.yaml")
54+
--flv_dir string output flv file at flvDir/APP/KEY_TIME.flv (default "tmp")
55+
--gop_num int gop num (default 1)
56+
--hls_addr string HLS server listen address (default ":7002")
57+
--httpflv_addr string HTTP-FLV server listen address (default ":7001")
58+
--level string Log level (default "info")
59+
--read_timeout int read time out (default 10)
60+
--rtmp_addr string RTMP server listen address (default ":1935")
61+
--write_timeout int write time out (default 10)
62+
```
63+
64+
### [和 flv.js 搭配使用](https://github.com/gwuhaolin/blog/issues/3)
65+
66+
对Golang感兴趣？请看[Golang 中文学习资料汇总](http://go.wuhaolin.cn/)
67+

0 commit comments

Comments
 (0)