-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.html
769 lines (673 loc) · 41.6 KB
/
index.html
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
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="description" content="None">
<link rel="shortcut icon" href="img/favicon.ico">
<title>Buildarr</title>
<link href="css/bootstrap.min.css" rel="stylesheet">
<link href="css/font-awesome.min.css" rel="stylesheet">
<link href="css/base.css" rel="stylesheet">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github.min.css">
<link href="assets/_mkdocstrings.css" rel="stylesheet">
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/highlight.min.js"></script>
<script>hljs.highlightAll();</script>
</head>
<body class="homepage">
<div class="navbar fixed-top navbar-expand-lg navbar-dark bg-primary">
<div class="container">
<a class="navbar-brand" href=".">Buildarr</a>
<!-- Expander button -->
<button type="button" class="navbar-toggler" data-toggle="collapse" data-target="#navbar-collapse">
<span class="navbar-toggler-icon"></span>
</button>
<!-- Expanded navigation -->
<div id="navbar-collapse" class="navbar-collapse collapse">
<!-- Main navigation -->
<ul class="nav navbar-nav">
<li class="dropdown">
<a href="#" class="nav-link dropdown-toggle" data-toggle="dropdown">Release Notes <b class="caret"></b></a>
<ul class="dropdown-menu">
<li>
<a href="release-notes/" class="dropdown-item">Buildarr Core</a>
</li>
<li>
<a href="plugins/sonarr/release-notes/" class="dropdown-item">Buildarr Sonarr Plugin</a>
</li>
<li>
<a href="plugins/radarr/release-notes/" class="dropdown-item">Buildarr Radarr Plugin</a>
</li>
<li>
<a href="plugins/prowlarr/release-notes/" class="dropdown-item">Buildarr Prowlarr Plugin</a>
</li>
<li>
<a href="plugins/jellyseerr/release-notes/" class="dropdown-item">Buildarr Jellyseerr Plugin</a>
</li>
<li>
<a href="docker/release-notes/" class="dropdown-item">Buildarr Docker Container</a>
</li>
<li>
<a href="installer/release-notes/" class="dropdown-item">Buildarr Installer for Windows</a>
</li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="nav-link dropdown-toggle" data-toggle="dropdown">Installation <b class="caret"></b></a>
<ul class="dropdown-menu">
<li>
<a href="installation/docker/" class="dropdown-item">Docker Container</a>
</li>
<li>
<a href="installation/python/" class="dropdown-item">Python Application</a>
</li>
<li>
<a href="installation/windows/" class="dropdown-item">Windows</a>
</li>
</ul>
</li>
<li class="navitem">
<a href="configuration/" class="nav-link">Configuration</a>
</li>
<li class="dropdown">
<a href="#" class="nav-link dropdown-toggle" data-toggle="dropdown">Plugins <b class="caret"></b></a>
<ul class="dropdown-menu">
<li>
<a href="plugins/" class="dropdown-item">Introduction</a>
</li>
<li class="dropdown-submenu">
<a href="#" class="dropdown-item">Buildarr Sonarr Plugin</a>
<ul class="dropdown-menu">
<li>
<a href="plugins/sonarr/" class="dropdown-item">Introduction</a>
</li>
<li>
<a href="plugins/sonarr/release-notes/" class="dropdown-item">Release Notes</a>
</li>
<li class="dropdown-submenu">
<a href="#" class="dropdown-item">Configuration</a>
<ul class="dropdown-menu">
<li>
<a href="plugins/sonarr/configuration/host/" class="dropdown-item">Host Configuration</a>
</li>
<li>
<a href="plugins/sonarr/configuration/media-management/" class="dropdown-item">Media Management</a>
</li>
<li class="dropdown-submenu">
<a href="#" class="dropdown-item">Profiles</a>
<ul class="dropdown-menu">
<li>
<a href="plugins/sonarr/configuration/profiles/quality/" class="dropdown-item">Quality Profiles</a>
</li>
<li>
<a href="plugins/sonarr/configuration/profiles/language/" class="dropdown-item">Language Profiles</a>
</li>
<li>
<a href="plugins/sonarr/configuration/profiles/delay/" class="dropdown-item">Delay Profiles</a>
</li>
<li>
<a href="plugins/sonarr/configuration/profiles/release/" class="dropdown-item">Release Profiles</a>
</li>
</ul>
</li>
<li>
<a href="plugins/sonarr/configuration/quality/" class="dropdown-item">Quality</a>
</li>
<li>
<a href="plugins/sonarr/configuration/indexers/" class="dropdown-item">Indexers</a>
</li>
<li>
<a href="plugins/sonarr/configuration/download-clients/" class="dropdown-item">Download Clients</a>
</li>
<li>
<a href="plugins/sonarr/configuration/import-lists/" class="dropdown-item">Import Lists</a>
</li>
<li>
<a href="plugins/sonarr/configuration/connect/" class="dropdown-item">Connect</a>
</li>
<li>
<a href="plugins/sonarr/configuration/metadata/" class="dropdown-item">Metadata</a>
</li>
<li>
<a href="plugins/sonarr/configuration/tags/" class="dropdown-item">Tags</a>
</li>
<li>
<a href="plugins/sonarr/configuration/general/" class="dropdown-item">General</a>
</li>
<li>
<a href="plugins/sonarr/configuration/ui/" class="dropdown-item">UI</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="dropdown-submenu">
<a href="#" class="dropdown-item">Buildarr Radarr Plugin</a>
<ul class="dropdown-menu">
<li>
<a href="plugins/radarr/" class="dropdown-item">Introduction</a>
</li>
<li class="dropdown-submenu">
<a href="#" class="dropdown-item">Configuration</a>
<ul class="dropdown-menu">
<li>
<a href="plugins/radarr/configuration/host/" class="dropdown-item">Host Configuration</a>
</li>
<li class="dropdown-submenu">
<a href="#" class="dropdown-item">Settings</a>
<ul class="dropdown-menu">
<li>
<a href="plugins/radarr/configuration/settings/media-management/" class="dropdown-item">Media Management</a>
</li>
<li class="dropdown-submenu">
<a href="#" class="dropdown-item">Profiles</a>
<ul class="dropdown-menu">
<li>
<a href="plugins/radarr/configuration/settings/profiles/quality-profiles/" class="dropdown-item">Quality Profiles</a>
</li>
<li>
<a href="plugins/radarr/configuration/settings/profiles/delay-profiles/" class="dropdown-item">Delay Profiles</a>
</li>
</ul>
</li>
<li>
<a href="plugins/radarr/configuration/settings/quality/" class="dropdown-item">Quality</a>
</li>
<li>
<a href="plugins/radarr/configuration/settings/custom-formats/" class="dropdown-item">Custom Formats</a>
</li>
<li>
<a href="plugins/radarr/configuration/settings/indexers/" class="dropdown-item">Indexers</a>
</li>
<li>
<a href="plugins/radarr/configuration/settings/download-clients/" class="dropdown-item">Download Clients</a>
</li>
<li>
<a href="plugins/radarr/configuration/settings/notifications/" class="dropdown-item">Notifications (Connect)</a>
</li>
<li>
<a href="plugins/radarr/configuration/settings/metadata/" class="dropdown-item">Metadata</a>
</li>
<li>
<a href="plugins/radarr/configuration/settings/tags/" class="dropdown-item">Tags</a>
</li>
<li>
<a href="plugins/radarr/configuration/settings/general/" class="dropdown-item">General</a>
</li>
<li>
<a href="plugins/radarr/configuration/settings/ui/" class="dropdown-item">UI</a>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li class="dropdown-submenu">
<a href="#" class="dropdown-item">Buildarr Prowlarr Plugin</a>
<ul class="dropdown-menu">
<li>
<a href="plugins/prowlarr/" class="dropdown-item">Introduction</a>
</li>
<li>
<a href="plugins/prowlarr/release-notes/" class="dropdown-item">Release Notes</a>
</li>
<li class="dropdown-submenu">
<a href="#" class="dropdown-item">Configuration</a>
<ul class="dropdown-menu">
<li>
<a href="plugins/prowlarr/configuration/host/" class="dropdown-item">Host Configuration</a>
</li>
<li class="dropdown-submenu">
<a href="#" class="dropdown-item">Settings</a>
<ul class="dropdown-menu">
<li class="dropdown-submenu">
<a href="#" class="dropdown-item">Indexers</a>
<ul class="dropdown-menu">
<li>
<a href="plugins/prowlarr/configuration/settings/indexers/indexers/" class="dropdown-item">Indexers</a>
</li>
<li>
<a href="plugins/prowlarr/configuration/settings/indexers/proxies/" class="dropdown-item">Proxies</a>
</li>
</ul>
</li>
<li class="dropdown-submenu">
<a href="#" class="dropdown-item">Apps</a>
<ul class="dropdown-menu">
<li>
<a href="plugins/prowlarr/configuration/settings/apps/applications/" class="dropdown-item">Applications</a>
</li>
<li>
<a href="plugins/prowlarr/configuration/settings/apps/sync-profiles/" class="dropdown-item">Sync Profiles</a>
</li>
</ul>
</li>
<li>
<a href="plugins/prowlarr/configuration/settings/download-clients/" class="dropdown-item">Download Clients</a>
</li>
<li>
<a href="plugins/prowlarr/configuration/settings/notifications/" class="dropdown-item">Notifications</a>
</li>
<li>
<a href="plugins/prowlarr/configuration/settings/tags/" class="dropdown-item">Tags</a>
</li>
<li>
<a href="plugins/prowlarr/configuration/settings/general/" class="dropdown-item">General</a>
</li>
<li>
<a href="plugins/prowlarr/configuration/settings/ui/" class="dropdown-item">UI</a>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li class="dropdown-submenu">
<a href="#" class="dropdown-item">Buildarr Jellyseerr Plugin</a>
<ul class="dropdown-menu">
<li>
<a href="plugins/jellyseerr/" class="dropdown-item">Introduction</a>
</li>
<li>
<a href="plugins/jellyseerr/release-notes/" class="dropdown-item">Release Notes</a>
</li>
<li class="dropdown-submenu">
<a href="#" class="dropdown-item">Configuration</a>
<ul class="dropdown-menu">
<li>
<a href="plugins/jellyseerr/configuration/host/" class="dropdown-item">Host Configuration</a>
</li>
<li class="dropdown-submenu">
<a href="#" class="dropdown-item">Settings</a>
<ul class="dropdown-menu">
<li>
<a href="plugins/jellyseerr/configuration/settings/general/" class="dropdown-item">General</a>
</li>
<li>
<a href="plugins/jellyseerr/configuration/settings/users/" class="dropdown-item">Users</a>
</li>
<li>
<a href="plugins/jellyseerr/configuration/settings/jellyfin/" class="dropdown-item">Jellyfin</a>
</li>
<li class="dropdown-submenu">
<a href="#" class="dropdown-item">Services</a>
<ul class="dropdown-menu">
<li>
<a href="plugins/jellyseerr/configuration/settings/services/sonarr/" class="dropdown-item">Sonarr</a>
</li>
<li>
<a href="plugins/jellyseerr/configuration/settings/services/radarr/" class="dropdown-item">Radarr</a>
</li>
</ul>
</li>
<li>
<a href="plugins/jellyseerr/configuration/settings/notifications/" class="dropdown-item">Notifications</a>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li class="navitem">
<a href="usage/" class="nav-link">Usage</a>
</li>
<li class="navitem">
<a href="https://github.com/buildarr/buildarr" class="nav-link">GitHub</a>
</li>
</ul>
<ul class="nav navbar-nav ml-auto">
<li class="nav-item">
<a href="#" class="nav-link" data-toggle="modal" data-target="#mkdocs_search_modal">
<i class="fa fa-search"></i> Search
</a>
</li>
</ul>
</div>
</div>
</div>
<div class="container">
<div class="row">
<div class="col-md-3"><div class="navbar-light navbar-expand-md bs-sidebar hidden-print affix" role="complementary">
<div class="navbar-header">
<button type="button" class="navbar-toggler collapsed" data-toggle="collapse" data-target="#toc-collapse" title="Table of Contents">
<span class="fa fa-angle-down"></span>
</button>
</div>
<div id="toc-collapse" class="navbar-collapse collapse card bg-secondary">
<ul class="nav flex-column">
<li class="nav-item" data-level="1"><a href="#welcome-to-buildarr" class="nav-link">Welcome to Buildarr!</a>
<ul class="nav flex-column">
<li class="nav-item" data-level="2"><a href="#similar-projects" class="nav-link">Similar projects</a>
<ul class="nav flex-column">
</ul>
</li>
<li class="nav-item" data-level="2"><a href="#installation" class="nav-link">Installation</a>
<ul class="nav flex-column">
</ul>
</li>
<li class="nav-item" data-level="2"><a href="#configuration" class="nav-link">Configuration</a>
<ul class="nav flex-column">
</ul>
</li>
<li class="nav-item" data-level="2"><a href="#running-buildarr" class="nav-link">Running Buildarr</a>
<ul class="nav flex-column">
</ul>
</li>
<li class="nav-item" data-level="2"><a href="#milestones" class="nav-link">Milestones</a>
<ul class="nav flex-column">
</ul>
</li>
<li class="nav-item" data-level="2"><a href="#bug-reports" class="nav-link">Bug Reports</a>
<ul class="nav flex-column">
</ul>
</li>
<li class="nav-item" data-level="2"><a href="#contributions" class="nav-link">Contributions</a>
<ul class="nav flex-column">
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div></div>
<div class="col-md-9" role="main">
<h1 id="welcome-to-buildarr">Welcome to Buildarr!<a class="headerlink" href="#welcome-to-buildarr" title="Permanent link">#</a></h1>
<p><a href="https://hub.docker.com/r/callum027/buildarr"><img alt="Docker - callum027/buildarr" src="https://img.shields.io/docker/v/callum027/buildarr?label=callum027%2Fbuildarr" /></a> <img alt="Docker Pulls" src="https://img.shields.io/docker/pulls/callum027/buildarr" /> <a href="https://github.com/buildarr/buildarr-installer/releases"><img alt="GitHub - buildarr-installer" src="https://img.shields.io/github/v/release/buildarr/buildarr-installer?label=buildarr-installer" /></a> <img alt="GitHub all releases" src="https://img.shields.io/github/downloads/buildarr/buildarr-installer/total" /> <a href="https://github.com/buildarr/buildarr/blob/main/LICENSE"><img alt="GitHub License" src="https://img.shields.io/github/license/buildarr/buildarr" /></a>
<br>
<a href="https://pypi.org/project/buildarr"><img alt="PyPI - buildarr" src="https://img.shields.io/pypi/v/buildarr?label=buildarr" /></a> <a href="https://pypi.org/project/buildarr-sonarr"><img alt="PyPI - buildarr-sonarr" src="https://img.shields.io/pypi/v/buildarr-sonarr?label=buildarr-sonarr" /></a> <a href="https://pypi.org/project/buildarr-radarr"><img alt="PyPI - buildarr-radarr" src="https://img.shields.io/pypi/v/buildarr-radarr?label=buildarr-radarr" /></a> <a href="https://pypi.org/project/buildarr-prowlarr"><img alt="PyPI - buildarr-prowlarr" src="https://img.shields.io/pypi/v/buildarr-prowlarr?label=buildarr-prowlarr" /></a> <a href="https://pypi.org/project/buildarr-jellyseerr"><img alt="PyPI - buildarr-jellyseerr" src="https://img.shields.io/pypi/v/buildarr-jellyseerr?label=buildarr-jellyseerr" /></a></p>
<p>This is Buildarr, a solution to automating deployment and configuration of your *Arr stack.</p>
<p>Have you spent many hours getting your setup for one or more linked Sonarr/Radarr/Prowlarr instances just right, only to have no way to reproduce this setup apart from UI screenshots and database backups?</p>
<p>Buildarr aims to alleviate those concerns by using a static configuration file to store settings for all your *Arr applications, and automatically configure them as defined. It can run just once using an ad-hoc user command, or as a service to keep your application configurations up to date. Buildarr runs idempotently, only making changes to your instance if they are required.</p>
<p>It can also automatically retrieve optimal configuration values from TRaSH-Guides for many things such as quality definitions and release profiles, so not only is there no need to manually input them into your configuration, Buildarr will also continually keep them up to date for you.</p>
<h2 id="similar-projects">Similar projects<a class="headerlink" href="#similar-projects" title="Permanent link">#</a></h2>
<p>Buildarr attempts to fulfill some of the needs of users of the following projects.</p>
<ul>
<li><a href="https://github.com/iam4x/bobarr">Bobarr</a> - An all-in-one package containing Sonarr, Radarr, Jackett etc<ul>
<li>Still requires manual configuration of many components, and there is no way to store the configuration as code.</li>
</ul>
</li>
<li><a href="https://github.com/Flemmarr/Flemmarr">Flemmarr</a> - Uses API parameters stored in YAML configuration files to push configuration changes to Sonarr, Radarr, Lidarr etc<ul>
<li>Requires users to comprehensively learn how the APIs of each application work, going through often poor documentation.</li>
<li>Since the values are machine-oriented, configuration files are difficult to write and understand.</li>
<li>Does not support idempotent updates (<a href="https://github.com/Flemmarr/Flemmarr/pull/14">at this time</a>).</li>
</ul>
</li>
<li><a href="https://github.com/recyclarr/recyclarr">Recyclarr</a> - Automatically syncs recommended TRaSH-Guides settings to Sonarr/Radarr instances<ul>
<li>Buildarr has support for this built-in, and in the case of Sonarr release profiles, supports the same filtering syntax.</li>
</ul>
</li>
</ul>
<h2 id="installation">Installation<a class="headerlink" href="#installation" title="Permanent link">#</a></h2>
<p>Buildarr can be installed using a variety of methods, on all of the same platforms as the *Arr stack applications:</p>
<ul>
<li><a href="installation/docker/">As a Docker container</a></li>
<li><a href="installation/python/">As a standard Python application</a></li>
<li><a href="installation/windows/">On Windows (either using an installer, or as a standard Python application)</a></li>
</ul>
<p>Buildarr uses a plugin architecture to allow additional applications to be supported.</p>
<p>The following plugins are currently available:</p>
<ul>
<li><a href="plugins/sonarr/"><code>buildarr-sonarr</code></a> - <a href="https://sonarr.tv">Sonarr</a> PVR for TV shows</li>
<li><a href="plugins/radarr/"><code>buildarr-radarr</code></a> - <a href="https://radarr.video">Radarr</a> PVR for movies</li>
<li><a href="plugins/prowlarr/"><code>buildarr-prowlarr</code></a> - <a href="https://prowlarr.com">Prowlarr</a> indexer manager for Arr applications</li>
<li><a href="plugins/jellyseerr/"><code>buildarr-jellyseerr</code></a> - <a href="https://github.com/Fallenbagel/jellyseerr">Jellyseerr</a> media request manager for Jellyfin, Sonarr and Radarr</li>
</ul>
<p>For more information on installing and using plugins, check the <a href="plugins/">plugin documentation</a>.</p>
<h2 id="configuration">Configuration<a class="headerlink" href="#configuration" title="Permanent link">#</a></h2>
<p>Buildarr uses YAML as its configuration file format. By default, Buildarr looks for <code>buildarr.yml</code> in the current directory.</p>
<p>It contains not only the settings for Buildarr itself, but also the application instances to be managed. Multiple instances of the same application type can be defined (for example, a common use case would be separate Sonarr instances for HD TV shows, 4K TV shows, and anime).</p>
<p>Any configuration on the remote instance not explicitly defined in the Buildarr configuration is not modified.</p>
<p>For more information on how Buildarr uses configuration and how to configure Buildarr itself, refer to <a href="configuration/">Configuring Buildarr</a>.</p>
<p>Here is an example of a simple Buildarr configuration that changes some settings on a Sonarr instance:</p>
<div class="highlight"><pre><span></span><code><span class="nn">---</span>
<span class="c1"># buildarr.yml</span>
<span class="c1"># Buildarr example configuration file.</span>
<span class="c1"># Buildarr configuration (all settings have sane default values)</span>
<span class="nt">buildarr</span><span class="p">:</span>
<span class="w"> </span><span class="nt">watch_config</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
<span class="w"> </span><span class="nt">update_days</span><span class="p">:</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">"monday"</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">"tuesday"</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">"wednesday"</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">"thursday"</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">"friday"</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">"saturday"</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">"sunday"</span>
<span class="w"> </span><span class="nt">update_times</span><span class="p">:</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">"03:00"</span>
<span class="c1"># Sonarr instance configuration</span>
<span class="nt">sonarr</span><span class="p">:</span>
<span class="w"> </span><span class="nt">hostname</span><span class="p">:</span><span class="w"> </span><span class="s">"localhost"</span>
<span class="w"> </span><span class="nt">port</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">8989</span>
<span class="w"> </span><span class="nt">protocol</span><span class="p">:</span><span class="w"> </span><span class="s">"http"</span>
<span class="w"> </span><span class="nt">settings</span><span class="p">:</span>
<span class="w"> </span><span class="c1"># General settings (all options supported except for changing the API key)</span>
<span class="w"> </span><span class="nt">general</span><span class="p">:</span>
<span class="w"> </span><span class="nt">host</span><span class="p">:</span>
<span class="w"> </span><span class="nt">instance_name</span><span class="p">:</span><span class="w"> </span><span class="s">"Sonarr</span><span class="nv"> </span><span class="s">(Buildarr</span><span class="nv"> </span><span class="s">Example)"</span>
</code></pre></div>
<p>If you have an already configured application instance, its configuration can be dumped. For example, to get the configuration of a Sonarr instance, this can be done using the following command (Buildarr will prompt for your API key):</p>
<div class="highlight"><pre><span></span><code>$<span class="w"> </span>docker<span class="w"> </span>run<span class="w"> </span>-it<span class="w"> </span>--rm<span class="w"> </span>callum027/buildarr:latest<span class="w"> </span>sonarr<span class="w"> </span>dump-config<span class="w"> </span>http://sonarr.example.com:8989
</code></pre></div>
<p>Once you have this configuration, you can insert it into <code>buildarr.yml</code> and ensure this configuration is maintained.</p>
<h2 id="running-buildarr">Running Buildarr<a class="headerlink" href="#running-buildarr" title="Permanent link">#</a></h2>
<p>Once you have a valid configuration file, you can try running Buildarr against your *Arr stack applications.</p>
<p>On startup, Buildarr daemon will do an initial sync with the defined instances, updating their configuration immediately.
After this initial run, Buildarr will wake up at scheduled times to periodically run updates as required.</p>
<div class="highlight"><pre><span></span><code>2023-11-12 10:00:29,220 buildarr:1 buildarr.cli.daemon [INFO] Buildarr version 0.7.0 (log level: INFO)
2023-11-12 10:00:29,220 buildarr:1 buildarr.cli.daemon [INFO] Loading configuration file '/config/buildarr.yml'
2023-11-12 10:00:29,775 buildarr:1 buildarr.cli.daemon [INFO] Finished loading configuration file
2023-11-12 10:00:29,775 buildarr:1 buildarr.cli.daemon [INFO] Daemon configuration:
2023-11-12 10:00:29,776 buildarr:1 buildarr.cli.daemon [INFO] - Watch configuration files: No
2023-11-12 10:00:29,776 buildarr:1 buildarr.cli.daemon [INFO] - Update at:
2023-11-12 10:00:29,776 buildarr:1 buildarr.cli.daemon [INFO] - Monday 03:00
2023-11-12 10:00:29,776 buildarr:1 buildarr.cli.daemon [INFO] - Tuesday 03:00
2023-11-12 10:00:29,777 buildarr:1 buildarr.cli.daemon [INFO] - Wednesday 03:00
2023-11-12 10:00:29,777 buildarr:1 buildarr.cli.daemon [INFO] - Thursday 03:00
2023-11-12 10:00:29,778 buildarr:1 buildarr.cli.daemon [INFO] - Friday 03:00
2023-11-12 10:00:29,778 buildarr:1 buildarr.cli.daemon [INFO] - Saturday 03:00
2023-11-12 10:00:29,778 buildarr:1 buildarr.cli.daemon [INFO] - Sunday 03:00
2023-11-12 10:00:29,778 buildarr:1 buildarr.cli.daemon [INFO] Scheduling update jobs
2023-11-12 10:00:29,779 buildarr:1 buildarr.cli.daemon [INFO] Finished scheduling update jobs
2023-11-12 10:00:29,779 buildarr:1 buildarr.cli.daemon [INFO] Config file monitoring is already disabled
2023-11-12 10:00:29,779 buildarr:1 buildarr.cli.daemon [INFO] Applying initial configuration
2023-11-12 10:00:29,932 buildarr:1 buildarr.cli.run [INFO] Loaded plugins: jellyseerr (0.3.0), prowlarr (0.5.0), radarr (0.2.0), sonarr (0.6.0)
2023-11-12 10:00:29,932 buildarr:1 buildarr.cli.run [INFO] Loading instance configurations
2023-11-12 10:00:29,973 buildarr:1 buildarr.cli.run [INFO] Finished loading instance configurations
2023-11-12 10:00:29,973 buildarr:1 buildarr.cli.run [INFO] Running with plugins: sonarr
2023-11-12 10:00:29,973 buildarr:1 buildarr.cli.run [INFO] Resolving instance dependencies
2023-11-12 10:00:29,973 buildarr:1 buildarr.cli.run [INFO] Finished resolving instance dependencies
2023-11-12 10:00:29,973 buildarr:1 buildarr.cli.run [INFO] Fetching TRaSH metadata
2023-11-12 10:00:36,723 buildarr:1 buildarr.cli.run [INFO] Finished fetching TRaSH metadata
2023-11-12 10:00:36,723 buildarr:1 buildarr.cli.run [INFO] Rendering instance configuration dynamic attributes
2023-11-12 10:00:36,739 buildarr:1 buildarr.cli.run [INFO] Finished rendering instance configuration dynamic attributes
2023-11-12 10:00:37,273 buildarr:1 buildarr.cli.run [INFO] <sonarr> (default) Fetching instance secrets
2023-11-12 10:00:37,273 buildarr:1 buildarr.cli.run [INFO] <sonarr> (default) Finished fetching instance secrets
2023-11-12 10:00:37,273 buildarr:1 buildarr.cli.run [INFO] <sonarr> (default) Running connection test
2023-11-12 10:00:37,343 buildarr:1 buildarr.cli.run [INFO] <sonarr> (default) Connection test successful
2023-11-12 10:00:38,112 buildarr:1 buildarr.cli.run [INFO] Performing post-initialisation configuration render
2023-11-12 10:00:39,292 buildarr:1 buildarr.cli.run [INFO] Finished performing post-initialisation configuration render
2023-11-12 10:00:39,292 buildarr:1 buildarr.cli.run [INFO] Updating configuration on remote instances
2023-11-12 10:00:39,292 buildarr:1 buildarr.cli.run [INFO] <sonarr> (default) Fetching remote configuration to check if updates are required
2023-11-12 10:00:39,738 buildarr:1 buildarr.cli.run [INFO] <sonarr> (default) Finished fetching remote configuration
2023-11-12 10:00:39,810 buildarr:1 buildarr.cli.run [INFO] <sonarr> (default) Updating remote configuration
2023-11-12 10:00:39,850 buildarr:1 buildarr.config.base [INFO] <sonarr> (default) sonarr.settings.general.host.instance_name: 'Sonarr' -> 'Sonarr (Buildarr Example)'
2023-11-12 10:00:39,933 buildarr:1 buildarr.cli.run [INFO] <sonarr> (default) Remote configuration successfully updated
2023-11-12 10:00:40,574 buildarr:1 buildarr.cli.run [INFO] <sonarr> (default) Finished updating remote configuration
2023-11-12 10:00:49,722 buildarr:1 buildarr.cli.run [INFO] Finished updating configuration on remote instances
2023-11-12 10:00:49,722 buildarr:1 buildarr.cli.run [INFO] Deleting unmanaged/unused resources on remote instances
2023-11-12 10:00:52,579 buildarr:1 buildarr.cli.run [INFO] <sonarr> (default) Refetching remote configuration to delete unused resources
2023-11-12 10:00:52,714 buildarr:1 buildarr.cli.run [INFO] <sonarr> (default) Finished refetching remote configuration
2023-11-12 10:00:52,771 buildarr:1 buildarr.cli.run [INFO] <sonarr> (default) Deleting unmanaged/unused resources on the remote instance
2023-11-12 10:00:52,843 buildarr:1 buildarr.cli.run [INFO] <sonarr> (default) Remote configuration is clean
2023-11-12 10:00:52,843 buildarr:1 buildarr.cli.run [INFO] <sonarr> (default) Finished deleting unmanaged/unused resources on the remote instance
2023-11-12 10:00:52,843 buildarr:1 buildarr.cli.run [INFO] Finished deleting unmanaged/unused resources on remote instances
2023-11-12 10:00:52,843 buildarr:1 buildarr.cli.run [INFO] Deleting downloaded TRaSH metadata
2023-11-12 10:00:52,873 buildarr:1 buildarr.cli.run [INFO] Finished deleting downloaded TRaSH metadata
2023-11-12 10:00:52,874 buildarr:1 buildarr.cli.daemon [INFO] Finished applying initial configuration
2023-11-12 10:00:52,874 buildarr:1 buildarr.cli.daemon [INFO] Setting up signal handlers
2023-11-12 10:00:52,875 buildarr:1 buildarr.cli.daemon [INFO] Finished setting up signal handlers
2023-11-12 10:00:52,875 buildarr:1 buildarr.cli.daemon [INFO] The next run will be at 2023-11-13 03:00
2023-11-12 10:00:52,875 buildarr:1 buildarr.cli.daemon [INFO] Buildarr ready.
</code></pre></div>
<p>For more information on how to interfact with Buildarr, refer to <a href="usage/">Using Buildarr</a>.</p>
<h2 id="milestones">Milestones<a class="headerlink" href="#milestones" title="Permanent link">#</a></h2>
<ul>
<li><del>Instance linking (e.g. Prowlarr-to-Sonarr/Radarr) and dependency resolution</del> (added in <a href="release-notes/#v030-2023-03-15">version 0.3.0</a>)</li>
<li><del>Auto-generation of Docker Compose environment files reflecting the Buildarr configuration</del> (added in <a href="release-notes/#v040-2023-03-31">version 0.4.0</a>)</li>
<li><del>Split Sonarr plugin to its own repository</del> (completed in <a href="release-notes/#v040-2023-03-31">version 0.4.0</a>)</li>
<li>Unit tests and code coverage</li>
<li>Create plugins for the following applications:<ul>
<li>Sonarr V4</li>
<li><del>Radarr</del> (now available as <a href="plugins/radarr/"><code>buildarr-radarr</code></a>)</li>
<li><del>Prowlarr</del> (now available as <a href="plugins/prowlarr/"><code>buildarr-prowlarr</code></a>)</li>
<li><del>Jellyseerr</del> (now available as <a href="plugins/jellyseerr/"><code>buildarr-jellyseerr</code></a>)</li>
<li>Bazarr</li>
<li>Unmanic</li>
<li>Unpackerr</li>
<li>Lidarr</li>
</ul>
</li>
<li>Stable plugin API between major versions</li>
</ul>
<h2 id="bug-reports">Bug Reports<a class="headerlink" href="#bug-reports" title="Permanent link">#</a></h2>
<p>Buildarr is still early in development, and even currently implemented features still require testing and fixing. There are so many possible configurations to cover that I simply cannot feasibly test every feature at this time.</p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p><strong>Buildarr debug logs can contain un-obfuscated copies of your API keys and passwords in the API request logs.</strong></p>
<p>To protect your personal information (and access privileges to any private trackers),
<strong>PLEASE</strong> use the "Find and Replace" function on your favourite text editor to ensure any API keys or passwords are removed from debug logs before submitting bug reports.</p>
</div>
<p>If you encounter an issue or error while using Buildarr, please do a Buildarr ad-hoc run with verbose log output by running Buildarr either:</p>
<ul>
<li>with <code>--log-level DEBUG</code> set on the command line, e.g. <code>buildarr --log-level DEBUG run</code>, or</li>
<li>with the <code>BUILDARR_LOG_LEVEL</code> environment variable set to <code>DEBUG</code></li>
</ul>
<p>and making an issue on <a href="https://github.com/buildarr/buildarr/issues/new">our GitHub repository</a>, with an explanation of the issue and the output from Buildarr.</p>
<p>Bug reports and pull requests can also be submitted to each respective component's repository:</p>
<ul>
<li>Buildarr Sonarr Plugin: <a href="https://github.com/buildarr/buildarr-sonarr"><code>buildarr/buildarr-sonarr</code></a></li>
<li>Buildarr Radarr Plugin: <a href="https://github.com/buildarr/buildarr-radarr"><code>buildarr/buildarr-radarr</code></a></li>
<li>Buildarr Prowlarr Plugin: <a href="https://github.com/buildarr/buildarr-prowlarr"><code>buildarr/buildarr-prowlarr</code></a></li>
<li>Buildarr Jellyseerr Plugin: <a href="https://github.com/buildarr/buildarr-jellyseerr"><code>buildarr/buildarr-jellyseerr</code></a></li>
<li>Buildarr Docker Container: <a href="https://github.com/buildarr/buildarr-docker"><code>buildarr/buildarr-docker</code></a></li>
<li>Buildarr Installer for Windows: <a href="https://github.com/buildarr/buildarr-installer"><code>buildarr/buildarr-installer</code></a></li>
</ul>
<h2 id="contributions">Contributions<a class="headerlink" href="#contributions" title="Permanent link">#</a></h2>
<p>If you're interested in making a contribution to the Buildarr project, thank you! Documentation of the internal APIs is still in the works, so for now, the best way to learn how Buildarr works is to clone the project and have a look at the comments and docstrings.</p>
<p>Pre-commit hooks are configured for this project. In this pre-commit hook, <a href="https://black.readthedocs.io/en/stable">Black</a>, <a href="https://beta.ruff.rs/docs">Ruff</a> and <a href="https://mypy-lang.org">Mypy</a> are run to automatically format source files, ensure grammatical correctness and variable type consistency.</p>
<p>To enable them, ensure the <code>pre-commit</code> Python package is installed in your local environment and run the following command:</p>
<div class="highlight"><pre><span></span><code>$<span class="w"> </span>pre-commit<span class="w"> </span>install
</code></pre></div>
<p>Poetry is used to manage the Python package definition and dependencies in this project.</p>
<p>If you're looking to develop a new plugin for adding support for a new application, please develop it as a new package and configure entry points in your Python package definitions to allow Buildarr to load your plugin.</p>
<p>Setuptools <code>setup.py</code> entry point definition example:</p>
<div class="highlight"><pre><span></span><code><span class="kn">from</span> <span class="nn">setuptools</span> <span class="kn">import</span> <span class="n">setup</span>
<span class="n">setup</span><span class="p">(</span>
<span class="c1"># ...,</span>
<span class="n">entry_points</span><span class="o">=</span><span class="p">{</span>
<span class="s2">"buildarr.plugins"</span><span class="p">:</span> <span class="p">[</span>
<span class="s2">"example = buildarr_example.plugin:ExamplePlugin"</span><span class="p">,</span>
<span class="p">],</span>
<span class="p">},</span>
<span class="p">)</span>
</code></pre></div>
<p>Setuptools <code>setup.cfg</code> entry point definition example:</p>
<div class="highlight"><pre><span></span><code><span class="k">[options.entry_points]</span>
<span class="na">buildarr.plugins</span><span class="w"> </span><span class="o">=</span>
<span class="w"> </span><span class="na">example</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">buildarr_example.plugin:ExamplePlugin</span>
</code></pre></div>
<p>Setuptools <code>pyproject.toml</code> entry point definition example:</p>
<div class="highlight"><pre><span></span><code><span class="k">[project.entry-points."buildarr.plugins"]</span>
<span class="s">"example"</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">"buildarr_example.plugin:ExamplePlugin"</span>
</code></pre></div>
<p>Poetry plugin definition example:</p>
<div class="highlight"><pre><span></span><code><span class="k">[tool.poetry.plugins."buildarr.plugins"]</span>
<span class="s">"example"</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">"buildarr_example.plugin:ExamplePlugin"</span>
</code></pre></div></div>
</div>
</div>
<footer class="col-md-12">
<hr>
<p>Documentation built with <a href="https://www.mkdocs.org/">MkDocs</a>.</p>
</footer>
<script src="js/jquery-3.6.0.min.js"></script>
<script src="js/bootstrap.min.js"></script>
<script>
var base_url = ".",
shortcuts = {"help": 191, "next": 78, "previous": 80, "search": 83};
</script>
<script src="js/base.js"></script>
<script src="search/main.js"></script>
<div class="modal" id="mkdocs_search_modal" tabindex="-1" role="dialog" aria-labelledby="searchModalLabel" aria-hidden="true">
<div class="modal-dialog modal-lg">
<div class="modal-content">
<div class="modal-header">
<h4 class="modal-title" id="searchModalLabel">Search</h4>
<button type="button" class="close" data-dismiss="modal"><span aria-hidden="true">×</span><span class="sr-only">Close</span></button>
</div>
<div class="modal-body">
<p>From here you can search these documents. Enter your search terms below.</p>
<form>
<div class="form-group">
<input type="search" class="form-control" placeholder="Search..." id="mkdocs-search-query" title="Type search term here">
</div>
</form>
<div id="mkdocs-search-results" data-no-results-text="No results found"></div>
</div>
<div class="modal-footer">
</div>
</div>
</div>
</div><div class="modal" id="mkdocs_keyboard_modal" tabindex="-1" role="dialog" aria-labelledby="keyboardModalLabel" aria-hidden="true">
<div class="modal-dialog">
<div class="modal-content">
<div class="modal-header">
<h4 class="modal-title" id="keyboardModalLabel">Keyboard Shortcuts</h4>
<button type="button" class="close" data-dismiss="modal"><span aria-hidden="true">×</span><span class="sr-only">Close</span></button>
</div>
<div class="modal-body">
<table class="table">
<thead>
<tr>
<th style="width: 20%;">Keys</th>
<th>Action</th>
</tr>
</thead>
<tbody>
<tr>
<td class="help shortcut"><kbd>?</kbd></td>
<td>Open this help</td>
</tr>
<tr>
<td class="next shortcut"><kbd>n</kbd></td>
<td>Next page</td>
</tr>
<tr>
<td class="prev shortcut"><kbd>p</kbd></td>
<td>Previous page</td>
</tr>
<tr>
<td class="search shortcut"><kbd>s</kbd></td>
<td>Search</td>
</tr>
</tbody>
</table>
</div>
<div class="modal-footer">
</div>
</div>
</div>
</div>
</body>
</html>
<!--
MkDocs version : 1.5.3
Build Date UTC : 2024-04-29 00:35:54.481030+00:00
-->