commit 95856e526efd96e33cc021eb939e0529a0caa74d · pyrox.dev/nixpkgs

nixos/doc/manual/release-notes/rl-2311.section.md

···

       76
       76
        
       

     

       77
       77
        
       - [Jool](https://nicmx.github.io/Jool/en/index.html), a kernelspace NAT64 and SIIT implementation, providing translation between IPv4 and IPv6. Available as [networking.jool.enable](#opt-networking.jool.enable).

     

       78
       78
        
       

     

       79
       79
       +
       - [Home Assistant Satellite], a streaming audio satellite for Home Assistant voice pipelines, where you can reuse existing mic/speaker hardware. Available as [services.homeassistant-satellite](#opt-services.homeassistant-satellite.enable).

     

       80
       80
       +
       

     

       79
       81
        
       - [Apache Guacamole](https://guacamole.apache.org/), a cross-platform, clientless remote desktop gateway. Available as [services.guacamole-server](#opt-services.guacamole-server.enable) and [services.guacamole-client](#opt-services.guacamole-client.enable) services.

     

       80
       82
        
       

     

       81
       83
        
       - [pgBouncer](https://www.pgbouncer.org), a PostgreSQL connection pooler. Available as [services.pgbouncer](#opt-services.pgbouncer.enable).

nixos/modules/module-list.nix

···

       556
       556
        
         ./services/home-automation/esphome.nix

     

       557
       557
        
         ./services/home-automation/evcc.nix

     

       558
       558
        
         ./services/home-automation/home-assistant.nix

     

       559
       559
       +
         ./services/home-automation/homeassistant-satellite.nix

     

       559
       560
        
         ./services/home-automation/zigbee2mqtt.nix

     

       560
       561
        
         ./services/logging/SystemdJournal2Gelf.nix

     

       561
       562
        
         ./services/logging/awstats.nix

+225

nixos/modules/services/home-automation/homeassistant-satellite.nix

···

       1
       1
       +
       { config

     

       2
       2
       +
       , lib

     

       3
       3
       +
       , pkgs

     

       4
       4
       +
       , ...

     

       5
       5
       +
       }:

     

       6
       6
       +
       

     

       7
       7
       +
       let

     

       8
       8
       +
         cfg = config.services.homeassistant-satellite;

     

       9
       9
       +
       

     

       10
       10
       +
         inherit (lib)

     

       11
       11
       +
           escapeShellArg

     

       12
       12
       +
           escapeShellArgs

     

       13
       13
       +
           mkOption

     

       14
       14
       +
           mdDoc

     

       15
       15
       +
           mkEnableOption

     

       16
       16
       +
           mkIf

     

       17
       17
       +
           mkPackageOptionMD

     

       18
       18
       +
           types

     

       19
       19
       +
           ;

     

       20
       20
       +
       

     

       21
       21
       +
         inherit (builtins)

     

       22
       22
       +
           toString

     

       23
       23
       +
           ;

     

       24
       24
       +
       

     

       25
       25
       +
         # override the package with the relevant vad dependencies

     

       26
       26
       +
         package = cfg.package.overridePythonAttrs (oldAttrs: {

     

       27
       27
       +
           propagatedBuildInputs = oldAttrs.propagatedBuildInputs

     

       28
       28
       +
             ++ lib.optional (cfg.vad == "webrtcvad") cfg.package.optional-dependencies.webrtc

     

       29
       29
       +
             ++ lib.optional (cfg.vad == "silero") cfg.package.optional-dependencies.silerovad

     

       30
       30
       +
             ++ lib.optional (cfg.pulseaudio.enable) cfg.package.optional-dependencies.pulseaudio;

     

       31
       31
       +
         });

     

       32
       32
       +
       

     

       33
       33
       +
       in

     

       34
       34
       +
       

     

       35
       35
       +
       {

     

       36
       36
       +
         meta.buildDocsInSandbox = false;

     

       37
       37
       +
       

     

       38
       38
       +
         options.services.homeassistant-satellite = with types; {

     

       39
       39
       +
           enable = mkEnableOption (mdDoc "Home Assistant Satellite");

     

       40
       40
       +
       

     

       41
       41
       +
           package = mkPackageOptionMD pkgs "homeassistant-satellite" { };

     

       42
       42
       +
       

     

       43
       43
       +
           user = mkOption {

     

       44
       44
       +
             type = str;

     

       45
       45
       +
             example = "alice";

     

       46
       46
       +
             description = mdDoc ''

     

       47
       47
       +
               User to run homeassistant-satellite under.

     

       48
       48
       +
             '';

     

       49
       49
       +
           };

     

       50
       50
       +
       

     

       51
       51
       +
           group = mkOption {

     

       52
       52
       +
             type = str;

     

       53
       53
       +
             default = "users";

     

       54
       54
       +
             description = mdDoc ''

     

       55
       55
       +
               Group to run homeassistant-satellite under.

     

       56
       56
       +
             '';

     

       57
       57
       +
           };

     

       58
       58
       +
       

     

       59
       59
       +
           host = mkOption {

     

       60
       60
       +
             type = str;

     

       61
       61
       +
             example = "home-assistant.local";

     

       62
       62
       +
             description = mdDoc ''

     

       63
       63
       +
               Hostname on which your Home Assistant instance can be reached.

     

       64
       64
       +
             '';

     

       65
       65
       +
           };

     

       66
       66
       +
       

     

       67
       67
       +
           port = mkOption {

     

       68
       68
       +
             type = port;

     

       69
       69
       +
             example = 8123;

     

       70
       70
       +
             description = mdDoc ''

     

       71
       71
       +
               Port on which your Home Assistance can be reached.

     

       72
       72
       +
             '';

     

       73
       73
       +
             apply = toString;

     

       74
       74
       +
           };

     

       75
       75
       +
       

     

       76
       76
       +
           protocol = mkOption {

     

       77
       77
       +
             type = enum [ "http" "https" ];

     

       78
       78
       +
             default = "http";

     

       79
       79
       +
             example = "https";

     

       80
       80
       +
             description = mdDoc ''

     

       81
       81
       +
               The transport protocol used to connect to Home Assistant.

     

       82
       82
       +
             '';

     

       83
       83
       +
           };

     

       84
       84
       +
       

     

       85
       85
       +
           tokenFile = mkOption {

     

       86
       86
       +
             type = path;

     

       87
       87
       +
             example = "/run/keys/hass-token";

     

       88
       88
       +
             description = mdDoc ''

     

       89
       89
       +
               Path to a file containing a long-lived access token for your Home Assistant instance.

     

       90
       90
       +
             '';

     

       91
       91
       +
             apply = escapeShellArg;

     

       92
       92
       +
           };

     

       93
       93
       +
       

     

       94
       94
       +
           sounds = {

     

       95
       95
       +
             awake = mkOption {

     

       96
       96
       +
               type = nullOr str;

     

       97
       97
       +
               default = null;

     

       98
       98
       +
               description = mdDoc ''

     

       99
       99
       +
                 Audio file to play when the wake word is detected.

     

       100
       100
       +
               '';

     

       101
       101
       +
             };

     

       102
       102
       +
       

     

       103
       103
       +
             done = mkOption {

     

       104
       104
       +
               type = nullOr str;

     

       105
       105
       +
               default = null;

     

       106
       106
       +
               description = mdDoc ''

     

       107
       107
       +
                 Audio file to play when the voice command is done.

     

       108
       108
       +
               '';

     

       109
       109
       +
             };

     

       110
       110
       +
           };

     

       111
       111
       +
       

     

       112
       112
       +
           vad = mkOption {

     

       113
       113
       +
             type = enum [ "disabled" "webrtcvad" "silero" ];

     

       114
       114
       +
             default = "disabled";

     

       115
       115
       +
             example = "silero";

     

       116
       116
       +
             description = mdDoc ''

     

       117
       117
       +
               Voice activity detection model. With `disabled` sound will be transmitted continously.

     

       118
       118
       +
             '';

     

       119
       119
       +
           };

     

       120
       120
       +
       

     

       121
       121
       +
           pulseaudio = {

     

       122
       122
       +
             enable = mkEnableOption "recording/playback via PulseAudio or PipeWire";

     

       123
       123
       +
       

     

       124
       124
       +
             socket = mkOption {

     

       125
       125
       +
               type = nullOr str;

     

       126
       126
       +
               default = null;

     

       127
       127
       +
               example = "/run/user/1000/pulse/native";

     

       128
       128
       +
               description = mdDoc ''

     

       129
       129
       +
                 Path or hostname to connect with the PulseAudio server.

     

       130
       130
       +
               '';

     

       131
       131
       +
             };

     

       132
       132
       +
       

     

       133
       133
       +
             duckingVolume = mkOption {

     

       134
       134
       +
               type = nullOr float;

     

       135
       135
       +
               default = null;

     

       136
       136
       +
               example = 0.4;

     

       137
       137
       +
               description = mdDoc ''

     

       138
       138
       +
                 Reduce output volume (between 0 and 1) to this percentage value while recording.

     

       139
       139
       +
               '';

     

       140
       140
       +
             };

     

       141
       141
       +
       

     

       142
       142
       +
             echoCancellation = mkEnableOption "acoustic echo cancellation";

     

       143
       143
       +
           };

     

       144
       144
       +
       

     

       145
       145
       +
           extraArgs = mkOption {

     

       146
       146
       +
             type = listOf str;

     

       147
       147
       +
             default = [ ];

     

       148
       148
       +
             description = mdDoc ''

     

       149
       149
       +
               Extra arguments to pass to the commandline.

     

       150
       150
       +
             '';

     

       151
       151
       +
             apply = escapeShellArgs;

     

       152
       152
       +
           };

     

       153
       153
       +
         };

     

       154
       154
       +
       

     

       155
       155
       +
         config = mkIf cfg.enable {

     

       156
       156
       +
           systemd.services."homeassistant-satellite" = {

     

       157
       157
       +
             description = "Home Assistant Satellite";

     

       158
       158
       +
             after = [

     

       159
       159
       +
               "network-online.target"

     

       160
       160
       +
             ];

     

       161
       161
       +
             wants = [

     

       162
       162
       +
               "network-online.target"

     

       163
       163
       +
             ];

     

       164
       164
       +
             wantedBy = [

     

       165
       165
       +
               "multi-user.target"

     

       166
       166
       +
             ];

     

       167
       167
       +
             path = with pkgs; [

     

       168
       168
       +
               ffmpeg-headless

     

       169
       169
       +
             ] ++ lib.optionals (!cfg.pulseaudio.enable) [

     

       170
       170
       +
               alsa-utils

     

       171
       171
       +
             ];

     

       172
       172
       +
             serviceConfig = {

     

       173
       173
       +
               User = cfg.user;

     

       174
       174
       +
               Group = cfg.group;

     

       175
       175
       +
               # https://github.com/rhasspy/hassio-addons/blob/master/assist_microphone/rootfs/etc/s6-overlay/s6-rc.d/assist_microphone/run

     

       176
       176
       +
               ExecStart = ''

     

       177
       177
       +
                 ${package}/bin/homeassistant-satellite \

     

       178
       178
       +
                   --host ${cfg.host} \

     

       179
       179
       +
                   --port ${cfg.port} \

     

       180
       180
       +
                   --protocol ${cfg.protocol} \

     

       181
       181
       +
                   --token-file ${cfg.tokenFile} \

     

       182
       182
       +
                   --vad ${cfg.vad} \

     

       183
       183
       +
                   ${lib.optionalString cfg.pulseaudio.enable "--pulseaudio"}${lib.optionalString (cfg.pulseaudio.socket != null) "=${cfg.pulseaudio.socket}"} \

     

       184
       184
       +
                   ${lib.optionalString (cfg.pulseaudio.enable && cfg.pulseaudio.duckingVolume != null) "--ducking-volume=${toString cfg.pulseaudio.duckingVolume}"} \

     

       185
       185
       +
                   ${lib.optionalString (cfg.pulseaudio.enable && cfg.pulseaudio.echoCancellation) "--echo-cancel"} \

     

       186
       186
       +
                   ${lib.optionalString (cfg.sounds.awake != null) "--awake-sound=${toString cfg.sounds.awake}"} \

     

       187
       187
       +
                   ${lib.optionalString (cfg.sounds.done != null) "--done-sound=${toString cfg.sounds.done}"} \

     

       188
       188
       +
                   ${cfg.extraArgs}

     

       189
       189
       +
               '';

     

       190
       190
       +
               CapabilityBoundingSet = "";

     

       191
       191
       +
               DeviceAllow = "";

     

       192
       192
       +
               DevicePolicy = "closed";

     

       193
       193
       +
               LockPersonality = true;

     

       194
       194
       +
               MemoryDenyWriteExecute = false; # onnxruntime/capi/onnxruntime_pybind11_state.so: cannot enable executable stack as shared object requires: Operation not permitted

     

       195
       195
       +
               PrivateDevices = true;

     

       196
       196
       +
               PrivateUsers = true;

     

       197
       197
       +
               ProtectHome = false; # Would deny access to local pulse/pipewire server

     

       198
       198
       +
               ProtectHostname = true;

     

       199
       199
       +
               ProtectKernelLogs = true;

     

       200
       200
       +
               ProtectKernelModules = true;

     

       201
       201
       +
               ProtectKernelTunables = true;

     

       202
       202
       +
               ProtectControlGroups = true;

     

       203
       203
       +
               ProtectProc = "invisible";

     

       204
       204
       +
               ProcSubset = "all"; # Error in cpuinfo: failed to parse processor information from /proc/cpuinfo

     

       205
       205
       +
               Restart = "always";

     

       206
       206
       +
               RestrictAddressFamilies = [

     

       207
       207
       +
                 "AF_INET"

     

       208
       208
       +
                 "AF_INET6"

     

       209
       209
       +
                 "AF_UNIX"

     

       210
       210
       +
               ];

     

       211
       211
       +
               RestrictNamespaces = true;

     

       212
       212
       +
               RestrictRealtime = true;

     

       213
       213
       +
               SupplementaryGroups = [

     

       214
       214
       +
                 "audio"

     

       215
       215
       +
               ];

     

       216
       216
       +
               SystemCallArchitectures = "native";

     

       217
       217
       +
               SystemCallFilter = [

     

       218
       218
       +
                 "@system-service"

     

       219
       219
       +
                 "~@privileged"

     

       220
       220
       +
               ];

     

       221
       221
       +
               UMask = "0077";

     

       222
       222
       +
             };

     

       223
       223
       +
           };

     

       224
       224
       +
         };

     

       225
       225
       +
       }