nixos/modules/services/databases/mongodb.nix

   1 { config, lib, pkgs, ... }:
   2
   3 with lib;
   4
   5 let
   6
   7   cfg = config.services.mongodb;
   8
   9   mongodb = cfg.package;
  10
  11   mongoCnf = cfg: pkgs.writeText "mongodb.conf"
  12   ''
  13     net.bindIp: ${cfg.bind_ip}
  14     ${optionalString cfg.quiet "systemLog.quiet: true"}
  15     systemLog.destination: syslog
  16     storage.dbPath: ${cfg.dbpath}
  17     ${optionalString cfg.enableAuth "security.authorization: enabled"}
  18     ${optionalString (cfg.replSetName != "") "replication.replSetName: ${cfg.replSetName}"}
  19     ${cfg.extraConfig}
  20   '';
  21
  22 in
  23
  24 {
  25
  26   ###### interface
  27
  28   options = {
  29
  30     services.mongodb = {
  31
  32       enable = mkEnableOption "the MongoDB server";
  33
  34       package = mkPackageOption pkgs "mongodb" { };
  35
  36       user = mkOption {
  37         type = types.str;
  38         default = "mongodb";
  39         description = "User account under which MongoDB runs";
  40       };
  41
  42       bind_ip = mkOption {
  43         type = types.str;
  44         default = "127.0.0.1";
  45         description = "IP to bind to";
  46       };
  47
  48       quiet = mkOption {
  49         type = types.bool;
  50         default = false;
  51         description = "quieter output";
  52       };
  53
  54       enableAuth = mkOption {
  55         type = types.bool;
  56         default = false;
  57         description = "Enable client authentication. Creates a default superuser with username root!";
  58       };
  59
  60       initialRootPassword = mkOption {
  61         type = types.nullOr types.str;
  62         default = null;
  63         description = "Password for the root user if auth is enabled.";
  64       };
  65
  66       dbpath = mkOption {
  67         type = types.str;
  68         default = "/var/db/mongodb";
  69         description = "Location where MongoDB stores its files";
  70       };
  71
  72       pidFile = mkOption {
  73         type = types.str;
  74         default = "/run/mongodb.pid";
  75         description = "Location of MongoDB pid file";
  76       };
  77
  78       replSetName = mkOption {
  79         type = types.str;
  80         default = "";
  81         description = ''
  82           If this instance is part of a replica set, set its name here.
  83           Otherwise, leave empty to run as single node.
  84         '';
  85       };
  86
  87       extraConfig = mkOption {
  88         type = types.lines;
  89         default = "";
  90         example = ''
  91           storage.journal.enabled: false
  92         '';
  93         description = "MongoDB extra configuration in YAML format";
  94       };
  95
  96       initialScript = mkOption {
  97         type = types.nullOr types.path;
  98         default = null;
  99         description = ''
 100           A file containing MongoDB statements to execute on first startup.
 101         '';
 102       };
 103     };
 104
 105   };
 106
 107
 108   ###### implementation
 109
 110   config = mkIf config.services.mongodb.enable {
 111     assertions = [
 112       { assertion = !cfg.enableAuth || cfg.initialRootPassword != null;
 113         message = "`enableAuth` requires `initialRootPassword` to be set.";
 114       }
 115     ];
 116
 117     users.users.mongodb = mkIf (cfg.user == "mongodb")
 118       { name = "mongodb";
 119         isSystemUser = true;
 120         group = "mongodb";
 121         description = "MongoDB server user";
 122       };
 123     users.groups.mongodb = mkIf (cfg.user == "mongodb") {};
 124
 125     environment.systemPackages = [ mongodb ];
 126
 127     systemd.services.mongodb =
 128       { description = "MongoDB server";
 129
 130         wantedBy = [ "multi-user.target" ];
 131         after = [ "network.target" ];
 132
 133         serviceConfig = {
 134           ExecStart = "${mongodb}/bin/mongod --config ${mongoCnf cfg} --fork --pidfilepath ${cfg.pidFile}";
 135           User = cfg.user;
 136           PIDFile = cfg.pidFile;
 137           Type = "forking";
 138           TimeoutStartSec=120; # initial creating of journal can take some time
 139           PermissionsStartOnly = true;
 140         };
 141
 142         preStart = let
 143           cfg_ = cfg // { enableAuth = false; bind_ip = "127.0.0.1"; };
 144         in ''
 145           rm ${cfg.dbpath}/mongod.lock || true
 146           if ! test -e ${cfg.dbpath}; then
 147               install -d -m0700 -o ${cfg.user} ${cfg.dbpath}
 148               # See postStart!
 149               touch ${cfg.dbpath}/.first_startup
 150           fi
 151           if ! test -e ${cfg.pidFile}; then
 152               install -D -o ${cfg.user} /dev/null ${cfg.pidFile}
 153           fi '' + lib.optionalString cfg.enableAuth ''
 154
 155           if ! test -e "${cfg.dbpath}/.auth_setup_complete"; then
 156             systemd-run --unit=mongodb-for-setup --uid=${cfg.user} ${mongodb}/bin/mongod --config ${mongoCnf cfg_}
 157             # wait for mongodb
 158             while ! ${mongodb}/bin/mongo --eval "db.version()" > /dev/null 2>&1; do sleep 0.1; done
 159
 160           ${mongodb}/bin/mongo <<EOF
 161             use admin
 162             db.createUser(
 163               {
 164                 user: "root",
 165                 pwd: "${cfg.initialRootPassword}",
 166                 roles: [
 167                   { role: "userAdminAnyDatabase", db: "admin" },
 168                   { role: "dbAdminAnyDatabase", db: "admin" },
 169                   { role: "readWriteAnyDatabase", db: "admin" }
 170                 ]
 171               }
 172             )
 173           EOF
 174             touch "${cfg.dbpath}/.auth_setup_complete"
 175             systemctl stop mongodb-for-setup
 176           fi
 177         '';
 178         postStart = ''
 179             if test -e "${cfg.dbpath}/.first_startup"; then
 180               ${optionalString (cfg.initialScript != null) ''
 181                 ${mongodb}/bin/mongo ${optionalString (cfg.enableAuth) "-u root -p ${cfg.initialRootPassword}"} admin "${cfg.initialScript}"
 182               ''}
 183               rm -f "${cfg.dbpath}/.first_startup"
 184             fi
 185         '';
 186       };
 187
 188   };
 189
 190 }