mirror of
https://github.com/ossrs/srs.git
synced 2025-03-09 15:49:59 +00:00
Update README, use docker by default.
This commit is contained in:
winlin
parent
1f6565ec9b
commit
411ae5aff7
1 changed files with 28 additions and 59 deletions
87
README.md
87
README.md
|
|
@ -31,16 +31,18 @@ Please note that while [MulanPSL-2.0 is compatible with Apache-2.0](https://www.
|
|||
some third-party libraries are distributed under their [licenses](https://ossrs.io/lts/en-us/license).
|
||||
|
||||
<a name="product"></a> <a name="usage-docker"></a>
|
||||
|
||||
## Usage
|
||||
|
||||
Please refer to the [Getting Started](https://ossrs.io/lts/en-us/docs/v5/doc/getting-started) or [中文文档：起步](https://ossrs.net/lts/zh-cn/docs/v5/doc/getting-started) guide.
|
||||
Please check the Getting Started guide in [English](https://ossrs.io/lts/en-us/docs/v5/doc/getting-started)
|
||||
or [Chinese](https://ossrs.net/lts/zh-cn/docs/v5/doc/getting-started). We highly recommend using SRS with docker:
|
||||
|
||||
To compile SRS from source:
|
||||
```bash
|
||||
docker run --rm -it -p 1935:1935 -p 1985:1985 -p 8080:8080 \
|
||||
-p 8000:8000/udp -p 10080:10080/udp ossrs/srs:5
|
||||
```
|
||||
|
||||
```
|
||||
git clone -b develop https://gitee.com/ossrs/srs.git &&
|
||||
cd srs/trunk && ./configure && make && ./objs/srs -c conf/srs.conf
|
||||
```
|
||||
> Tips: If you're in China, use this image `registry.cn-hangzhou.aliyuncs.com/ossrs/srs:5` for faster speed.
|
||||
|
||||
Open [http://localhost:8080/](http://localhost:8080/) to verify, and then stream using the following
|
||||
[FFmpeg](https://ffmpeg.org/download.html) command:
|
||||
|
|
@ -61,48 +63,13 @@ Play the following streams using media players:
|
|||
* You can play HTTP-FLV stream URL [http://localhost:8080/live/livestream.flv](http://localhost:8080/players/srs_player.html?autostart=true&stream=livestream.flv) on a webpage using the srs-player, an HTML5-based player.
|
||||
* Use srs-player for playing HLS stream with URL [http://localhost:8080/live/livestream.m3u8](http://localhost:8080/players/srs_player.html?autostart=true&stream=livestream.m3u8).
|
||||
|
||||
Please note that to convert RTMP to WebRTC, you should use the file [rtmp2rtc.conf](https://github.com/ossrs/srs/issues/2728#issuecomment-964686152).
|
||||
If you'd like to use WebRTC, convert RTMP to WebRTC, or convert WebRTC to RTMP, please check out
|
||||
the wiki documentation in either [English](https://ossrs.io/lts/en-us/docs/v5/doc/getting-started#webrtc) or
|
||||
[Chinese](https://ossrs.net/lts/zh-cn/docs/v5/doc/getting-started#webrtc).
|
||||
|
||||
* Use the srs-player to play the WebRTC stream with URL [http://localhost:1985/rtc/v1/whip-play/?app=live&stream=livestream](http://localhost:8080/players/whep.html?autostart=true) via WHEP.
|
||||
|
||||
> Note: In addition to FFmpeg or OBS, it is possible to [publish by H5](http://localhost:8080/players/whip.html) via WHIP as well.
|
||||
> To enable WebRTC to publish and convert it to RTMP, please refer to the wiki([CN](https://ossrs.net/lts/zh-cn/docs/v5/doc/webrtc#rtc-to-rtmp), [EN](https://ossrs.io/lts/en-us/docs/v5/doc/webrtc#rtc-to-rtmp)) documentation.
|
||||
> It is essential to ensure the candidate([CN](https://ossrs.net/lts/zh-cn/docs/v5/doc/webrtc#config-candidate) or [EN](https://ossrs.io/lts/en-us/docs/v5/doc/webrtc#config-candidate))
|
||||
> is set correctly for WebRTC to avoid potential issues, as it can cause significant problems.
|
||||
|
||||
> Note: It is highly recommended to run SRS directly with docker([CN](https://ossrs.net/lts/zh-cn/docs/v5/doc/getting-started) / [EN](https://ossrs.io/lts/en-us/docs/v5/doc/getting-started)),
|
||||
> CVM([CN](https://ossrs.net/lts/zh-cn/docs/v5/doc/getting-started-cloud) / [EN](https://ossrs.io/lts/en-us/docs/v5/doc/getting-started-cloud)),
|
||||
> or K8s([CN](https://ossrs.net/lts/zh-cn/docs/v5/doc/getting-started-k8s) / [EN](https://ossrs.io/lts/en-us/docs/v5/doc/getting-started-k8s)).
|
||||
> However, compiling SRS from source code is also possible and easy. For detailed instructions, please refer to the
|
||||
> "Getting Started"([CN](https://ossrs.net/lts/zh-cn/docs/v5/doc/getting-started) / [EN](https://ossrs.io/lts/en-us/docs/v5/doc/getting-started)) guide.
|
||||
|
||||
> Note: If you require HTTPS for WebRTC and modern browsers, please refer to the HTTPS API([CN](https://ossrs.net/lts/zh-cn/docs/v5/doc/http-api#https-api) / [EN](https://ossrs.io/lts/en-us/docs/v5/doc/http-api#https-api)),
|
||||
> HTTPS Callback([CN](https://ossrs.net/lts/zh-cn/docs/v5/doc/http-callback#https-callback) / [EN](https://ossrs.io/lts/en-us/docs/v5/doc/http-callback#https-callback)),
|
||||
> and HTTPS Live Streaming([CN](https://ossrs.io/lts/en-us/docs/v5/doc/delivery-http-flv#https-flv-live-stream) / [EN](https://ossrs.io/lts/en-us/docs/v5/doc/delivery-http-flv#https-flv-live-stream))
|
||||
> documentation. Additionally, SRS works perfectly with an HTTPS proxy like Nginx.
|
||||
|
||||
<a name="srs-40-wiki"></a> <a name="wiki"></a>
|
||||
Please refer to the following wikis for more information:
|
||||
|
||||
* What are the steps to deliver RTMP streaming? ([CN](https://ossrs.net/lts/zh-cn/docs/v5/doc/sample-rtmp), [EN](https://ossrs.io/lts/en-us/docs/v5/doc/sample-rtmp))
|
||||
* What is the process for delivering WebRTC streaming? ([CN](https://ossrs.net/lts/zh-cn/docs/v5/doc/webrtc), [EN](https://ossrs.io/lts/en-us/docs/v5/doc/webrtc))
|
||||
* What are the steps to convert RTMP to HTTP-FLV streaming? ([CN](https://ossrs.net/lts/zh-cn/docs/v5/doc/sample-http-flv), [EN](https://ossrs.io/lts/en-us/docs/v5/doc/sample-http-flv))
|
||||
* How can RTMP be converted to HLS streaming? ([CN](https://ossrs.net/lts/zh-cn/docs/v5/doc/sample-hls), [EN](https://ossrs.io/lts/en-us/docs/v5/doc/sample-hls))
|
||||
* What is the best approach for delivering low-latency streaming? ([CN](https://ossrs.net/lts/zh-cn/docs/v5/doc/sample-realtime), [EN](https://ossrs.io/lts/en-us/docs/v5/doc/sample-realtime))
|
||||
* How can an RTMP Edge-Cluster be constructed? ([CN](https://ossrs.net/lts/zh-cn/docs/v5/doc/sample-rtmp-cluster), [EN](https://ossrs.io/lts/en-us/docs/v5/doc/sample-rtmp-cluster))
|
||||
* What is the process for building an RTMP Origin-Cluster? ([CN](https://ossrs.net/lts/zh-cn/docs/v5/doc/sample-origin-cluster), [EN](https://ossrs.io/lts/en-us/docs/v5/doc/sample-origin-cluster))
|
||||
* How can an HLS Edge-Cluster be set up?([CN](https://ossrs.net/lts/zh-cn/docs/v5/doc/sample-hls-cluster), [EN](https://ossrs.io/lts/en-us/docs/v5/doc/sample-hls-cluster))
|
||||
|
||||
Here are some other important wikis:
|
||||
|
||||
* Usage: What is the method for delivering DASH (Experimental)? ([CN](https://ossrs.net/lts/zh-cn/docs/v5/doc/sample-dash), [EN](https://ossrs.io/lts/en-us/docs/v5/doc/sample-dash))
|
||||
* Usage: How can an RTMP stream be transcoded using FFMPEG? ([CN](https://ossrs.net/lts/zh-cn/docs/v5/doc/sample-ffmpeg), [EN](https://ossrs.io/lts/en-us/docs/v5/doc/sample-ffmpeg))
|
||||
* Usage: What is the process for setting up an HTTP FLV Live Streaming Cluster? ([CN](https://ossrs.net/lts/zh-cn/docs/v5/doc/sample-http-flvCluster), [EN](https://ossrs.io/lts/en-us/docs/v5/doc/sample-http-flvCluster))
|
||||
* Usage: How can HLS be delivered using an NGINX Cluster? ([CN](https://ossrs.net/lts/zh-cn/docs/v5/doc/sample-hls-cluster), [EN](https://ossrs.io/lts/en-us/docs/v5/doc/sample-hls-cluster))
|
||||
* Usage: What steps are to ingest a file, stream, or device to RTMP? ([CN](https://ossrs.net/lts/zh-cn/docs/v5/doc/sample-ingest), [EN](https://ossrs.io/lts/en-us/docs/v5/doc/sample-ingest))
|
||||
* Usage: How can a stream be forwarded to other servers? ([CN](https://ossrs.net/lts/zh-cn/docs/v5/doc/sample-forward), [EN](https://ossrs.io/lts/en-us/docs/v5/doc/sample-forward))
|
||||
* Usage: What are the strategies for improving edge performance on multiple CPUs? ([CN](https://ossrs.net/lts/zh-cn/docs/v5/doc/reuse-port), [EN](https://ossrs.io/lts/en-us/docs/v5/doc/reuse-port))
|
||||
* Usage: How can bugs be reported or contact be made with us? ([CN](https://ossrs.net/lts/zh-cn/contact), [EN](https://ossrs.io/lts/en-us/contact))
|
||||
To learn more about RTMP, HLS, HTTP-FLV, SRT, MPEG-DASH, WebRTC protocols, clustering,
|
||||
HTTP API, DVR, and transcoding, please check the documents in [English](https://ossrs.io)
|
||||
or [Chinese](https://ossrs.net).
|
||||
|
||||
## Sponsor
|
||||
|
||||
|
|
@ -118,12 +85,16 @@ developers listed below:
|
|||
|
||||
[](https://opencollective.com/srs-server)
|
||||
|
||||
We at SRS aim to establish a non-profit, open-source community that assists developers worldwide in creating
|
||||
your own high-quality streaming and RTC platforms to support your businesses.
|
||||
At SRS, our goal is to create a free, open-source community that helps developers all over the world
|
||||
build high-quality streaming and RTC platforms for their businesses.
|
||||
|
||||
## AUTHORS
|
||||
<a name="authors"></a>
|
||||
|
||||
The [TOC(Technical Oversight Committee)](trunk/AUTHORS.md#toc) and [contributors](trunk/AUTHORS.md#contributors):
|
||||
## Contributing
|
||||
|
||||
The [authors](trunk/AUTHORS.md#authors), [TOC(Technical Oversight Committee)](trunk/AUTHORS.md#toc),
|
||||
and [contributors](trunk/AUTHORS.md#contributors) are listed [here](trunk/AUTHORS.md). The TOC members
|
||||
who made significant contributions and maintained parts of SRS are listed below:
|
||||
|
||||
* [Winlin](https://github.com/winlinvip): Founder of the project, focusing on ST and Issues/PR. Responsible for architecture and maintenance.
|
||||
* [ZhaoWenjie](https://github.com/wenjiegit): One of the earliest contributors, focusing on HDS and Windows. Has expertise in client technology.
|
||||
|
|
@ -136,16 +107,14 @@ The [TOC(Technical Oversight Committee)](trunk/AUTHORS.md#toc) and [contributors
|
|||
* [ChenHaibo](https://github.com/duiniuluantanqin): Specializes in GB28181 and HTTP API, contributing to patches for FFmpeg with WHIP.
|
||||
* [ZhangJunqin](https://github.com/chundonglinlin): Focused on H.265, Prometheus Exporter, and API module.
|
||||
|
||||
A big `THANK YOU` also goes to:
|
||||
A huge `THANK YOU` goes out to:
|
||||
|
||||
* All [contributors](trunk/AUTHORS.md#contributors) of SRS.
|
||||
* All friends of SRS for [big supports](https://ossrs.net/lts/zh-cn/product).
|
||||
* [Genes](http://sourceforge.net/users/genes), [Mabbott](http://sourceforge.net/users/mabbott) and [Michael Talyanksy](https://github.com/michaeltalyansky) for creating and introducing [st](https://github.com/ossrs/state-threads/tree/srs).
|
||||
* All the [contributors](trunk/AUTHORS.md#contributors) of SRS.
|
||||
* All the friends of SRS who gave [big support](https://ossrs.net/lts/zh-cn/product).
|
||||
* [Genes](http://sourceforge.net/users/genes), [Mabbott](http://sourceforge.net/users/mabbott), and [Michael Talyanksy](https://github.com/michaeltalyansky) for making and sharing [State Threads](https://github.com/ossrs/state-threads/tree/srs).
|
||||
|
||||
## Contributing
|
||||
|
||||
We extend our heartfelt gratitude to the community for their contributions in identifying bugs and enhancing the project.
|
||||
To stay connected with us and keep contributing to our community, please follow the [guide](https://github.com/ossrs/srs/contribute).
|
||||
We're really thankful to everyone in the community for helping us find bugs and improve the project.
|
||||
To stay in touch and keep helping our community, please check out this [guide](https://github.com/ossrs/srs/contribute).
|
||||
|
||||
## LICENSE
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue