Neo4j
services.neo4j.bolt.enable
Enable the BOLT connector for Neo4j. Setting this option to
false will stop Neo4j from listening for incoming
connections on the BOLT port (7687 by default).
Type: boolean
Default
true
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/databases/neo4j.nix
services.neo4j.bolt.listenAddress
Neo4j listen address for BOLT traffic. The listen address is
expressed in the format <ip-address>:<port-number>.
Type: string
Default
":7687"
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/databases/neo4j.nix
services.neo4j.bolt.sslPolicy
Neo4j SSL policy for BOLT traffic.
The legacy policy is a special policy which is not defined in
the policy configuration section, but rather derives from
{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.
Type: string
Default
"legacy"
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/databases/neo4j.nix
services.neo4j.bolt.tlsLevel
SSL/TSL requirement level for BOLT traffic.
Type: one of "REQUIRED", "OPTIONAL", "DISABLED"
Default
"OPTIONAL"
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/databases/neo4j.nix
services.neo4j.constrainLoadCsv
Sets the root directory for file URLs used with the Cypher
LOAD CSV clause to be that defined by
{option}directories.imports. It restricts
access to only those files within that directory and its
subdirectories.
Setting this option to false introduces
possible security problems.
Type: boolean
Default
true
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/databases/neo4j.nix
services.neo4j.defaultListenAddress
Default network interface to listen for incoming connections. To listen for connections on all interfaces, use "0.0.0.0".
Specifies the default IP address and address part of connector
specific {option}listenAddress options. To bind specific
connectors to a specific network interfaces, specify the entire
{option}listenAddress option for that connector.
Type: string
Default
"127.0.0.1"
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/databases/neo4j.nix
services.neo4j.directories.certificates
Directory for storing certificates to be used by Neo4j for TLS connections.
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 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}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.
Type: path
Default
"${config.services.neo4j.directories.home}/certificates"
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/databases/neo4j.nix
services.neo4j.directories.data
Path of the data directory. You must not configure more than one Neo4j installation to use the same data directory.
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 neo4j.
Type: path
Default
"${config.services.neo4j.directories.home}/data"
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/databases/neo4j.nix
services.neo4j.directories.home
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 to
the Neo4j daemon user neo4j.
Type: path
Default
"/var/lib/neo4j"
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/databases/neo4j.nix
services.neo4j.directories.imports
The root directory for file URLs used with the Cypher
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 neo4j.
Type: path
Default
"${config.services.neo4j.directories.home}/import"
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/databases/neo4j.nix
services.neo4j.directories.plugins
Path of the database plugin directory. Compiled Java JAR files that contain database procedures will be loaded if they are placed in this directory.
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 neo4j.
Type: path
Default
"${config.services.neo4j.directories.home}/plugins"
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/databases/neo4j.nix
services.neo4j.enable
Whether to enable Neo4j Community Edition.
Type: boolean
Default
false
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/databases/neo4j.nix
services.neo4j.extraServerConfig
Extra configuration for Neo4j Community server. Refer to the complete reference of Neo4j configuration settings.
Type: strings concatenated with "\n"
Default
""
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/databases/neo4j.nix
services.neo4j.http.enable
Enable the HTTP connector for Neo4j. Setting this option to
false will stop Neo4j from listening for incoming
connections on the HTTPS port (7474 by default).
Type: boolean
Default
true
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/databases/neo4j.nix
services.neo4j.http.listenAddress
Neo4j listen address for HTTP traffic. The listen address is
expressed in the format <ip-address>:<port-number>.
Type: string
Default
":7474"
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/databases/neo4j.nix
services.neo4j.https.enable
Enable the HTTPS connector for Neo4j. Setting this option to
false will stop Neo4j from listening for incoming
connections on the HTTPS port (7473 by default).
Type: boolean
Default
true
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/databases/neo4j.nix
services.neo4j.https.listenAddress
Neo4j listen address for HTTPS traffic. The listen address is
expressed in the format <ip-address>:<port-number>.
Type: string
Default
":7473"
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/databases/neo4j.nix
services.neo4j.https.sslPolicy
Neo4j SSL policy for HTTPS traffic.
The legacy policy is a special policy which is not defined in the
policy configuration section, but rather derives from
{option}directories.certificates and
associated files (by default: {file}neo4j.key and
{file}neo4j.cert). Its use will be deprecated.
Type: string
Default
"legacy"
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/databases/neo4j.nix
services.neo4j.package
The neo4j package to use.
Type: package
Default
pkgs.neo4j
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/databases/neo4j.nix
services.neo4j.readOnly
Only allow read operations from this Neo4j instance.
Type: boolean
Default
false
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/databases/neo4j.nix
services.neo4j.shell.enable
Enable a remote shell server which Neo4j Shell clients can log in to.
Only applicable to {command}neo4j-shell.
Type: boolean
Default
false
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/databases/neo4j.nix
services.neo4j.ssl.policies
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 SSL Framework for further details.
Type: attribute set of (submodule)
Default
{ }
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/databases/neo4j.nix
services.neo4j.ssl.policies.<name>.allowKeyGeneration
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.
The public certificate is required to be duplicated to the
directory holding trusted certificates as defined by the
{option}trustedDir option.
Keys should in general be generated and distributed offline by a trusted certificate authority and not by utilizing this mode.
Type: boolean
Default
false
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/databases/neo4j.nix
services.neo4j.ssl.policies.<name>.baseDirectory
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 are
left at their default. Ensure read/write permissions are given
to the Neo4j daemon user neo4j.
It is also possible to override each individual
configuration with absolute paths. See the
{option}privateKey and {option}publicCertificate
policy options.
Type: path
Default
"${config.services.neo4j.directories.certificates}/${name}"
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/databases/neo4j.nix
services.neo4j.ssl.policies.<name>.ciphers
Restrict the allowed ciphers of this policy to those defined here. The default ciphers are those of the JVM platform.
Type: null or (list of string)
Default
null
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/databases/neo4j.nix
services.neo4j.ssl.policies.<name>.clientAuth
The client authentication stance for this policy.
Type: one of "NONE", "OPTIONAL", "REQUIRE"
Default
"REQUIRE"
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/databases/neo4j.nix
services.neo4j.ssl.policies.<name>.privateKey
The name of private PKCS #8 key file for this policy to be found
in the {option}baseDirectory, or the absolute path to
the key file. It is mandatory that a key can be found or generated.
Type: string
Default
"private.key"
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/databases/neo4j.nix
services.neo4j.ssl.policies.<name>.publicCertificate
The name of public X.509 certificate (chain) file in PEM format
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.
The public certificate is required to be duplicated to the
directory holding trusted certificates as defined by the
{option}trustedDir option.
Type: string
Default
"public.crt"
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/databases/neo4j.nix
services.neo4j.ssl.policies.<name>.revokedDir
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 or
{option}directories.certificates to something other than
their default. Ensure read/write permissions are given to the
Neo4j daemon user neo4j.
Type: path
Default
"${config.services.neo4j.ssl.policies.<name>.baseDirectory}/revoked"
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/databases/neo4j.nix
services.neo4j.ssl.policies.<name>.tlsVersions
Restrict the TLS protocol versions of this policy to those defined here.
Type: list of string
Default
["TLSv1.2"]
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/databases/neo4j.nix
services.neo4j.ssl.policies.<name>.trustAll
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 no security.
Type: boolean
Default
false
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/databases/neo4j.nix
services.neo4j.ssl.policies.<name>.trustedDir
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 or
{option}directories.certificates to something other than
their default. Ensure read/write permissions are given to the
Neo4j daemon user neo4j.
The public certificate as defined by
{option}publicCertificate is required to be duplicated
to this directory.
Type: path
Default
"${config.services.neo4j.ssl.policies.<name>.baseDirectory}/trusted"
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/databases/neo4j.nix
services.neo4j.workerCount
Number of Neo4j worker threads, where the default of
0 indicates a worker count equal to the number of
available processors.
Type: integer between 0 and 44738 (both inclusive)
Default
0
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/databases/neo4j.nix