···

       
1
       
-
       
{ config, options, lib, pkgs, ... }:

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
2
       
 
       
let

     

       
3
       
 
       
  cfg = config.services.couchdb;

     

       
4
       
 
       
  opt = options.services.couchdb;

     

       
5
       
-
       
  configFile = pkgs.writeText "couchdb.ini" (

     

       
6
       
-
       
    ''

     

       
7
       
-
       
      [couchdb]

     

       
8
       
-
       
      database_dir = ${cfg.databaseDir}

     

       
9
       
-
       
      uri_file = ${cfg.uriFile}

     

       
10
       
-
       
      view_index_dir = ${cfg.viewIndexDir}

     

       
11
       
-
       
    '' + (lib.optionalString (cfg.adminPass != null) ''

     

       
12
       
-
       
      [admins]

     

       
13
       
-
       
      ${cfg.adminUser} = ${cfg.adminPass}

     

       
14
       
-
       
    '' + ''

     

       
15
       
-
       
      [chttpd]

     

       
16
       
-
       
    '') +

     

       
17
       
-
       
    ''

     

       
18
       
-
       
      port = ${toString cfg.port}

     

       
19
       
-
       
      bind_address = ${cfg.bindAddress}

     

       
20
       
 
       


     

       
21
       
-
       
      [log]

     

       
22
       
-
       
      file = ${cfg.logFile}

     

       
23
       
-
       
    '');

     

       
24
       
-
       
  executable = "${cfg.package}/bin/couchdb";

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
25
       
 
       


     

       
26
       
-
       
in {

     

       
27
       
 
       


     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
28
       
 
       
  ###### interface

     

       
29
       
 
       


     

       
30
       
 
       
  options = {

     

       
31
       
-
       


     

       
32
       
 
       
    services.couchdb = {

     

       
33
       
-
       


     

       
34
       
 
       
      enable = lib.mkEnableOption "CouchDB Server";

     

       
35
       
 
       


     

       
36
       
 
       
      package = lib.mkPackageOption pkgs "couchdb3" { };

     
···

       
128
       
 
       
      };

     

       
129
       
 
       


     

       
130
       
 
       
      extraConfig = lib.mkOption {

     

       
131
       
-
       
        type = lib.types.lines;

     

       
132
       
-
       
        default = "";

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
133
       
 
       
        description = ''

     

       
134
       
-
       
          Extra configuration. Overrides any other configuration.

     

       
135
       
 
       
        '';

     

       
136
       
 
       
      };

     

       
137
       
 
       


     
···

       
146
       
 
       


     

       
147
       
 
       
      configFile = lib.mkOption {

     

       
148
       
 
       
        type = lib.types.path;

     

       
0
       
 
       

     

       
149
       
 
       
        description = ''

     

       
150
       
 
       
          Configuration file for persisting runtime changes. File

     

       
151
       
 
       
          needs to be readable and writable from couchdb user/group.

     

       
152
       
 
       
        '';

     

       
153
       
 
       
      };

     

       
154
       
-
       


     

       
155
       
 
       
    };

     

       
156
       
-
       


     

       
157
       
 
       
  };

     

       
158
       
 
       


     

       
159
       
 
       
  ###### implementation

     

       
160
       
 
       


     

       
161
       
-
       
  config = lib.mkIf config.services.couchdb.enable {

     

       
162
       
-
       


     

       
163
       
 
       
    environment.systemPackages = [ cfg.package ];

     

       
164
       
-
       


     

       
165
       
-
       
    services.couchdb.configFile = lib.mkDefault "/var/lib/couchdb/local.ini";

     

       
166
       
 
       


     

       
167
       
 
       
    systemd.tmpfiles.rules = [

     

       
168
       
 
       
      "d '${dirOf cfg.uriFile}' - ${cfg.user} ${cfg.group} - -"

     
···

       
185
       
 
       
      '';

     

       
186
       
 
       


     

       
187
       
 
       
      environment = {

     

       
188
       
-
       
        # we are actually specifying 5 configuration files:

     

       
189
       
-
       
        # 1. the preinstalled default.ini

     

       
190
       
-
       
        # 2. the module configuration

     

       
191
       
-
       
        # 3. the extraConfig from the module options

     

       
192
       
-
       
        # 4. the locally writable config file, which couchdb itself writes to

     

       
193
       
-
       
        ERL_FLAGS= ''-couch_ini ${cfg.package}/etc/default.ini ${configFile} ${pkgs.writeText "couchdb-extra.ini" cfg.extraConfig} ${cfg.configFile}'';

     

       
194
       
 
       
        # 5. the vm.args file

     

       
195
       
-
       
        COUCHDB_ARGS_FILE=''${cfg.argsFile}'';

     

       
196
       
-
       
        HOME =''${cfg.databaseDir}'';

     

       
197
       
 
       
      };

     

       
198
       
 
       


     

       
199
       
 
       
      serviceConfig = {

     
···

       
210
       
 
       
    };

     

       
211
       
 
       


     

       
212
       
 
       
    users.groups.couchdb.gid = config.ids.gids.couchdb;

     

       
213
       
-
       


     

       
214
       
 
       
  };

     

       
215
       
 
       
}

     

···

       
1
       
+
       
{

     

       
2
       
+
       
  config,

     

       
3
       
+
       
  options,

     

       
4
       
+
       
  lib,

     

       
5
       
+
       
  pkgs,

     

       
6
       
+
       
  ...

     

       
7
       
+
       
}:

     

       
8
       
 
       
let

     

       
9
       
 
       
  cfg = config.services.couchdb;

     

       
10
       
 
       
  opt = options.services.couchdb;

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
11
       
 
       


     

       
12
       
+
       
  baseConfig = {

     

       
13
       
+
       
    couchdb = {

     

       
14
       
+
       
      database_dir = cfg.databaseDir;

     

       
15
       
+
       
      uri_file = cfg.uriFile;

     

       
16
       
+
       
      view_index_dir = cfg.viewIndexDir;

     

       
17
       
+
       
    };

     

       
18
       
+
       
    chttpd = {

     

       
19
       
+
       
      port = cfg.port;

     

       
20
       
+
       
      bind_address = cfg.bindAddress;

     

       
21
       
+
       
    };

     

       
22
       
+
       
    log = {

     

       
23
       
+
       
      file = cfg.logFile;

     

       
24
       
+
       
    };

     

       
25
       
+
       
  };

     

       
26
       
+
       
  adminConfig = lib.optionalAttrs (cfg.adminPass != null) {

     

       
27
       
+
       
    admins = {

     

       
28
       
+
       
      "${cfg.adminUser}" = cfg.adminPass;

     

       
29
       
+
       
    };

     

       
30
       
+
       
  };

     

       
31
       
+
       
  appConfig = lib.recursiveUpdate (lib.recursiveUpdate baseConfig adminConfig) cfg.extraConfig;

     

       
32
       
 
       


     

       
33
       
+
       
  optionsConfigFile = pkgs.writeText "couchdb.ini" (lib.generators.toINI { } appConfig);

     

       
34
       
 
       


     

       
35
       
+
       
  # we are actually specifying 5 configuration files:

     

       
36
       
+
       
  # 1. the preinstalled default.ini

     

       
37
       
+
       
  # 2. the module configuration

     

       
38
       
+
       
  # 3. the extraConfigFiles from the module options

     

       
39
       
+
       
  # 4. the locally writable config file, which couchdb itself writes to

     

       
40
       
+
       
  configFiles = [

     

       
41
       
+
       
    "${cfg.package}/etc/default.ini"

     

       
42
       
+
       
    optionsConfigFile

     

       
43
       
+
       
  ] ++ cfg.extraConfigFiles ++ [ cfg.configFile ];

     

       
44
       
+
       
  executable = "${cfg.package}/bin/couchdb";

     

       
45
       
+
       
in

     

       
46
       
+
       
{

     

       
47
       
 
       
  ###### interface

     

       
48
       
 
       


     

       
49
       
 
       
  options = {

     

       
0
       
 
       

     

       
50
       
 
       
    services.couchdb = {

     

       
0
       
 
       

     

       
51
       
 
       
      enable = lib.mkEnableOption "CouchDB Server";

     

       
52
       
 
       


     

       
53
       
 
       
      package = lib.mkPackageOption pkgs "couchdb3" { };

     
···

       
145
       
 
       
      };

     

       
146
       
 
       


     

       
147
       
 
       
      extraConfig = lib.mkOption {

     

       
148
       
+
       
        type = lib.types.attrs;

     

       
149
       
+
       
        default = { };

     

       
150
       
+
       
        description = "Extra configuration options for CouchDB";

     

       
151
       
+
       
      };

     

       
152
       
+
       
      extraConfigFiles = lib.mkOption {

     

       
153
       
+
       
        type = lib.types.listOf lib.types.path;

     

       
154
       
+
       
        default = [ ];

     

       
155
       
 
       
        description = ''

     

       
156
       
+
       
          Extra configuration files. Overrides any other configuration. You can use this to setup the Admin user without putting the password in your nix store.

     

       
157
       
 
       
        '';

     

       
158
       
 
       
      };

     

       
159
       
 
       


     
···

       
168
       
 
       


     

       
169
       
 
       
      configFile = lib.mkOption {

     

       
170
       
 
       
        type = lib.types.path;

     

       
171
       
+
       
        default = "/var/lib/couchdb/local.ini";

     

       
172
       
 
       
        description = ''

     

       
173
       
 
       
          Configuration file for persisting runtime changes. File

     

       
174
       
 
       
          needs to be readable and writable from couchdb user/group.

     

       
175
       
 
       
        '';

     

       
176
       
 
       
      };

     

       
0
       
 
       

     

       
177
       
 
       
    };

     

       
0
       
 
       

     

       
178
       
 
       
  };

     

       
179
       
 
       


     

       
180
       
 
       
  ###### implementation

     

       
181
       
 
       


     

       
182
       
+
       
  config = lib.mkIf cfg.enable {

     

       
0
       
 
       

     

       
183
       
 
       
    environment.systemPackages = [ cfg.package ];

     

       
0
       
 
       

     

       
0
       
 
       

     

       
184
       
 
       


     

       
185
       
 
       
    systemd.tmpfiles.rules = [

     

       
186
       
 
       
      "d '${dirOf cfg.uriFile}' - ${cfg.user} ${cfg.group} - -"

     
···

       
203
       
 
       
      '';

     

       
204
       
 
       


     

       
205
       
 
       
      environment = {

     

       
206
       
+
       
        ERL_FLAGS = ''-couch_ini ${lib.concatStringsSep " " configFiles}'';

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
207
       
 
       
        # 5. the vm.args file

     

       
208
       
+
       
        COUCHDB_ARGS_FILE = ''${cfg.argsFile}'';

     

       
209
       
+
       
        HOME = ''${cfg.databaseDir}'';

     

       
210
       
 
       
      };

     

       
211
       
 
       


     

       
212
       
 
       
      serviceConfig = {

     
···

       
223
       
 
       
    };

     

       
224
       
 
       


     

       
225
       
 
       
    users.groups.couchdb.gid = config.ids.gids.couchdb;

     

       
0
       
 
       

     

       
226
       
 
       
  };

     

       
227
       
 
       
}