nixos/modules/services/databases/firebird.nix

   1 { config, lib, pkgs, ... }:
   2
   3 # TODO: This may file may need additional review, eg which configurations to
   4 # expose to the user.
   5 #
   6 # I only used it to access some simple databases.
   7
   8 # test:
   9 # isql, then type the following commands:
  10 # CREATE DATABASE '/var/db/firebird/data/test.fdb' USER 'SYSDBA' PASSWORD 'masterkey';
  11 # CONNECT '/var/db/firebird/data/test.fdb' USER 'SYSDBA' PASSWORD 'masterkey';
  12 # CREATE TABLE test ( text varchar(100) );
  13 # DROP DATABASE;
  14 #
  15 # Be careful, virtuoso-opensource also provides a different isql command !
  16
  17 # There are at least two ways to run firebird. superserver has been chosen
  18 # however there are no strong reasons to prefer this or the other one AFAIK
  19 # Eg superserver is said to be most efficiently using resources according to
  20 # https://www.firebirdsql.org/manual/qsg25-classic-or-super.html
  21 let
  22
  23   cfg = config.services.firebird;
  24
  25   firebird = cfg.package;
  26
  27   dataDir = "${cfg.baseDir}/data";
  28   systemDir = "${cfg.baseDir}/system";
  29
  30 in
  31
  32 {
  33
  34   ###### interface
  35
  36   options = {
  37
  38     services.firebird = {
  39
  40       enable = lib.mkEnableOption "the Firebird super server";
  41
  42       package = lib.mkPackageOption pkgs "firebird" {
  43         example = "firebird_3";
  44         extraDescription = ''
  45           For SuperServer use override: `pkgs.firebird_3.override { superServer = true; };`
  46         '';
  47       };
  48
  49       port = lib.mkOption {
  50         default = 3050;
  51         type = lib.types.port;
  52         description = ''
  53           Port Firebird uses.
  54         '';
  55       };
  56
  57       user = lib.mkOption {
  58         default = "firebird";
  59         type = lib.types.str;
  60         description = ''
  61           User account under which firebird runs.
  62         '';
  63       };
  64
  65       baseDir = lib.mkOption {
  66         default = "/var/lib/firebird";
  67         type = lib.types.str;
  68         description = ''
  69           Location containing data/ and system/ directories.
  70           data/ stores the databases, system/ stores the password database security2.fdb.
  71         '';
  72       };
  73
  74     };
  75
  76   };
  77
  78
  79   ###### implementation
  80
  81   config = lib.mkIf config.services.firebird.enable {
  82
  83     environment.systemPackages = [cfg.package];
  84
  85     systemd.tmpfiles.rules = [
  86       "d '${dataDir}' 0700 ${cfg.user} - - -"
  87       "d '${systemDir}' 0700 ${cfg.user} - - -"
  88     ];
  89
  90     systemd.services.firebird =
  91       { description = "Firebird Super-Server";
  92
  93         wantedBy = [ "multi-user.target" ];
  94
  95         # TODO: moving security2.fdb into the data directory works, maybe there
  96         # is a better way
  97         preStart =
  98           ''
  99             if ! test -e "${systemDir}/security2.fdb"; then
 100                 cp ${firebird}/security2.fdb "${systemDir}"
 101             fi
 102
 103             if ! test -e "${systemDir}/security3.fdb"; then
 104                 cp ${firebird}/security3.fdb "${systemDir}"
 105             fi
 106
 107             if ! test -e "${systemDir}/security4.fdb"; then
 108                 cp ${firebird}/security4.fdb "${systemDir}"
 109             fi
 110
 111             chmod -R 700         "${dataDir}" "${systemDir}" /var/log/firebird
 112           '';
 113
 114         serviceConfig.User = cfg.user;
 115         serviceConfig.LogsDirectory = "firebird";
 116         serviceConfig.LogsDirectoryMode = "0700";
 117         serviceConfig.ExecStart = "${firebird}/bin/fbserver -d";
 118
 119         # TODO think about shutdown
 120       };
 121
 122     environment.etc."firebird/firebird.msg".source = "${firebird}/firebird.msg";
 123
 124     # think about this again - and eventually make it an option
 125     environment.etc."firebird/firebird.conf".text = ''
 126       # RootDirectory = Restrict ${dataDir}
 127       DatabaseAccess = Restrict ${dataDir}
 128       ExternalFileAccess = Restrict ${dataDir}
 129       # what is this? is None allowed?
 130       UdfAccess = None
 131       # "Native" =  traditional interbase/firebird, "mixed" is windows only
 132       Authentication = Native
 133
 134       # defaults to -1 on non Win32
 135       #MaxUnflushedWrites = 100
 136       #MaxUnflushedWriteTime = 100
 137
 138       # show trace if trouble occurs (does this require debug build?)
 139       # BugcheckAbort = 0
 140       # ConnectionTimeout = 180
 141
 142       #RemoteServiceName = gds_db
 143       RemoteServicePort = ${toString cfg.port}
 144
 145       # randomly choose port for server Event Notification
 146       #RemoteAuxPort = 0
 147       # rsetrict connections to a network card:
 148       #RemoteBindAddress =
 149       # there are some additional settings which should be reviewed
 150     '';
 151
 152     users.users.firebird = {
 153       description = "Firebird server user";
 154       group = "firebird";
 155       uid = config.ids.uids.firebird;
 156     };
 157
 158     users.groups.firebird.gid = config.ids.gids.firebird;
 159
 160   };
 161 }