Skip to content

Commit d388b66

Browse files
committed
Update Linux installations and add a dedicated section about accessing neo4j
1 parent 3f329eb commit d388b66

File tree

5 files changed

+151
-81
lines changed

5 files changed

+151
-81
lines changed

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

Lines changed: 65 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ You can install Neo4j on Debian, and Debian-based distributions like Ubuntu, usi
88
== Java prerequisites
99

1010
Neo4j {neo4j-version} requires the Java 21 runtime.
11+
Starting with Neo4j 2025.10, Java 25 is also supported.
1112

1213
=== OpenJDK Java 21
1314
Most of our supported Linux distributions have OpenJDK Java 21 available by default.
@@ -17,7 +18,7 @@ Consequently, no extra setup is required if you are using OpenJDK Java, the corr
1718
=== Oracle JDK, Zulu JDK, or Corretto JDK
1819

1920
If you wish to use a non-default JDK, it must be installed before starting the Neo4j installation.
20-
Otherwise, your package manager will install the default Java distribution for your operating system, usually OpenJDK.
21+
Otherwise, your package manager installs the default Java distribution for your operating system, usually OpenJDK.
2122

2223
Java download and installation instructions can be found on the manufacturer's website:
2324

@@ -28,7 +29,7 @@ Java download and installation instructions can be found on the manufacturer's w
2829
[[multiple-java-versions]]
2930
=== Dealing with multiple installed Java versions
3031

31-
You must configure your default Java version to point to Java 21, or Neo4j {neo4j-version-exact} will be unable to start.
32+
You must configure your default Java version to point to Java 21 or Java 25 (starting with Neo4j 2025.10), or Neo4j {neo4j-version-exact} will be unable to start.
3233
Do so with the `update-java-alternatives` command.
3334

3435
. List all your installed versions of Java with `update-java-alternatives --list`.
@@ -39,13 +40,15 @@ Your results may vary, but this is an example of the output:
3940
----
4041
java-1.21.0-openjdk-amd64 2111 /usr/lib/jvm/java-1.21.0-openjdk-amd64
4142
java-1.17.0-openjdk-amd64 1711 /usr/lib/jvm/java-1.17.0-openjdk-amd64
43+
java-1.25.0-openjdk-amd64 2511 /usr/lib/jvm/java-1.25.0-openjdk-amd64
4244
----
4345

44-
. Identify your Java 21 version from the list of installed javas. In this case, it is `java-1.21.0-openjdk-amd64`.
46+
. Identify your Java 21 version (default) from the list of installed Javas.
47+
In this case, it is `java-1.21.0-openjdk-amd64`.
4548

4649
. Set Java 21 as the default by replacing `<java21name>` with its name:
4750
+
48-
[source, shell]
51+
[source, bash]
4952
----
5053
sudo update-java-alternatives --jre --set <java21name>
5154
----
@@ -61,9 +64,9 @@ sudo update-java-alternatives --jre --set <java21name>
6164

6265
The Debian package is available from https://debian.neo4j.com.
6366

64-
. To add the Neo4j repository to the package manager, run the following as a sudo user:
67+
. To add the Neo4j repository to the package manager, run the following as a `sudo` user:
6568
+
66-
[source, shell]
69+
[source, bash]
6770
----
6871
wget -O - https://debian.neo4j.com/neotechnology.gpg.key | sudo gpg --dearmor -o /etc/apt/keyrings/neotechnology.gpg
6972
echo 'deb [signed-by=/etc/apt/keyrings/neotechnology.gpg] https://debian.neo4j.com stable latest' | sudo tee -a /etc/apt/sources.list.d/neo4j.list
@@ -72,7 +75,7 @@ sudo apt-get update
7275
+
7376
. Once the repository has been added to `apt`, you can verify which Neo4j versions are available by running:
7477
+
75-
[source, shell]
78+
[source, bash]
7679
----
7780
apt list -a neo4j
7881
----
@@ -83,7 +86,7 @@ In Ubuntu server installations, you also need to make sure that the `universe` r
8386
If the `universe` repository is not present, the Neo4j installation will fail with the error `Depends: daemon but it is not installable`.
8487
8588
This can be fixed by running the command:
86-
[source, shell,subs="attributes"]
89+
[source, bash,subs="attributes"]
8790
----
8891
sudo add-apt-repository universe
8992
----
@@ -93,42 +96,36 @@ sudo add-apt-repository universe
9396
[[debian-install]]
9497
=== Install Neo4j
9598

96-
To install Neo4j, run one of the following commands depending on which version you want to install:
99+
To install Neo4j, run one of the following commands depending on which version you want to install.
100+
Note that the version includes an epoch version component (`1:`), following the https://www.debian.org/doc/debian-policy/[Debian policy on versioning].
97101

98-
* Neo4j Community Edition:
102+
* Neo4j Community Edition (CE):
99103
+
100-
[source, shell, subs="attributes"]
104+
[source, bash, subs="attributes"]
101105
----
102106
sudo apt-get install neo4j=1:{neo4j-version-exact}
103107
----
104108

105-
* Neo4j Enterprise Edition:
109+
* Neo4j Enterprise Edition (EE):
106110
+
107-
[source, shell, subs="attributes"]
111+
[source, bash, subs="attributes"]
108112
----
109113
sudo apt-get install neo4j-enterprise=1:{neo4j-version-exact}
110114
----
111-
112-
Note that the version includes an epoch version component (`1:`), following the https://www.debian.org/doc/debian-policy/[Debian policy on versioning].
113-
114-
When installing Neo4j Enterprise Edition, you will be prompted to accept the license agreement.
115-
Once the license agreement is accepted installation begins.
115+
+
116+
You will be prompted to accept either the commercial or the evaluation license agreement before the installation begins.
116117
Your answer to the license agreement prompt will be remembered for future installations on the same system.
117-
118+
+
118119
To forget the stored answer, and trigger the license agreement prompt on subsequent installation, use `debconf-communicate` to purge the stored answer:
119-
120-
[source, shell]
120+
+
121+
[source, bash]
121122
----
122123
echo purge | sudo debconf-communicate neo4j-enterprise
123124
----
124-
125-
[role=enterprise-edition]
126-
==== Non-interactive installation of Neo4j Enterprise Edition
127-
128-
For Neo4j Enterprise Edition, the license agreement is presented in an interactive prompt.
125+
+
129126
If you require non-interactive installation of Neo4j Enterprise Edition, you can indicate that you have read and accepted the license agreement using `debconf-set-selections`:
130-
131-
[source, shell]
127+
+
128+
[source, bash, subs="attributes"]
132129
----
133130
echo "neo4j-enterprise neo4j/accept-license select Accept commercial license" | sudo debconf-set-selections
134131
----
@@ -140,39 +137,39 @@ If you cannot reach `https://debian.neo4j.com`, perhaps due to a firewall, you n
140137

141138
[NOTE]
142139
====
143-
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 `apt` for installing Neo4j; xref:cypher-shell.adoc[Cypher Shell] and Java (if not installed already):
140+
It is important to note that using this method means that the offline machine will not receive the dependencies that are normally downloaded and installed automatically when using `apt` for installing Neo4j, xref:cypher-shell.adoc[Cypher Shell], and Java (if not installed already):
144141
145142
* The Cypher Shell package can be downloaded from link:{neo4j-download-center-uri}[Neo4j Deployment Center].
146143
* For information on supported versions of Java, see xref:installation/requirements.adoc[System requirements].
147144
====
148145

149146
. Run the following to download the required Debian software package:
147+
** Neo4j Community Edition:
148+
+
149+
[source, bash, subs="attributes"]
150+
----
151+
curl -O https://dist.neo4j.org/deb/neo4j_{neo4j-version-exact}_all.deb
152+
----
150153
** Neo4j Enterprise Edition:
151154
+
152-
[source, shell, subs="attributes"]
155+
[source, bash, subs="attributes"]
153156
----
154157
curl -O https://dist.neo4j.org/deb/neo4j-enterprise_{neo4j-version-exact}_all.deb
155158
----
156159
+
157160
[NOTE]
158161
====
159162
To list all files that the Debian software package (`.deb` file) installs:
160-
[source, shell, subs="attributes"]
163+
[source, bash, subs="attributes"]
161164
----
162165
dpkg --contents neo4j_{neo4j-version-exact}_all.deb
163166
----
164167
====
165-
** Neo4j Community Edition:
166-
+
167-
[source, shell, subs="attributes"]
168-
----
169-
curl -O https://dist.neo4j.org/deb/neo4j_{neo4j-version-exact}_all.deb
170-
----
171168

172169
. Manually move the downloaded Debian package to the offline machine.
173170
. Run the following on the offline machine to install Neo4j:
174171
+
175-
[source, shell]
172+
[source, bash]
176173
----
177174
sudo dpkg -i <deb file name>
178175
----
@@ -204,7 +201,7 @@ For operating systems that are not using `systemd`, some package-specific option
204201
== Starting the service automatically on system start
205202

206203
On Debian-based distributions, run the following command to ensure that Neo4j starts automatically at boot time:
207-
[source, shell]
204+
[source, bash]
208205
----
209206
sudo systemctl enable neo4j
210207
----
@@ -221,14 +218,39 @@ For more information, see xref:configuration/set-initial-password.adoc[].
221218

222219
For more information on operating the Neo4j system service, see xref:installation/linux/systemd.adoc[Neo4j system service].
223220

221+
== Access Neo4j
222+
223+
By default, Neo4j Community Edition does not include graph tools such as visualization, data exploration, and monitoring.
224+
However, you can use the Neo4j Aura console to access these features for free.
225+
No subscription is required.
226+
227+
. Sign up or log in to the link:https://console-preview.neo4j.io/self-managed[Aura Console].
228+
. On the *Instances* page, click the *Self-managed* tab and then *+ Add deployment* button.
229+
. Select *URL Connection*.
230+
. Provide a *Name* and *Connection URL*.
231+
If you have installed Neo4j locally on your system, you can connect to _\http://localhost:7474_.
232+
. Click the *Connect* dropdown to launch various graph tools such as *Query*, *Explore*, and *Dashboards*.
233+
. Type the username `neo4j` and your password or the default password `neo4j`.
234+
You will be prompted to change the latter upon first login.
235+
+
236+
image::aura-add-deployment.png[width=800,alt=Aura add self-managed deployment]
237+
238+
You are now connected and can use the Aura Console to run Cypher queries, visualize graphs, and optionally monitor your local Neo4j database in Neo4j Aura.
239+
For details, see link:https://neo4j.com/docs/getting-started/#_work_with_data[Get started with Neo4j].
240+
241+
Alternatively, you can use the Neo4j Browser, a web-based user interface for interacting with Neo4j that is included with the Neo4j installation.
242+
To access the Neo4j Browser, open a web browser and navigate to _\http://localhost:7474_.
243+
Connect using the username `neo4j` with your password or the default password `neo4j`.
244+
If the default password is used, you will be prompted to change it upon first login.
245+
224246
== Uninstall Neo4j
225247

226248
Follow these steps to uninstall Neo4j:
227249

228250
. (Optional) Create a xref:/backup-restore/index.adoc[backup] to avoid losing your data.
229-
. Uninstall Neo4j:
251+
. Uninstall Neo4j by running the following command:
230252
+
231-
[source, shell]
232-
---
253+
[source, bash]
254+
----
233255
sudo apt remove neo4j
234-
---
256+
----

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

Lines changed: 31 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ You can deploy Neo4j on Red Hat, CentOS, Fedora, or Amazon Linux distributions u
88
== Java prerequisites
99

1010
Neo4j {neo4j-version} requires the Java 21 runtime.
11+
Starting with Neo4j 2025.10, Java 25 is also supported.
1112

1213
=== OpenJDK Java 21
1314
Most of our supported Linux distributions have OpenJDK Java 21 available by default.
@@ -16,7 +17,7 @@ Consequently, no extra setup is required if you are using OpenJDK Java, the corr
1617
=== Zulu JDK 21 or Corretto 21
1718

1819
If you want to use a non-default JDK, it must be installed before starting the Neo4j installation.
19-
Otherwise, your package manager will install the default Java distribution for your operating system, usually OpenJDK.
20+
Otherwise, your package manager installs the default Java distribution for your operating system, usually OpenJDK.
2021

2122
Installation instructions can be found on the manufacturer's website:
2223

@@ -71,14 +72,14 @@ yum list neo4j --showduplicates
7172

7273
Install Neo4j as `root` using the following commands depending on which edition you are using:
7374

74-
* Community Edition
75+
* Neo4j Community Edition
7576
+
7677
[source, bash, subs="attributes"]
7778
----
7879
yum install neo4j-{neo4j-version-exact}
7980
----
8081

81-
* Enterprise Edition
82+
* Neo4j Enterprise Edition
8283
+
8384
Accept either the commercial or the evaluation license agreement before running the Neo4j Enterprise Edition.
8485
The following are examples of using an interactive prompt and a non-interactive installation:
@@ -183,14 +184,14 @@ If you are upgrading from Neo4j 5.x or earlier, due to strict dependencies betwe
183184
This must be one single command, and Neo4j Cypher Shell must be the first package in the command.
184185
====
185186
+
186-
* Community Edition
187+
* Neo4j Community Edition
187188
+
188189
[source, bash, subs="attributes"]
189190
----
190191
rpm --install cypher-shell-{neo4j-version-exact}-1.noarch.rpm neo4j-{neo4j-version-exact}-1.noarch.rpm
191192
----
192193
+
193-
* Enterprise Edition
194+
* Neo4j Enterprise Edition
194195
+
195196
Accept either the commercial or the evaluation license agreement before running the Neo4j Enterprise Edition.
196197
The following example uses an interactive prompt:
@@ -229,6 +230,31 @@ For more information, see xref:configuration/set-initial-password.adoc[].
229230

230231
For more information on operating the Neo4j system service, see xref:installation/linux/systemd.adoc[Neo4j system service].
231232

233+
== Access Neo4j
234+
235+
By default, Neo4j Community Edition does not include graph tools such as visualization, data exploration, and monitoring.
236+
However, you can use the Neo4j Aura console to access these features for free.
237+
No subscription is required.
238+
239+
. Sign up or log in to the link:https://console-preview.neo4j.io/self-managed[Aura Console].
240+
. On the *Instances* page, click the *Self-managed* tab and then *+ Add deployment* button.
241+
. Select *URL Connection*.
242+
. Provide a *Name* and *Connection URL*.
243+
If you have installed Neo4j locally on your system, you can connect to _\http://localhost:7474_.
244+
. Click the *Connect* dropdown to launch various graph tools such as *Query*, *Explore*, and *Dashboards*.
245+
. Type the username `neo4j` and your password or the default password `neo4j`.
246+
You will be prompted to change the latter upon first login.
247+
+
248+
image::aura-add-deployment.png[width=800,alt=Aura add self-managed deployment]
249+
250+
You are now connected and can use the Aura Console to run Cypher queries, visualize graphs, and optionally monitor your local Neo4j database in Neo4j Aura.
251+
For details, see link:https://neo4j.com/docs/getting-started/#_work_with_data[Get started with Neo4j].
252+
253+
Alternatively, you can use the Neo4j Browser, a web-based user interface for interacting with Neo4j that is included with the Neo4j installation.
254+
To access the Neo4j Browser, open a web browser and navigate to _\http://localhost:7474_.
255+
Connect using the username `neo4j` with your password or the default password `neo4j`.
256+
If the default password is used, you will be prompted to change it upon first login.
257+
232258
== Uninstall Neo4j
233259

234260
Follow these steps to uninstall Neo4j:

0 commit comments

Comments
 (0)