1+ ###############################################################################
2+ # ______ #
3+ # / _____) #
4+ # ( (____ ____ _____ ____ ___ _____ ____ _ _ _____ ____ #
5+ # \____ \ | _ \ (____ || _ \ / ___)| ___ | / || ___ | / ___) #
6+ # _____) )| | | |/ ___ || |_| ||___ || ____|| | \ V / || | #
7+ # (______/ |_| |_|\_ ____|| __/ / |_____)|_| \_ /
8+ # |_| #
9+ # #
10+ # Snapserver config file #
11+ # #
12+ ###############################################################################
13+
14+ # default values are commented
15+ # uncomment and edit to change them
16+
17+ # Settings can be overwritten on command line with :
18+ # " --<section>.<name>=<value>" . g. -- server. threads= 4
19+
20+ # General server settings #####################################################
21+ #
22+ [server]
23+ # Number of additional worker threads to use
24+ # - For values < 0 the number of threads will be 2 (on single and dual cores)
25+ # or 4 (for quad and more cores)
26+ # - 0 will utilize just the processes main thread and might cause audio drops
27+ # in case there are a couple of longer running tasks, such as encoding
28+ # multiple audio streams
29+ {{ if .server. threads }}
30+ threads = {{ .server. threads }}
31+ {{ end }}
32+
33+ # the pid file when running as daemon
34+ #pidfile = / var/ / snapserver/
35+
36+ # the user to run as when daemonized
37+ #user = snapserver
38+ # the group to run as when daemonized
39+ #group = snapserver
40+
41+ # directory where persistent data is stored (server. json)
42+ # if empty, data dir will be
43+ # - " /var/lib/snapserver/" as daemon
44+ # - " $HOME /.config/snapserver/" as daemon
45+ {{ if .server. datadir }}
46+ datadir = {{ .server. datadir }}
47+ {{ end }}
48+ #
49+ ###############################################################################
50+
51+
52+ # HTTP RPC ####################################################################
53+ #
54+ [http]
55+ # enable HTTP Json RPC (HTTP POST and websockets)
56+ {{ if .http. enabled }}
57+ enabled = {{ .http. enabled }}
58+ {{ end }}
59+
60+ # address to listen on, can be specified multiple times
61+ # use " 0.0.0.0" IPv4 address or :: to bind to any IPv6 address
62+ # or " 127.0.0.1" " ::1" IPv4 or IPv6 , respectively
63+ # use the address of a specific network interface to just listen to and accept
64+ # connections from that interface
65+ #bind_to_address = 0.0.0.0
66+
67+ # which port the server should listen to
68+ #port = 1780
69+
70+ # serve a website from the doc_root location
71+ # disabled if commented or empty
72+ {{ if .http. doc_root }}
73+ doc_root = {{ .http. doc_root }}
74+ {{ end }}
75+ #
76+ ###############################################################################
77+
78+
79+ # TCP RPC #####################################################################
80+ #
81+ [tcp]
82+ # enable TCP Json RPC
83+ {{ if .tcp. enabled }}
84+ enabled = {{ .tcp. enabled }}
85+ {{ end }}
86+
87+ # address to listen on, can be specified multiple times
88+ # use " 0.0.0.0" IPv4 address or :: to bind to any IPv6 address
89+ # or " 127.0.0.1" " ::1" IPv4 or IPv6 , respectively
90+ # use the address of a specific network interface to just listen to and accept
91+ # connections from that interface
92+ #bind_to_address = 0.0.0.0
93+
94+ # which port the server should listen to
95+ #port = 1705
96+ #
97+ ###############################################################################
98+
99+
100+ # Stream settings #############################################################
101+ #
102+ [stream]
103+ # address to listen on, can be specified multiple times
104+ # use " 0.0.0.0" IPv4 address or :: to bind to any IPv6 address
105+ # or " 127.0.0.1" " ::1" IPv4 or IPv6 , respectively
106+ # use the address of a specific network interface to just listen to and accept
107+ # connections from that interface
108+ #bind_to_address = 0.0.0.0
109+
110+ # which port the server should listen to
111+ #port = 1704
112+
113+ # source URI of the PCM input stream, can be configured multiple times
114+ # The following notation is used in this paragraph :
115+ # < angle brackets> : the whole expression must be replaced with your specific setting
116+ # [square brackets]: the whole expression is optional and can be left out
117+ # [key= value]: if you leave this option out, " value" default for " key"
118+ #
119+ # Format : TYPE :// host/path?name=<name>[&codec=<codec>][&sampleformat=<sampleformat>][&chunk_ms=<chunk ms>]
120+ # parameters have the form " key=value" " &"
121+ # parameter " name" for all sources, while codec, sampleformat and chunk_ms are optional
122+ # and will override the default codec, sampleformat or chunk_ms settings
123+ # Non blocking sources support the dryout_ms parameter : when no new data is read from the source, send silence to the clients
124+ # Available types are :
125+ # pipe : pipe :// /<path/to/pipe>?name=<name>[&mode=create][&dryout_ms=2000], mode can be "create" or "read"
126+ # 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][¶ms=<generic librepsot process arguments>]
127+ # note that you need to have the librespot binary on your machine
128+ # sampleformat will be set to " 44100:16:2"
129+ # file : file :// /<path/to/PCM/file>?name=<name>
130+ # process : process :// /<path/to/process>?name=<name>[&dryout_ms=2000][&wd_timeout=0][&log_stderr=false][¶ms=<process arguments>]
131+ # airplay : airplay :// /<path/to/airplay>?name=<name>[&dryout_ms=2000][&port=5000]
132+ # note that you need to have the airplay binary on your machine
133+ # sampleformat will be set to " 44100:16:2"
134+ # tcp server : tcp :// <listen IP, e.g. 127.0.0.1>:<port>?name=<name>[&mode=server]
135+ # tcp client : tcp :// <server IP, e.g. 127.0.0.1>:<port>?name=<name>&mode=client
136+ # alsa : alsa :// ?name=<name>&device=<alsa device>[&send_silence=false][&idle_threshold=100][&silence_threshold_percent=0.0]
137+ # meta : meta :// /<name of source#1>/<name of source#2>/.../<name of source#N>?name=<name>
138+
139+ {{ range $source := .stream. sources }}
140+ source = {{ $source }}
141+ {{ end }}
142+
143+ # Default sample format
144+ {{ if .stream. sampleformat }}
145+ sampleformat = {{ .stream. sampleformat }}
146+ {{ end }}
147+
148+ # Default transport codec
149+ # (flac|ogg|opus|pcm)[:options]
150+ # Type codec :? to get codec specific options
151+ {{ if .stream. codec }}
152+ codec = {{ .stream. codec }}
153+ {{ end }}
154+
155+ # Default source stream read chunk size [ms]
156+ #chunk_ms = 20
157+
158+ # Buffer [ms]
159+ {{ if .stream. buffer }}
160+ codec = {{ .stream. buffer }}
161+ {{ end }}
162+
163+ # Send audio to muted clients
164+ {{ if .stream. send_to_muted }}
165+ send_to_muted = {{ .stream. send_to_muted }}
166+ {{ end }}
167+
168+
169+ #
170+ ###############################################################################
171+
172+
173+ # Logging options #############################################################
174+ #
175+ [logging]
176+
177+ # log sink [null ,system,stdout,stderr,file :< filename> ]
178+ # when left empty : if running as daemon " system" else " stdout"
179+ #sink =
180+ {{ if .logging. sink }}
181+ sink = {{ .logging. sink }}
182+ {{ end }}
183+
184+ # log filter < tag> :< level> [,< tag> :< level> ]*
185+ # with tag = * or < log tag> and level = [trace,debug,info,notice,warning,error,fatal]
186+ #filter = *: info
187+ {{ if .logging. filter }}
188+ filter = {{ .logging. filter }}
189+ {{ else }}
190+ filter = *: info
191+ {{ end }}
192+ #
193+ ###############################################################################
0 commit comments