commit 87ccd1a47b9566fba4a5b19ecbc89c2d5222eeaa · pyrox.dev/nixpkgs

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

···

       113
       113
        
       

     

       114
       114
        
       - [woodpecker-server](https://woodpecker-ci.org/), a simple CI engine with great extensibility. Available as [services.woodpecker-server](#opt-services.woodpecker-server.enable).

     

       115
       115
        
       

     

       116
       116
       +
       - [lldap](https://github.com/lldap/lldap), a lightweight authentication server that provides an opinionated, simplified LDAP interface for authentication. Available as [services.lldap](#opt-services.lldap.enable).

     

       117
       117
       +
       

     

       116
       118
        
       - [ReGreet](https://github.com/rharish101/ReGreet), a clean and customizable greeter for greetd. Available as [programs.regreet](#opt-programs.regreet.enable).

     

       117
       119
        
       

     

       118
       120
        
       - [v4l2-relayd](https://git.launchpad.net/v4l2-relayd), a streaming relay for v4l2loopback using gstreamer. Available as [services.v4l2-relayd](#opt-services.v4l2-relayd.instances._name_.enable).

nixos/modules/module-list.nix

···

       395
       395
        
         ./services/databases/hbase-standalone.nix

     

       396
       396
        
         ./services/databases/influxdb.nix

     

       397
       397
        
         ./services/databases/influxdb2.nix

     

       398
       398
       +
         ./services/databases/lldap.nix

     

       398
       399
        
         ./services/databases/memcached.nix

     

       399
       400
        
         ./services/databases/monetdb.nix

     

       400
       401
        
         ./services/databases/mongodb.nix

+121

nixos/modules/services/databases/lldap.nix

···

       1
       1
       +
       { config, lib, pkgs, utils, ... }:

     

       2
       2
       +
       

     

       3
       3
       +
       let

     

       4
       4
       +
         cfg = config.services.lldap;

     

       5
       5
       +
         format = pkgs.formats.toml { };

     

       6
       6
       +
       in

     

       7
       7
       +
       {

     

       8
       8
       +
         options.services.lldap = with lib; {

     

       9
       9
       +
           enable = mkEnableOption (mdDoc "lldap");

     

       10
       10
       +
       

     

       11
       11
       +
           package = mkPackageOptionMD pkgs "lldap" { };

     

       12
       12
       +
       

     

       13
       13
       +
           environment = mkOption {

     

       14
       14
       +
             type = with types; attrsOf str;

     

       15
       15
       +
             default = { };

     

       16
       16
       +
             example = {

     

       17
       17
       +
               LLDAP_JWT_SECRET_FILE = "/run/lldap/jwt_secret";

     

       18
       18
       +
               LLDAP_LDAP_USER_PASS_FILE = "/run/lldap/user_password";

     

       19
       19
       +
             };

     

       20
       20
       +
             description = lib.mdDoc ''

     

       21
       21
       +
               Environment variables passed to the service.

     

       22
       22
       +
               Any config option name prefixed with `LLDAP_` takes priority over the one in the configuration file.

     

       23
       23
       +
             '';

     

       24
       24
       +
           };

     

       25
       25
       +
       

     

       26
       26
       +
           environmentFile = mkOption {

     

       27
       27
       +
             type = types.nullOr types.path;

     

       28
       28
       +
             default = null;

     

       29
       29
       +
             description = lib.mdDoc ''

     

       30
       30
       +
               Environment file as defined in {manpage}`systemd.exec(5)` passed to the service.

     

       31
       31
       +
             '';

     

       32
       32
       +
           };

     

       33
       33
       +
       

     

       34
       34
       +
           settings = mkOption {

     

       35
       35
       +
             description = mdDoc ''

     

       36
       36
       +
               Free-form settings written directly to the `lldap_config.toml` file.

     

       37
       37
       +
               Refer to <https://github.com/lldap/lldap/blob/main/lldap_config.docker_template.toml> for supported values.

     

       38
       38
       +
             '';

     

       39
       39
       +
       

     

       40
       40
       +
             default = { };

     

       41
       41
       +
       

     

       42
       42
       +
             type = types.submodule {

     

       43
       43
       +
               freeformType = format.type;

     

       44
       44
       +
               options = {

     

       45
       45
       +
                 ldap_host = mkOption {

     

       46
       46
       +
                   type = types.str;

     

       47
       47
       +
                   description = mdDoc "The host address that the LDAP server will be bound to.";

     

       48
       48
       +
                   default = "::";

     

       49
       49
       +
                 };

     

       50
       50
       +
       

     

       51
       51
       +
                 ldap_port = mkOption {

     

       52
       52
       +
                   type = types.port;

     

       53
       53
       +
                   description = mdDoc "The port on which to have the LDAP server.";

     

       54
       54
       +
                   default = 3890;

     

       55
       55
       +
                 };

     

       56
       56
       +
       

     

       57
       57
       +
                 http_host = mkOption {

     

       58
       58
       +
                   type = types.str;

     

       59
       59
       +
                   description = mdDoc "The host address that the HTTP server will be bound to.";

     

       60
       60
       +
                   default = "::";

     

       61
       61
       +
                 };

     

       62
       62
       +
       

     

       63
       63
       +
                 http_port = mkOption {

     

       64
       64
       +
                   type = types.port;

     

       65
       65
       +
                   description = mdDoc "The port on which to have the HTTP server, for user login and administration.";

     

       66
       66
       +
                   default = 17170;

     

       67
       67
       +
                 };

     

       68
       68
       +
       

     

       69
       69
       +
                 http_url = mkOption {

     

       70
       70
       +
                   type = types.str;

     

       71
       71
       +
                   description = mdDoc "The public URL of the server, for password reset links.";

     

       72
       72
       +
                   default = "http://localhost";

     

       73
       73
       +
                 };

     

       74
       74
       +
       

     

       75
       75
       +
                 ldap_base_dn = mkOption {

     

       76
       76
       +
                   type = types.str;

     

       77
       77
       +
                   description = mdDoc "Base DN for LDAP.";

     

       78
       78
       +
                   example = "dc=example,dc=com";

     

       79
       79
       +
                 };

     

       80
       80
       +
       

     

       81
       81
       +
                 ldap_user_dn = mkOption {

     

       82
       82
       +
                   type = types.str;

     

       83
       83
       +
                   description = mdDoc "Admin username";

     

       84
       84
       +
                   default = "admin";

     

       85
       85
       +
                 };

     

       86
       86
       +
       

     

       87
       87
       +
                 ldap_user_email = mkOption {

     

       88
       88
       +
                   type = types.str;

     

       89
       89
       +
                   description = mdDoc "Admin email.";

     

       90
       90
       +
                   default = "admin@example.com";

     

       91
       91
       +
                 };

     

       92
       92
       +
       

     

       93
       93
       +
                 database_url = mkOption {

     

       94
       94
       +
                   type = types.str;

     

       95
       95
       +
                   description = mdDoc "Database URL.";

     

       96
       96
       +
                   default = "sqlite://./users.db?mode=rwc";

     

       97
       97
       +
                   example = "postgres://postgres-user:password@postgres-server/my-database";

     

       98
       98
       +
                 };

     

       99
       99
       +
               };

     

       100
       100
       +
             };

     

       101
       101
       +
           };

     

       102
       102
       +
         };

     

       103
       103
       +
       

     

       104
       104
       +
         config = lib.mkIf cfg.enable {

     

       105
       105
       +
           systemd.services.lldap = {

     

       106
       106
       +
             description = "Lightweight LDAP server (lldap)";

     

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

     

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

     

       109
       109
       +
             serviceConfig = {

     

       110
       110
       +
               ExecStart = "${lib.getExe cfg.package} run --config-file ${format.generate "lldap_config.toml" cfg.settings}";

     

       111
       111
       +
               StateDirectory = "lldap";

     

       112
       112
       +
               WorkingDirectory = "%S/lldap";

     

       113
       113
       +
               User = "lldap";

     

       114
       114
       +
               Group = "lldap";

     

       115
       115
       +
               DynamicUser = true;

     

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

     

       117
       117
       +
             };

     

       118
       118
       +
             inherit (cfg) environment;

     

       119
       119
       +
           };

     

       120
       120
       +
         };

     

       121
       121
       +
       }