-
-
Notifications
You must be signed in to change notification settings - Fork 26
/
Copy pathconfigure.py
executable file
·1336 lines (1176 loc) · 49.2 KB
/
configure.py
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
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#!/usr/bin/python3
""" Update Amplipi's configuration on the raspberry pi or your test setup
This script is initially designed to support local git installs, pi installs, and amplipi installs
"""
import platform
import subprocess
import os
import pathlib
import pwd # username
import glob
from typing import List, Union, Tuple, Dict, Any, Optional
import time
import re
import sys
import requests
import json
# pylint: disable=broad-except
# pylint: disable=bare-except
RSYSLOG_CFG = """# /etc/rsyslog.conf configuration file for rsyslog
# Created by AmpliPi installer
# Drastically limits logging to any local files while maintaining
# remote logging capabilities.
#
# For more information install rsyslog-doc and see
# /usr/share/doc/rsyslog-doc/html/configuration/index.html
#################
#### MODULES ####
#################
module(load="imuxsock") # provides support for local system logging
module(load="imklog") # provides kernel logging support
###########################
#### GLOBAL DIRECTIVES ####
###########################
#
# Use traditional timestamp format.
# To enable high precision timestamps, comment out the following line.
#
$ActionFileDefaultTemplate RSYSLOG_TraditionalFileFormat
#
# Set the default permissions for all log files.
#
$FileOwner root
$FileGroup adm
$FileCreateMode 0640
$DirCreateMode 0755
$Umask 0022
#
# Where to place spool and state files
#
$WorkDirectory /var/spool/rsyslog
#
# Include all config files in /etc/rsyslog.d/
#
$IncludeConfig /etc/rsyslog.d/*.conf
###############
#### RULES ####
###############
# Emergencies are sent to everybody logged in.
#
*.emerg :omusrmsg:*
"""
_os_deps: Dict[str, Dict[str, Any]] = {
'base': {
'apt': ['python3-pip', 'python3-venv', 'curl', 'authbind',
'python3-pil', 'libopenjp2-7', # Pillow dependencies
'libatlas-base-dev', # numpy dependencies
'stm32flash', # Programming Preamp Board
'xkcdpass', # Random passphrase generation
'systemd-journal-remote', # Remote/web based log access
'jq', # JSON parser used in check-release script
'redis', # background job queue
# pygobject dependencies (Spotifyd)
'libgirepository1.0-dev', 'libcairo2-dev',
],
},
'usb': {
'apt': [
'udisks2', 'udiskie', # Required to mount filesystem without desktop installed
],
'copy': [
{
'from': 'config/10-udisks.pkla',
'to': '/etc/polkit-1/localauthority/50-local.d/10-udisks.pkla',
'sudo': 'true',
},
{
'from': 'config/99-udisks2.rules',
'to': '/etc/udev/rules.d/99-udisks2.rules',
'sudo': 'true',
}
],
'script': [
'sudo cp scripts/udiskie.service /etc/systemd/system',
'sudo chmod 444 /etc/systemd/system/udiskie.service',
'sudo systemctl enable udiskie.service',
]
},
'logging': {
"copy": [
{
'from': 'config/deactivate_persist_logs_crontab',
'to': '/etc/cron.d/deactivate_persist_logs',
'sudo': 'true',
},
{
'from': 'scripts/increment_auto_off.py',
'to': '/usr/local/bin/increment_auto_off.py',
'sudo': 'true',
},
],
'script': [
'echo "reconfiguring secondary logging utility rsyslog to only allow remote logging"',
f"echo '{RSYSLOG_CFG}' | sudo tee /etc/rsyslog.conf",
# just in case it was disabled...
'sudo systemctl enable rsyslog.service',
'sudo systemctl restart rsyslog.service',
'echo "If first deploy, reconfiguring journald to only log to RAM"',
r'[ ! -d /var/log/journal ] && echo -e "[Journal]\nStorage=volatile\nRuntimeMaxUse=64M\nForwardToConsole=no\nForwardToWall=no\n" | sudo tee /etc/systemd/journald.conf',
'sudo systemctl enable systemd-journald.service',
'sudo systemctl restart systemd-journald.service',
'echo Handle dependencies for log persistence options',
'sudo mkdir -p /var/log/journal',
'sudo systemd-tmpfiles --create --prefix /var/log/journal',
'echo "enable socket to the journald server to allow easy access to system logs"',
'sudo systemctl enable systemd-journal-gatewayd.socket',
'sudo systemctl restart systemd-journal-gatewayd.socket',
'echo "deleting some old logs"',
'sudo journalctl --rotate',
'sudo journalctl --vacuum-time=10m',
'sudo rm /var/log/daemon* && echo "removed daemon logs" || echo ok',
'sudo rm /var/log/syslog* && echo "removed syslogs" || echo ok',
'sudo rm /var/log/messages* && echo "removed messages" || echo ok',
'sudo rm /var/log/user* && echo "removed user logs" || echo ok',
]
},
'support_tunnel': {
'apt': [
'libsystemd-dev', # permits logging directly to journald
'wireguard', 'wireguard-tools' # -tools for wg-quick usage
],
'copy': [
{
'from': 'config/support_tunnel_crontab',
'to': '/etc/cron.d/support_tunnel',
'sudo': 'true'
},
{
'from': 'config/support_group_sudoers',
'to': '/etc/sudoers.d/099_support-nopasswd',
'sudo': 'true'
},
{ # support tunnel scripts must be only be writable by root
'from': 'scripts/support_tunnel_post_up.sh',
'to': '/usr/local/bin/support_tunnel_post_up.sh',
'sudo': 'true'
},
{
'from': 'scripts/support_tunnel_post_down.sh',
'to': '/usr/local/bin/support_tunnel_post_down.sh',
'sudo': 'true'
},
{
'from': 'config/support_tunnel_config.ini',
'to': '/etc/support_tunnel/config.ini',
'sudo': 'true'
}
],
'script': [
'sudo addgroup support',
'sudo adduser pi support',
'sudo mkdir -p /var/lib/support_tunnel',
'sudo chmod 0777 /var/lib/support_tunnel', # TODO: lock this down
'if [ ! -e /opt/support_tunnel ] ; then'
' pushd $(mktemp --directory)',
' git clone https://github.com/micro-nova/support_tunnel.git',
' sudo mv support_tunnel /opt',
' popd',
'fi',
'pushd /opt/support_tunnel',
'git fetch && git reset --hard origin/main',
'if [ ! -e /opt/support_tunnel/venv ]; then',
' /usr/bin/python3 -m venv venv',
'fi',
'/opt/support_tunnel/venv/bin/pip install -r requirements.txt',
'popd',
]
},
'stat-collector': {
"copy": [
{
'from': 'config/stat_collector_crontab',
'to': '/etc/cron.d/statcollector',
'sudo': 'true',
},
{
'from': 'scripts/collect_stats.sh',
'to': '/usr/local/bin/collect_stats.sh',
'sudo': 'true',
},
],
},
# streams
# TODO: can stream dependencies be aggregated from the streams themselves?
'airplay': {
'apt': ['shairport-sync'],
'copy': [{'from': 'bin/ARCH/shairport-sync-ap2', 'to': 'streams/shairport-sync-ap2'},
{'from': 'bin/ARCH/shairport-sync', 'to': 'streams/shairport-sync'}],
'script': [
'if which nqptp > /dev/null; then exit 0; fi',
'pushd $(mktemp --directory)',
'git clone https://github.com/mikebrady/nqptp.git',
'pushd nqptp',
'autoreconf -fi',
'./configure --with-systemd-startup',
'make',
'sudo make install',
'sudo systemctl enable nqptp && sudo systemctl restart nqptp',
'popd',
'popd',
]
},
'internet_radio': {
'apt': ['vlc']
},
'fmradio': {
'apt': ['rtl-sdr', 'git', 'build-essential', 'libsndfile1-dev', 'libliquid-dev', 'meson'],
'script': [
'if ! which redsea > /dev/null; then', # TODO: check version
' echo "Installing redsea"',
' cd /tmp',
' git clone --depth 1 https://github.com/windytan/redsea.git',
' cd redsea',
' meson setup build',
' cd build',
' meson compile',
' sudo cp redsea /usr/local/bin/',
' sudo wget https://raw.githubusercontent.com/osmocom/rtl-sdr/master/rtl-sdr.rules -P /etc/udev/rules.d/',
' sudo udevadm control --reload-rules',
' sudo udevadm trigger',
'fi',
]
},
'lms': {
'apt': ['libcrypt-openssl-rsa-perl', 'libio-socket-ssl-perl', 'libopusfile0'],
'copy': [{'from': 'bin/ARCH/find_lms_server', 'to': 'streams/find_lms_server'}],
'script': [
'if [ ! $(dpkg-query --show --showformat=\'${Status}\' logitechmediaserver | grep -q installed) ]; then '
' wget -nv https://storage.googleapis.com/amplipi-deb/pool/main/l/logitechmediaserver/logitechmediaserver_8.5.2_all.deb -O /tmp/logitechmediaserver_8.5.2.deb',
' sudo dpkg -i /tmp/logitechmediaserver_8.5.2.deb',
' if [ ! -e /home/pi/.config/amplipi/lms_mode ] ; then sudo systemctl disable logitechmediaserver; fi',
' if [ ! -e /home/pi/.config/amplipi/lms_mode ] ; then sudo systemctl stop logitechmediaserver; fi',
'fi',
'wget -nv https://storage.googleapis.com/amplipi-deb/pool/main/s/squeezelite/squeezelite_2.0.0-1488+git20240509.0e85ddf-1.1_armhf.deb -O /tmp/squeezelite_2.0.0-1488+git20240509.0e85ddf-1.1_armhf.deb',
'sudo dpkg -i /tmp/squeezelite_2.0.0-1488+git20240509.0e85ddf-1.1_armhf.deb',
'sudo systemctl stop squeezelite',
'sudo systemctl disable squeezelite',
'sudo chmod 755 /media/pi',
'sudo chmod 755 /media/pi/*',
'sudo cp scripts/udisks2-listener.sh /usr/local/bin',
'sudo cp scripts/edit_media_directories.py /usr/local/bin',
'sudo cp scripts/udisks2-listener.service /etc/systemd/system',
'sudo chmod 444 /etc/systemd/system/udisks2-listener.service',
'sudo systemctl enable udisks2-listener.service',
]
},
'dlna': {
'apt': ['uuid-runtime', 'build-essential', 'autoconf', 'automake', 'libtool', 'pkg-config',
'libupnp-dev', 'libgstreamer1.0-dev', 'gstreamer1.0-plugins-base',
'gstreamer1.0-plugins-good', 'gstreamer1.0-plugins-bad', 'gstreamer1.0-plugins-ugly',
'gstreamer1.0-libav', 'gstreamer1.0-alsa', 'git'],
'script': [
'if [ ! -d "gmrender-resurrect" ] ; then',
' git clone https://github.com/hzeller/gmrender-resurrect.git gmrender-resurrect',
' cd gmrender-resurrect',
'else',
' cd gmrender-resurrect',
' git pull https://github.com/hzeller/gmrender-resurrect.git',
'fi',
'./autogen.sh',
'./configure',
'make',
'sudo make install',
],
},
'plexamp': {
# TODO: do a full install of plexamp, the partial install below is not useful
# 'script' : [ './streams/plexamp_nodeinstall.bash' ]
},
'spotify': {
# from https://github.com/devgianlu/go-librespot's release page
'copy': [{'from': 'bin/ARCH/go-librespot', 'to': 'streams/go-librespot'}],
},
'pandora': {
'apt': [
'libao4', 'libavcodec58', 'libavfilter7', 'libavformat58', 'libavutil56', 'libc6', 'libcurl3-gnutls', 'libgcrypt20', 'libjson-c3'
],
'copy': [{'from': 'bin/ARCH/pianobar', 'to': 'streams/pianobar'}],
},
'bluetooth': {
'amplipi_only': True,
'apt': ['libsndfile1', 'libsndfile1-dev', 'libbluetooth-dev', 'bluealsa', 'python-dbus',
'libasound2-dev', 'git', 'autotools-dev', 'automake', 'libtool', 'm4'],
'script': [
# referencing arm here is okay because bluetooth is marked as 'amplipi_only'
'sudo cp bin/arm/rtl8761b_fw /lib/firmware/rtl_bt/rtl8761b_fw.bin',
'sudo cp bin/arm/rtl8761b_config /lib/firmware/rtl_bt/rtl8761b_config.bin',
'sudo cp config/bluetooth/main.conf /etc/bluetooth/main.conf',
# TODO: investigate where to put these services
'sudo cp config/bluetooth/bluealsa.service /lib/systemd/system/',
'sudo cp streams/bluetooth_agent /usr/local/bin/',
'sudo cp config/bluetooth/bluetooth_agent.service /etc/systemd/system/',
# Install SBC
'if ! [ -e /usr/local/lib/libsbc.so.1.3.1 ]',
'then',
'echo Installing SBC...',
'pushd $(mktemp --directory)',
'git clone https://git.kernel.org/pub/scm/bluetooth/sbc.git',
'cd sbc',
'git checkout 8dc5d5ba381512ad5b1afa45c63ec6b0a3833244', # sbc release 2.0
'sudo ./bootstrap-configure',
'sudo ./configure',
'sudo make',
'sudo make install',
'popd',
'else',
'echo SBC already installed, skipping installation.',
'fi',
# Add pi user to bluetooth group so we don't need to run sudo
'sudo usermod -G bluetooth -a pi',
'sudo chmod +x /usr/local/bin/bluetooth_agent',
'sudo systemctl enable bluetooth',
'sudo systemctl enable bluealsa',
'sudo systemctl enable bluetooth_agent',
]
}
}
def _check_and_update_streamer(env):
"""Check if this is a streamer (no preamp firmware)"""
is_streamer_path = os.path.join(env['config_dir'], 'is_streamer')
env['is_streamer'] = os.path.exists(is_streamer_path)
def _check_and_setup_platform(development, ci_mode):
script_dir = os.path.dirname(os.path.realpath(__file__))
env = {
'user': pwd.getpwuid(os.getuid()).pw_name,
'has_apt': False,
'is_git_repo': False,
'platform_supported': False,
'script_dir': script_dir,
'base_dir': script_dir.rsplit('/', 1)[0],
'config_dir': os.path.join(os.path.expanduser('~'), '.config', 'amplipi'),
'is_amplipi': False,
'is_streamer': False,
'arch': 'unknown',
'is_ci': ci_mode,
}
# Get the platform name
# - example pi output: Linux-5.4.51-v7+-armv7l-with-debian-10.4
# - example ubuntu output: Linux-5.4.0-66-generic-x86_64-with-Ubuntu-18.04-bionic
lplatform = platform.platform().lower()
# Figure out what platform we are on since we expect to be on a raspberry pi or a debian based development system
if 'linux' in lplatform:
apt = subprocess.run('which apt-get'.split(), check=True)
if apt:
env['has_apt'] = True
if 'x86_64' in lplatform:
env['arch'] = 'x64'
elif 'armv7l' in lplatform:
env['arch'] = 'arm'
env['is_amplipi'] = 'amplipi' in platform.node() # checks hostname
if env['arch'] == 'x64' and env['has_apt']:
# possibly a development machine running a debian-based distro
env['platform_supported'] = True
if env['arch'] == 'arm' and 'debian' in lplatform:
# possibly a Rasperry Pi running Raspbian
env['platform_supported'] = True
if development:
# We're explicitly overriding any checks here; assume we're supported.
env['platform_supported'] = True
_check_and_update_streamer(env)
return env
class Task:
""" Task runner for scripted installation tasks """
def __init__(self, name: str, args: Optional[List[str]] = None, multiargs=None, output='', success=False, wd=None, shell=False):
# pylint: disable=too-many-arguments
self.name = name
if multiargs:
assert args is None
self.margs = multiargs
elif args is not None:
self.margs = [args]
else:
self.margs = [[]]
self.output = output
self.success = success
self.wd = wd
self.shell = shell
def __str__(self):
desc = f"{self.name} : {self.margs}" if len(
self.margs) > 0 else f"{self.name} :"
for line in self.output.splitlines():
if line:
desc += f'\n {line}'
if not self.success:
desc += '\n Error: Task Failed'
return desc
def run(self):
""" Run the command line task or tasks sequentially and keep track of failures, stops at the first failure"""
for args in self.margs:
out = subprocess.run(args, cwd=self.wd, shell=self.shell, check=False,
stdout=subprocess.PIPE, stderr=subprocess.STDOUT)
self.output += out.stdout.decode()
self.success = out.returncode == 0
if not self.success:
break
return self
def _setup_loopbacks(base_dir) -> List[Task]:
""" Configure ALSA loopbacks using snd_aloop kernel module """
return [Task('copy loopback module configuration', multiargs=[
f'sudo cp {base_dir}/config/modules.conf /etc/modules'.split(),
f'sudo cp {base_dir}/config/sound.conf /etc/modprobe.d/sound.conf'.split(),
]).run()]
def _install_os_deps(env, progress, deps=_os_deps.keys()) -> List[Task]:
def print_progress(tasks):
progress(tasks)
return tasks
tasks = []
# TODO: add extra apt repos
# find latest apt packages. --allow-releaseinfo-change automatically allows the following change:
# Repository 'http://raspbian.raspberrypi.org/raspbian buster InRelease' changed its 'Suite' value from 'stable' to 'oldstable'
tasks += print_progress([Task('get latest debian packages',
'sudo apt-get update --allow-releaseinfo-change'.split()).run()])
# Upgrade current packages
print_progress(
[Task("upgrading debian packages, this will take 10+ minutes", success=True)])
tasks += print_progress([Task('upgrade debian packages',
'sudo apt-get dist-upgrade --assume-yes'.split()).run()])
# organize stuff to install
packages = set()
files = []
scripts: Dict[str, List[str]] = {}
for dep in deps:
install_steps = _os_deps[dep]
if install_steps.get('amplipi_only', False) and not env['is_amplipi']:
continue
if 'copy' in install_steps:
files += install_steps['copy']
if 'apt' in install_steps:
packages.update(install_steps['apt'])
if 'script' in install_steps:
scripts[dep] = install_steps['script']
# copy files
for file in files:
_from = file['from'].replace('ARCH', env['arch'])
_to = file['to']
# prepend home to relative paths
if _from[0] != '/':
_from = f"{env['base_dir']}/{_from}"
if _to[0] != '/':
_to = f"{env['base_dir']}/{_to}"
_sudo = "sudo " if 'sudo' in file else ""
_parent_dir = pathlib.Path(_to).parent
if _sudo or not _parent_dir.exists():
tasks += print_progress([Task(f"creating parent dir(s) for {_from}", f"{_sudo}mkdir -p {_parent_dir}".split()).run()])
tasks += print_progress([Task(f"copy -f {_from} to {_to}", f"{_sudo}cp -f {_from} {_to}".split()).run()]) # shairport needs the -f if it is running
if env['is_amplipi'] or env['is_ci']:
# copy alsa configuration file
_from = f"{env['base_dir']}/config/asound.conf"
_to = "/etc/asound.conf"
tasks += print_progress(
[Task(f"copy {_from} to {_to}", f"sudo cp {_from} {_to}".split()).run()])
# copy boot_config.txt RPi firmware configuration file
_boot_config_from = f"{env['base_dir']}/config/boot_config.txt"
_boot_config_to = "/boot/config.txt"
tasks += print_progress([Task(f"copy {_boot_config_from} to {_boot_config_to}",
f"sudo cp {_boot_config_from} {_boot_config_to}".split()).run()])
# fix usb soundcard name
usb_audio_rule_path = '/etc/udev/rules.d/85-amplipi-usb-audio.rules'
if not os.path.exists(usb_audio_rule_path):
_from = f"{env['base_dir']}/config/85-amplipi-usb-audio.rules"
_to = usb_audio_rule_path
tasks += print_progress([Task('fix usb soundcard id', multiargs=[
# add new rule (udev watches this directory for changes)
f"sudo cp {_from} {_to}".split(),
# trigger an 'add' action on the 'sound' subsystem
'sudo udevadm trigger -s sound -c add'.split(),
# wait for udev rules to fire and settle
'udevadm settle'.split(),
]).run()])
# disable pulseaudio (it was muting some inputs and is not needed)
tasks += print_progress([Task('disable pulseaudio', multiargs=[
'systemctl --user mask pulseaudio.socket'.split(),
'systemctl --user mask pulseaudio.service'.split(),
]).run()])
# serial port permission granting
tasks.append(Task('Check serial permissions', 'groups'.split()).run())
tasks[-1].success = 'pi' in tasks[-1].output
if not tasks[-1].success:
tasks += print_progress([Task("Giving pi serial permission. !!!AmpliPi will need to be restarted after this!!!",
"sudo gpasswd -a pi dialout".split()).run()])
return tasks
# setup tmpfs (ram disk)
tasks += print_progress(_setup_tmpfs(env['config_dir'], env))
# setup crontab - Replace the entire Pi user's crontab with AmpliPi's config/crontab
# and point it to the AmpliPi install location's script directory.
tasks += print_progress([Task("Setting up crontab", [
f"cat {env['base_dir']}/config/crontab | sed 's@SCRIPTS_DIR@{env['base_dir']}/scripts@' | crontab -"], shell=True).run()])
# setup loopbacks
tasks += print_progress(_setup_loopbacks(env['base_dir']))
# install debian packages
tasks += print_progress([Task('install debian packages',
'sudo apt-get install -y'.split() + list(packages)).run()])
# Run scripts
for dep, script in scripts.items():
sh_loc = f'{env["base_dir"]}/install_{dep}.sh'
with open(sh_loc, 'a') as sh:
for scrap in script:
sh.write(scrap + '\n')
shargs = f'bash {sh_loc}'.split()
clean = f'rm {sh_loc}'.split()
tasks += print_progress(
[Task(f'run {dep} install script', args=shargs, wd=env['base_dir']).run()])
tasks += print_progress(
[Task(f'remove {dep} temporary script', args=clean, wd=env['base_dir']).run()])
# cleanup
sp_check_tasks, sp_active = _service_status('shairport-sync', system=True)
tasks += sp_check_tasks
if sp_active:
# shairport-sync install sets up a daemon we need to stop, remove it
tasks += print_progress(_stop_service('shairport-sync', system=True))
tasks += print_progress(_disable_service('shairport-sync', system=True))
return tasks
def _install_python_deps(env: dict, deps: List[str]):
tasks = []
if len(deps) > 0:
last_dir = os.path.abspath(os.curdir)
os.chdir(env['script_dir'])
tasks += [Task('install python packages',
'bash install_python_deps.bash'.split()).run()]
os.chdir(last_dir)
return tasks
def _add_desktop_icon(env, directory: pathlib.Path, name, command) -> Task:
""" Add a desktop icon to the pi """
entry = f"""[Desktop Entry]
Name={name}
Icon=lxterminal
Exec=lxterminal -t "{name}" --working-directory={env["base_dir"]} -e {command}
Type=Application
Terminal=false
Categories=Utility;
"""
success = True
try:
filepath = directory.joinpath(f'{name}.desktop')
with open(f'{filepath}', 'w') as icon:
icon.write(entry)
except Exception:
success = False
return Task(f'Add desktop icon for {name}', success=success)
def _setup_tmpfs(config_dir, env):
""" Adds tmpfs entries used by AmpliPi to /etc/fstab """
# Warning: these hide the existing filesystem,
# if anything is already present at the path created.
tmpfs_opts = 'defaults,noatime,uid=pi,gid=pi,size=100M'
conf_entry = f'amplipi/config {config_dir}/srcs tmpfs {tmpfs_opts} 0 0'
web_entry = f'amplipi/web {config_dir}/web/generated tmpfs {tmpfs_opts} 0 0'
args = [
'sudo sed -i "/^amplipi/d" /etc/fstab',
f'echo {conf_entry} | sudo tee -a /etc/fstab',
f'echo {web_entry} | sudo tee -a /etc/fstab',
f'mkdir -p {config_dir}/srcs {config_dir}/web/generated',
]
if not env['is_ci']:
args.append(f'sudo mount -a')
tasks = [Task('Add tmpfs entries to fstab.', multiargs=args, shell=True).run()]
return tasks
def _web_service(directory: str):
return f"""\
[Unit]
Description=Amplipi Home Audio System
After=network.target
[Service]
Type=simple
WorkingDirectory={directory}
ExecStart=/usr/bin/authbind --deep {directory}/venv/bin/python -m uvicorn --host 0.0.0.0 --port 80 amplipi.asgi:application
Restart=always
[Install]
WantedBy=default.target
"""
def _tasks_service(directory: str):
return f"""\
[Unit]
Description=AmpliPi Background Tasks
After=redis-server.service
[Service]
Type=simple
WorkingDirectory={directory}
ExecStart={directory}/venv/bin/python -m celery -A amplipi.tasks worker
Restart=always
[Install]
WantedBy=default.target
"""
def _update_service(directory: str, port: int = 5001):
return f"""\
[Unit]
Description=Amplipi Software Updater
After=network.target
[Service]
Type=simple
WorkingDirectory={directory}
ExecStart={directory}/venv/bin/python -m uvicorn amplipi.updater.asgi:app --host 0.0.0.0 --port {port}
Restart=on-abort
[Install]
WantedBy=default.target
"""
def _display_service(directory: str):
return f"""\
[Unit]
Description=Amplipi Front Panel Display
[Service]
Type=simple
WorkingDirectory={directory}
ExecStart={directory}/venv/bin/python -m amplipi.display.display
Restart=on-abort
[Install]
WantedBy=default.target
"""
def _audiodetector_service(base_dir: str, config_dir: str):
return f"""\
[Unit]
Description=Amplipi RCA Input Audio Detector
ConditionPathExists=!/home/pi/.config/amplipi/is_streamer
[Service]
Type=simple
WorkingDirectory={config_dir}/srcs
ExecStart={base_dir}/amplipi/audiodetector/audiodetector
Restart=on-failure
RestartSec=10
[Install]
WantedBy=default.target
"""
def systemctl_cmd(system: bool) -> str:
""" Get the relevant systemctl command based on @system {True: system, False: user} """
if system:
return 'sudo systemctl'
# user
return 'systemctl --user'
def _service_status(service: str, system: bool = False) -> Tuple[List[Task], bool]:
# Status can be: active, reloading, inactive, failed, activating, or deactivating
cmd = f'{systemctl_cmd(system)} is-active {service}'
tasks = [Task(f'Check {service} status', cmd.split()).run()]
# The exit code reflects the status of the service, not the command itself.
# Just assume the command was run successfully.
tasks[0].success = True
active = 'active' in tasks[0].output and 'inactive' not in tasks[0].output
return (tasks, active)
# Stop a systemd service. By default use the Session (user) session
def _stop_service(name: str, system: bool = False) -> List[Task]:
service = f'{name}.service'
tasks, running = _service_status(service, system)
if running:
cmd = f'{systemctl_cmd(system)} stop {service}'
tasks.append(Task(f'Stop {service}', cmd.split()).run())
return tasks
def _remove_service(name: str) -> List[Task]:
filename = f'{name}.service'
directory = pathlib.Path.home().joinpath('.config/systemd/user')
tasks = [Task(f'Remove {filename}')]
try:
# Delete the service file
pathlib.Path(directory).joinpath(filename).unlink()
tasks[0].output = f'Removed {filename}'
tasks[0].success = True
except Exception as exc:
tasks[0].output = str(exc)
tasks[0].success = False
return tasks
def _enable_service(name: str, system: bool = False) -> List[Task]:
service = f'{name}.service'
cmd = f'{systemctl_cmd(system)} enable {service}'
tasks = [Task(f'Enable {service}', cmd.split()).run()]
return tasks
def _disable_service(name: str, system: bool = False) -> List[Task]:
service = f'{name}.service'
cmd = f'{systemctl_cmd(system)} disable {service}'
tasks = [Task(f'Disable {service}', cmd.split()).run()]
return tasks
def _start_restart_service(name: str, restart: bool, test_url: Union[None, str] = None) -> List[Task]:
service = f'{name}.service'
if restart:
tasks = [
Task(f'Restart {service}', f'systemctl --user restart {service}'.split()).run()]
else:
# just start
tasks = [
Task(f'Start {service}', f'systemctl --user start {service}'.split()).run()]
# wait a bit, so initial failures are detected before is-active is called
if tasks[-1].success:
# we need to check if the service is running
for _ in range(50): # retry for 10 seconds, giving the service time to start
task_check, running = _service_status(service)
if running:
break
time.sleep(0.2)
tasks += task_check
if test_url and running:
task = None
for _ in range(60): # retry for 30 seconds, giving the server time to start
task = _check_url(test_url)
if task.success:
break
time.sleep(0.5)
tasks.append(task)
elif name == 'amplipi':
tasks[-1].output += "\ntry checking this service failure using 'scripts/run_debug_webserver' on the system"
tasks.append(Task(
f'Check {service} Status', f'systemctl --user status {service}'.split()).run())
elif 'amplipi-updater' in name:
tasks[-1].output += "\ntry debugging this service failure using 'scripts/run_debug_updater' on the system"
tasks.append(Task(
f'Check {service} Status', f'systemctl --user status {service}'.split()).run())
return tasks
def _start_service(name: str, test_url: Union[None, str] = None) -> List[Task]:
return _start_restart_service(name, restart=False, test_url=test_url)
def _restart_service(name: str, test_url: Union[None, str] = None) -> List[Task]:
return _start_restart_service(name, restart=True, test_url=test_url)
def _create_dir(directory: str) -> List[Task]:
tasks = [Task(f'Create directory {directory}')]
path = pathlib.Path(directory)
if path.exists():
tasks[-1].success = True
tasks[-1].output = f'Directory {directory} already exists'
else:
try:
path.mkdir(parents=True)
tasks[-1].success = True
tasks[-1].output = f'Created {directory}'
except:
tasks[-1].output = f'Failed to create {directory}'
return tasks
def _create_service(name: str, config: str, env: dict) -> List[Task]:
filename = f'{name}.service'
directory = pathlib.Path.home().joinpath('.config/systemd/user')
tasks = []
# create the systemd directory if it doesn't already exist
tasks += _create_dir(str(directory))
# create the service file, overwriting any existing one
tasks.append(Task(f'Create {filename}'))
try:
with directory.joinpath(filename).open('w+') as svc_file:
svc_file.write(config)
tasks[-1].success = True
tasks[-1].output = f'Created {filename}'
except:
tasks[-1].output = f'Failed to create {filename}'
if not env['is_ci']:
# recreate systemd's dependency tree
tasks.append(Task('Reload systemd config', 'systemctl --user daemon-reload'.split()).run())
return tasks
PORT_FILE = '/etc/authbind/byport/80'
def _configure_authbind() -> List[Task]:
""" Configure access to port 80 so we can run amplipi as a non-root user
Executes the following commands
sudo touch /etc/authbind/byport/80
sudo chmod 777 /etc/authbind/byport/80
"""
tasks = []
if not os.path.exists(PORT_FILE):
tasks.append(Task('Setup autobind', multiargs=[
f'sudo touch {PORT_FILE}'.split(),
f'sudo chmod 777 {PORT_FILE}'.split()
]).run())
elif os.stat(PORT_FILE).st_mode != 0o1000777:
tasks.append(
Task('Setup autobind', f'sudo chmod 777 {PORT_FILE}'.split()).run())
return tasks
# Enable linger so that user manager is started at boot
def _enable_linger(user: str, env) -> List[Task]:
if env['is_ci']:
# https://unix.stackexchange.com/a/721463
margs = [
'sudo mkdir -p /var/lib/systemd/linger'.split(),
f'sudo touch /var/lib/systemd/linger/{user}'.split()
]
else:
margs = [f'sudo loginctl enable-linger {user}'.split()]
return [Task(f'Enable linger for {user} user', multiargs=margs).run()]
def _api_key() -> Optional[str]:
""" Get a singular API key for use with the updater """
user_file_path = os.path.join(os.path.expanduser('~'), '.config', 'amplipi', 'users.json')
try:
with open(user_file_path, encoding='utf-8') as user_file:
users = json.load(user_file)
for user, config in users.items():
if "access_key" in config:
return config["access_key"]
except Exception as e:
# This is a little wholesale, but there is the case where a users file doesn't exist.
# Additionally, we do not want to print any sensitive information to the console; we
# simply bail.
return None
return None
def _copy_old_config(dest_dir: str) -> Task:
# try to copy the config of the current running amplipi service into dest_dir/house.json
# success is desirable, but not strictly required since the config will be generated from defaults if missing.
# This helps us tolerate a changing `dest_dir`, but there's a good chance the service will write-back
# its config to this location too.
task = Task("Write running config to disk")
url = "http://localhost/api"
key = _api_key()
if key:
url += f'?api-key={key}'
try:
req = requests.get(url)
if req.ok:
with open(f'{dest_dir}/house.json', 'wb') as f:
f.write(req.content)
task.output += "\nOk!"
task.success = True
except Exception as e:
task.output += f"\nError: {e}"
task.output += f"\nContinuing anyways, in case this current install is broken and needs an upgrade."
task.success = True
return task
def _create_backup(env, suffix: str = "") -> List[Task]:
task = Task('Take a configuration backup', f"{env['base_dir']}/scripts/backup_config.sh {suffix}".split())
task.run()
# Everything that consumes this wants a List, so let's give 'em a list.
return [task]
def _check_url(url) -> Task:
task = Task(f'Check url {url}')
key = _api_key()
if key:
task.name += " (with api key)"
url += f'?api-key={key}'
try:
req = requests.get(url)
if req.ok:
task.output += "\nOk!"
task.success = True
else:
task.output += f"\nError: {req.reason}"
except:
task.output = 'Failed to check url, this happens when the server is offline'
return task
def _check_version(url) -> Task:
task = Task('Checking version reported by API')
task.output = f'\nusing: {url}'
key = _api_key()
if key:
url += f"?api-key={key}"
task.output += " (with api key)"
try:
req = requests.get(url)
if req.ok:
reported_version = req.json()['info']['version']
task.success = True
task.output += f'\nversion={reported_version}'
except Exception:
task.output = 'Failed checking version'
return task
def _update_web(env: dict, restart_updater: bool, progress) -> List[Task]:
def print_progress(tasks):
progress(tasks)
return tasks
tasks = []
if not env['is_ci']:
# try to copy the old config into the potentially new directory
# This fixes some potential update issues caused by migrating install to a different directory
# (using the web updated the install dir used to be amplipi-dev2 and is now amplipi-dev)
tasks += print_progress([_copy_old_config(env['config_dir'])])