1
0
mirror of https://gitlab.xiph.org/xiph/ezstream.git synced 2024-12-04 14:46:31 -05:00
ezstream/examples/ezstream-full.xml

211 lines
5.9 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<!--
EXAMPLE: A valid configuration that contains every configuration option
NB: /ezstream/metadata/program is commented out so that this configuration
can work without scripting.
-->
<!-- Ezstream configuration root element -->
<ezstream>
<!--
Server configuration
-->
<servers>
<server>
<!-- Identifying name (default: "default") -->
<name>Test Server</name>
<!-- Transport protocol: HTTP, HTTPS (default: "HTTP") -->
<protocol>HTTP</protocol>
<!-- Server address -->
<hostname>127.0.0.1</hostname>
<!-- Server port (default: 8000) -->
<port>8000</port>
<!-- Login user (default: "source") -->
<user>source</user>
<!-- Login password (check file permissions, or everyone can see this) -->
<password>hackme</password>
<!--
Configure TLS requirement: none, may, required (default: "may")
For compatibility reasons, the default configuration and this example
is "may". THIS IS INSECURE. It allows a MitM to intercept the
password and tamper with the stream. It is recommended to set this to
"required" when configuring TLS to secure streaming over untrusted
networks.
-->
<tls>May</tls>
<!--
Configure allowed cipher suites for TLS other than the libshout default.
See openssl(1)/ciphers(1) for details.
-->
<tls_cipher_suite>HIGH:!kRSA:!kECDH:!DH:!PKS:!aNULL:!eNULL:!3DES:!MD5:!SHA:!TLSv1</tls_cipher_suite>
<!--
Directory to use for server certificate verification in "hash format".
See openssl(1)/verify(1) for details.
-->
<ca_dir>/etc/ssl/certs</ca_dir>
<!--
CA bundle for both server certificate verification and building the
client certificate chain.
-->
<ca_file>/etc/ssl/certs/ca-certificates.crt</ca_file>
<!--
X.503 client certificate, in PEM format, containing both certificate
(with public key) and private key in the same file, for authentication.
-->
<client_cert>/etc/ssl/ezstream.crt</client_cert>
<!-- Number of reconnection attempts, before giving up (default: 0) -->
<reconnect_attempts>20</reconnect_attempts>
</server>
</servers>
<!--
Stream configuration
-->
<streams>
<stream>
<!--
Identifying name (default: "default")
NB: Only the "default" stream is supported at this point.
-->
<!-- <name>default</name> -->
<!-- Mount point on server -->
<mountpoint>/stream.ogg</mountpoint>
<!-- Name of the intake entry to use (default: "default") -->
<intake>Test Input</intake>
<!-- Name of the server entry to use (default: "default") -->
<server>Test Server</server>
<!--
Setting to allow stream to be listed in public YP directory
(default: no)
-->
<public>No</public>
<!-- Stream format: Vorbis, MP3, Theora -->
<format>Vorbis</format>
<!-- Encoder name (defined below) to use for (re)encoding -->
<encoder>OggEnc-Q1.5</encoder>
<!-- Various other informational settings -->
<stream_name>Test Stream</stream_name>
<stream_url>http://localhost:8000/</stream_url>
<stream_genre>Beeps</stream_genre>
<stream_description>Test tones and noise</stream_description>
<stream_quality>1.5</stream_quality>
<stream_bitrate>16</stream_bitrate>
<stream_samplerate>44100</stream_samplerate>
<stream_channels>2</stream_channels>
</stream>
</streams>
<!--
Intake configuration
-->
<intakes>
<intake>
<!-- Identifying name (default: "default") -->
<name>Test Input</name>
<!--
Media type: autodetect, file, playlist, program, stdin
(default: autodetect)
-->
<type>playlist</type>
<!-- Input file, program name, or "stdin" keyword (deprecated) -->
<filename>playlist.m3u</filename>
<!-- Setting to shuffle playlists -->
<shuffle>Yes</shuffle>
<!-- Setting whether to stream intake indefinitely or only once -->
<stream_once>Yes</stream_once>
</intake>
</intakes>
<!--
Metadata configuration
-->
<metadata>
<!-- Program to query for metadata instead of from media files -->
<!-- <program>meta.sh</program> -->
<!-- Metadata format -->
<format_str>@a@ - @t@</format_str>
<!-- Interval for additional metadata refreshes (default: -1 (none)) -->
<refresh_interval>-1</refresh_interval>
<!-- Setting to clean up extraneous whitespace (default: no) -->
<normalize_strings>Yes</normalize_strings>
<!-- Setting to suppress all metadata udpates (default: no) -->
<no_updates>Yes</no_updates>
</metadata>
<!--
Decoder configurations
-->
<decoders>
<decoder>
<!-- Decoder name -->
<name>OggDec</name>
<!-- Program and options -->
<program>oggdec -R -b 16 -e 1 -s 1 -o - @T@</program>
<!-- File extensions to use this decoder for -->
<file_ext>.ogg</file_ext>
<file_ext>.oga</file_ext>
</decoder>
<decoder>
<name>MadPlay</name>
<program>madplay -b 16 -R 44100 -S -o raw:- @T@</program>
<file_ext>.mp3</file_ext>
</decoder>
<decoder>
<name>Flac</name>
<program>flac -s -d --force-raw-format --sign=signed --endian=little -o - @T@</program>
<file_ext>.flac</file_ext>
</decoder>
</decoders>
<!--
Encoder configurations
-->
<encoders>
<encoder>
<!-- Encoder name -->
<name>OggEnc-Q1.5</name>
<!-- Output stream format -->
<format>Vorbis</format>
<!-- Program and options -->
<program>oggenc -r -B 16 -C 2 -R 44100 --raw-endianness 1 -q 1.5 -t @M@ -</program>
</encoder>
<encoder>
<name>Lame-CBR128</name>
<format>MP3</format>
<program>lame --preset cbr 128 -r -s 44.1 --bitwidth 16 - -</program>
</encoder>
</encoders>
</ezstream>