Chapter 6. Configuration

Table of Contents

Common configuration elements
Network elements

There are some general considerations about the configuration of FreeCast applications. Each application is configurable via XML files. These XML files follow the same logic.

The configuration file only needs to complete and overwrite the default configuration of the application.

Common configuration elements

Network elements

Host

Host elements used into the FreeCast configuration designate an IP address over a IP network (like your local network or Internet). Hosts can be specified via either host names or IP addresses. As usually, host names will be resolved by FreeCast applications.

Example 6.1. Host configurations

<host>82.68.47.19</host>
<host>stream.acme-radio.org</host>

This information can be used by FreeCast applications in another context than your local network. Don't use local host names or local IP addresses in a configuration file which must be used over Internet.

Port

Port elements designate a TCP port or a port selection:

  • A single port is designated by a number.

  • A port range is defined by a lower and an higher port separated by a -.

  • A random port range is defined by a lower and an higher port separated by a ~.

  • A port selection can contain one or more ports or port ranges separated by a ,.

Example 6.2. Port configurations

<port>1665</port>
<port>1664,1666-1680</port> <!-- port 1664 or from 1666 to 1670 -->
<port>30000~30100</port> <!-- port from 30000 to 30100 choosed randomly -->

Listen TCP address

<listenaddress>
  <host>0.0.0.0</host>
  <port>1665</port>
</listenaddress>
host

the listen IP address. The default is 0.0.0.0, connections will be listened over all network interfaces. By choosing a specific address, you can limit the reachability. For instance, You can use localhost to limit the reachability to your computer. Don't modify this default parameter unless you have a specific need.

port

the TCP port used to listen and receive requests from other FreeCast applications. By using a port selection, you can avoid problems with ports already used by other applications. In this case, the first free port will be used.

The choice of a listen address must be compatible with your network configuration. Listening connections on a computer behind a router or a firewall can require a manual configuration step about the related software or hardware.

Target TCP address

<listenaddress>
  <host>freecast.acme-radio.org</host>
  <port>1665</port>
</listenaddress>
host

by default, the target host is localhost.

port

you must specify the port where the requests are listened to by the remote host. You can't use a port selection.