From 45c86674ba920db1e20940c894a77a97bb0a4ebf Mon Sep 17 00:00:00 2001 From: Reneta Popova Date: Fri, 31 Jan 2025 15:54:29 +0000 Subject: [PATCH 1/5] Update the TAR/ZIP steps to include decoupling of files from binaries --- modules/ROOT/pages/installation/osx.adoc | 4 ++-- modules/ROOT/pages/installation/windows.adoc | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/modules/ROOT/pages/installation/osx.adoc b/modules/ROOT/pages/installation/osx.adoc index d454da326..f202b8a33 100644 --- a/modules/ROOT/pages/installation/osx.adoc +++ b/modules/ROOT/pages/installation/osx.adoc @@ -19,6 +19,8 @@ Select the appropriate tar.gz distribution for your platform. . Extract the contents of the archive, using `tar -xf` . For example, `tar -xf neo4j-community-{neo4j-version-exact}-unix.tar.gz`. . Place the extracted files in a permanent home on your server and set the environment variable `NEO4J_HOME` to point to the extracted directory, for example, `export NEO4J_HOME=/path/to/_` to make it easier to refer to it later. +. 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. +Storing your Neo4j files outside the installation can simplify the upgrade process later. . Accept either the commercial or the evaluation license agreement before running the Neo4j Enterprise Edition. If you are using Community Edition, you can skip this step. * Use one of the following options to accept the commercial license agreement. @@ -30,8 +32,6 @@ See the link:https://neo4j.com/terms/licensing/[Neo4j licensing] page for detail + ** Set the environment variable `NEO4J_ACCEPT_LICENSE_AGREEMENT=eval`. ** Run `$NEO4J_HOME/bin/neo4j-admin server license --accept-evaluation`. -. (Optional) Decouple the data and configuration directories from the binary files by setting the environment variable `NEO4J_CONF` and `server.directories.data` to point to the desired locations. -Storing your data and configuration on a separate disk or partition can simplify the upgrade process later. . Before starting up the database for the first time, it is recommended to use the `set-initial-password` command of `neo4j-admin` to define the password for the native user `neo4j`. + If the password is not set explicitly using this method, it will be set to the default password `neo4j`. diff --git a/modules/ROOT/pages/installation/windows.adoc b/modules/ROOT/pages/installation/windows.adoc index 6410322cd..099d0534d 100644 --- a/modules/ROOT/pages/installation/windows.adoc +++ b/modules/ROOT/pages/installation/windows.adoc @@ -18,6 +18,8 @@ Select the appropriate ZIP distribution. .. Ensure that the two are identical. . Right-click the downloaded file and click *Extract All*. . Place the extracted files in a permanent home on your server and set the environment variable `NEO4J_HOME` to point to the extracted directory, for example, `export NEO4J_HOME=/path/to/_` to make it easier to refer to it later. +. 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. +Storing your Neo4j files outside the installation can simplify the upgrade process later. . Accept either the commercial or the evaluation license agreement before running the Neo4j Enterprise Edition. If you are using Community Edition, you can skip this step. * Use one of the following options to accept the commercial license agreement. @@ -29,8 +31,6 @@ See the link:https://neo4j.com/terms/licensing/[Neo4j licensing] page for detail + ** Set it as an environment variable using `set NEO4J_ACCEPT_LICENSE_AGREEMENT=eval`. ** Run `$NEO4J_HOME\bin\neo4j-admin server license --accept-evaluation`. -. (Optional) Decouple the data and configuration directories from the binary files by setting the environment variable `NEO4J_CONF` and `server.directories.data` to point to the desired locations. -Storing your data and configuration on a separate disk or partition can simplify the upgrade process later. . Before starting up the database for the first time, it is recommended to use the `set-initial-password` command of `neo4j-admin` to define the password for the native user `neo4j`. + If the password is not set explicitly using this method, it will be set to the default password `neo4j`. From afe9309eecebcdd6f8f13323b489eb7dfc87e8ab Mon Sep 17 00:00:00 2001 From: Reneta Popova Date: Tue, 4 Feb 2025 10:15:14 +0000 Subject: [PATCH 2/5] apply suggestions from review --- modules/ROOT/pages/installation/osx.adoc | 7 ++++++- modules/ROOT/pages/installation/windows.adoc | 7 ++++++- 2 files changed, 12 insertions(+), 2 deletions(-) diff --git a/modules/ROOT/pages/installation/osx.adoc b/modules/ROOT/pages/installation/osx.adoc index f202b8a33..e7ae1030c 100644 --- a/modules/ROOT/pages/installation/osx.adoc +++ b/modules/ROOT/pages/installation/osx.adoc @@ -20,7 +20,12 @@ Select the appropriate tar.gz distribution for your platform. For example, `tar -xf neo4j-community-{neo4j-version-exact}-unix.tar.gz`. . Place the extracted files in a permanent home on your server and set the environment variable `NEO4J_HOME` to point to the extracted directory, for example, `export NEO4J_HOME=/path/to/_` to make it easier to refer to it later. . 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. -Storing your Neo4j files outside the installation can simplify the upgrade process later. ++ +[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. If you are using Community Edition, you can skip this step. * Use one of the following options to accept the commercial license agreement. diff --git a/modules/ROOT/pages/installation/windows.adoc b/modules/ROOT/pages/installation/windows.adoc index 099d0534d..fac1ff0ee 100644 --- a/modules/ROOT/pages/installation/windows.adoc +++ b/modules/ROOT/pages/installation/windows.adoc @@ -19,7 +19,12 @@ Select the appropriate ZIP distribution. . Right-click the downloaded file and click *Extract All*. . Place the extracted files in a permanent home on your server and set the environment variable `NEO4J_HOME` to point to the extracted directory, for example, `export NEO4J_HOME=/path/to/_` to make it easier to refer to it later. . 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. -Storing your Neo4j files outside the installation can simplify the upgrade process later. ++ +[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. If you are using Community Edition, you can skip this step. * Use one of the following options to accept the commercial license agreement. From 2f14bcc1d8a15f246dab2013db742e85d82a82ec Mon Sep 17 00:00:00 2001 From: Reneta Popova Date: Tue, 4 Feb 2025 10:17:48 +0000 Subject: [PATCH 3/5] change the slashes to backslashes --- modules/ROOT/pages/installation/windows.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/ROOT/pages/installation/windows.adoc b/modules/ROOT/pages/installation/windows.adoc index fac1ff0ee..3b739023c 100644 --- a/modules/ROOT/pages/installation/windows.adoc +++ b/modules/ROOT/pages/installation/windows.adoc @@ -17,7 +17,7 @@ Select the appropriate ZIP distribution. .. Using the appropriate commands for your platform, display the `SHA-256` hash for the file that you downloaded. .. Ensure that the two are identical. . Right-click the downloaded file and click *Extract All*. -. Place the extracted files in a permanent home on your server and set the environment variable `NEO4J_HOME` to point to the extracted directory, for example, `export NEO4J_HOME=/path/to/_` to make it easier to refer to it later. +. Place the extracted files in a permanent home on your server and set the environment variable `NEO4J_HOME` to point to the extracted directory, for example, `export NEO4J_HOME=\path\to\_` to make it easier to refer to it later. . 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] From 752f4b2f9624342d2a3a0b2bd850eea8ac01093b Mon Sep 17 00:00:00 2001 From: Reneta Popova Date: Tue, 4 Feb 2025 10:23:03 +0000 Subject: [PATCH 4/5] update the linux tar steps --- modules/ROOT/pages/installation/linux/tarball.adoc | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/modules/ROOT/pages/installation/linux/tarball.adoc b/modules/ROOT/pages/installation/linux/tarball.adoc index 58b115bc7..2feec67b8 100644 --- a/modules/ROOT/pages/installation/linux/tarball.adoc +++ b/modules/ROOT/pages/installation/linux/tarball.adoc @@ -42,6 +42,13 @@ chown -R neo4j:adm /opt/neo4j-enterprise-{neo4j-version-exact} ---- 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. ++ +[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. If you are using Community Edition, you can skip this step. * Use one of the following options to accept the commercial license agreement. From aac9a7bc69f5dca627c595361119bae15cdc75ad Mon Sep 17 00:00:00 2001 From: Reneta Popova Date: Tue, 4 Feb 2025 15:35:02 +0000 Subject: [PATCH 5/5] remove the leftover step --- modules/ROOT/pages/installation/linux/tarball.adoc | 2 -- 1 file changed, 2 deletions(-) diff --git a/modules/ROOT/pages/installation/linux/tarball.adoc b/modules/ROOT/pages/installation/linux/tarball.adoc index 2feec67b8..a0a01daef 100644 --- a/modules/ROOT/pages/installation/linux/tarball.adoc +++ b/modules/ROOT/pages/installation/linux/tarball.adoc @@ -60,8 +60,6 @@ See the link:https://neo4j.com/terms/licensing/[Neo4j licensing] page for detail + ** Set the environment variable `NEO4J_ACCEPT_LICENSE_AGREEMENT=eval`. ** Run `/bin/neo4j-admin server license --accept-evaluation`. -. (Optional) Decouple the data and configuration directories from the binary files by setting the environment variable `NEO4J_CONF` and `server.directories.data` to point to the desired locations. -Storing your data and configuration on a separate disk or partition can simplify the upgrade process later. . Before starting up the database for the first time, it is recommended to use the `set-initial-password` command of `neo4j-admin` to define the password for the native user `neo4j`. + If the password is not set explicitly using this method, it will be set to the default password `neo4j`.