nixos/modules/services/misc/autofs.nix

   1 { config, lib, pkgs, ... }:
   2 let
   3
   4   cfg = config.services.autofs;
   5
   6   autoMaster = pkgs.writeText "auto.master" cfg.autoMaster;
   7
   8 in
   9
  10 {
  11
  12   ###### interface
  13
  14   options = {
  15
  16     services.autofs = {
  17
  18       enable = lib.mkOption {
  19         type = lib.types.bool;
  20         default = false;
  21         description = ''
  22           Mount filesystems on demand. Unmount them automatically.
  23           You may also be interested in afuse.
  24         '';
  25       };
  26
  27       autoMaster = lib.mkOption {
  28         type = lib.types.str;
  29         example = lib.literalExpression ''
  30           let
  31             mapConf = pkgs.writeText "auto" '''
  32              kernel    -ro,soft,intr       ftp.kernel.org:/pub/linux
  33              boot      -fstype=ext2        :/dev/hda1
  34              windoze   -fstype=smbfs       ://windoze/c
  35              removable -fstype=ext2        :/dev/hdd
  36              cd        -fstype=iso9660,ro  :/dev/hdc
  37              floppy    -fstype=auto        :/dev/fd0
  38              server    -rw,hard,intr       / -ro myserver.me.org:/ \
  39                                            /usr myserver.me.org:/usr \
  40                                            /home myserver.me.org:/home
  41             ''';
  42           in '''
  43             /auto file:''${mapConf}
  44           '''
  45         '';
  46         description = ''
  47           Contents of `/etc/auto.master` file. See {command}`auto.master(5)` and {command}`autofs(5)`.
  48         '';
  49       };
  50
  51       timeout = lib.mkOption {
  52         type = lib.types.int;
  53         default = 600;
  54         description = "Set the global minimum timeout, in seconds, until directories are unmounted";
  55       };
  56
  57       debug = lib.mkOption {
  58         type = lib.types.bool;
  59         default = false;
  60         description = ''
  61           Pass -d and -7 to automount and write log to the system journal.
  62         '';
  63       };
  64
  65     };
  66
  67   };
  68
  69
  70   ###### implementation
  71
  72   config = lib.mkIf cfg.enable {
  73
  74     boot.kernelModules = [ "autofs" ];
  75
  76     systemd.services.autofs =
  77       { description = "Automounts filesystems on demand";
  78         after = [ "network.target" "ypbind.service" "sssd.service" "network-online.target" ];
  79         wants = [ "network-online.target" ];
  80         wantedBy = [ "multi-user.target" ];
  81
  82         preStart = ''
  83           # There should be only one autofs service managed by systemd, so this should be safe.
  84           rm -f /tmp/autofs-running
  85         '';
  86
  87         serviceConfig = {
  88           Type = "forking";
  89           PIDFile = "/run/autofs.pid";
  90           ExecStart = "${pkgs.autofs5}/bin/automount ${lib.optionalString cfg.debug "-d"} -p /run/autofs.pid -t ${builtins.toString cfg.timeout} ${autoMaster}";
  91           ExecReload = "${pkgs.coreutils}/bin/kill -HUP $MAINPID";
  92         };
  93       };
  94
  95   };
  96
  97 }