Skip to content

Commit

Permalink
Update README. v5.11.12
Browse files Browse the repository at this point in the history
  • Loading branch information
winlinvip committed Nov 4, 2023
1 parent ad0b48f commit 700b893
Showing 1 changed file with 9 additions and 4 deletions.
13 changes: 9 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,19 +18,24 @@ virtual live events, automatic HTTPS, and an easy-to-use HTTP Open API.
## Usage

Run srs-stack in one docker:
Run srs-stack in one docker, then open http://localhost:2022 in browser:

```bash
docker run --rm -it --name srs-stack -v $HOME/data:/data \
-p 2022:2022 -p 2443:2443 -p 1935:1935 -p 8000:8000/udp -p 10080:10080/udp \
ossrs/srs-stack:5
```

> Note: Please use `-e REACT_APP_LOCALE=zh` and `registry.cn-hangzhou.aliyuncs.com/ossrs/srs-stack:5` in China.
> Important: Remember to mount the `/data` volume to avoid losing data when the container restarts. For instance,
> if you mount `/data` to `$HOME/data`, all data will be stored in the `$HOME/data` folder. Be sure to modify this
> according to your desired directory.
> Note: All data will be saved in `$HOME/data` directory, please change it to your directory.
> Important: To use WebRTC WHIP in a browser, avoid using localhost or 127.0.0.1. Instead, use a private IP (e.g., https://192.168.3.85:2443),
> a public IP (e.g., https://136.12.117.13:2443), or a domain (e.g., https://your-domain.com:2443). To set up HTTPS,
> refer to [this post](https://blog.ossrs.io/how-to-secure-srs-with-lets-encrypt-by-1-click-cb618777639f).
Then open http://localhost:2022 in browser.
> Note: In China, use `registry.cn-hangzhou.aliyuncs.com/ossrs/srs-stack:5` to accelerate the Docker pull process
> and ensure the proper language is set.
The ports used for SRS Stack:

Expand Down

0 comments on commit 700b893

Please sign in to comment.