Skip to content

Commit f5ff7fa

Browse files
authored
Update all installations and add a section about accessing Neo4j via Aura console (#2680) (#2684)
1 parent 17f5c5d commit f5ff7fa

File tree

9 files changed

+122
-114
lines changed

9 files changed

+122
-114
lines changed

modules/ROOT/content-nav.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@
2323
** xref:docker/plugins.adoc[]
2424
** xref:docker/docker-compose-standalone.adoc[]
2525
** xref:docker/clustering.adoc[]
26+
** xref:docker/accessing-neo4j.adoc[]
2627
** xref:docker/operations.adoc[]
2728
** xref:docker/dump-load.adoc[]
2829
** xref:docker/backup-restore.adoc[]
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
:description: How to access Neo4j using the Aura Console or Neo4j Browser.
2+
3+
= Access Neo4j
4+
5+
include::partial$/access-neo4j.adoc[]

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

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

10-
Neo4j {neo4j-version} requires the Java 21 runtime.
10+
Neo4j 2025.x requires the Java 21 runtime (default).
1111

1212
=== OpenJDK Java 21
1313
Most of the supported Linux distributions have OpenJDK Java 21 available by default.
@@ -17,7 +17,7 @@ Consequently, no extra setup is required if you are using OpenJDK Java, the corr
1717
=== Oracle JDK, Zulu JDK, or Corretto JDK
1818

1919
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.
20+
Otherwise, your package manager installs the default Java distribution for your operating system, usually OpenJDK.
2121

2222
Java download and installation instructions can be found on the manufacturer's website:
2323

@@ -41,11 +41,12 @@ java-1.21.0-openjdk-amd64 2111 /usr/lib/jvm/java-1.21.0-openjdk-amd64
4141
java-1.17.0-openjdk-amd64 1711 /usr/lib/jvm/java-1.17.0-openjdk-amd64
4242
----
4343

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

4647
. Set Java 21 as the default by replacing `<java21name>` with its name:
4748
+
48-
[source, shell]
49+
[source, bash]
4950
----
5051
sudo update-java-alternatives --jre --set <java21name>
5152
----
@@ -61,9 +62,9 @@ sudo update-java-alternatives --jre --set <java21name>
6162

6263
The Debian package is available from https://debian.neo4j.com.
6364

64-
. To add the Neo4j repository to the package manager, run the following as a sudo user:
65+
. To add the Neo4j repository to the package manager, run the following as a `sudo` user:
6566
+
66-
[source, shell]
67+
[source, bash]
6768
----
6869
wget -O - https://debian.neo4j.com/neotechnology.gpg.key | sudo gpg --dearmor -o /etc/apt/keyrings/neotechnology.gpg
6970
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 +73,7 @@ sudo apt-get update
7273
+
7374
. Once the repository has been added to `apt`, you can verify which Neo4j versions are available by running:
7475
+
75-
[source, shell]
76+
[source, bash]
7677
----
7778
apt list -a neo4j
7879
----
@@ -83,7 +84,7 @@ In Ubuntu server installations, you also need to make sure that the `universe` r
8384
If the `universe` repository is not present, the Neo4j installation will fail with the error `Depends: daemon but it is not installable`.
8485
8586
This can be fixed by running the command:
86-
[source, shell,subs="attributes"]
87+
[source, bash,subs="attributes"]
8788
----
8889
sudo add-apt-repository universe
8990
----
@@ -93,42 +94,36 @@ sudo add-apt-repository universe
9394
[[debian-install]]
9495
=== Install Neo4j
9596

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

98-
* Neo4j Community Edition:
100+
* Neo4j Community Edition (CE):
99101
+
100-
[source, shell, subs="attributes"]
102+
[source, bash, subs="attributes"]
101103
----
102104
sudo apt-get install neo4j=1:{neo4j-version-exact}
103105
----
104106

105-
* Neo4j Enterprise Edition:
107+
* Neo4j Enterprise Edition (EE):
106108
+
107-
[source, shell, subs="attributes"]
109+
[source, bash, subs="attributes"]
108110
----
109111
sudo apt-get install neo4j-enterprise=1:{neo4j-version-exact}
110112
----
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.
113+
+
114+
You will be prompted to accept either the commercial or the evaluation license agreement before the installation begins.
116115
Your answer to the license agreement prompt will be remembered for future installations on the same system.
117-
116+
+
118117
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]
118+
+
119+
[source, bash]
121120
----
122121
echo purge | sudo debconf-communicate neo4j-enterprise
123122
----
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.
123+
+
129124
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]
125+
+
126+
[source, bash, subs="attributes"]
132127
----
133128
echo "neo4j-enterprise neo4j/accept-license select Accept commercial license" | sudo debconf-set-selections
134129
----
@@ -140,39 +135,39 @@ If you cannot reach `https://debian.neo4j.com`, perhaps due to a firewall, you n
140135

141136
[NOTE]
142137
====
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):
138+
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):
144139
145140
* The Cypher Shell package can be downloaded from link:{neo4j-download-center-uri}[Neo4j Deployment Center].
146141
* For information on supported versions of Java, see xref:installation/requirements.adoc[System requirements].
147142
====
148143

149144
. Run the following to download the required Debian software package:
145+
** Neo4j Community Edition:
146+
+
147+
[source, bash, subs="attributes"]
148+
----
149+
curl -O https://dist.neo4j.org/deb/neo4j_{neo4j-version-exact}_all.deb
150+
----
150151
** Neo4j Enterprise Edition:
151152
+
152-
[source, shell, subs="attributes"]
153+
[source, bash, subs="attributes"]
153154
----
154155
curl -O https://dist.neo4j.org/deb/neo4j-enterprise_{neo4j-version-exact}_all.deb
155156
----
156157
+
157158
[NOTE]
158159
====
159160
To list all files that the Debian software package (`.deb` file) installs:
160-
[source, shell, subs="attributes"]
161+
[source, bash, subs="attributes"]
161162
----
162163
dpkg --contents neo4j_{neo4j-version-exact}_all.deb
163164
----
164165
====
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-
----
171166

172167
. Manually move the downloaded Debian package to the offline machine.
173168
. Run the following on the offline machine to install Neo4j:
174169
+
175-
[source, shell]
170+
[source, bash]
176171
----
177172
sudo dpkg -i <deb file name>
178173
----
@@ -204,7 +199,7 @@ For operating systems that are not using `systemd`, some package-specific option
204199
== Starting the service automatically on system start
205200

206201
On Debian-based distributions, run the following command to ensure that Neo4j starts automatically at boot time:
207-
[source, shell]
202+
[source, bash]
208203
----
209204
sudo systemctl enable neo4j
210205
----
@@ -221,14 +216,18 @@ For more information, see xref:configuration/set-initial-password.adoc[].
221216

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

219+
== Access Neo4j
220+
221+
include::partial$/access-neo4j.adoc[]
222+
224223
== Uninstall Neo4j
225224

226225
Follow these steps to uninstall Neo4j:
227226

228227
. (Optional) Create a xref:/backup-restore/index.adoc[backup] to avoid losing your data.
229-
. Uninstall Neo4j:
228+
. Uninstall Neo4j by running the following command:
230229
+
231-
[source, shell]
232-
---
230+
[source, bash]
231+
----
233232
sudo apt remove neo4j
234-
---
233+
----

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

Lines changed: 10 additions & 6 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 21 runtime.
10+
Neo4j 2025.x requires the Java 21 runtime (default).
1111

1212
=== OpenJDK Java 21
1313
Most of the supported Linux distributions have OpenJDK Java 21 available by default.
@@ -16,7 +16,7 @@ Consequently, no extra setup is required if you are using OpenJDK Java, the corr
1616
=== Zulu JDK 21 or Corretto 21
1717

1818
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.
19+
Otherwise, your package manager installs the default Java distribution for your operating system, usually OpenJDK.
2020

2121
Installation instructions can be found on the manufacturer's website:
2222

@@ -71,14 +71,14 @@ yum list neo4j --showduplicates
7171

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

74-
* Community Edition
74+
* Neo4j Community Edition
7575
+
7676
[source, bash, subs="attributes"]
7777
----
7878
yum install neo4j-{neo4j-version-exact}
7979
----
8080

81-
* Enterprise Edition
81+
* Neo4j Enterprise Edition
8282
+
8383
Accept either the commercial or the evaluation license agreement before running the Neo4j Enterprise Edition.
8484
The following are examples of using an interactive prompt and a non-interactive installation:
@@ -183,14 +183,14 @@ If you are upgrading from Neo4j 5.x or earlier, due to strict dependencies betwe
183183
This must be one single command, and Neo4j Cypher Shell must be the first package in the command.
184184
====
185185
+
186-
* Community Edition
186+
* Neo4j Community Edition
187187
+
188188
[source, bash, subs="attributes"]
189189
----
190190
rpm --install cypher-shell-{neo4j-version-exact}-1.noarch.rpm neo4j-{neo4j-version-exact}-1.noarch.rpm
191191
----
192192
+
193-
* Enterprise Edition
193+
* Neo4j Enterprise Edition
194194
+
195195
Accept either the commercial or the evaluation license agreement before running the Neo4j Enterprise Edition.
196196
The following example uses an interactive prompt:
@@ -229,6 +229,10 @@ For more information, see xref:configuration/set-initial-password.adoc[].
229229

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

232+
== Access Neo4j
233+
234+
include::partial$/access-neo4j.adoc[]
235+
232236
== Uninstall Neo4j
233237

234238
Follow these steps to uninstall Neo4j:

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,6 @@ Follow these steps to uninstall Neo4j:
9494
. Uninstall Neo4j:
9595
+
9696
[source, shell]
97-
---
97+
----
9898
sudo apt remove neo4j
99-
---
99+
----

0 commit comments

Comments
 (0)