Skip to content

handy list of ports used table for readme #4361

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

handy list of ports used table for readme #4361

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -255,6 +255,29 @@ Otherwise, [compile the server from source](#openwrt-1).
ffmpeg -i rtsp://localhost:8554/mystream -c copy output.mp4
```

### List of Ports and URLs

In case you need to configure your firewall rules.

| Port | Protocol | Example URL |
|------|-------------|-----------------------------------|
| 1935 | RTMP | rtmp://localhost:1935/mystream |
| 1937 | RTMPS | rtmps://localhost:1937/mystream |
| 8189*| UDP WebRTC | open port 8189 UDP on firewall |
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You should probably mention 8000/8001 (RTP/RTCP) for the RTSP UDP transport

| 8322 | RTSPS / SSL | rtsps://localhost:8322/mystream |
| 8554 | RTMP / OBS | rtsp://localhost:8554/mystream |
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

8554 is usually RTSP

| 8888 | WebRTC/HLS | http://localhost:8888/mystream |
| 8889 | WHIP | http://localhost:8889/mystream/whip |
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

8889 is WebRTC (WHIP is just the ingress protocol, 8889 supports whep as well, 8888 is HLS (not WebRTC)

| 8890*| UDP SRT | srt://localhost:8890?streamid=read:mystream:user:pass |
| 9996 | Playback | http://localhost:9996/list?path=[mypath]&start=[start]&end=[end] |
| 9997 | Control API | 127.0.0.1:9997/v3/paths/list |
| 9998 | Metrics API | 127.0.0.1:9998/metrics |
| 9999 | PerfProf | 127.0.0.1:9999/debug/pprof/heap |

- Most often ports are TCP, with the exception of UDP ports 8890 and 8189, which can be both
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You should probably add TCP/UDP directly to the table - that's pretty useful information for configuring firewall rules.

- Some ports are not enabled by default such as 9996, see configuration to enable
- By default the API only binds to 127.0.0.1 / localhost for security reasons

## Publish to the server

### By software
Expand Down