Setting up Neo4j Enterprise Edition Linux - tomgeudens/practical-neo4j GitHub Wiki
Disclaimer: This document aims at getting a Neo4j database up-and-running in the context of a training or experiment. It is not fit for production installation purposes. It also assumes a single user single machine developer installation and is in that respect similar to a Neo4j Desktop installation (which also provides the Enterprise Edition). For that purpose the Neo4j Enterprise Edition software requires no further licensing. For any other purpose ... it does !
Version: this document is current for version 4.4.40
Last Update: 2024/12/27 - Neo4j 4.4.40
This document will assume everything (software, installation, database) is going to happen in a single neo4j folder (which is created below). This folder must reside in a location that is writable for the user with which you are logged on. No elevated rights will be needed (and try to avoid using root). The /home/ folder is perfect.
<user>@<machine>:~$
<user>@<machine>:~$ mkdir neo4j
<user>@<machine>:~$ mkdir neo4j/scripts
<user>@<machine>:~$ cd neo4j
<user>@<machine>:~/neo4j$
Everything that follows will assume that you are positioned in the neo4j folder !
Now, six scripts need to be put in the scripts folder. You can download these from here :
<user>@<machine>:~/neo4j$ wget -O "scripts/version.sh" https://raw.githubusercontent.com/tomgeudens/practical-neo4j/master/scripts/fourohandbeyond/linux/version.sh
<user>@<machine>:~/neo4j$ wget -O "scripts/download.sh" https://raw.githubusercontent.com/tomgeudens/practical-neo4j/master/scripts/fourohandbeyond/linux/download.sh
<user>@<machine>:~/neo4j$ wget -O "scripts/unpack.sh" https://raw.githubusercontent.com/tomgeudens/practical-neo4j/master/scripts/fourohandbeyond/linux/unpack.sh
<user>@<machine>:~/neo4j$ wget -O "scripts/move.sh" https://raw.githubusercontent.com/tomgeudens/practical-neo4j/master/scripts/fourohandbeyond/linux/move.sh
<user>@<machine>:~/neo4j$ wget -O "scripts/settings.sh" https://raw.githubusercontent.com/tomgeudens/practical-neo4j/master/scripts/fourohandbeyond/linux/settings.sh
<user>@<machine>:~/neo4j$ wget -O "scripts/environment.sh" https://raw.githubusercontent.com/tomgeudens/practical-neo4j/master/scripts/fourohandbeyond/linux/environment.sh
Do verify the sizes match up ...
<user>@<machine>:~/neo4j$ ls -l scripts/
... 479 ... download.sh
... 188 ... environment.sh
... 215 ... move.sh
... 2221 ... settings.sh
... 230 ... unpack.sh
... 113 ... version.sh
In this step a subfolder install will be created and the following softwares will be put into it :
| What | Location |
|---|---|
| Java JRE | install/zulu11.76.21-ca-jre11.0.25-linux_x64.tar.gz |
| Neo4j Enterprise Server | install/neo4j-enterprise-4.4.40-unix.tar.gz |
| GDS library | install/neo4j-graph-data-science-2.6.8.zip |
The instructions below will use a simple script to accomplish this. Note that this is one of the scripts you downloaded earlier.
<user>@<machine>:~/neo4j$ sh -x scripts/download.sh
<user>@<machine>:~/neo4j$ ls -l install/
... 245946456 ... neo4j-enterprise-4.4.40-unix.tar.gz
... 51829203 ... neo4j-graph-data-science-2.6.8.zip
... 43420924 ... zulu11.76.21-ca-jre11.0.25-linux_x64.tar.gz
Do check that the sizes match with yours !
In this step, everything that is compressed will be unpacked. Typically that's the Neo4j software, the Java software and the Graph Data Science zip.
<user>@<machine>:~/neo4j$ sh -x scripts/unpack.sh
+ tar -xzf install/zulu11.76.21-ca-jre11.0.25-linux_x64.tar.gz
+ tar -xzf install/neo4j-enterprise-4.4.40-unix.tar.gz
+ unzip -q install/neo4j-graph-data-science-2.6.8.zip -d install
<user>@<machine>:~/neo4j$ ls -l
... install
... neo4j-enterprise-4.4.40
... scripts
... zulu11.76.21-ca-jre11.0.25-linux_x64
With all the plugins now in jar form, it's time to move them into the plugins folder.
<user>@<machine>:~/neo4j$ sh -x scripts/move.sh
+ mv neo4j-enterprise-4.4.40/labs/apoc-4.4.0.34-core.jar neo4j-enterprise-4.4.40/plugins
+ mv install/neo4j-graph-data-science-2.6.8.jar neo4j-enterprise-4.4.40/plugins
And verify that things match up ...
<user>@<machine>:~/neo4j$ ls -l neo4j-enterprise-4.4.40/plugins/
... 16748882 ... apoc-4.4.0.34-core.jar
... 58520104 ... neo4j-graph-data-science-2.6.8.jar
... 2217 ... README.txt
With that done, it’s time for some basic customization ...
Most of the default settings of Neo4j are fine for the purposes of a training or experimentation, but not all. The script below (that you downloaded earlier) fixes what needs fixing and also sets the initial password for the database to morpheus. Alternatively you can also modify the neo4j.conf and apoc.conf files manually, the statement shows all the changes you need to make.
<user>@<machine>:~/neo4j$ sh -x scripts/settings.sh
Selecting JVM - Version:11.0.25+9-LTS, Name:OpenJDK 64-Bit Server VM, Vendor:Azul Systems, Inc.
Changed password for user 'neo4j'. IMPORTANT: this change will only take effect if performed before the database is started for the first time.
<user>@<machine>:~/neo4j$ tail -n 18 neo4j-enterprise-4.4.40/conf/neo4j.conf
metrics.enabled=true
metrics.namespaces.enabled=true
metrics.filter=*
metrics.csv.enabled=false
metrics.prometheus.enabled=false
metrics.graphite.enabled=false
metrics.jmx.enabled=true
dbms.security.procedures.unrestricted=apoc.*,gds.*
dbms.default_listen_address=0.0.0.0
dbms.logs.query.enabled=off
dbms.memory.heap.initial_size=2g
dbms.memory.heap.max_size=2g
dbms.memory.pagecache.size=1g
dbms.memory.transaction.global_max_size=2000m
dbms.tx_log.rotation.retention_policy=1G size
dbms.db.timezone=SYSTEM
dbms.logs.user.stdout_enabled=false
browser.remote_content_hostname_whitelist=*
<user>@<machine>:~/neo4j$ cat neo4j-enterprise-4.4.40/conf/apoc.conf
apoc.export.file.enabled=true
apoc.import.file.enabled=true
apoc.import.file.use_neo4j_config=true
Ready to start now ...
We are going to be running the database in console mode. That means that the command we are going to issue will continue running in the foreground (so do not close the shell unless you want to bring down the database). An important thing here is that you need to have the correct (11 for Neo4j 4.x.x) Java environment. And the final script you downloaded earlier does just that ...
<user>@<machine>:~/neo4j$ . ./scripts/environment.sh
<user>@<machine>:~/neo4j$ echo $JAVA_HOME
<yourlocation>/neo4j/zulu11.76.21-ca-jre11.0.25-linux_x64
<user>@<machine>:~/neo4j$ neo4j-enterprise-4.4.40/bin/neo4j console
Directories in use:
home: /neo4j/neo4j-enterprise-4.4.40
config: /neo4j/neo4j-enterprise-4.4.40/conf
logs: /neo4j/neo4j-enterprise-4.4.40/logs
plugins: /neo4j/neo4j-enterprise-4.4.40/plugins
import: /neo4j/neo4j-enterprise-4.4.40/import
data: /neo4j/neo4j-enterprise-4.4.40/data
certificates: /neo4j/neo4j-enterprise-4.4.40/certificates
licenses: /neo4j/neo4j-enterprise-4.4.40/licenses
run: /neo4j/neo4j-enterprise-4.4.40/run
Starting Neo4j.
2024-12-27 10:01:44.891+0100 INFO Starting...
2024-12-27 10:01:45.070+0100 INFO This instance is ServerId{xxxxxxxx} (xxxxxxxx-yyyy-zzzz-aaaa-bbbbbbbbbbbb)
SLF4J(W): No SLF4J providers were found.
SLF4J(W): Defaulting to no-operation (NOP) logger implementation
SLF4J(W): See https://www.slf4j.org/codes.html#noProviders for further details.
SLF4J(W): Class path contains SLF4J bindings targeting slf4j-api versions 1.7.x or earlier.
SLF4J(W): Ignoring binding found at [jar:file:<yourlocation>/neo4j/neo4j-enterprise-4.4.40/lib/slf4j-nop-1.7.30.jar!/org/slf4j/impl/StaticLoggerBinder.class]
SLF4J(W): See https://www.slf4j.org/codes.html#ignoredBindings for an explanation.
2024-12-27 10:01:45.860+0100 INFO ======== Neo4j 4.4.40 ========
2024-12-27 10:01:45.881+0100 INFO Progress tracking: enabled
2024-12-27 10:01:45.881+0100 INFO Memory usage guard: minimum estimate
2024-12-27 10:01:45.883+0100 INFO GDS license file: null
2024-12-27 10:01:45.883+0100 INFO GDS license state: unlicensed
2024-12-27 10:01:45.886+0100 INFO Register GraphDataScience...
2024-12-27 10:01:45.893+0100 INFO GraphDataScience registered.
2024-12-27 10:01:45.893+0100 INFO Register GraphDataScienceExtras...
2024-12-27 10:01:45.893+0100 INFO GraphDataScienceExtras registered.
2024-12-27 10:01:45.893+0100 INFO Register MetricsFacade...
2024-12-27 10:01:45.893+0100 INFO MetricsFacade registered.
2024-12-27 10:01:45.894+0100 INFO Register legacy Task Store/ Registry...
2024-12-27 10:01:45.894+0100 INFO Task Store/ Registry registered.
2024-12-27 10:01:45.894+0100 INFO Register legacy User Log Registry...
2024-12-27 10:01:45.895+0100 INFO User Log Registry registered.
2024-12-27 10:01:46.079+0100 INFO GDS compatibility: for Neo4j Settings 5.x (placeholder) -- not available, for Neo4j Settings 4.4 -- available, selected: Neo4j Settings 4.4
2024-12-27 10:01:46.079+0100 INFO GDS compatibility: for Neo4j 4.4 -- available, for Neo4j 5.11 (placeholder) -- not available, for Neo4j 5.12 (placeholder) -- not available, for Neo4j 5.13 (placeholder) -- not available, for Neo4j 5.14 (placeholder) -- not available, for Neo4j 5.15 (placeholder) -- not available, for Neo4j 5.16 (placeholder) -- not available, for Neo4j 5.17 (placeholder) -- not available, for Neo4j RC (placeholder) -- not available, for Neo4j 5.19 (placeholder) -- not available, for Neo4j 5.20 (placeholder) -- not available, selected: Neo4j 4.4
2024-12-27 10:01:54.533+0100 INFO Bolt enabled on [0:0:0:0:0:0:0:0]:7687.
2024-12-27 10:01:55.084+0100 INFO Remote interface available at http://localhost:7474/
2024-12-27 10:01:55.087+0100 INFO id: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
2024-12-27 10:01:55.087+0100 INFO name: system
2024-12-27 10:01:55.087+0100 INFO creationDate: 2024-12-27T10:01:46.37+01:00
2024-12-27 10:01:55.087+0100 INFO Started.
The SLF4J(W) is a known warning that can be ignored.
Enjoy!
The observation has been made that it can be hard to correctly cut-and-paste the commands from in between the output and the explanation. Below you'll therefore find just the necessary commands.
Setup
The assumption is that you have positioned yourself in the location where the self-contained setup needs to go
mkdir neo4j
mkdir neo4j/scripts
cd neo4j
wget -O "scripts/version.sh" https://raw.githubusercontent.com/tomgeudens/practical-neo4j/master/scripts/fourohandbeyond/linux/version.sh
wget -O "scripts/download.sh" https://raw.githubusercontent.com/tomgeudens/practical-neo4j/master/scripts/fourohandbeyond/linux/download.sh
wget -O "scripts/unpack.sh" https://raw.githubusercontent.com/tomgeudens/practical-neo4j/master/scripts/fourohandbeyond/linux/unpack.sh
wget -O "scripts/move.sh" https://raw.githubusercontent.com/tomgeudens/practical-neo4j/master/scripts/fourohandbeyond/linux/move.sh
wget -O "scripts/settings.sh" https://raw.githubusercontent.com/tomgeudens/practical-neo4j/master/scripts/fourohandbeyond/linux/settings.sh
wget -O "scripts/environment.sh" https://raw.githubusercontent.com/tomgeudens/practical-neo4j/master/scripts/fourohandbeyond/linux/environment.sh
Installation
The assumption is that you have positioned yourself in the neo4j folder (created in Setup)
sh -x scripts/download.sh
sh -x scripts/unpack.sh
sh -x scripts/move.sh
sh -x scripts/settings.sh
Running
Whereas Setup and Installation are only executed once, this one is repeated every time you want to start the database. The assumption is that you have positioned yourself in the neo4j folder (created in Setup)
. ./scripts/environment.sh
neo4j-enterprise-4.4.40/bin/neo4j console