-
Notifications
You must be signed in to change notification settings - Fork 135
Expand file tree
/
Copy pathslskd.example.yml
More file actions
333 lines (333 loc) · 9.1 KB
/
slskd.example.yml
File metadata and controls
333 lines (333 loc) · 9.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
# debug: false
# headless: false
# remote_configuration: false
# remote_file_management: false
# instance_name: default
# flags:
# no_logo: false
# no_start: false
# no_config_watch: false
# no_connect: false
# no_share_scan: false
# force_share_scan: false
# force_migrations: false
# no_version_check: false
# log_sql: false
# log_unobserved_exceptions: false
# experimental: false
# volatile: false
# case_sensitive_reg_ex: false
# legacy_windows_tcp_keepalive: false
# optimistic_relay_file_info: false
# relay:
# enabled: false
# mode: controller # controller (default), agent, or debug (for local development)
# # controller config is required when running in 'agent' mode
# # this specifies the relay controller that will be controlling this agent
# controller:
# address: https://some.site.com:5000
# ignore_certificate_errors: false
# api_key: <a 16-255 character string corresponding to one of the controller's 'readwrite' or 'administrator' API keys>
# secret: <a 16-255 character shared secret matching the controller's config for this agent>
# downloads: false
# # agent config is optional when running in 'controller' mode
# # this specifies all of the agents capable of connecting
# agents:
# my_agent:
# instance_name: my_agent # make sure the top-level instance_name of the agent matches!
# secret: <a 16-255 character string unique to this agent>
# cidr: 0.0.0.0/0,::/0
# permissions:
# file:
# mode: ~ # not for Windows, chmod syntax, e.g. 644, 777. can't escalate beyond umask
# directories:
# incomplete: ~
# downloads: ~
# shares:
# directories:
# - ~
# filters:
# - \.ini$
# - Thumbs.db$
# - \.DS_Store$
# cache:
# storage_mode: memory
# workers: 16
# retention: ~ # retain indefinitely (do not automatically re-scan)
# transfers:
# upload:
# slots: 20
# speed_limit: 1000 # in kibibytes
# limits:
# queued:
# files: 500
# megabytes: 5000
# daily:
# files: 1000
# megabytes: 10000
# failures: 200
# weekly:
# files: 5000
# megabytes: 50000
# failures: 1000
# download:
# slots: 500
# speed_limit: 1000
# retry:
# incomplete: resume # 'overwrite' or 'resume'
# attempts: 3
# delay: 5000 # initial time between retries, in milliseconds
# max_delay: 60000 # maximum time between retries, in milliseconds
# groups:
# default:
# upload:
# priority: 500
# strategy: roundrobin
# slots: 10
# limits:
# queued:
# files: 150
# megabytes: 1500
# daily: ~ # no daily limits (weekly still apply)
# weekly:
# files: 1500
# megabytes: 15000
# failures: 150
# leechers:
# thresholds:
# files: 1
# directories: 1
# upload:
# priority: 999
# strategy: roundrobin
# slots: 1
# speed_limit: 100
# limits:
# queued:
# files: 15
# megabytes: 150
# daily:
# files: 30
# megabytes: 300
# failures: 10
# weekly:
# files: 150
# megabytes: 1500
# failures: 30
# blacklisted:
# members:
# - <username to blacklist>
# patterns:
# - <regular expression to match against usernames>
# cidrs:
# - <CIDR to blacklist, e.g. 255.255.255.255/32>
# user_defined:
# my_buddies:
# upload:
# priority: 250
# strategy: firstinfirstout
# slots: 10
# limits:
# queued:
# files: 1000 # override global default
# members:
# - alice
# - bob
# blacklist:
# enabled: true
# file: <path to file containing CIDRs to blacklist>
# filters:
# search:
# request:
# - ^.{1,2}$
# rooms:
# - ~
# web:
# port: 5030
# ip_address: 0.0.0.0,[::]
# socket: ~
# https:
# disabled: false
# port: 5031
# ip_address: 0.0.0.0,[::]
# force: false
# certificate:
# pfx: ~
# password: ~
# url_base: /
# content_path: wwwroot
# logging: false
# authentication:
# disabled: false
# username: slskd
# password: slskd
# jwt:
# key: ~
# ttl: 604800000
# api_keys:
# my_api_key:
# key: <some example string between 16 and 255 characters>
# role: readonly # readonly, readwrite, administrator
# cidr: 0.0.0.0/0,::/0
# retention:
# search: 10080 # 7 days, in minutes
# transfers:
# upload:
# succeeded: 1440 # 1 day, in minutes
# errored: 30
# cancelled: 5
# failed: 180 # any unsuccessful transfer, including errored and cancelled
# download:
# succeeded: 1440 # 1 day, in minutes
# errored: 20160 # 2 weeks, in minutes
# cancelled: 5
# failed: 180 # any unsuccessful transfer, including errored and cancelled
# files:
# complete: 20160 # 2 weeks, in minutes
# incomplete: 43200 # 30 days, in minutes
# logs: 180 # days
# throttling:
# search:
# incoming:
# concurrency: 10 # number of search requests to process at the same time
# circuit_breaker: 500 # maximum number of pending search requests
# response_file_limit: 500 # maximum number of files to return in a single search response
# logger:
# disk: false
# no_color: false
# loki: ~
# metrics:
# enabled: false
# url: /metrics
# authentication:
# disabled: false
# username: slskd
# password: slskd
# feature:
# swagger: false
# soulseek:
# address: vps.slsknet.org
# port: 2271
# username: ~
# password: ~
# description: |
# A slskd user. https://github.com/slskd/slskd
# picture: path/to/slsk-profile-picture.jpg
# listen_ip_address: 0.0.0.0
# listen_port: 50300
# diagnostic_level: Info
# distributed_network:
# disabled: false
# disable_children: false
# child_limit: 25
# logging: false
# connection:
# timeout:
# connect: 10000
# inactivity: 15000
# transfer: 30000
# buffer:
# read: 16384
# write: 16384
# transfer: 262144
# write_queue: 250
# proxy:
# enabled: false
# address: ~
# port: ~
# username: ~
# password: ~
# integrations:
# vpn:
# enabled: false
# port_forwarding: false
# polling_interval: 2500
# gluetun:
# url: http://localhost:8000
# timeout: 1000
# auth: apikey # or basic or none
# api_key: <gluetun API key>
# username: <username if using basic auth>
# password: <password if using basic auth>
# webhooks:
# my_webhook:
# on:
# - DownloadFileComplete
# call:
# url: https://192.168.1.42:8080/slskd_webhook
# headers:
# - name: X-API-Key
# value: foobar1234
# - name: Authorization
# value: Bearer eyJ...ssw5c
# - name: User-Agent
# value: slskd/0.0
# ignore_certificate_errors: false
# timeout: 5000 # in milliseconds
# retry:
# attempts: 3
# scripts:
# run_command_with_linux_system_shell: # automatically uses the executable defined in $SHELL
# on:
# - DownloadFileComplete
# run:
# command: 'echo "$SLSKD_SCRIPT_DATA" >> linux_system_shell.txt'
# run_with_sh:
# on:
# - DownloadFileComplete
# run:
# executable: /bin/sh
# args: '-c "echo $SLSKD_SCRIPT_DATA >> linux_sh.txt"'
# run_with_sh_and_args_list:
# on:
# - DownloadFileComplete
# run:
# executable: /bin/sh
# arglist:
# - -c
# - echo $SLSKD_SCRIPT_DATA >> linux_sh_and_args_list.txt
# run_command_with_windows_system_shell: # automatically uses cmd.exe (included with all Windows installs)
# on:
# - DownloadFileComplete
# run:
# command: 'echo "%SLSKD_SCRIPT_DATA%" >> windows_system_shell.txt'
# run_with_windows_cmd:
# on:
# - DownloadFileComplete
# run:
# executable: cmd.exe
# args: '/c "echo "%SLSKD_SCRIPT_DATA%" >> windows_cmd.txt"'
# run_with_windows_git_bash:
# on:
# - DownloadFileComplete
# run:
# executable: C:\Program Files\Git\bin\bash.exe
# args: '-c "echo "$SLSKD_SCRIPT_DATA" >> windows_git_bash.txt"'
# run_with_windows_cmd_and_args_list:
# on:
# - DownloadFileComplete
# run:
# executable: cmd.exe
# arglist:
# - /c
# - 'echo "%SLSKD_SCRIPT_DATA%" >> windows_cmd_and_args_list.txt'
# ftp:
# enabled: false
# address: ~
# port: ~
# username: ~
# password: ~
# remote_path: /
# encryption_mode: auto
# ignore_certificate_errors: false
# overwrite_existing: true
# connection_timeout: 5000
# retry_attempts: 3
# pushbullet:
# enabled: false
# access_token: ~
# notification_prefix: "From slskd:"
# notify_on_private_message: true
# notify_on_room_mention: true
# retry_attempts: 3
# cooldown_time: 900000