example config file for snapserver, git ignore actual config file

Author: romkey

snapserver/.gitignore

@@ -0,0 +1 @@
+config/snapcast.conf

snapserver/config/snapcast.conf.example

@@ -0,0 +1,186 @@
+#######################################################################################
+#     ______                                                                          #
+#    / _____)                                                                         #
+#   ( (____   ____   _____  ____    ___  _____   ____  _   _  _____   ____            #
+#    \____ \ |  _ \ (____ ||  _ \  /___)| ___ | / ___)| | | || ___ | / ___)           #
+#    _____) )| | | |/ ___ || |_| ||___ || ____|| |     \ V / | ____|| |               #
+#   (______/ |_| |_|\_____||  __/ (___/ |_____)|_|      \_/  |_____)|_|               #
+#                          |_|                                                        #
+#                                                                                     #
+#  Snapserver config file                                                             #
+#                                                                                     #
+#  Source: https://github.com/badaix/snapcast/blob/develop/server/etc/snapserver.conf #                                                                          #
+#                                                                                     #
+#######################################################################################
+
+# default values are commented
+# uncomment and edit to change them
+
+# Settings can be overwritten on command line with:
+#  "--<section>.<name>=<value>", e.g. --server.threads=4
+
+
+# General server settings #####################################################
+#
+[server]
+# Number of additional worker threads to use
+# - For values < 0 the number of threads will be 2 (on single and dual cores)
+#   or 4 (for quad and more cores)
+# - 0 will utilize just the processes main thread and might cause audio drops
+#   in case there are a couple of longer running tasks, such as encoding
+#   multiple audio streams
+#threads = -1
+
+# the pid file when running as daemon
+#pidfile = /var/run/snapserver/pid
+
+# the user to run as when daemonized
+#user = snapserver
+# the group to run as when daemonized
+#group = snapserver
+
+# directory where persistent data is stored (server.json)
+# if empty, data dir will be
+#  - "/var/lib/snapserver/" when running as daemon
+#  - "$HOME/.config/snapserver/" when not running as daemon
+datadir = /data/
+
+#
+###############################################################################
+
+
+# HTTP RPC ####################################################################
+#
+[http]
+# enable HTTP Json RPC (HTTP POST and websockets)
+enabled = true
+
+# address to listen on, can be specified multiple times
+# use "0.0.0.0" to bind to any IPv4 address or :: to bind to any IPv6 address
+# or "127.0.0.1" or "::1" to bind to localhost IPv4 or IPv6, respectively
+# use the address of a specific network interface to just listen to and accept
+# connections from that interface
+bind_to_address = 0.0.0.0
+
+# which port the server should listen to
+port = 1780
+
+# serve a website from the doc_root location
+# disabled if commented or empty
+doc_root = /usr/share/snapserver/snapweb
+
+# Hostname or IP under which clients can reach this host
+# used to serve cached cover art
+# use <hostname> as placeholder for your actual host name
+#host = <hostname>
+
+#
+###############################################################################
+
+
+# TCP RPC #####################################################################
+#
+[tcp]
+# enable TCP Json RPC
+enabled = true
+
+# address to listen on, can be specified multiple times
+# use "0.0.0.0" to bind to any IPv4 address or :: to bind to any IPv6 address
+# or "127.0.0.1" or "::1" to bind to localhost IPv4 or IPv6, respectively
+# use the address of a specific network interface to just listen to and accept
+# connections from that interface
+bind_to_address = 0.0.0.0
+
+# which port the server should listen to
+port = 1705
+#
+###############################################################################
+
+
+# Stream settings #############################################################
+#
+[stream]
+# address to listen on, can be specified multiple times
+# use "0.0.0.0" to bind to any IPv4 address or :: to bind to any IPv6 address
+# or "127.0.0.1" or "::1" to bind to localhost IPv4 or IPv6, respectively
+# use the address of a specific network interface to just listen to and accept
+# connections from that interface
+bind_to_address = 0.0.0.0
+
+# which port the server should listen to
+port = 1704
+
+# source URI of the PCM input stream, can be configured multiple times
+# The following notation is used in this paragraph:
+#  <angle brackets>: the whole expression must be replaced with your specific setting
+# [square brackets]: the whole expression is optional and can be left out
+# [key=value]: if you leave this option out, "value" will be the default for "key"
+#
+# Format: TYPE://host/path?name=<name>[&codec=<codec>][&sampleformat=<sampleformat>][&chunk_ms=<chunk ms>][&controlscript=<control script filename>[&controlscriptparams=<control script command line arguments>]]
+#  parameters have the form "key=value", they are concatenated with an "&" character
+#  parameter "name" is mandatory for all sources, while codec, sampleformat and chunk_ms are optional
+#  and will override the default codec, sampleformat or chunk_ms settings
+# Non blocking sources support the dryout_ms parameter: when no new data is read from the source, send silence to the clients
+# Available types are:
+# pipe: pipe:///<path/to/pipe>?name=<name>[&mode=create][&dryout_ms=2000], mode can be "create" or "read"
+# librespot: librespot:///<path/to/librespot>?name=<name>[&dryout_ms=2000][&username=<my username>&password=<my password>][&devicename=Snapcast][&bitrate=320][&wd_timeout=7800][&volume=100][&onevent=""][&nomalize=false][&autoplay=false][&params=<generic librepsot process arguments>]
+#  note that you need to have the librespot binary on your machine
+#  sampleformat will be set to "44100:16:2"
+# file: file:///<path/to/PCM/file>?name=<name>
+# process: process:///<path/to/process>?name=<name>[&dryout_ms=2000][&wd_timeout=0][&log_stderr=false][&params=<process arguments>]
+# airplay: airplay:///<path/to/airplay>?name=<name>[&dryout_ms=2000][&port=5000]
+#  note that you need to have the airplay binary on your machine
+#  sampleformat will be set to "44100:16:2"
+# tcp server: tcp://<listen IP, e.g. 127.0.0.1>:<port>?name=<name>[&mode=server]
+# tcp client: tcp://<server IP, e.g. 127.0.0.1>:<port>?name=<name>&mode=client
+# alsa: alsa:///?name=<name>&device=<alsa device>[&send_silence=false][&idle_threshold=100][&silence_threshold_percent=0.0]
+# meta: meta:///<name of source#1>/<name of source#2>/.../<name of source#N>?name=<name>
+#source = librespot://librespot?name=LibreSpot&bitrate=320&sampleformat=44100:16:2
+# source = airplay:///usr/bin/shairport-sync?name=shairport[&dryout_ms=2000&devicename=Snapcast&port=5000
+#source = pipe:////audio/snapcast_fifo?name=Mopidy
+source = pipe:////audio/snapfifo?name=fifo
+
+# Default sample format: <sample rate>:<bits per sample>:<channels>
+sampleformat = 44100:16:2
+
+# Default transport codec
+# (flac|ogg|opus|pcm)[:options]
+# Start Snapserver with "--stream:codec=<codec>:?" to get codec specific options
+codec = pcm
+
+# Default source stream read chunk size [ms].
+# The server will continously read this number of milliseconds from the source into buffer and pass this buffer to the encoder.
+# The encoded buffer is sent to the clients. Some codecs have a higher latency and will need more data, e.g. Flac will need ~26ms chunks
+#chunk_ms = 20
+
+# Buffer [ms]
+# The end-to-end latency, from capturing a sample on the server until the sample is played-out on the client
+buffer = 3000
+
+# Send audio to muted clients
+send_to_muted = false
+
+# Streaming client options ####################################################
+#
+[streaming_client]
+
+# Volume assigned to new snapclients [percent]
+# Defaults to 100 if unset
+initial_volume = 100
+#
+###############################################################################
+
+
+# Logging options #############################################################
+#
+[logging]
+
+# log sink [null,system,stdout,stderr,file:<filename>]
+# when left empty: if running as daemon "system" else "stdout"
+#sink =
+
+# log filter <tag>:<level>[,<tag>:<level>]*
+# with tag = * or <log tag> and level = [trace,debug,info,notice,warning,error,fatal]
+#filter = *:info
+#
+###############################################################################