diff options
Diffstat (limited to 'nixpkgs/nixos/modules/services/databases/neo4j.nix')
| -rw-r--r-- | nixpkgs/nixos/modules/services/databases/neo4j.nix | 268 |
1 files changed, 118 insertions, 150 deletions
diff --git a/nixpkgs/nixos/modules/services/databases/neo4j.nix b/nixpkgs/nixos/modules/services/databases/neo4j.nix index 8816f3b2e4b6..833e6606d984 100644 --- a/nixpkgs/nixos/modules/services/databases/neo4j.nix +++ b/nixpkgs/nixos/modules/services/databases/neo4j.nix @@ -36,48 +36,43 @@ let serverConfig = pkgs.writeText "neo4j.conf" '' # General dbms.allow_upgrade=${boolToString cfg.allowUpgrade} - dbms.connectors.default_listen_address=${cfg.defaultListenAddress} - dbms.read_only=${boolToString cfg.readOnly} + dbms.default_listen_address=${cfg.defaultListenAddress} + dbms.databases.default_to_read_only=${boolToString cfg.readOnly} ${optionalString (cfg.workerCount > 0) '' dbms.threads.worker_count=${toString cfg.workerCount} ''} - # Directories + # Directories (readonly) dbms.directories.certificates=${cfg.directories.certificates} - dbms.directories.data=${cfg.directories.data} - dbms.directories.logs=${cfg.directories.home}/logs dbms.directories.plugins=${cfg.directories.plugins} + dbms.directories.lib=${cfg.package}/share/neo4j/lib ${optionalString (cfg.constrainLoadCsv) '' dbms.directories.import=${cfg.directories.imports} - ''} + ''} + + # Directories (read and write) + dbms.directories.data=${cfg.directories.data} + dbms.directories.logs=${cfg.directories.home}/logs + dbms.directories.run=${cfg.directories.home}/run # HTTP Connector ${optionalString (cfg.http.enable) '' dbms.connector.http.enabled=${boolToString cfg.http.enable} dbms.connector.http.listen_address=${cfg.http.listenAddress} - ''} - ${optionalString (!cfg.http.enable) '' - # It is not possible to disable the HTTP connector. To fully prevent - # clients from connecting to HTTP, block the HTTP port (7474 by default) - # via firewall. listen_address is set to the loopback interface to - # prevent remote clients from connecting. - dbms.connector.http.listen_address=127.0.0.1 + dbms.connector.http.advertised_address=${cfg.http.listenAddress} ''} # HTTPS Connector dbms.connector.https.enabled=${boolToString cfg.https.enable} dbms.connector.https.listen_address=${cfg.https.listenAddress} - https.ssl_policy=${cfg.https.sslPolicy} + dbms.connector.https.advertised_address=${cfg.https.listenAddress} # BOLT Connector dbms.connector.bolt.enabled=${boolToString cfg.bolt.enable} dbms.connector.bolt.listen_address=${cfg.bolt.listenAddress} - bolt.ssl_policy=${cfg.bolt.sslPolicy} + dbms.connector.bolt.advertised_address=${cfg.bolt.listenAddress} dbms.connector.bolt.tls_level=${cfg.bolt.tlsLevel} - # neo4j-shell - dbms.shell.enabled=${boolToString cfg.shell.enable} - # SSL Policies ${concatStringsSep "\n" sslPolicies} @@ -95,8 +90,10 @@ let dbms.jvm.additional=-Djdk.tls.rejectClientInitiatedRenegotiation=true dbms.jvm.additional=-Dunsupported.dbms.udc.source=tarball - # Usage Data Collector - dbms.udc.enabled=${boolToString cfg.udc.enable} + #dbms.memory.heap.initial_size=12000m + #dbms.memory.heap.max_size=12000m + #dbms.memory.pagecache.size=4g + #dbms.tx_state.max_off_heap_memory=8000m # Extra Configuration ${cfg.extraServerConfig} @@ -114,6 +111,8 @@ in { (mkRemovedOptionModule [ "services" "neo4j" "port" ] "Use services.neo4j.http.listenAddress instead.") (mkRemovedOptionModule [ "services" "neo4j" "boltPort" ] "Use services.neo4j.bolt.listenAddress instead.") (mkRemovedOptionModule [ "services" "neo4j" "httpsPort" ] "Use services.neo4j.https.listenAddress instead.") + (mkRemovedOptionModule [ "services" "neo4j" "shell" "enabled" ] "shell.enabled was removed upstream") + (mkRemovedOptionModule [ "services" "neo4j" "udc" "enabled" ] "udc.enabled was removed upstream") ]; ###### interface @@ -123,7 +122,7 @@ in { enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable Neo4j Community Edition. ''; }; @@ -131,7 +130,7 @@ in { allowUpgrade = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Allow upgrade of Neo4j database files from an older version. ''; }; @@ -139,15 +138,14 @@ in { constrainLoadCsv = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Sets the root directory for file URLs used with the Cypher - <literal>LOAD CSV</literal> clause to be that defined by - <option>directories.imports</option>. It restricts + `LOAD CSV` clause to be that defined by + {option}`directories.imports`. It restricts access to only those files within that directory and its subdirectories. - </para> - <para> - Setting this option to <literal>false</literal> introduces + + Setting this option to `false` introduces possible security problems. ''; }; @@ -155,24 +153,23 @@ in { defaultListenAddress = mkOption { type = types.str; default = "127.0.0.1"; - description = '' + description = lib.mdDoc '' Default network interface to listen for incoming connections. To listen for connections on all interfaces, use "0.0.0.0". - </para> - <para> + Specifies the default IP address and address part of connector - specific <option>listenAddress</option> options. To bind specific + specific {option}`listenAddress` options. To bind specific connectors to a specific network interfaces, specify the entire - <option>listenAddress</option> option for that connector. + {option}`listenAddress` option for that connector. ''; }; extraServerConfig = mkOption { type = types.lines; default = ""; - description = '' + description = lib.mdDoc '' Extra configuration for Neo4j Community server. Refer to the - <link xlink:href="https://neo4j.com/docs/operations-manual/current/reference/configuration-settings/">complete reference</link> + [complete reference](https://neo4j.com/docs/operations-manual/current/reference/configuration-settings/) of Neo4j configuration settings. ''; }; @@ -181,7 +178,7 @@ in { type = types.package; default = pkgs.neo4j; defaultText = literalExpression "pkgs.neo4j"; - description = '' + description = lib.mdDoc '' Neo4j package to use. ''; }; @@ -189,7 +186,7 @@ in { readOnly = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Only allow read operations from this Neo4j instance. ''; }; @@ -197,9 +194,9 @@ in { workerCount = mkOption { type = types.ints.between 0 44738; default = 0; - description = '' + description = lib.mdDoc '' Number of Neo4j worker threads, where the default of - <literal>0</literal> indicates a worker count equal to the number of + `0` indicates a worker count equal to the number of available processors. ''; }; @@ -208,9 +205,9 @@ in { enable = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Enable the BOLT connector for Neo4j. Setting this option to - <literal>false</literal> will stop Neo4j from listening for incoming + `false` will stop Neo4j from listening for incoming connections on the BOLT port (7687 by default). ''; }; @@ -218,36 +215,34 @@ in { listenAddress = mkOption { type = types.str; default = ":7687"; - description = '' + description = lib.mdDoc '' Neo4j listen address for BOLT traffic. The listen address is - expressed in the format <literal><ip-address>:<port-number></literal>. + expressed in the format `<ip-address>:<port-number>`. ''; }; sslPolicy = mkOption { type = types.str; default = "legacy"; - description = '' + description = lib.mdDoc '' Neo4j SSL policy for BOLT traffic. - </para> - <para> + The legacy policy is a special policy which is not defined in the policy configuration section, but rather derives from - <option>directories.certificates</option> and - associated files (by default: <filename>neo4j.key</filename> and - <filename>neo4j.cert</filename>). Its use will be deprecated. - </para> - <para> + {option}`directories.certificates` and + associated files (by default: {file}`neo4j.key` and + {file}`neo4j.cert`). Its use will be deprecated. + Note: This connector must be configured to support/require SSL/TLS for the legacy policy to actually be utilized. See - <option>bolt.tlsLevel</option>. + {option}`bolt.tlsLevel`. ''; }; tlsLevel = mkOption { type = types.enum [ "REQUIRED" "OPTIONAL" "DISABLED" ]; default = "OPTIONAL"; - description = '' + description = lib.mdDoc '' SSL/TSL requirement level for BOLT traffic. ''; }; @@ -258,21 +253,19 @@ in { type = types.path; default = "${cfg.directories.home}/certificates"; defaultText = literalExpression ''"''${config.${opt.directories.home}}/certificates"''; - description = '' + description = lib.mdDoc '' Directory for storing certificates to be used by Neo4j for TLS connections. - </para> - <para> + When setting this directory to something other than its default, ensure the directory's existence, and that read/write permissions are - given to the Neo4j daemon user <literal>neo4j</literal>. - </para> - <para> + given to the Neo4j daemon user `neo4j`. + Note that changing this directory from its default will prevent the directory structure required for each SSL policy from being automatically generated. A policy's directory structure as defined by - its <option>baseDirectory</option>,<option>revokedDir</option> and - <option>trustedDir</option> must then be setup manually. The + its {option}`baseDirectory`,{option}`revokedDir` and + {option}`trustedDir` must then be setup manually. The existence of these directories is mandatory, as well as the presence of the certificate file and the private key. Ensure the correct permissions are set on these directories and files. @@ -283,25 +276,24 @@ in { type = types.path; default = "${cfg.directories.home}/data"; defaultText = literalExpression ''"''${config.${opt.directories.home}}/data"''; - description = '' + description = lib.mdDoc '' Path of the data directory. You must not configure more than one Neo4j installation to use the same data directory. - </para> - <para> + When setting this directory to something other than its default, ensure the directory's existence, and that read/write permissions are - given to the Neo4j daemon user <literal>neo4j</literal>. + given to the Neo4j daemon user `neo4j`. ''; }; home = mkOption { type = types.path; default = "/var/lib/neo4j"; - description = '' + description = lib.mdDoc '' Path of the Neo4j home directory. Other default directories are subdirectories of this path. This directory will be created if - non-existent, and its ownership will be <command>chown</command> to - the Neo4j daemon user <literal>neo4j</literal>. + non-existent, and its ownership will be {command}`chown` to + the Neo4j daemon user `neo4j`. ''; }; @@ -309,16 +301,15 @@ in { type = types.path; default = "${cfg.directories.home}/import"; defaultText = literalExpression ''"''${config.${opt.directories.home}}/import"''; - description = '' + description = lib.mdDoc '' The root directory for file URLs used with the Cypher - <literal>LOAD CSV</literal> clause. Only meaningful when - <option>constrainLoadCvs</option> is set to - <literal>true</literal>. - </para> - <para> + `LOAD CSV` clause. Only meaningful when + {option}`constrainLoadCvs` is set to + `true`. + When setting this directory to something other than its default, ensure the directory's existence, and that read permission is - given to the Neo4j daemon user <literal>neo4j</literal>. + given to the Neo4j daemon user `neo4j`. ''; }; @@ -326,15 +317,14 @@ in { type = types.path; default = "${cfg.directories.home}/plugins"; defaultText = literalExpression ''"''${config.${opt.directories.home}}/plugins"''; - description = '' + description = lib.mdDoc '' Path of the database plugin directory. Compiled Java JAR files that contain database procedures will be loaded if they are placed in this directory. - </para> - <para> + When setting this directory to something other than its default, ensure the directory's existence, and that read permission is - given to the Neo4j daemon user <literal>neo4j</literal>. + given to the Neo4j daemon user `neo4j`. ''; }; }; @@ -344,21 +334,18 @@ in { type = types.bool; default = true; description = '' - The HTTP connector is required for Neo4j, and cannot be disabled. - Setting this option to <literal>false</literal> will force the HTTP - connector's <option>listenAddress</option> to the loopback - interface to prevent connection of remote clients. To prevent all - clients from connecting, block the HTTP port (7474 by default) by - firewall. + Enable the HTTP connector for Neo4j. Setting this option to + <literal>false</literal> will stop Neo4j from listening for incoming + connections on the HTTPS port (7474 by default). ''; }; listenAddress = mkOption { type = types.str; default = ":7474"; - description = '' + description = lib.mdDoc '' Neo4j listen address for HTTP traffic. The listen address is - expressed in the format <literal><ip-address>:<port-number></literal>. + expressed in the format `<ip-address>:<port-number>`. ''; }; }; @@ -367,9 +354,9 @@ in { enable = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Enable the HTTPS connector for Neo4j. Setting this option to - <literal>false</literal> will stop Neo4j from listening for incoming + `false` will stop Neo4j from listening for incoming connections on the HTTPS port (7473 by default). ''; }; @@ -377,24 +364,23 @@ in { listenAddress = mkOption { type = types.str; default = ":7473"; - description = '' + description = lib.mdDoc '' Neo4j listen address for HTTPS traffic. The listen address is - expressed in the format <literal><ip-address>:<port-number></literal>. + expressed in the format `<ip-address>:<port-number>`. ''; }; sslPolicy = mkOption { type = types.str; default = "legacy"; - description = '' + description = lib.mdDoc '' Neo4j SSL policy for HTTPS traffic. - </para> - <para> + The legacy policy is a special policy which is not defined in the policy configuration section, but rather derives from - <option>directories.certificates</option> and - associated files (by default: <filename>neo4j.key</filename> and - <filename>neo4j.cert</filename>). Its use will be deprecated. + {option}`directories.certificates` and + associated files (by default: {file}`neo4j.key` and + {file}`neo4j.cert`). Its use will be deprecated. ''; }; }; @@ -403,9 +389,9 @@ in { enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Enable a remote shell server which Neo4j Shell clients can log in to. - Only applicable to <command>neo4j-shell</command>. + Only applicable to {command}`neo4j-shell`. ''; }; }; @@ -417,18 +403,16 @@ in { allowKeyGeneration = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Allows the generation of a private key and associated self-signed certificate. Only performed when both objects cannot be found for this policy. It is recommended to turn this off again after keys have been generated. - </para> - <para> + The public certificate is required to be duplicated to the directory holding trusted certificates as defined by the - <option>trustedDir</option> option. - </para> - <para> + {option}`trustedDir` option. + Keys should in general be generated and distributed offline by a trusted certificate authority and not by utilizing this mode. ''; @@ -438,17 +422,16 @@ in { type = types.path; default = "${cfg.directories.certificates}/${name}"; defaultText = literalExpression ''"''${config.${opt.directories.certificates}}/''${name}"''; - description = '' + description = lib.mdDoc '' The mandatory base directory for cryptographic objects of this policy. This path is only automatically generated when this - option as well as <option>directories.certificates</option> are + option as well as {option}`directories.certificates` are left at their default. Ensure read/write permissions are given - to the Neo4j daemon user <literal>neo4j</literal>. - </para> - <para> + to the Neo4j daemon user `neo4j`. + It is also possible to override each individual configuration with absolute paths. See the - <option>privateKey</option> and <option>publicCertificate</option> + {option}`privateKey` and {option}`publicCertificate` policy options. ''; }; @@ -456,7 +439,7 @@ in { ciphers = mkOption { type = types.nullOr (types.listOf types.str); default = null; - description = '' + description = lib.mdDoc '' Restrict the allowed ciphers of this policy to those defined here. The default ciphers are those of the JVM platform. ''; @@ -465,7 +448,7 @@ in { clientAuth = mkOption { type = types.enum [ "NONE" "OPTIONAL" "REQUIRE" ]; default = "REQUIRE"; - description = '' + description = lib.mdDoc '' The client authentication stance for this policy. ''; }; @@ -473,9 +456,9 @@ in { privateKey = mkOption { type = types.str; default = "private.key"; - description = '' + description = lib.mdDoc '' The name of private PKCS #8 key file for this policy to be found - in the <option>baseDirectory</option>, or the absolute path to + in the {option}`baseDirectory`, or the absolute path to the key file. It is mandatory that a key can be found or generated. ''; }; @@ -483,16 +466,15 @@ in { publicCertificate = mkOption { type = types.str; default = "public.crt"; - description = '' + description = lib.mdDoc '' The name of public X.509 certificate (chain) file in PEM format - for this policy to be found in the <option>baseDirectory</option>, + for this policy to be found in the {option}`baseDirectory`, or the absolute path to the certificate file. It is mandatory that a certificate can be found or generated. - </para> - <para> + The public certificate is required to be duplicated to the directory holding trusted certificates as defined by the - <option>trustedDir</option> option. + {option}`trustedDir` option. ''; }; @@ -500,22 +482,22 @@ in { type = types.path; default = "${config.baseDirectory}/revoked"; defaultText = literalExpression ''"''${config.${options.baseDirectory}}/revoked"''; - description = '' + description = lib.mdDoc '' Path to directory of CRLs (Certificate Revocation Lists) in PEM format. Must be an absolute path. The existence of this directory is mandatory and will need to be created manually when: setting this option to something other than its default; setting - either this policy's <option>baseDirectory</option> or - <option>directories.certificates</option> to something other than + either this policy's {option}`baseDirectory` or + {option}`directories.certificates` to something other than their default. Ensure read/write permissions are given to the - Neo4j daemon user <literal>neo4j</literal>. + Neo4j daemon user `neo4j`. ''; }; tlsVersions = mkOption { type = types.listOf types.str; default = [ "TLSv1.2" ]; - description = '' + description = lib.mdDoc '' Restrict the TLS protocol versions of this policy to those defined here. ''; @@ -524,7 +506,7 @@ in { trustAll = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Makes this policy trust all remote parties. Enabling this is not recommended and the policy's trusted directory will be ignored. Use of this mode is discouraged. It would offer encryption but @@ -536,19 +518,18 @@ in { type = types.path; default = "${config.baseDirectory}/trusted"; defaultText = literalExpression ''"''${config.${options.baseDirectory}}/trusted"''; - description = '' + description = lib.mdDoc '' Path to directory of X.509 certificates in PEM format for trusted parties. Must be an absolute path. The existence of this directory is mandatory and will need to be created manually when: setting this option to something other than its default; setting - either this policy's <option>baseDirectory</option> or - <option>directories.certificates</option> to something other than + either this policy's {option}`baseDirectory` or + {option}`directories.certificates` to something other than their default. Ensure read/write permissions are given to the - Neo4j daemon user <literal>neo4j</literal>. - </para> - <para> + Neo4j daemon user `neo4j`. + The public certificate as defined by - <option>publicCertificate</option> is required to be duplicated + {option}`publicCertificate` is required to be duplicated to this directory. ''; }; @@ -573,29 +554,16 @@ in { })); default = {}; - description = '' + description = lib.mdDoc '' Defines the SSL policies for use with Neo4j connectors. Each attribute of this set defines a policy, with the attribute name defining the name of the policy and its namespace. Refer to the operations manual section on Neo4j's - <link xlink:href="https://neo4j.com/docs/operations-manual/current/security/ssl-framework/">SSL Framework</link> + [SSL Framework](https://neo4j.com/docs/operations-manual/current/security/ssl-framework/) for further details. ''; }; - udc = { - enable = mkOption { - type = types.bool; - default = false; - description = '' - Enable the Usage Data Collector which Neo4j uses to collect usage - data. Refer to the operations manual section on the - <link xlink:href="https://neo4j.com/docs/operations-manual/current/configuration/usage-data-collector/">Usage Data Collector</link> - for more information. - ''; - }; - }; - }; ###### implementation @@ -627,7 +595,7 @@ in { wantedBy = [ "multi-user.target" ]; after = [ "network.target" ]; environment = { - NEO4J_HOME = "${cfg.package}/share/neo4j"; + NEO4J_HOME = "${cfg.directories.home}"; NEO4J_CONF = "${cfg.directories.home}/conf"; }; serviceConfig = { @@ -668,6 +636,6 @@ in { }; meta = { - maintainers = with lib.maintainers; [ patternspandemic ]; + maintainers = with lib.maintainers; [ patternspandemic jonringer erictapen ]; }; } |