23.3. File Locations

This table shows where important files can be found by default in various Neo4j distribution packages.

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/Ubuntu .deb

/etc/neo4j/neo4j.conf

/var/lib/neo4j/data

/var/log/neo4j

/var/lib/neo4j/metrics

/var/lib/neo4j/import

/var/lib/neo4j/bin

/var/lib/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.1.0-SNAPSHOT\bin

(in package)

%ProgramFiles%\Neo4j CE 3.1.0-SNAPSHOT\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)

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

Log Files

Filename Description

neo4j.log

The standard log, where general information about Neo4j is written.

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 only.)

Configuration

Some of these paths are configurable with dbms.directories.* settings; see Section 24.7, “Configuration Settings Reference” for details.

The locations of <neo4j-home>, bin and conf can be configured using environment variables.

Location Default Environment variable Notes

<neo4j-home>

parent of bin

NEO4J_HOME

Must be set explicitly if bin is not a subdirectory.

bin

directory where neo4j script is located

NEO4J_BIN

Must be set explicitly if neo4j script is invoked as a symlink.

conf

<neo4j-home>/conf

NEO4J_CONF

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

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
Exectute
  • all files in bin