1
0
Fork 0
mirror of https://github.com/ossrs/srs.git synced 2025-02-13 11:51:57 +00:00

Add comments for RTC candidate.

This commit is contained in:
winlin 2020-03-31 17:26:32 +08:00
parent 03289012fd
commit ecf0f012b5
2 changed files with 10 additions and 7 deletions

View file

@ -316,11 +316,15 @@ rtc_server {
# The udp listen port, we will reuse it for connections.
# default: 8080
listen 8000;
# The exposed candidate IP, response in SDP candidate line.
# It can be:
# * Retrieve server IP automatically, specified by stats.network for multiple networks.
# $CANDIDATE Read the IP from ENV variable $EIP, see https://github.com/ossrs/srs/issues/307#issuecomment-599028124
# The exposed candidate IPs, response in SDP candidate line. It can be:
# * Retrieve server IP automatically, from all network interfaces.
# eth0 Retrieve server IP by specified network interface name. # TODO: Implements it.
# $CANDIDATE Read the IP from ENV variable $EIP, use * if not set, see https://github.com/ossrs/srs/issues/307#issuecomment-599028124
# x.x.x.x A specified IP address or DNS name, which can be access by client such as Chrome.
# You can specific more than one interface name:
# eth0 eth1 Use network interface eth0 and eth1. # TODO: Implements it.
# Also by IP or DNS names:
# 192.168.1.3 10.1.2.3 rtc.me # TODO: Implements it.
# default: *
candidate *;
}

View file

@ -23,10 +23,9 @@ rtc_server {
# Listen at udp://8000
listen 8000;
#
# The $CANDIDATE means fetch from env, if not configed, use default * as bellow.
# The $CANDIDATE means fetch from env, if not configed, use * as default.
#
# The * means using IP of network interface stats.network,
# For example, if stats.network=0, then use IP of eth0 as candidate.
# The * means retrieving server IP automatically, from all network interfaces,
# @see https://github.com/ossrs/srs/issues/307#issuecomment-599028124
candidate $CANDIDATE;
}