commit 9293bc7d55ae3faa43ca97f7bd4225ef688022fd · pyrox.dev/nixpkgs

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

···

       16
       16
        
       

     

       17
       17
        
       - [Omnom](https://github.com/asciimoo/omnom), a webpage bookmarking and snapshotting service. Available as [services.omnom](options.html#opt-services.omnom.enable).

     

       18
       18
        
       

     

       19
       19
       +
       - [Traccar](https://www.traccar.org/), a modern GPS Tracking Platform. Available as [services.traccar](#opt-services.traccar.enable).

     

       20
       20
       +
       

     

       19
       21
        
       - [Amazon CloudWatch Agent](https://github.com/aws/amazon-cloudwatch-agent), the official telemetry collector for AWS CloudWatch and AWS X-Ray. Available as [services.amazon-cloudwatch-agent](#opt-services.amazon-cloudwatch-agent.enable).

     

       20
       22
        
       

     

       21
       23
        
       - [agorakit](https://github.com/agorakit/agorakit), an organization tool for citizens' collectives. Available with [services.agorakit](#opt-services.agorakit.enable).

nixos/modules/module-list.nix

···

       947
       947
        
         ./services/monitoring/telegraf.nix

     

       948
       948
        
         ./services/monitoring/thanos.nix

     

       949
       949
        
         ./services/monitoring/todesk.nix

     

       950
       950
       +
         ./services/monitoring/traccar.nix

     

       950
       951
        
         ./services/monitoring/tremor-rs.nix

     

       951
       952
        
         ./services/monitoring/tuptime.nix

     

       952
       953
        
         ./services/monitoring/unpoller.nix

+125

nixos/modules/services/monitoring/traccar.nix

···

       1
       1
       +
       {

     

       2
       2
       +
         config,

     

       3
       3
       +
         lib,

     

       4
       4
       +
         pkgs,

     

       5
       5
       +
         ...

     

       6
       6
       +
       }:

     

       7
       7
       +
       let

     

       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>";

     

       13
       13
       +
         mkConfig =

     

       14
       14
       +
           configurationOptions:

     

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

     

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

     

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

     

       18
       18
       +
             <properties>

     

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

     

       20
       20
       +
             </properties>

     

       21
       21
       +
           '';

     

       22
       22
       +
       

     

       23
       23
       +
         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
       +
         };

     

       32
       32
       +
       in

     

       33
       33
       +
       {

     

       34
       34
       +
         options.services.traccar = {

     

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

     

       36
       36
       +
           settings = lib.mkOption {

     

       37
       37
       +
             apply = lib.recursiveUpdate defaultConfig;

     

       38
       38
       +
             default = defaultConfig;

     

       39
       39
       +
             description = ''

     

       40
       40
       +
               {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:

     

       44
       44
       +
               `<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`

     

       48
       48
       +
               instead of this world-readable attribute set.

     

       49
       49
       +
             '';

     

       50
       50
       +
           };

     

       51
       51
       +
           environmentFile = lib.mkOption {

     

       52
       52
       +
             type = lib.types.nullOr lib.types.path;

     

       53
       53
       +
             default = null;

     

       54
       54
       +
             description = ''

     

       55
       55
       +
               File containing environment variables to substitute in the configuration before starting Traccar.

     

       56
       56
       +
       

     

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

     

       58
       58
       +
       

     

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

     

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

     

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

     

       62
       62
       +
             '';

     

       63
       63
       +
           };

     

       64
       64
       +
         };

     

       65
       65
       +
       

     

       66
       66
       +
         config =

     

       67
       67
       +
           let

     

       68
       68
       +
             configuration = mkConfig cfg.settings;

     

       69
       69
       +
           in

     

       70
       70
       +
           lib.mkIf cfg.enable {

     

       71
       71
       +
             systemd.services.traccar = {

     

       72
       72
       +
               enable = true;

     

       73
       73
       +
               description = "Traccar";

     

       74
       74
       +
       

     

       75
       75
       +
               after = [ "network-online.target" ];

     

       76
       76
       +
               wantedBy = [ "multi-user.target" ];

     

       77
       77
       +
               wants = [ "network-online.target" ];

     

       78
       78
       +
       

     

       79
       79
       +
               preStart = ''

     

       80
       80
       +
                 # Copy new templates into our state directory.

     

       81
       81
       +
                 cp -a --update=none ${pkgs.traccar}/templates ${stateDirectory}

     

       82
       82
       +
                 test -f '${configFilePath}' && rm -f '${configFilePath}'

     

       83
       83
       +
       

     

       84
       84
       +
                 # Substitute the configFile from Envvars read from EnvironmentFile

     

       85
       85
       +
                 old_umask=$(umask)

     

       86
       86
       +
                 umask 0177

     

       87
       87
       +
                 ${lib.getExe pkgs.envsubst} \

     

       88
       88
       +
                   -i ${configuration} \

     

       89
       89
       +
                   -o ${configFilePath}

     

       90
       90
       +
                 umask $old_umask

     

       91
       91
       +
               '';

     

       92
       92
       +
       

     

       93
       93
       +
               serviceConfig = {

     

       94
       94
       +
                 DynamicUser = true;

     

       95
       95
       +
                 EnvironmentFile = cfg.environmentFile;

     

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

     

       97
       97
       +
                 LockPersonality = true;

     

       98
       98
       +
                 NoNewPrivileges = true;

     

       99
       99
       +
                 PrivateDevices = true;

     

       100
       100
       +
                 PrivateTmp = true;

     

       101
       101
       +
                 PrivateUsers = true;

     

       102
       102
       +
                 ProtectClock = true;

     

       103
       103
       +
                 ProtectControlGroups = true;

     

       104
       104
       +
                 ProtectHome = true;

     

       105
       105
       +
                 ProtectHostname = true;

     

       106
       106
       +
                 ProtectKernelLogs = true;

     

       107
       107
       +
                 ProtectKernelModules = true;

     

       108
       108
       +
                 ProtectKernelTunables = true;

     

       109
       109
       +
                 ProtectSystem = "strict";

     

       110
       110
       +
                 Restart = "on-failure";

     

       111
       111
       +
                 RestartSec = 10;

     

       112
       112
       +
                 RestrictRealtime = true;

     

       113
       113
       +
                 RestrictSUIDSGID = true;

     

       114
       114
       +
                 StateDirectory = "traccar";

     

       115
       115
       +
                 SuccessExitStatus = 143;

     

       116
       116
       +
                 Type = "simple";

     

       117
       117
       +
                 # Set the working directory to traccar's package.

     

       118
       118
       +
                 # Traccar only searches for the DB migrations relative to it's WorkingDirectory and nothing worked to

     

       119
       119
       +
                 # work around this. To avoid copying the migrations over to the state directory, we use the package as

     

       120
       120
       +
                 # WorkingDirectory.

     

       121
       121
       +
                 WorkingDirectory = "${pkgs.traccar}";

     

       122
       122
       +
               };

     

       123
       123
       +
             };

     

       124
       124
       +
           };

     

       125
       125
       +
       }

+43

pkgs/by-name/tr/traccar/package.nix

···

       1
       1
       +
       {

     

       2
       2
       +
         fetchzip,

     

       3
       3
       +
         lib,

     

       4
       4
       +
         pkgs,

     

       5
       5
       +
         stdenvNoCC,

     

       6
       6
       +
       }:

     

       7
       7
       +
       stdenvNoCC.mkDerivation rec {

     

       8
       8
       +
         pname = "traccar";

     

       9
       9
       +
         version = "6.5";

     

       10
       10
       +
         nativeBuildInputs = [ pkgs.makeWrapper ];

     

       11
       11
       +
       

     

       12
       12
       +
         src = fetchzip {

     

       13
       13
       +
           stripRoot = false;

     

       14
       14
       +
           url = "https://github.com/traccar/traccar/releases/download/v${version}/traccar-other-${version}.zip";

     

       15
       15
       +
           hash = "sha256-XCG3G24oe/qR6LiMJASb9STOnyTCtw+2HigaPawcQvU=";

     

       16
       16
       +
         };

     

       17
       17
       +
       

     

       18
       18
       +
         installPhase = ''

     

       19
       19
       +
           runHook preInstall

     

       20
       20
       +
       

     

       21
       21
       +
           for dir in lib schema templates web ; do

     

       22
       22
       +
             mkdir -p $out/$dir

     

       23
       23
       +
             cp -a $dir $out

     

       24
       24
       +
           done

     

       25
       25
       +
       

     

       26
       26
       +
           mkdir -p $out/share/traccar

     

       27
       27
       +
           install -Dm644 tracker-server.jar $out

     

       28
       28
       +
       

     

       29
       29
       +
           makeWrapper ${pkgs.openjdk}/bin/java $out/bin/traccar \

     

       30
       30
       +
             --add-flags "-jar $out/tracker-server.jar"

     

       31
       31
       +
       

     

       32
       32
       +
           runHook postInstall

     

       33
       33
       +
         '';

     

       34
       34
       +
       

     

       35
       35
       +
         meta = with lib; {

     

       36
       36
       +
           description = "Open source GPS tracking system";

     

       37
       37
       +
           homepage = "https://www.traccar.org/";

     

       38
       38
       +
           sourceProvenance = with sourceTypes; [ binaryBytecode ];

     

       39
       39
       +
           license = licenses.asl20;

     

       40
       40
       +
           mainProgram = "traccar";

     

       41
       41
       +
           maintainers = with maintainers; [ frederictobiasc ];

     

       42
       42
       +
         };

     

       43
       43
       +
       }