Ocyss/srs-auth / .agents/skills/internal-docs-for-srs
internal-docs-for-srs
FlaggedRoute SRS and Oryx tasks to the smallest relevant set of trusted project documentation and maintain the project documentation bundled with this skill. Use whenever support or development work requires locating, choosing, reading, creating, updating, or reviewing SRS documentation, or whenever Oryx work requires project documentation for deployment, streaming, authentication, recording to local or S3-compatible storage, restreaming, virtual live, camera, transcoding, HTTPS, APIs, callbacks, AI features, or development. Includes the C++ media server documentation, Oryx project documentation, website pages, changelog, executable API examples, and next-generation Go server and performance documentation.
references/proxy/proxy-origin-cluster.md
View on GitHub# Origin Cluster
How to use the proxy server to build an origin cluster for SRS media server.
## Build
To build the proxy server, you need to have Go 1.18+ installed. Then, you can build the proxy
server by below command, and get the executable binary `bin/srs-proxy`:
```bash
cd ~/git &&
git clone https://github.com/ossrs/srs.git &&
cd proxy && make
```
> Note: You can also download the dependencies by running `go mod download` before building.
We will support the Docker image in the future, or integrate the proxy server into the Oryx
project.
Clone and build SRS, which is the default backend origin server:
```bash
cd ~/git &&
git clone https://github.com/ossrs/srs.git &&
cd srs/trunk && ./configure && make
```
SRS will automatically register itself to the proxy server, see `Automatic Registration` in [proxy-protocol.md](./proxy-protocol.md).
You can use any other RTMP server as the backend origin server, but you need to register the backend server manually, see `Manual Registration API` in [proxy-protocol.md](./proxy-protocol.md).
## Legacy
From SRS 7.0+, the new Origin Cluster is based on proxy server, not the old MESH based SRS servers.
However, if you want to use the old origin cluster, you can switch to SRS 6.0.
## RTMP Origin Cluster
To use the RTMP origin cluster, you need to deploy the proxy server and the origin server.
First, start the proxy server:
```bash
env PROXY_RTMP_SERVER=1935 PROXY_HTTP_SERVER=8080 \
PROXY_HTTP_API=1985 PROXY_WEBRTC_SERVER=8000 PROXY_SRT_SERVER=10080 \
PROXY_SYSTEM_API=12025 PROXY_LOAD_BALANCER_TYPE=memory ./bin/srs-proxy
```
> Note: Here we use the memory load balancer, you can switch to `redis` if you want to run more
> than one proxy server.
Then, deploy three origin servers, which connects to the proxy server via port `12025`:
```bash
./objs/srs -c conf/origin1-for-proxy.conf
./objs/srs -c conf/origin2-for-proxy.conf
./objs/srs -c conf/origin3-for-proxy.conf
```
> Note: The origin servers are independent, so it's recommended to deploy them as Deployments
> in Kubernetes (K8s).
Now, you're able to publish RTMP stream to the proxy server:
```bash
ffmpeg -re -i doc/source.flv -c copy -f flv rtmp://localhost/live/livestream
```
And play the RTMP stream from the proxy server:
```bash
ffplay rtmp://localhost/live/livestream
```
Or play HTTP-FLV stream from the proxy server:
```bash
ffplay http://localhost:8080/live/livestream.flv
```
Or play HLS stream from the proxy server:
```bash
ffplay http://localhost:8080/live/livestream.m3u8
```
Or play the WebRTC stream via [WHEP player](http://localhost:8080/players/whep.html) from proxy server.
You can also use VLC or other players to play the stream in proxy server.
## WebRTC Origin Cluster
To use the WebRTC origin cluster, you need to deploy the proxy server and the origin server.
First, start the proxy server:
```bash
env PROXY_RTMP_SERVER=1935 PROXY_HTTP_SERVER=8080 \
PROXY_HTTP_API=1985 PROXY_WEBRTC_SERVER=8000 PROXY_SRT_SERVER=10080 \
PROXY_SYSTEM_API=12025 PROXY_LOAD_BALANCER_TYPE=memory ./bin/srs-proxy
```
> Note: Here we use the memory load balancer, you can switch to `redis` if you want to run more
> than one proxy server.
Then, deploy three origin servers, which connects to the proxy server via port `12025`:
```bash
./objs/srs -c conf/origin1-for-proxy.conf
./objs/srs -c conf/origin2-for-proxy.conf
./objs/srs -c conf/origin3-for-proxy.conf
```
> Note: The origin servers are independent, so it's recommended to deploy them as Deployments
> in Kubernetes (K8s).
Now, you're able to publish WebRTC stream via [WHIP publisher](http://localhost:8080/players/whip.html) to the proxy server.
And play the WebRTC stream via [WHEP player](http://localhost:8080/players/whep.html) from proxy server.
Or play the RTMP stream from the proxy server:
```bash
ffplay rtmp://localhost/live/livestream
```
Or play HTTP-FLV stream from the proxy server:
```bash
ffplay http://localhost:8080/live/livestream.flv
```
Or play HLS stream from the proxy server:
```bash
ffplay http://localhost:8080/live/livestream.m3u8
```
You can also use VLC or other players to play the stream in proxy server.
## SRT Origin Cluster
To use the SRT origin cluster, you need to deploy the proxy server and the origin server.
First, start the proxy server:
```bash
env PROXY_RTMP_SERVER=1935 PROXY_HTTP_SERVER=8080 \
PROXY_HTTP_API=1985 PROXY_WEBRTC_SERVER=8000 PROXY_SRT_SERVER=10080 \
PROXY_SYSTEM_API=12025 PROXY_LOAD_BALANCER_TYPE=memory ./bin/srs-proxy
```
> Note: Here we use the memory load balancer, you can switch to `redis` if you want to run more
> than one proxy server.
Then, deploy three origin servers, which connects to the proxy server via port `12025`:
```bash
./objs/srs -c conf/origin1-for-proxy.conf
./objs/srs -c conf/origin2-for-proxy.conf
./objs/srs -c conf/origin3-for-proxy.conf
```
> Note: The origin servers are independent, so it's recommended to deploy them as Deployments
> in Kubernetes (K8s).
Now, you're able to publish SRT stream to the proxy server:
```bash
ffmpeg -re -i ./doc/source.flv -c copy -pes_payload_size 0 -f mpegts \
'srt://127.0.0.1:10080?streamid=#!::r=live/livestream,m=publish'
```
And play the SRT stream from the proxy server:
```bash
ffplay 'srt://127.0.0.1:10080?streamid=#!::r=live/livestream,m=request'
```
Or play the RTMP stream from the proxy server:
```bash
ffplay rtmp://localhost/live/livestream
```
Or play HTTP-FLV stream from the proxy server:
```bash
ffplay http://localhost:8080/live/livestream.flv
```
Or play HLS stream from the proxy server:
```bash
ffplay http://localhost:8080/live/livestream.m3u8
```
Or play the WebRTC stream via [WHEP player](http://localhost:8080/players/whep.html) from proxy server.
You can also use VLC or other players to play the stream in proxy server.
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| writing-skillsobra/superpowersUse when creating new skills, editing existing skills, or verifying skills work before deployment | Stars: 322k | Updated | Claude CodeCodex | Verified | Install |
| xlsxanthropics/skillsUse this skill any time a spreadsheet file is the primary input or output. This means any task where the user wants to: open, read, edit, or fix an existing .xlsx, .xlsm, .xltx, .csv, or .tsv file (e.g., adding columns, computing formulas, formatting, charting, cleaning messy data); create a new spreadsheet from scratch or from other data sources; or convert between tabular file formats. Trigger especially when the user references a spreadsheet file by name or path — even casually (like "the xlsx in my downloads") — and wants something done to it or produced from it. Also trigger for cleaning or restructuring messy tabular data files (malformed rows, misplaced headers, junk data) into proper spreadsheets. The deliverable must be a spreadsheet file. Do NOT trigger when the primary deliverable is a Word document, HTML report, standalone Python script, database pipeline, or Google Sheets API integration, even if tabular data is involved. | Stars: 198k | Updated | Claude CodeCodex | Verified | Install |
| shipping-and-launchaddyosmani/agent-skillsPrepares production launches. Use when preparing to deploy to production, or when asking what needs to be in place before shipping. Use when you need a pre-launch checklist, when setting up monitoring, when planning a staged rollout, or when you need a rollback strategy. | Stars: 119k | Updated | Claude CodeCodex | Verified | Install |
| childhoodthedotmack/claude-memBabysit a shipped release after merge, publication, or deployment. Verify published packages, production behavior, installed plugins, and late CI or user reports until the observation window is clean; use babysit for PR readiness before release. | Stars: 118k | Updated | Claude CodeCodex | Verified | Install |