Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions modules/ROOT/content-nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
** xref:docker/plugins.adoc[]
** xref:docker/docker-compose-standalone.adoc[]
** xref:docker/clustering.adoc[]
** xref:docker/accessing-neo4j.adoc[]
** xref:docker/operations.adoc[]
** xref:docker/dump-load.adoc[]
** xref:docker/backup-restore.adoc[]
Expand Down
5 changes: 5 additions & 0 deletions modules/ROOT/pages/docker/accessing-neo4j.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
:description: How to access Neo4j using the Aura Console or Neo4j Browser.

= Access Neo4j

include::partial$/access-neo4j.adoc[]
85 changes: 42 additions & 43 deletions modules/ROOT/pages/installation/linux/debian.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ You can install Neo4j on Debian, and Debian-based distributions like Ubuntu, usi
[[debian-prerequisites]]
== Java prerequisites

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

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

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

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

Expand All @@ -41,11 +41,12 @@ java-1.21.0-openjdk-amd64 2111 /usr/lib/jvm/java-1.21.0-openjdk-amd64
java-1.17.0-openjdk-amd64 1711 /usr/lib/jvm/java-1.17.0-openjdk-amd64
----

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

. Set Java 21 as the default by replacing `<java21name>` with its name:
+
[source, shell]
[source, bash]
----
sudo update-java-alternatives --jre --set <java21name>
----
Expand All @@ -61,9 +62,9 @@ sudo update-java-alternatives --jre --set <java21name>

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

. To add the Neo4j repository to the package manager, run the following as a sudo user:
. To add the Neo4j repository to the package manager, run the following as a `sudo` user:
+
[source, shell]
[source, bash]
----
wget -O - https://debian.neo4j.com/neotechnology.gpg.key | sudo gpg --dearmor -o /etc/apt/keyrings/neotechnology.gpg
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
Expand All @@ -72,7 +73,7 @@ sudo apt-get update
+
. Once the repository has been added to `apt`, you can verify which Neo4j versions are available by running:
+
[source, shell]
[source, bash]
----
apt list -a neo4j
----
Expand All @@ -83,7 +84,7 @@ In Ubuntu server installations, you also need to make sure that the `universe` r
If the `universe` repository is not present, the Neo4j installation will fail with the error `Depends: daemon but it is not installable`.

This can be fixed by running the command:
[source, shell,subs="attributes"]
[source, bash,subs="attributes"]
----
sudo add-apt-repository universe
----
Expand All @@ -93,42 +94,36 @@ sudo add-apt-repository universe
[[debian-install]]
=== Install Neo4j

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

* Neo4j Community Edition:
* Neo4j Community Edition (CE):
+
[source, shell, subs="attributes"]
[source, bash, subs="attributes"]
----
sudo apt-get install neo4j=1:{neo4j-version-exact}
----

* Neo4j Enterprise Edition:
* Neo4j Enterprise Edition (EE):
+
[source, shell, subs="attributes"]
[source, bash, subs="attributes"]
----
sudo apt-get install neo4j-enterprise=1:{neo4j-version-exact}
----

Note that the version includes an epoch version component (`1:`), following the https://www.debian.org/doc/debian-policy/[Debian policy on versioning].

When installing Neo4j Enterprise Edition, you will be prompted to accept the license agreement.
Once the license agreement is accepted installation begins.
+
You will be prompted to accept either the commercial or the evaluation license agreement before the installation begins.
Your answer to the license agreement prompt will be remembered for future installations on the same system.

+
To forget the stored answer, and trigger the license agreement prompt on subsequent installation, use `debconf-communicate` to purge the stored answer:

[source, shell]
+
[source, bash]
----
echo purge | sudo debconf-communicate neo4j-enterprise
----

[role=enterprise-edition]
==== Non-interactive installation of Neo4j Enterprise Edition

For Neo4j Enterprise Edition, the license agreement is presented in an interactive prompt.
+
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`:

[source, shell]
+
[source, bash, subs="attributes"]
----
echo "neo4j-enterprise neo4j/accept-license select Accept commercial license" | sudo debconf-set-selections
----
Expand All @@ -140,39 +135,39 @@ If you cannot reach `https://debian.neo4j.com`, perhaps due to a firewall, you n

[NOTE]
====
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):
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):

* The Cypher Shell package can be downloaded from link:{neo4j-download-center-uri}[Neo4j Deployment Center].
* For information on supported versions of Java, see xref:installation/requirements.adoc[System requirements].
====

. Run the following to download the required Debian software package:
** Neo4j Community Edition:
+
[source, bash, subs="attributes"]
----
curl -O https://dist.neo4j.org/deb/neo4j_{neo4j-version-exact}_all.deb
----
** Neo4j Enterprise Edition:
+
[source, shell, subs="attributes"]
[source, bash, subs="attributes"]
----
curl -O https://dist.neo4j.org/deb/neo4j-enterprise_{neo4j-version-exact}_all.deb
----
+
[NOTE]
====
To list all files that the Debian software package (`.deb` file) installs:
[source, shell, subs="attributes"]
[source, bash, subs="attributes"]
----
dpkg --contents neo4j_{neo4j-version-exact}_all.deb
----
====
** Neo4j Community Edition:
+
[source, shell, subs="attributes"]
----
curl -O https://dist.neo4j.org/deb/neo4j_{neo4j-version-exact}_all.deb
----

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

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

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

== Access Neo4j

include::partial$/access-neo4j.adoc[]

== Uninstall Neo4j

Follow these steps to uninstall Neo4j:

. (Optional) Create a xref:/backup-restore/index.adoc[backup] to avoid losing your data.
. Uninstall Neo4j:
. Uninstall Neo4j by running the following command:
+
[source, shell]
---
[source, bash]
----
sudo apt remove neo4j
---
----
16 changes: 10 additions & 6 deletions modules/ROOT/pages/installation/linux/rpm.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ You can deploy Neo4j on Red Hat, CentOS, Fedora, or Amazon Linux distributions u
[[linux-rpm-prerequisites]]
== Java prerequisites

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

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

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

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

Expand Down Expand Up @@ -71,14 +71,14 @@ yum list neo4j --showduplicates

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

* Community Edition
* Neo4j Community Edition
+
[source, bash, subs="attributes"]
----
yum install neo4j-{neo4j-version-exact}
----

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

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

== Access Neo4j

include::partial$/access-neo4j.adoc[]

== Uninstall Neo4j

Follow these steps to uninstall Neo4j:
Expand Down
4 changes: 2 additions & 2 deletions modules/ROOT/pages/installation/linux/systemd.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,6 @@ Follow these steps to uninstall Neo4j:
. Uninstall Neo4j:
+
[source, shell]
---
----
sudo apt remove neo4j
---
----
Loading