Skip to content

Commit 81707ca

Browse files
authored
Update the TAR/ZIP steps to include decoupling of files from binaries (neo4j#2092)
1 parent a4bbf33 commit 81707ca

File tree

3 files changed

+22
-7
lines changed

3 files changed

+22
-7
lines changed

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

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,13 @@ chown -R neo4j:adm /opt/neo4j-enterprise-{neo4j-version-exact}
4242
----
4343
chown -R neo4j /opt/neo4j-enterprise-{neo4j-version-exact}
4444
----
45+
. 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.
46+
+
47+
[NOTE]
48+
====
49+
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.
50+
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.
51+
====
4552
. Accept either the commercial or the evaluation license agreement before running the Neo4j Enterprise Edition.
4653
If you are using Community Edition, you can skip this step.
4754
* Use one of the following options to accept the commercial license agreement.
@@ -53,8 +60,6 @@ See the link:https://neo4j.com/terms/licensing/[Neo4j licensing] page for detail
5360
+
5461
** Set the environment variable `NEO4J_ACCEPT_LICENSE_AGREEMENT=eval`.
5562
** Run `<NEO4J_HOME>/bin/neo4j-admin server license --accept-evaluation`.
56-
. (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.
57-
Storing your data and configuration on a separate disk or partition can simplify the upgrade process later.
5863
. 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`.
5964
+
6065
If the password is not set explicitly using this method, it will be set to the default password `neo4j`.

modules/ROOT/pages/installation/osx.adoc

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,13 @@ Select the appropriate tar.gz distribution for your platform.
1919
. Extract the contents of the archive, using `tar -xf` <filename>.
2020
For example, `tar -xf neo4j-community-{neo4j-version-exact}-unix.tar.gz`.
2121
. 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/_<NEO4J_HOME>` to make it easier to refer to it later.
22+
. 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.
23+
+
24+
[NOTE]
25+
====
26+
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.
27+
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.
28+
====
2229
. Accept either the commercial or the evaluation license agreement before running the Neo4j Enterprise Edition.
2330
If you are using Community Edition, you can skip this step.
2431
* Use one of the following options to accept the commercial license agreement.
@@ -30,8 +37,6 @@ See the link:https://neo4j.com/terms/licensing/[Neo4j licensing] page for detail
3037
+
3138
** Set the environment variable `NEO4J_ACCEPT_LICENSE_AGREEMENT=eval`.
3239
** Run `$NEO4J_HOME/bin/neo4j-admin server license --accept-evaluation`.
33-
. (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.
34-
Storing your data and configuration on a separate disk or partition can simplify the upgrade process later.
3540
. 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`.
3641
+
3742
If the password is not set explicitly using this method, it will be set to the default password `neo4j`.

modules/ROOT/pages/installation/windows.adoc

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,14 @@ Select the appropriate ZIP distribution.
1717
.. Using the appropriate commands for your platform, display the `SHA-256` hash for the file that you downloaded.
1818
.. Ensure that the two are identical.
1919
. Right-click the downloaded file and click *Extract All*.
20-
. 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/_<NEO4J_HOME>` to make it easier to refer to it later.
20+
. 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\_<NEO4J_HOME>` to make it easier to refer to it later.
21+
. 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.
22+
+
23+
[NOTE]
24+
====
25+
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.
26+
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.
27+
====
2128
. Accept either the commercial or the evaluation license agreement before running the Neo4j Enterprise Edition.
2229
If you are using Community Edition, you can skip this step.
2330
* Use one of the following options to accept the commercial license agreement.
@@ -29,8 +36,6 @@ See the link:https://neo4j.com/terms/licensing/[Neo4j licensing] page for detail
2936
+
3037
** Set it as an environment variable using `set NEO4J_ACCEPT_LICENSE_AGREEMENT=eval`.
3138
** Run `$NEO4J_HOME\bin\neo4j-admin server license --accept-evaluation`.
32-
. (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.
33-
Storing your data and configuration on a separate disk or partition can simplify the upgrade process later.
3439
. 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`.
3540
+
3641
If the password is not set explicitly using this method, it will be set to the default password `neo4j`.

0 commit comments

Comments
 (0)