3.2. File locations

This section provides an overview of where files are stored in the different Neo4j distributions, and the necessary file permissions for running Neo4j.

This section describes the following:

3.2.1. Where to find important files

The table below lists the location of important files, and whether the location is customizable:

Table 3.1. The locations of important files
Package Configuration Data * Logs Metrics Import Bin Lib Plugins

Linux or OS X tarball

<neo4j-home>/conf/neo4j.conf

<neo4j-home>/data

<neo4j-home>/logs

<neo4j-home>/metrics

<neo4j-home>/import

<neo4j-home>/bin

<neo4j-home>/lib

<neo4j-home>/plugins

Windows zip

<neo4j-home>\conf\neo4j.conf

<neo4j-home>\data

<neo4j-home>\logs

<neo4j-home>\metrics

<neo4j-home>\import

<neo4j-home>\bin

<neo4j-home>\lib

<neo4j-home>\plugins

Debian

/etc/neo4j/neo4j.conf

/var/lib/neo4j/data

/var/log/neo4j/ **

/var/lib/neo4j/metrics

/var/lib/neo4j/import

/usr/bin

/usr/share/neo4j/lib

/var/lib/neo4j/plugins

RPM

/etc/neo4j/neo4j.conf

/var/lib/neo4j/data

/var/log/neo4j/ **

/var/lib/neo4j/metrics

/var/lib/neo4j/import

/usr/bin

/usr/share/neo4j/lib

/var/lib/neo4j/plugins

Windows desktop

%APPDATA%\Neo4j Community Edition\neo4j.conf

%APPDATA%\Neo4j Community Edition

%APPDATA%\Neo4j Community Edition\logs

%APPDATA%\Neo4j Community Edition\metrics

%APPDATA%\Neo4j Community Edition\import

%ProgramFiles%\Neo4j CE 3.4\bin

(in package)

%ProgramFiles%\Neo4j CE 3.4\plugins

OS X desktop

${HOME}/Documents/Neo4j/neo4j.conf

${HOME}/Documents/Neo4j

${HOME}/Documents/Neo4j/logs

${HOME}/Documents/Neo4j/metrics

${HOME}/Documents/Neo4j/import

(in package)

(in package)

(in package)

Customizable by option

See Table 3.2, “Configuration of <neo4j-home> and conf

dbms.directories.data

dbms.directories.logs

dbms.directories.metrics

dbms.directories.import

Not applicable

dbms.directories.lib

dbms.directories.plugins

* Please note that the data directory is internal to Neo4j and its structure is subject to change between versions without notice.

** To view the neo4j.log for Debian and RPM, use journalctl --unit=neo4j.

The locations of <neo4j-home> and conf can be configured using environment variables, as described below:

Table 3.2. Configuration of <neo4j-home> and conf
Location Default Environment variable Notes

<neo4j-home>

parent of bin

NEO4J_HOME

Must be set explicitly if bin is not a subdirectory.

conf

<neo4j-home>/conf

NEO4J_CONF

Must be set explicitly if it is not a subdirectory of <neo4j-home>.

3.2.2. Log files

Filename Description

neo4j.log

The standard log, where general information about Neo4j is written. Not written for Debian and RPM packages. See relevant sections.

debug.log

Information useful when debugging problems with Neo4j.

http.log

Request log for the HTTP API.

gc.log

Garbage Collection logging provided by the JVM.

query.log

Log of executed queries that takes longer than a specified threshold. (Enterprise Edition only.)

security.log

Log of security events. (Enterprise Edition only.)

service-error.log

Log of errors encountered when installing or running the Windows service. (Windows only.)

3.2.3. File permissions

The user that Neo4j runs as must have the following permissions:

Read only
  • conf
  • import
  • bin
  • lib
  • plugins
Read and write
  • data
  • logs
  • metrics
Execute
  • all files in bin