From d388b663ac19cade56d2072b362842db7fb2f1fe Mon Sep 17 00:00:00 2001 From: Reneta Popova Date: Tue, 21 Oct 2025 16:46:29 +0100 Subject: [PATCH 1/5] Update Linux installations and add a dedicated section about accessing neo4j --- .../ROOT/pages/installation/linux/debian.adoc | 108 +++++++++++------- .../ROOT/pages/installation/linux/rpm.adoc | 36 +++++- .../pages/installation/linux/tarball.adoc | 86 ++++++++------ modules/ROOT/pages/installation/osx.adoc | 1 + modules/ROOT/pages/installation/windows.adoc | 1 + 5 files changed, 151 insertions(+), 81 deletions(-) diff --git a/modules/ROOT/pages/installation/linux/debian.adoc b/modules/ROOT/pages/installation/linux/debian.adoc index 614988e80..fcd9e9e20 100644 --- a/modules/ROOT/pages/installation/linux/debian.adoc +++ b/modules/ROOT/pages/installation/linux/debian.adoc @@ -8,6 +8,7 @@ You can install Neo4j on Debian, and Debian-based distributions like Ubuntu, usi == Java prerequisites Neo4j {neo4j-version} requires the Java 21 runtime. +Starting with Neo4j 2025.10, Java 25 is also supported. === OpenJDK Java 21 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 === 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: @@ -28,7 +29,7 @@ Java download and installation instructions can be found on the manufacturer's w [[multiple-java-versions]] === Dealing with multiple installed Java versions -You must configure your default Java version to point to Java 21, or Neo4j {neo4j-version-exact} will be unable to start. +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. Do so with the `update-java-alternatives` command. . 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: ---- 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 +java-1.25.0-openjdk-amd64 2511 /usr/lib/jvm/java-1.25.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 `` with its name: + -[source, shell] +[source, bash] ---- sudo update-java-alternatives --jre --set ---- @@ -61,9 +64,9 @@ sudo update-java-alternatives --jre --set 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 @@ -72,7 +75,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 ---- @@ -83,7 +86,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 ---- @@ -93,42 +96,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 ---- @@ -140,16 +137,22 @@ 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 ---- @@ -157,22 +160,16 @@ curl -O https://dist.neo4j.org/deb/neo4j-enterprise_{neo4j-version-exact}_all.de [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 ---- @@ -204,7 +201,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 ---- @@ -221,14 +218,39 @@ 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 + +By default, Neo4j Community Edition does not include graph tools such as visualization, data exploration, and monitoring. +However, you can use the Neo4j Aura console to access these features for free. +No subscription is required. + +. Sign up or log in to the link:https://console-preview.neo4j.io/self-managed[Aura Console]. +. On the *Instances* page, click the *Self-managed* tab and then *+ Add deployment* button. +. Select *URL Connection*. +. Provide a *Name* and *Connection URL*. +If you have installed Neo4j locally on your system, you can connect to _\http://localhost:7474_. +. Click the *Connect* dropdown to launch various graph tools such as *Query*, *Explore*, and *Dashboards*. +. Type the username `neo4j` and your password or the default password `neo4j`. +You will be prompted to change the latter upon first login. ++ +image::aura-add-deployment.png[width=800,alt=Aura add self-managed deployment] + +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. +For details, see link:https://neo4j.com/docs/getting-started/#_work_with_data[Get started with Neo4j]. + +Alternatively, you can use the Neo4j Browser, a web-based user interface for interacting with Neo4j that is included with the Neo4j installation. +To access the Neo4j Browser, open a web browser and navigate to _\http://localhost:7474_. +Connect using the username `neo4j` with your password or the default password `neo4j`. +If the default password is used, you will be prompted to change it upon first login. + == 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 ---- \ No newline at end of file +---- \ No newline at end of file diff --git a/modules/ROOT/pages/installation/linux/rpm.adoc b/modules/ROOT/pages/installation/linux/rpm.adoc index 4846cb94f..bf8037332 100644 --- a/modules/ROOT/pages/installation/linux/rpm.adoc +++ b/modules/ROOT/pages/installation/linux/rpm.adoc @@ -8,6 +8,7 @@ You can deploy Neo4j on Red Hat, CentOS, Fedora, or Amazon Linux distributions u == Java prerequisites Neo4j {neo4j-version} requires the Java 21 runtime. +Starting with Neo4j 2025.10, Java 25 is also supported. === OpenJDK Java 21 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 === 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: @@ -71,14 +72,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: @@ -183,14 +184,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: @@ -229,6 +230,31 @@ 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 + +By default, Neo4j Community Edition does not include graph tools such as visualization, data exploration, and monitoring. +However, you can use the Neo4j Aura console to access these features for free. +No subscription is required. + +. Sign up or log in to the link:https://console-preview.neo4j.io/self-managed[Aura Console]. +. On the *Instances* page, click the *Self-managed* tab and then *+ Add deployment* button. +. Select *URL Connection*. +. Provide a *Name* and *Connection URL*. +If you have installed Neo4j locally on your system, you can connect to _\http://localhost:7474_. +. Click the *Connect* dropdown to launch various graph tools such as *Query*, *Explore*, and *Dashboards*. +. Type the username `neo4j` and your password or the default password `neo4j`. +You will be prompted to change the latter upon first login. ++ +image::aura-add-deployment.png[width=800,alt=Aura add self-managed deployment] + +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. +For details, see link:https://neo4j.com/docs/getting-started/#_work_with_data[Get started with Neo4j]. + +Alternatively, you can use the Neo4j Browser, a web-based user interface for interacting with Neo4j that is included with the Neo4j installation. +To access the Neo4j Browser, open a web browser and navigate to _\http://localhost:7474_. +Connect using the username `neo4j` with your password or the default password `neo4j`. +If the default password is used, you will be prompted to change it upon first login. + == Uninstall Neo4j Follow these steps to uninstall Neo4j: diff --git a/modules/ROOT/pages/installation/linux/tarball.adoc b/modules/ROOT/pages/installation/linux/tarball.adoc index 1eba07701..bb384f0ae 100644 --- a/modules/ROOT/pages/installation/linux/tarball.adoc +++ b/modules/ROOT/pages/installation/linux/tarball.adoc @@ -3,27 +3,28 @@ = Linux executable (.tar) Before you install Neo4j on Linux from a tarball and run it as a console application or a service, check xref:installation/requirements.adoc[System Requirements] to see if your setup is suitable. +. If it is not already installed, get link:https://openjdk.org/[OpenJDK 21] or link:https://www.oracle.com/java/technologies/downloads/?er=221886[Oracle Java 21]. +Starting with Neo4j 2025.10, Java 25 is also supported. [[unix-console]] == Install Neo4j from a tarball -. If it is not already installed, get link:https://openjdk.org/[OpenJDK 21] or link:https://www.oracle.com/java/technologies/downloads/?er=221886[Oracle Java 21]. . Download the latest Neo4j tarball from link:{neo4j-download-center-uri}/?gdb-selfmanaged[Neo4j Deployment Center] and unpack it: + -[source, shell, subs="attributes"] +[source, bash, subs="attributes"] ---- tar zxf neo4j-enterprise-{neo4j-version-exact}-unix.tar.gz ---- . Move the extracted files to your server's _/opt_ directory and create a symlink to it: + -[source, shell, subs="attributes"] +[source, bash, subs="attributes"] ---- mv neo4j-enterprise-{neo4j-version-exact} /opt/ ln -s /opt/neo4j-enterprise-{neo4j-version-exact} /opt/neo4j ---- . Create a `neo4j` user and group: + -[source, shell] +[source, bash] ---- groupadd neo4j useradd -g neo4j neo4j -s /bin/bash @@ -32,28 +33,27 @@ useradd -g neo4j neo4j -s /bin/bash * *Ubuntu* + -[source, shell, subs="attributes"] +[source, bash, subs="attributes"] ---- chown -R neo4j:adm /opt/neo4j-enterprise-{neo4j-version-exact} ---- * *RedHat* + -[source, shell, subs="attributes"] +[source, bash, subs="attributes"] ---- chown -R neo4j /opt/neo4j-enterprise-{neo4j-version-exact} ---- -. xref:configuration/file-locations.adoc#file-locations-file-locations[Change the default locations] of the _data_, _conf_, _certificates_, _licenses_, and _plugins_ (if you plan to use custom plugins) directories by setting the environment variable `NEO4J_CONF` and the respective xref:configuration/configuration-settings.adoc#_server_directories_settings[`server.directories.*`] settings to point to the desired locations. +. (Recommended) xref:configuration/file-locations.adoc#file-locations-file-locations[Change the default locations] of the _data_, _conf_, _certificates_, _licenses_, and _plugins_ (if you plan to use custom plugins) directories by setting the environment variable `NEO4J_CONF` and the respective xref:configuration/configuration-settings.adoc#_server_directories_settings[`server.directories.*`] settings to point to the desired locations. + [NOTE] ==== Storing your Neo4j files outside `NEO4J_HOME` will simplify the upgrade process later because you will be able to replace the DBMS binaries without affecting the configuration and state. Otherwise, these Neo4j files will remain in the old installation folder and may be accidentally overwritten during an upgrade or deleted during a subsequent uninstall. ==== -. Accept either the commercial or the evaluation license agreement before running the Neo4j Enterprise Edition. +. label:enterprise[Enterprise Edition] Accept either the commercial or the evaluation license agreement. If you are using Community Edition, you can skip this step. * Use one of the following options to accept the commercial license agreement. See the link:https://legal.neo4j.com/[Neo4j licensing] page for details on the available agreements. -+ ** Set the environment variable `NEO4J_ACCEPT_LICENSE_AGREEMENT=yes`. ** Run `/bin/neo4j-admin server license --accept-commercial` * Use one of the following options to accept the link:https://neo4j.com/terms/enterprise_us/[Neo4j Evaluation Agreement for Neo4j Software]. @@ -66,13 +66,8 @@ If the password is not set explicitly using this method, it will be set to the d In that case, you will be prompted to change the default password at first login. + For more information, see xref:configuration/set-initial-password.adoc[]. . Start Neo4j: -* To run Neo4j as a console application, use: `/bin/neo4j console`. -* To run Neo4j in a background process, use: `/bin/neo4j start`. -. Open _\http://localhost:7474/_ in your web browser. -. Connect using the username `neo4j` with your password or the default password `neo4j`. -You will then be prompted to change the password. -. Stop the server by typing `Ctrl-C` in the console. - +* To run Neo4j as a console application, use: `$NEO4J_HOME/bin/neo4j console`. +* To run Neo4j in a background process, use: `$NEO4J_HOME/bin/neo4j start`. [[linux-tarball-start-automatically]] == Configure Neo4j to start automatically on system boot @@ -81,7 +76,7 @@ You can create a Neo4j service and configure it to start automatically on system . Create the file _/lib/systemd/system/neo4j.service_ with the following contents: + -[source, shell] +[source, bash] ---- [Unit] Description=Neo4j Graph Database @@ -103,14 +98,14 @@ WantedBy=multi-user.target . Reload systemctl to pick up the new service file: + -[source, shell] +[source, bash] ---- systemctl daemon-reload ---- . Configure Neo4j to start at boot time: + -[source, shell] +[source, bash] ---- systemctl enable neo4j ---- @@ -123,19 +118,19 @@ For more information, see xref:configuration/set-initial-password.adoc[]. . Start Neo4j: + -[source, shell] +[source, bash] ---- systemctl start neo4j ---- . Check the status of the newly created service: + -[source, shell] +[source, bash] ---- systemctl status neo4j ---- . Reboot the system (if desired) to verify that Neo4j restarts on boot: + -[source, shell] +[source, bash] ---- reboot ---- @@ -149,7 +144,7 @@ Linux platforms impose an upper limit on the number of concurrently open files p To check your limit for the current session, run the command `ulimit -n`. The default value is 1024. -[source, shell] +[source, bash] ---- ulimit -n ---- @@ -166,7 +161,7 @@ The following steps set the open file descriptor limit to 60000 for the user _ne . Open the _neo4j.service_ file with root privileges. + -[source, shell] +[source, bash] ---- sudo systemctl edit neo4j.service ---- @@ -185,7 +180,7 @@ LimitNOFILE=60000 . Open the _user.conf_ file with root privileges in a text editor. This example uses Vim: + -[source, shell] +[source, bash] ---- sudo vi /etc/systemd/user.conf ---- @@ -201,7 +196,7 @@ DefaultLimitNOFILE=60000 . Open the _/etc/security/limits.conf_ file. + -[source, shell] +[source, bash] ---- sudo vi /etc/security/limits.conf ---- @@ -216,13 +211,38 @@ neo4j hard nofile 60000 . Reload the `systemd` settings. + -[source, shell] +[source, bash] ---- sudo systemctl daemon-reload ---- . Reboot your machine. +== Access Neo4j + +By default, Neo4j Community Edition does not include graph tools such as visualization, data exploration, and monitoring. +However, you can use the Neo4j Aura console to access these features for free. +No subscription is required. + +. Sign up or log in to the link:https://console-preview.neo4j.io/self-managed[Aura Console]. +. On the *Instances* page, click the *Self-managed* tab and then *+ Add deployment* button. +. Select *URL Connection*. +. Provide a *Name* and *Connection URL*. +If you have installed Neo4j locally on your system, you can connect to _\http://localhost:7474_. +. Click the *Connect* dropdown to launch various graph tools such as *Query*, *Explore*, and *Dashboards*. +. Type the username `neo4j` and your password or the default password `neo4j`. +You will be prompted to change the latter upon first login. ++ +image::aura-add-deployment.png[width=800,alt=Aura add self-managed deployment] + +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. +For details, see link:https://neo4j.com/docs/getting-started/#_work_with_data[Get started with Neo4j]. + +Alternatively, you can use the Neo4j Browser, a web-based user interface for interacting with Neo4j that is included with the Neo4j installation. +To access the Neo4j Browser, open a web browser and navigate to _\http://localhost:7474_. +Connect using the username `neo4j` with your password or the default password `neo4j`. +If the default password is used, you will be prompted to change it upon first login. + == Uninstall Neo4j Follow these steps to uninstall Neo4j on Linux: @@ -230,15 +250,15 @@ Follow these steps to uninstall Neo4j on Linux: . (Optional) Create a xref:/backup-restore/index.adoc[backup] to avoid losing your data. . Stop all Neo4j running services: + -[source, shell] ---- +[source, bash] +---- sudo systemctl stop neo4j sudo systemctl disable neo4j ---- +---- . Delete _NEO4J_HOME_ and the file _/lib/systemd/system/neo4j.service_: + -[source, shell] ---- +[source, bash] +---- rm /lib/systemd/system/neo4j.service rm -rf NEO4J_HOME ---- \ No newline at end of file +---- \ No newline at end of file diff --git a/modules/ROOT/pages/installation/osx.adoc b/modules/ROOT/pages/installation/osx.adoc index 511970c5d..0bf2624b3 100644 --- a/modules/ROOT/pages/installation/osx.adoc +++ b/modules/ROOT/pages/installation/osx.adoc @@ -4,6 +4,7 @@ Before you install Neo4j on macOS, check xref:installation/requirements.adoc[System Requirements] to see if your setup is suitable. If it is not already installed, get link:https://openjdk.org/[OpenJDK 21] or link:https://www.azul.com/downloads/[ZuluJDK 21]. +Starting with Neo4j 2025.10, Java 25 is also supported. [[osx-console]] == Install and start Neo4j diff --git a/modules/ROOT/pages/installation/windows.adoc b/modules/ROOT/pages/installation/windows.adoc index 36c581999..935bf2729 100644 --- a/modules/ROOT/pages/installation/windows.adoc +++ b/modules/ROOT/pages/installation/windows.adoc @@ -4,6 +4,7 @@ Before you install Neo4j on Windows, check xref:installation/requirements.adoc[System Requirements] to see if your setup is suitable. If it is not already installed, get link:https://www.oracle.com/java/technologies/downloads/?er=221886[OracleJDK 21] or link:https://www.azul.com/downloads/[ZuluJDK 21]. +Starting with Neo4j 2025.10, Java 25 is also supported. [[windows-console]] == Install and start Neo4j From d845d8cac69d3febe65e0041238a221370b09243 Mon Sep 17 00:00:00 2001 From: Reneta Popova Date: Tue, 21 Oct 2025 17:10:51 +0100 Subject: [PATCH 2/5] Add accessing neo4j for docker and move the section under partials --- modules/ROOT/content-nav.adoc | 1 + .../ROOT/pages/docker/accessing-neo4j.adoc | 5 ++++ .../ROOT/pages/installation/linux/debian.adoc | 23 +------------------ .../ROOT/pages/installation/linux/rpm.adoc | 23 +------------------ .../pages/installation/linux/systemd.adoc | 4 ++-- .../pages/installation/linux/tarball.adoc | 23 +------------------ modules/ROOT/pages/installation/osx.adoc | 23 +------------------ modules/ROOT/partials/access-neo4j.adoc | 22 ++++++++++++++++++ 8 files changed, 34 insertions(+), 90 deletions(-) create mode 100644 modules/ROOT/pages/docker/accessing-neo4j.adoc create mode 100644 modules/ROOT/partials/access-neo4j.adoc diff --git a/modules/ROOT/content-nav.adoc b/modules/ROOT/content-nav.adoc index 45c757466..649c9410d 100644 --- a/modules/ROOT/content-nav.adoc +++ b/modules/ROOT/content-nav.adoc @@ -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[] diff --git a/modules/ROOT/pages/docker/accessing-neo4j.adoc b/modules/ROOT/pages/docker/accessing-neo4j.adoc new file mode 100644 index 000000000..974910b61 --- /dev/null +++ b/modules/ROOT/pages/docker/accessing-neo4j.adoc @@ -0,0 +1,5 @@ +:description: How to access Neo4j using the Aura Console or Neo4j Browser. + += Access Neo4j + +include::partial$/access-neo4j.adoc[] \ No newline at end of file diff --git a/modules/ROOT/pages/installation/linux/debian.adoc b/modules/ROOT/pages/installation/linux/debian.adoc index fcd9e9e20..f30e903c0 100644 --- a/modules/ROOT/pages/installation/linux/debian.adoc +++ b/modules/ROOT/pages/installation/linux/debian.adoc @@ -220,28 +220,7 @@ For more information on operating the Neo4j system service, see xref:installatio == Access Neo4j -By default, Neo4j Community Edition does not include graph tools such as visualization, data exploration, and monitoring. -However, you can use the Neo4j Aura console to access these features for free. -No subscription is required. - -. Sign up or log in to the link:https://console-preview.neo4j.io/self-managed[Aura Console]. -. On the *Instances* page, click the *Self-managed* tab and then *+ Add deployment* button. -. Select *URL Connection*. -. Provide a *Name* and *Connection URL*. -If you have installed Neo4j locally on your system, you can connect to _\http://localhost:7474_. -. Click the *Connect* dropdown to launch various graph tools such as *Query*, *Explore*, and *Dashboards*. -. Type the username `neo4j` and your password or the default password `neo4j`. -You will be prompted to change the latter upon first login. -+ -image::aura-add-deployment.png[width=800,alt=Aura add self-managed deployment] - -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. -For details, see link:https://neo4j.com/docs/getting-started/#_work_with_data[Get started with Neo4j]. - -Alternatively, you can use the Neo4j Browser, a web-based user interface for interacting with Neo4j that is included with the Neo4j installation. -To access the Neo4j Browser, open a web browser and navigate to _\http://localhost:7474_. -Connect using the username `neo4j` with your password or the default password `neo4j`. -If the default password is used, you will be prompted to change it upon first login. +include::partial$/access-neo4j.adoc[] == Uninstall Neo4j diff --git a/modules/ROOT/pages/installation/linux/rpm.adoc b/modules/ROOT/pages/installation/linux/rpm.adoc index bf8037332..71b8aadcd 100644 --- a/modules/ROOT/pages/installation/linux/rpm.adoc +++ b/modules/ROOT/pages/installation/linux/rpm.adoc @@ -232,28 +232,7 @@ For more information on operating the Neo4j system service, see xref:installatio == Access Neo4j -By default, Neo4j Community Edition does not include graph tools such as visualization, data exploration, and monitoring. -However, you can use the Neo4j Aura console to access these features for free. -No subscription is required. - -. Sign up or log in to the link:https://console-preview.neo4j.io/self-managed[Aura Console]. -. On the *Instances* page, click the *Self-managed* tab and then *+ Add deployment* button. -. Select *URL Connection*. -. Provide a *Name* and *Connection URL*. -If you have installed Neo4j locally on your system, you can connect to _\http://localhost:7474_. -. Click the *Connect* dropdown to launch various graph tools such as *Query*, *Explore*, and *Dashboards*. -. Type the username `neo4j` and your password or the default password `neo4j`. -You will be prompted to change the latter upon first login. -+ -image::aura-add-deployment.png[width=800,alt=Aura add self-managed deployment] - -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. -For details, see link:https://neo4j.com/docs/getting-started/#_work_with_data[Get started with Neo4j]. - -Alternatively, you can use the Neo4j Browser, a web-based user interface for interacting with Neo4j that is included with the Neo4j installation. -To access the Neo4j Browser, open a web browser and navigate to _\http://localhost:7474_. -Connect using the username `neo4j` with your password or the default password `neo4j`. -If the default password is used, you will be prompted to change it upon first login. +include::partial$/access-neo4j.adoc[] == Uninstall Neo4j diff --git a/modules/ROOT/pages/installation/linux/systemd.adoc b/modules/ROOT/pages/installation/linux/systemd.adoc index 2991ce819..68f69f6e9 100644 --- a/modules/ROOT/pages/installation/linux/systemd.adoc +++ b/modules/ROOT/pages/installation/linux/systemd.adoc @@ -94,6 +94,6 @@ Follow these steps to uninstall Neo4j: . Uninstall Neo4j: + [source, shell] ---- +---- sudo apt remove neo4j ---- \ No newline at end of file +---- \ No newline at end of file diff --git a/modules/ROOT/pages/installation/linux/tarball.adoc b/modules/ROOT/pages/installation/linux/tarball.adoc index bb384f0ae..b28af169f 100644 --- a/modules/ROOT/pages/installation/linux/tarball.adoc +++ b/modules/ROOT/pages/installation/linux/tarball.adoc @@ -220,28 +220,7 @@ sudo systemctl daemon-reload == Access Neo4j -By default, Neo4j Community Edition does not include graph tools such as visualization, data exploration, and monitoring. -However, you can use the Neo4j Aura console to access these features for free. -No subscription is required. - -. Sign up or log in to the link:https://console-preview.neo4j.io/self-managed[Aura Console]. -. On the *Instances* page, click the *Self-managed* tab and then *+ Add deployment* button. -. Select *URL Connection*. -. Provide a *Name* and *Connection URL*. -If you have installed Neo4j locally on your system, you can connect to _\http://localhost:7474_. -. Click the *Connect* dropdown to launch various graph tools such as *Query*, *Explore*, and *Dashboards*. -. Type the username `neo4j` and your password or the default password `neo4j`. -You will be prompted to change the latter upon first login. -+ -image::aura-add-deployment.png[width=800,alt=Aura add self-managed deployment] - -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. -For details, see link:https://neo4j.com/docs/getting-started/#_work_with_data[Get started with Neo4j]. - -Alternatively, you can use the Neo4j Browser, a web-based user interface for interacting with Neo4j that is included with the Neo4j installation. -To access the Neo4j Browser, open a web browser and navigate to _\http://localhost:7474_. -Connect using the username `neo4j` with your password or the default password `neo4j`. -If the default password is used, you will be prompted to change it upon first login. +include::partial$/access-neo4j.adoc[] == Uninstall Neo4j diff --git a/modules/ROOT/pages/installation/osx.adoc b/modules/ROOT/pages/installation/osx.adoc index 0bf2624b3..c52139127 100644 --- a/modules/ROOT/pages/installation/osx.adoc +++ b/modules/ROOT/pages/installation/osx.adoc @@ -74,28 +74,7 @@ Alternatively, if you want to install Neo4j Enterprise or prefer native service == Access Neo4j -By default, Neo4j Community Edition does not include graph tools such as visualization, data exploration, and monitoring. -However, you can use the Neo4j Aura console to access these features for free. -No subscription is required. - -. Sign up or log in to the link:https://console-preview.neo4j.io/self-managed[Aura Console]. -. On the *Instances* page, click the *Self-managed* tab and then *+ Add deployment* button. -. Select *URL Connection*. -. Provide a *Name* and *Connection URL*. -If you have installed Neo4j locally on your system, you can connect to _\http://localhost:7474_. -. Click the *Connect* dropdown to launch various graph tools such as *Query*, *Explore*, and *Dashboards*. -. Type the username `neo4j` and your password or the default password `neo4j`. -You will be prompted to change the latter upon first login. -+ -image::aura-add-deployment.png[width=800,alt=Aura add self-managed deployment] - -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. -For details, see link:https://neo4j.com/docs/getting-started/#_work_with_data[Get started with Neo4j]. - -Alternatively, you can use the Neo4j Browser, a web-based user interface for interacting with Neo4j that is included with the Neo4j installation. -To access the Neo4j Browser, open a web browser and navigate to _\http://localhost:7474_. -Connect using the username `neo4j` with your password or the default password `neo4j`. -If the default password is used, you will be prompted to change it upon first login. +include::partial$/access-neo4j.adoc[] == Logging diff --git a/modules/ROOT/partials/access-neo4j.adoc b/modules/ROOT/partials/access-neo4j.adoc new file mode 100644 index 000000000..bd2c9a2f3 --- /dev/null +++ b/modules/ROOT/partials/access-neo4j.adoc @@ -0,0 +1,22 @@ +By default, Neo4j Community Edition does not include graph tools such as visualization, data exploration, and monitoring. +However, you can use the Neo4j Aura console to access these features for free. +No subscription is required. + +. Sign up or log in to the link:https://console-preview.neo4j.io/self-managed[Aura Console]. +. On the *Instances* page, click the *Self-managed* tab and then *+ Add deployment* button. +. Select *URL Connection*. +. Provide a *Name* and *Connection URL*. +If you have installed Neo4j locally on your system, you can connect to _\http://localhost:7474_. +. Click the *Connect* dropdown to launch various graph tools such as *Query*, *Explore*, and *Dashboards*. +. Type the username `neo4j` and your password or the default password `neo4j`. +You will be prompted to change the latter upon first login. ++ +image::aura-add-deployment.png[width=800,alt=Aura add self-managed deployment] + +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. +For details, see link:https://neo4j.com/docs/getting-started/#_work_with_data[Get started with Neo4j]. + +Alternatively, you can use the Neo4j Browser, a web-based user interface for interacting with Neo4j that is included with the Neo4j installation. +To access the Neo4j Browser, open a web browser and navigate to _\http://localhost:7474_. +Connect using the username `neo4j` with your password or the default password `neo4j`. +If the default password is used, you will be prompted to change it upon first login. \ No newline at end of file From 775e73a9a5903e222557d1c8bfee3a21b7f10497 Mon Sep 17 00:00:00 2001 From: Reneta Popova Date: Wed, 22 Oct 2025 10:36:20 +0100 Subject: [PATCH 3/5] update the java prerequisites --- modules/ROOT/pages/installation/linux/debian.adoc | 2 +- modules/ROOT/pages/installation/linux/rpm.adoc | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/modules/ROOT/pages/installation/linux/debian.adoc b/modules/ROOT/pages/installation/linux/debian.adoc index f30e903c0..ffee8cc70 100644 --- a/modules/ROOT/pages/installation/linux/debian.adoc +++ b/modules/ROOT/pages/installation/linux/debian.adoc @@ -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). Starting with Neo4j 2025.10, Java 25 is also supported. === OpenJDK Java 21 diff --git a/modules/ROOT/pages/installation/linux/rpm.adoc b/modules/ROOT/pages/installation/linux/rpm.adoc index 71b8aadcd..2ff8662db 100644 --- a/modules/ROOT/pages/installation/linux/rpm.adoc +++ b/modules/ROOT/pages/installation/linux/rpm.adoc @@ -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). Starting with Neo4j 2025.10, Java 25 is also supported. === OpenJDK Java 21 From 789e0d9f40acd62f126fab185932ff8fd9855fe4 Mon Sep 17 00:00:00 2001 From: Reneta Popova Date: Wed, 22 Oct 2025 15:11:05 +0200 Subject: [PATCH 4/5] Apply suggestion from @renetapopova --- modules/ROOT/pages/installation/linux/debian.adoc | 1 + 1 file changed, 1 insertion(+) diff --git a/modules/ROOT/pages/installation/linux/debian.adoc b/modules/ROOT/pages/installation/linux/debian.adoc index ffee8cc70..656d1b175 100644 --- a/modules/ROOT/pages/installation/linux/debian.adoc +++ b/modules/ROOT/pages/installation/linux/debian.adoc @@ -38,6 +38,7 @@ Your results may vary, but this is an example of the output: + [queryresult] ---- +java-1.25.0-openjdk-amd64 2511 /usr/lib/jvm/java-1.25.0-openjdk-amd64 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 java-1.25.0-openjdk-amd64 2511 /usr/lib/jvm/java-1.25.0-openjdk-amd64 From ac6ca6a84e96ac90e95ae1daa382902123f1db0d Mon Sep 17 00:00:00 2001 From: Reneta Popova Date: Wed, 22 Oct 2025 15:11:49 +0200 Subject: [PATCH 5/5] Apply suggestion from @renetapopova --- modules/ROOT/pages/installation/linux/debian.adoc | 1 - 1 file changed, 1 deletion(-) diff --git a/modules/ROOT/pages/installation/linux/debian.adoc b/modules/ROOT/pages/installation/linux/debian.adoc index 656d1b175..618b53ee0 100644 --- a/modules/ROOT/pages/installation/linux/debian.adoc +++ b/modules/ROOT/pages/installation/linux/debian.adoc @@ -41,7 +41,6 @@ Your results may vary, but this is an example of the output: java-1.25.0-openjdk-amd64 2511 /usr/lib/jvm/java-1.25.0-openjdk-amd64 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 -java-1.25.0-openjdk-amd64 2511 /usr/lib/jvm/java-1.25.0-openjdk-amd64 ---- . Identify your Java 21 version (default) from the list of installed Javas.