commit 90934eae5038a7e6ae801ec9207b15a35ba583af · pyrox.dev/nixpkgs

+22 -25

nixos/modules/services/search/meilisearch.nix

···

       4
        
         pkgs,

     

       5
        
         ...

     

       6
        
       }:

     

       7
       -
       

     

       8
       -
       with lib;

     

       9
       -
       

     

       10
        
       let

     

       11
        
         cfg = config.services.meilisearch;

     

       12
        
       

     

       13
        
       in

     

       14
        
       {

     

       15
        
       

     

       16
       -
         meta.maintainers = with maintainers; [

     

       17
        
           Br1ght0ne

     

       18
        
           happysalada

     

       19
        
         ];

     
···

       22
        
         ###### interface

     

       23
        
       

     

       24
        
         options.services.meilisearch = {

     

       25
       -
           enable = mkEnableOption "MeiliSearch - a RESTful search API";

     

       26
        
       

     

       27
       -
           package = mkPackageOption pkgs "meilisearch" {

     

       28
        
             extraDescription = ''

     

       29
        
               Use this if you require specific features to be enabled. The default package has no features.

     

       30
        
             '';

     

       31
        
           };

     

       32
        
       

     

       33
       -
           listenAddress = mkOption {

     

       34
        
             description = "MeiliSearch listen address.";

     

       35
        
             default = "127.0.0.1";

     

       36
       -
             type = types.str;

     

       37
        
           };

     

       38
        
       

     

       39
       -
           listenPort = mkOption {

     

       40
        
             description = "MeiliSearch port to listen on.";

     

       41
        
             default = 7700;

     

       42
       -
             type = types.port;

     

       43
        
           };

     

       44
        
       

     

       45
       -
           environment = mkOption {

     

       46
        
             description = "Defines the running environment of MeiliSearch.";

     

       47
        
             default = "development";

     

       48
       -
             type = types.enum [

     

       49
        
               "development"

     

       50
        
               "production"

     

       51
        
             ];

     

       52
        
           };

     

       53
        
       

     

       54
        
           # TODO change this to LoadCredentials once possible

     

       55
       -
           masterKeyEnvironmentFile = mkOption {

     

       56
        
             description = ''

     

       57
        
               Path to file which contains the master key.

     

       58
        
               By doing so, all routes will be protected and will require a key to be accessed.

     
···

       61
        
               MEILI_MASTER_KEY=my_secret_key

     

       62
        
             '';

     

       63
        
             default = null;

     

       64
       -
             type = with types; nullOr path;

     

       65
        
           };

     

       66
        
       

     

       67
       -
           noAnalytics = mkOption {

     

       68
        
             description = ''

     

       69
        
               Deactivates analytics.

     

       70
        
               Analytics allow MeiliSearch to know how many users are using MeiliSearch,

     
···

       72
        
               This process is entirely anonymous.

     

       73
        
             '';

     

       74
        
             default = true;

     

       75
       -
             type = types.bool;

     

       76
        
           };

     

       77
        
       

     

       78
       -
           logLevel = mkOption {

     

       79
        
             description = ''

     

       80
        
               Defines how much detail should be present in MeiliSearch's logs.

     

       81
        
               MeiliSearch currently supports four log levels, listed in order of increasing verbosity:

     
···

       86
        
                 Useful when diagnosing issues and debugging

     

       87
        
             '';

     

       88
        
             default = "INFO";

     

       89
       -
             type = types.str;

     

       90
        
           };

     

       91
        
       

     

       92
       -
           maxIndexSize = mkOption {

     

       93
        
             description = ''

     

       94
        
               Sets the maximum size of the index.

     

       95
        
               Value must be given in bytes or explicitly stating a base unit.

     
···

       97
        
               Default is 100 GiB

     

       98
        
             '';

     

       99
        
             default = "107374182400";

     

       100
       -
             type = types.str;

     

       101
        
           };

     

       102
        
       

     

       103
       -
           payloadSizeLimit = mkOption {

     

       104
        
             description = ''

     

       105
        
               Sets the maximum size of accepted JSON payloads.

     

       106
        
               Value must be given in bytes or explicitly stating a base unit.

     
···

       108
        
               Default is ~ 100 MB

     

       109
        
             '';

     

       110
        
             default = "104857600";

     

       111
       -
             type = types.str;

     

       112
        
           };

     

       113
        
       

     

       114
        
         };

     

       115
        
       

     

       116
        
         ###### implementation

     

       117
        
       

     

       118
       -
         config = mkIf cfg.enable {

     

       119
        
       

     

       120
        
           # used to restore dumps

     

       121
        
           environment.systemPackages = [ cfg.package ];

     
···

       127
        
             environment = {

     

       128
        
               MEILI_DB_PATH = "/var/lib/meilisearch";

     

       129
        
               MEILI_HTTP_ADDR = "${cfg.listenAddress}:${toString cfg.listenPort}";

     

       130
       -
               MEILI_NO_ANALYTICS = boolToString cfg.noAnalytics;

     

       131
        
               MEILI_ENV = cfg.environment;

     

       132
        
               MEILI_DUMP_DIR = "/var/lib/meilisearch/dumps";

     

       133
        
               MEILI_LOG_LEVEL = cfg.logLevel;

     
···

       137
        
               ExecStart = "${cfg.package}/bin/meilisearch";

     

       138
        
               DynamicUser = true;

     

       139
        
               StateDirectory = "meilisearch";

     

       140
       -
               EnvironmentFile = mkIf (cfg.masterKeyEnvironmentFile != null) cfg.masterKeyEnvironmentFile;

     

       141
        
             };

     

       142
        
           };

     

       143
        
         };

···

       4
        
         pkgs,

     

       5
        
         ...

     

       6
        
       }:

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       7
        
       let

     

       8
        
         cfg = config.services.meilisearch;

     

       9
        
       

     

       10
        
       in

     

       11
        
       {

     

       12
        
       

     

       13
       +
         meta.maintainers = with lib.maintainers; [

     

       14
        
           Br1ght0ne

     

       15
        
           happysalada

     

       16
        
         ];

     
···

       19
        
         ###### interface

     

       20
        
       

     

       21
        
         options.services.meilisearch = {

     

       22
       +
           enable = lib.mkEnableOption "MeiliSearch - a RESTful search API";

     

       23
        
       

     

       24
       +
           package = lib.mkPackageOption pkgs "meilisearch" {

     

       25
        
             extraDescription = ''

     

       26
        
               Use this if you require specific features to be enabled. The default package has no features.

     

       27
        
             '';

     

       28
        
           };

     

       29
        
       

     

       30
       +
           listenAddress = lib.mkOption {

     

       31
        
             description = "MeiliSearch listen address.";

     

       32
        
             default = "127.0.0.1";

     

       33
       +
             type = lib.types.str;

     

       34
        
           };

     

       35
        
       

     

       36
       +
           listenPort = lib.mkOption {

     

       37
        
             description = "MeiliSearch port to listen on.";

     

       38
        
             default = 7700;

     

       39
       +
             type = lib.types.port;

     

       40
        
           };

     

       41
        
       

     

       42
       +
           environment = lib.mkOption {

     

       43
        
             description = "Defines the running environment of MeiliSearch.";

     

       44
        
             default = "development";

     

       45
       +
             type = lib.types.enum [

     

       46
        
               "development"

     

       47
        
               "production"

     

       48
        
             ];

     

       49
        
           };

     

       50
        
       

     

       51
        
           # TODO change this to LoadCredentials once possible

     

       52
       +
           masterKeyEnvironmentFile = lib.mkOption {

     

       53
        
             description = ''

     

       54
        
               Path to file which contains the master key.

     

       55
        
               By doing so, all routes will be protected and will require a key to be accessed.

     
···

       58
        
               MEILI_MASTER_KEY=my_secret_key

     

       59
        
             '';

     

       60
        
             default = null;

     

       61
       +
             type = with lib.types; nullOr path;

     

       62
        
           };

     

       63
        
       

     

       64
       +
           noAnalytics = lib.mkOption {

     

       65
        
             description = ''

     

       66
        
               Deactivates analytics.

     

       67
        
               Analytics allow MeiliSearch to know how many users are using MeiliSearch,

     
···

       69
        
               This process is entirely anonymous.

     

       70
        
             '';

     

       71
        
             default = true;

     

       72
       +
             type = lib.types.bool;

     

       73
        
           };

     

       74
        
       

     

       75
       +
           logLevel = lib.mkOption {

     

       76
        
             description = ''

     

       77
        
               Defines how much detail should be present in MeiliSearch's logs.

     

       78
        
               MeiliSearch currently supports four log levels, listed in order of increasing verbosity:

     
···

       83
        
                 Useful when diagnosing issues and debugging

     

       84
        
             '';

     

       85
        
             default = "INFO";

     

       86
       +
             type = lib.types.str;

     

       87
        
           };

     

       88
        
       

     

       89
       +
           maxIndexSize = lib.mkOption {

     

       90
        
             description = ''

     

       91
        
               Sets the maximum size of the index.

     

       92
        
               Value must be given in bytes or explicitly stating a base unit.

     
···

       94
        
               Default is 100 GiB

     

       95
        
             '';

     

       96
        
             default = "107374182400";

     

       97
       +
             type = lib.types.str;

     

       98
        
           };

     

       99
        
       

     

       100
       +
           payloadSizeLimit = lib.mkOption {

     

       101
        
             description = ''

     

       102
        
               Sets the maximum size of accepted JSON payloads.

     

       103
        
               Value must be given in bytes or explicitly stating a base unit.

     
···

       105
        
               Default is ~ 100 MB

     

       106
        
             '';

     

       107
        
             default = "104857600";

     

       108
       +
             type = lib.types.str;

     

       109
        
           };

     

       110
        
       

     

       111
        
         };

     

       112
        
       

     

       113
        
         ###### implementation

     

       114
        
       

     

       115
       +
         config = lib.mkIf cfg.enable {

     

       116
        
       

     

       117
        
           # used to restore dumps

     

       118
        
           environment.systemPackages = [ cfg.package ];

     
···

       124
        
             environment = {

     

       125
        
               MEILI_DB_PATH = "/var/lib/meilisearch";

     

       126
        
               MEILI_HTTP_ADDR = "${cfg.listenAddress}:${toString cfg.listenPort}";

     

       127
       +
               MEILI_NO_ANALYTICS = lib.boolToString cfg.noAnalytics;

     

       128
        
               MEILI_ENV = cfg.environment;

     

       129
        
               MEILI_DUMP_DIR = "/var/lib/meilisearch/dumps";

     

       130
        
               MEILI_LOG_LEVEL = cfg.logLevel;

     
···

       134
        
               ExecStart = "${cfg.package}/bin/meilisearch";

     

       135
        
               DynamicUser = true;

     

       136
        
               StateDirectory = "meilisearch";

     

       137
       +
               EnvironmentFile = lib.mkIf (cfg.masterKeyEnvironmentFile != null) cfg.masterKeyEnvironmentFile;

     

       138
        
             };

     

       139
        
           };

     

       140
        
         };