From c0a7790c91bf5fb3e862223fce7d7087337eb49b Mon Sep 17 00:00:00 2001 From: winlin Date: Tue, 4 Jan 2022 11:18:52 +0800 Subject: [PATCH] Update README --- README.md | 11 ++++++++++- trunk/doc/Resources.md | 9 +++++++++ 2 files changed, 19 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a3f4cbe00..b84842667 100755 --- a/README.md +++ b/README.md @@ -31,7 +31,13 @@ SRS is licenced under [MIT][LICENSE], but some depended libraries are distribute ## Usage -Build SRS from source or **docker([CN](https://github.com/ossrs/srs/wiki/v4_CN_Home#docker) / [EN](https://github.com/ossrs/srs/wiki/v4_EN_Home#docker))**, please read **Wiki: Gettting Started([CN](https://github.com/ossrs/srs/wiki/v4_CN_Home#getting-started) / [EN](https://github.com/ossrs/srs/wiki/v4_EN_Home#getting-started))**: +> Highly recommend that directly run SRS by +> **docker([CN](https://github.com/ossrs/srs/wiki/v4_CN_Home#docker) / [EN](https://github.com/ossrs/srs/wiki/v4_EN_Home#docker))**, +> or **K8s([CN](https://github.com/ossrs/srs/wiki/v4_CN_Home#k8s) / [EN](https://github.com/ossrs/srs/wiki/v4_EN_Home#k8s))**, +> however it's also easy to build SRS from source code, for detail please see +> **Getting Started([CN](https://github.com/ossrs/srs/wiki/v4_CN_Home#getting-started) / [EN](https://github.com/ossrs/srs/wiki/v4_EN_Home#getting-started))**. + +Build SRS from source: ``` git clone -b 4.0release https://gitee.com/ossrs/srs.git && @@ -52,6 +58,9 @@ Play the following streams by [players](https://ossrs.net): * RTMP (by [VLC](https://www.videolan.org/)): rtmp://localhost/live/livestream * H5(HTTP-FLV): [http://localhost:8080/live/livestream.flv](http://localhost:8080/players/srs_player.html?autostart=true&stream=livestream.flv&port=8080&schema=http) * H5(HLS): [http://localhost:8080/live/livestream.m3u8](http://localhost:8080/players/srs_player.html?autostart=true&stream=livestream.m3u8&port=8080&schema=http) + +Note that if convert RTMP to WebRTC, please use [`rtmp2rtc.conf`](https://github.com/ossrs/srs/issues/2728#issuecomment-964686152): + * H5(WebRTC): [webrtc://localhost/live/livestream](http://localhost:8080/players/rtc_player.html?autostart=true) diff --git a/trunk/doc/Resources.md b/trunk/doc/Resources.md index 0c90b6748..e90922f4d 100644 --- a/trunk/doc/Resources.md +++ b/trunk/doc/Resources.md @@ -45,6 +45,15 @@ Other API used by [ossrs.net](https://ossrs.net): * `/im-service/v1/` The latest available version API, by IM. * `/code-service/v1/` The latest available version API, by Code verification. +The statistic path for [ossrs.net](https://ossrs.net): + +* `/srs/xxx` The GitHub pages for [srs](https://github.com/ossrs/srs) +* `/wiki/xxx` The GitHub wiki for [srs](https://github.com/ossrs/srs/wiki) +* `/release/xxx` The pages for [ossrs.net](https://ossrs.net) +* `/console/xxx` The pages for [console](http://ossrs.net/console/) +* `/player/xxx` The pages for [players and publishers](http://ossrs.net/players/) +* `/k8s/xxx` The template and repository deploy by K8s, like [srs-k8s-template](https://github.com/ossrs/srs-k8s-template) + ## Mirrors Gitee: [https://gitee.com/ossrs/srs][gitee], the GIT usage([CN][v4_CN_Git], [EN][v4_EN_Git])