Skip to content

Commit cf7372d

Browse files
authored
Update the steps for installing Neo4j via a package installer (#1546) (#1548)
Cherry-picked from #1546
1 parent 79d8863 commit cf7372d

File tree

1 file changed

+37
-53
lines changed
  • modules/ROOT/pages/installation/linux

1 file changed

+37
-53
lines changed

modules/ROOT/pages/installation/linux/rpm.adoc

Lines changed: 37 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ You can deploy Neo4j on Red Hat, CentOS, Fedora, or Amazon Linux distributions u
77
[[linux-rpm-prerequisites]]
88
== Java prerequisites
99

10-
Neo4j {neo4j-version} requires the Java 17 runtime.
10+
Neo4j 5.x runs on Java 17, and from Neo4j 5.14, it also supports Java 21.
1111

1212

1313
=== OpenJDK Java 17
@@ -19,8 +19,8 @@ Consequently, no extra setup is required if you are using OpenJDK Java, the corr
1919
=== Oracle Java 17
2020
There is some minor setup required for compatibility with Oracle Java 17 because Oracle and OpenJDK provide incompatible RPM packages for Java 17.
2121

22-
We provide an adapter for Oracle Java 17 which must be installed before Neo4j.
23-
The adapter contains no code, but will stop the package manager from installing OpenJDK 17 as a dependency despite an existing Oracle Java 17 installation.
22+
You can use an adapter for Oracle Java 17, which must be installed before Neo4j.
23+
The adapter contains no code but stops the package manager from installing OpenJDK 17 as a dependency despite an existing Oracle Java 17 installation.
2424

2525
. Download and install the Oracle Java 17 JDK from the https://www.oracle.com/technetwork/java/javase/downloads/index.html[Oracle website].
2626
. Install the adapter:
@@ -34,8 +34,8 @@ The SHA-256 of the adapter package can be verified against https://dist.neo4j.or
3434

3535
=== Zulu JDK 17 or Corretto 17
3636

37-
If you wish to use a non-default JDK, it must be installed prior to starting the Neo4j installation.
38-
Otherwise your package manager will install the default java distribution for your operating system, usually OpenJDK.
37+
If you want to use a non-default JDK, it must be installed before starting the Neo4j installation.
38+
Otherwise, your package manager will install the default Java distribution for your operating system, usually OpenJDK.
3939

4040
Installation instructions can be found on the manufacturer's website:
4141

@@ -85,8 +85,9 @@ yum install neo4j-{neo4j-version-exact}
8585
* Enterprise Edition
8686
+
8787
From Neo4j 5.4 onwards, you are required to accept either the commercial or the evaluation license agreement before running the Neo4j Enterprise Edition.
88-
The following example uses an interactive prompt:
88+
The following are examples of using an interactive prompt and a non-interactive installation:
8989
+
90+
.Interactive installation of Enterprise Edition under the commercial license
9091
[source, shell, subs="attributes"]
9192
----
9293
yum install neo4j-enterprise-{neo4j-version-exact}
@@ -105,13 +106,13 @@ NEO4J_ACCEPT_LICENSE_AGREEMENT=yes yum install neo4j-enterprise-{neo4j-version-e
105106

106107
[NOTE]
107108
====
108-
Neo4j supports Security-Enhanced Linux (SELinux), by default.
109+
Neo4j supports Security-Enhanced Linux (SELinux) by default.
109110
====
110111

111112
[[linux-rpm-suse]]
112113
== Install on SUSE
113114

114-
For SUSE-based distributions the steps are as follows:
115+
For SUSE-based distributions, the steps are as follows:
115116

116117
. Use the following as `root` to add the repository:
117118
+
@@ -132,15 +133,18 @@ zypper install neo4j-{neo4j-version-exact}
132133
* Enterprise Edition
133134
+
134135
From Neo4j 5.4 onwards, you are required to accept either the commercial or the evaluation license agreement before running the Neo4j Enterprise Edition.
135-
The following example uses an interactive prompt:
136+
The following are examples of using an interactive prompt and a non-interactive installation:
136137
+
138+
.Interactive installation of Enterprise Edition under the commercial license
137139
[source, shell, subs="attributes"]
138140
----
139141
zypper install neo4j-enterprise-{neo4j-version-exact}
140142
----
141143
You have to choose either a link:https://neo4j.com/terms/licensing/[commercial license] or an link:https://neo4j.com/terms/enterprise_us/[evaluation license] before the interactive installation is allowed to complete.
144+
+
142145
For a non-interactive installation, you can set the `NEO4J_ACCEPT_LICENSE_AGREEMENT` to `yes` (for the commercial license) or `eval` (for the evaluation license) as in the following example:
143146
+
147+
.Non-interactive installation of Enterprise Edition under the commercial license
144148
[source, shell, subs="attributes"]
145149
----
146150
NEO4J_ACCEPT_LICENSE_AGREEMENT=yes zypper install neo4j-enterprise-{neo4j-version-exact}
@@ -149,33 +153,34 @@ NEO4J_ACCEPT_LICENSE_AGREEMENT=yes zypper install neo4j-enterprise-{neo4j-versio
149153
[[linux-rpm-install-offline-installation]]
150154
== Offline installation
151155

152-
If you cannot reach `\https://yum.neo4j.com/stable/{neo4j-version}` to install Neo4j using RPM, perhaps due to a firewall, you will need to obtain Neo4j via an alternative machine that has the relevant access, and then move the RPM package manually.
156+
If you cannot reach `\https://yum.neo4j.com/stable/{neo4j-version}` to install Neo4j using RPM, perhaps due to a firewall, you need to obtain Neo4j via an alternative machine that has the relevant access, and then move the RPM package manually.
153157

154158
[NOTE]
155159
====
156-
It is important to note that using this method will mean that the offline machine will not receive the dependencies that are normally downloaded and installed automatically when using `yum` for installing Neo4j; xref:tools/cypher-shell.adoc[Neo4j Cypher Shell] and Java.
157-
158-
For information on supported versions of Java, see xref:installation/requirements.adoc[System requirements].
160+
It is important to note that using this method means that the offline machine cannot receive the dependencies that are normally downloaded and installed automatically when using `yum` for installing Neo4j, xref:tools/cypher-shell.adoc[Neo4j Cypher Shell], and Java.
159161
====
160162

161-
162-
[[linux-rpm-install-offline-install-download]]
163-
=== Install Neo4j using the RPM installer
164-
165-
. Run the following to obtain the required Neo4j RPM package:
163+
. Download the Neo4j and Cypher Shell RPM installers from https://neo4j.com/deployment-center/[Deployment Center] or run the following to obtain the required packages:
166164
+
167-
* Neo4j Enterprise Edition:
165+
* Cypher Shell:
168166
+
169167
[source, curl, subs="attributes"]
170168
----
171-
curl -O https://dist.neo4j.org/rpm/neo4j-enterprise-{neo4j-version-exact}-1.noarch.rpm
169+
curl -O https://dist.neo4j.org/cypher-shell/cypher-shell-{neo4j-version-exact}-1.noarch.rpm
172170
----
173171
* Neo4j Community Edition:
174172
+
175173
[source, curl, subs="attributes"]
176174
----
177175
curl -O https://dist.neo4j.org/rpm/neo4j-{neo4j-version-exact}-1.noarch.rpm
178176
----
177+
* Neo4j Enterprise Edition:
178+
+
179+
[source, curl, subs="attributes"]
180+
----
181+
curl -O https://dist.neo4j.org/rpm/neo4j-enterprise-{neo4j-version-exact}-1.noarch.rpm
182+
----
183+
179184
. Manually move the downloaded RPM packages to the offline machine.
180185
Before installing Neo4j, you must manually install the required Java 17 packages.
181186
+
@@ -184,13 +189,20 @@ Before installing Neo4j, you must manually install the required Java 17 packages
184189
If using Oracle Java 17, the same dependency issues apply as with the xref:installation/linux/rpm.adoc#linux-rpm-prerequisites-oracle[Oracle Java prerequisites].
185190
You will need to additionally download and install the Java adaptor described in that section.
186191
====
187-
. Install Neo4j as `root` using the following command depending on which edition you are using:
192+
. Install Neo4j and Cypher Shell as `root` using the following command depending on which edition you are using:
193+
+
194+
[NOTE]
195+
====
196+
If you are upgrading from Neo4j 4.4 or earlier versions of 5.x, due to strict dependencies between Neo4j and Cypher Shell, both packages must be upgraded simultaneously.
197+
This must be one single command, and Neo4j Cypher Shell must be the first package in the command.
198+
For later versions, you can install them separately but still need to install Cypher Shell first.
199+
====
188200
+
189201
* Community Edition
190202
+
191203
[source, shell, subs="attributes"]
192204
----
193-
rpm --install neo4j-{neo4j-version-exact}-1.noarch.rpm
205+
rpm --install cypher-shell-{neo4j-version-exact}-1.noarch.rpm neo4j-{neo4j-version-exact}-1.noarch.rpm
194206
----
195207
+
196208
* Enterprise Edition
@@ -200,46 +212,18 @@ The following example uses an interactive prompt:
200212
+
201213
[source, shell, subs="attributes"]
202214
----
203-
rpm --install neo4j-enterprise-{neo4j-version-exact}
215+
rpm --install cypher-shell-{neo4j-version-exact}-1.noarch.rpm neo4j-enterprise-{neo4j-version-exact}-1.noarch.rpm
204216
----
205217
You have to choose either a link:https://neo4j.com/terms/licensing/[commercial license] or an link:https://neo4j.com/terms/enterprise_us/[evaluation license] before the interactive installation is allowed to complete.
206218
For a non-interactive installation, you can set the `NEO4J_ACCEPT_LICENSE_AGREEMENT` to `yes` (for the commercial license) or `eval` (for the evaluation license) as in the following example:
207219
+
208220
[source, shell, subs="attributes"]
209221
----
210-
NEO4J_ACCEPT_LICENSE_AGREEMENT=yes rpm --install neo4j-enterprise-{neo4j-version-exact}-1.noarch.rpm
211-
----
212-
213-
214-
[[linux-rpm-install-offline-install-perform]]
215-
=== Install Cypher Shell using the RPM installer
216-
217-
. Downloaded the Cypher Shell RPM installer from {neo4j-download-center-uri}/#cyphershell[Neo4j Download Center].
218-
. Install Cypher Shell by running the following command as a `root` user:
219-
+
220-
[source, shell]
221-
----
222-
rpm --install <Cypher Shell RPM file name>
222+
NEO4J_ACCEPT_LICENSE_AGREEMENT=yes rpm --install cypher-shell-{neo4j-version-exact}-1.noarch.rpm neo4j-enterprise-{neo4j-version-exact}-1.noarch.rpm
223223
----
224224

225-
[[linux-rpm-install-offline-install-upgrade]]
226-
==== Offline upgrade from 4.4.0 or later
227-
228-
Before you begin, you will need to have Java 17 pre-installed and set to the default Java version.
229-
If using Oracle Java 17, the same dependency issues apply as with the xref:installation/linux/rpm.adoc#linux-rpm-prerequisites-oracle[Oracle Java prerequisites].
230-
231-
Due to strict dependencies between Neo4j and Cypher Shell, both packages must be upgraded simultaneously.
232-
Run the following on the offline machine as `root`, to install Neo4j Cypher Shell and Neo4j simultaneously:
233-
234-
[source, shell]
235-
----
236-
rpm -U <Cypher Shell RPM file name> <Neo4j RPM file name>
237-
----
238-
239-
This must be one single command, and Neo4j Cypher Shell must be the first package in the command.
240-
241225
[[rpm-service-start-automatically]]
242-
== Starting the service automatically on system start
226+
== Start the Neo4j service automatically on system start
243227

244228
To enable Neo4j to start automatically on system boot, run the following command:
245229

0 commit comments

Comments
 (0)