commit 2c063819078b1fc98efd1efec68d57aa495f579b · pyrox.dev/nixpkgs

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

···

       133
       133
        
       

     

       134
       134
        
       - [`services.victorialogs.package`](#opt-services.victorialogs.package) now defaults to `victorialogs`, as `victoriametrics` no longer contains the VictoriaLogs binaries.

     

       135
       135
        
       

     

       136
       136
       +
       - The `services.traccar.settings` attribute has been reworked. Instead of the previous flat attribute set the new implementation uses nested attribute sets. You need to update you configuration manually. For instance, `services.traccar.settings.loggerConsole` becomes `services.traccar.settings.logger.console`.

     

       137
       137
       +
       

     

       136
       138
        
       - The `wstunnel` module was converted to RFC42-style settings, you will need to update your NixOS config if you make use of this module.

     

       137
       139
        
       

     

       138
       140
        
       - [private-gpt](https://github.com/zylon-ai/private-gpt) service has been removed by lack of maintenance upstream.

+37 -19

nixos/modules/services/monitoring/traccar.nix

···

       8
       8
        
         cfg = config.services.traccar;

     

       9
       9
        
         stateDirectory = "/var/lib/traccar";

     

       10
       10
        
         configFilePath = "${stateDirectory}/config.xml";

     

       11
       11
       -
         expandCamelCase = lib.replaceStrings lib.upperChars (map (s: ".${s}") lib.lowerChars);

     

       12
       12
       -
         mkConfigEntry = key: value: "<entry key='${expandCamelCase key}'>${value}</entry>";

     

       11
       11
       +
       

     

       12
       12
       +
         # Map leafs to XML <entry> elements as expected by traccar, using

     

       13
       13
       +
         # dot-separated keys for nested attribute paths.

     

       14
       14
       +
         mapLeafs = lib.mapAttrsRecursive (

     

       15
       15
       +
           path: value: "<entry key='${lib.concatStringsSep "." path}'>${value}</entry>"

     

       16
       16
       +
         );

     

       17
       17
       +
       

     

       18
       18
       +
         mkConfigEntry = config: lib.collect builtins.isString (mapLeafs config);

     

       19
       19
       +
       

     

       13
       20
        
         mkConfig =

     

       14
       21
        
           configurationOptions:

     

       15
       22
        
           pkgs.writeText "traccar.xml" ''

     

       16
       23
        
             <?xml version='1.0' encoding='UTF-8'?>

     

       17
       24
        
             <!DOCTYPE properties SYSTEM 'http://java.sun.com/dtd/properties.dtd'>

     

       18
       25
        
             <properties>

     

       19
       19
       -
                 ${builtins.concatStringsSep "\n" (lib.mapAttrsToList mkConfigEntry configurationOptions)}

     

       26
       26
       +
                 ${builtins.concatStringsSep "\n" (mkConfigEntry configurationOptions)}

     

       20
       27
        
             </properties>

     

       21
       28
        
           '';

     

       22
       29
        
       

     

       23
       30
        
         defaultConfig = {

     

       24
       24
       -
           databaseDriver = "org.h2.Driver";

     

       25
       25
       -
           databasePassword = "";

     

       26
       26
       -
           databaseUrl = "jdbc:h2:${stateDirectory}/traccar";

     

       27
       27
       -
           databaseUser = "sa";

     

       28
       28
       -
           loggerConsole = "true";

     

       29
       29
       -
           mediaPath = "${stateDirectory}/media";

     

       30
       30
       -
           templatesRoot = "${stateDirectory}/templates";

     

       31
       31
       +
           database = {

     

       32
       32
       +
             driver = "org.h2.Driver";

     

       33
       33
       +
             password = "";

     

       34
       34
       +
             url = "jdbc:h2:${stateDirectory}/traccar";

     

       35
       35
       +
             user = "sa";

     

       36
       36
       +
           };

     

       37
       37
       +
           logger.console = "true";

     

       38
       38
       +
           media.path = "${stateDirectory}/media";

     

       39
       39
       +
           templates.root = "${stateDirectory}/templates";

     

       31
       40
        
         };

     

       41
       41
       +
       

     

       32
       42
        
       in

     

       33
       43
        
       {

     

       34
       44
        
         options.services.traccar = {

     

       35
       45
        
           enable = lib.mkEnableOption "Traccar, an open source GPS tracking system";

     

       46
       46
       +
           settingsFile = lib.mkOption {

     

       47
       47
       +
             type = with lib.types; nullOr path;

     

       48
       48
       +
             default = null;

     

       49
       49
       +
             description = ''

     

       50
       50
       +
               File used as configuration for traccar. When specified, {option}`settings` is ignored.

     

       51
       51
       +
             '';

     

       52
       52
       +
           };

     

       36
       53
        
           settings = lib.mkOption {

     

       37
       54
        
             apply = lib.recursiveUpdate defaultConfig;

     

       38
       55
        
             default = defaultConfig;

     

       39
       56
        
             description = ''

     

       40
       57
        
               {file}`config.xml` configuration as a Nix attribute set.

     

       41
       41
       -
               Attribute names are translated from camelCase to dot-separated strings. For instance:

     

       42
       42
       -
               {option}`mailSmtpPort = "25"`

     

       43
       43
       -
               would result in the following configuration property:

     

       58
       58
       +
               This option is ignored if `settingsFile` is set.

     

       59
       59
       +
       

     

       60
       60
       +
               Nested attributes get translated to a properties entry in the traccar configuration.

     

       61
       61
       +
               For instance: `mail.smtp.port = "25"` results in the following entry:

     

       44
       62
        
               `<entry key='mail.smtp.port'>25</entry>`

     

       45
       45
       -
               Configuration options should match those described in

     

       46
       46
       -
               [Traccar - Configuration File](https://www.traccar.org/configuration-file/).

     

       47
       47
       -
               Secret tokens should be specified using {option}`environmentFile`

     

       63
       63
       +
       

     

       64
       64
       +
               Secrets should be specified using {option}`environmentFile`

     

       48
       65
        
               instead of this world-readable attribute set.

     

       66
       66
       +
               [Traccar - Configuration File](https://www.traccar.org/configuration-file/).

     

       49
       67
        
             '';

     

       50
       68
        
           };

     

       51
       69
        
           environmentFile = lib.mkOption {

     
···

       56
       74
        
       

     

       57
       75
        
               Can be used for storing the secrets without making them available in the world-readable Nix store.

     

       58
       76
        
       

     

       59
       59
       -
               For example, you can set {option}`services.traccar.settings.databasePassword = "$TRACCAR_DB_PASSWORD"`

     

       77
       77
       +
               For example, you can set {option}`services.traccar.settings.database.password = "$TRACCAR_DB_PASSWORD"`

     

       60
       78
        
               and then specify `TRACCAR_DB_PASSWORD="<secret>"` in the environment file.

     

       61
       79
        
               This value will get substituted in the configuration file.

     

       62
       80
        
             '';

     
···

       65
       83
        
       

     

       66
       84
        
         config =

     

       67
       85
        
           let

     

       68
       68
       -
             configuration = mkConfig cfg.settings;

     

       86
       86
       +
             configuration = if cfg.settingsFile != null then cfg.settingsFile else mkConfig cfg.settings;

     

       69
       87
        
           in

     

       70
       88
        
           lib.mkIf cfg.enable {

     

       71
       89
        
             systemd.services.traccar = {

     
···

       92
       110
        
       

     

       93
       111
        
               serviceConfig = {

     

       94
       112
        
                 DynamicUser = true;

     

       95
       95
       -
                 EnvironmentFile = cfg.environmentFile;

     

       113
       113
       +
                 EnvironmentFile = lib.mkIf (cfg.environmentFile != null) cfg.environmentFile;

     

       96
       114
        
                 ExecStart = "${lib.getExe pkgs.traccar} ${configFilePath}";

     

       97
       115
        
                 LockPersonality = true;

     

       98
       116
        
                 NoNewPrivileges = true;