Skip to content

Commit 2d15195

Browse files
committed
Update Neo4j Server installation instructions
Fixes #256
1 parent 5020b1a commit 2d15195

File tree

1 file changed

+10
-11
lines changed

1 file changed

+10
-11
lines changed
Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,21 @@
11
[[neo4j-server]]
22
= Neo4j Server
33

4-
The GDS library is intended to be used on a standalone Neo4j server.
4+
On a standalone Neo4j Server, GDS will need to be installed and configured manually.
55

6-
On a standalone Neo4j Server, the library will need to be installed and configured manually.
6+
1. Download `neo4j-graph-data-science-[version].zip` from the https://neo4j.com/download-center/#algorithms[Neo4j Download Center]
77

8-
1. Download `neo4j-graph-data-science-[version].jar` from the https://neo4j.com/download-center/#algorithms[Neo4j Download Center] and copy it into the `$NEO4J_HOME/plugins` directory.
8+
2. Unzip the archive and move the `neo4j-graph-data-science-[version].jar` file into the `$NEO4J_HOME/plugins` directory.
99

10-
11-
2. Add the following to your `$NEO4J_HOME/conf/neo4j.conf` file:
10+
3. Add the following to your `$NEO4J_HOME/conf/neo4j.conf` file:
1211
+
1312
----
1413
dbms.security.procedures.unrestricted=gds.*
1514
----
1615
This configuration entry is necessary because the GDS library accesses low-level components of Neo4j to maximise performance.
1716
+
1817

19-
3. Check if the procedure allowlist is enabled in the `$NEO4J_HOME/conf/neo4j.conf` file and add the GDS library if necessary:
18+
4. Check if the procedure allowlist is enabled in the `$NEO4J_HOME/conf/neo4j.conf` file and add the GDS library if necessary:
2019
+
2120
----
2221
dbms.security.procedures.allowlist=gds.*
@@ -26,22 +25,22 @@ dbms.security.procedures.allowlist=gds.*
2625
NOTE: Before `Neo4j 4.2`, the configuration setting is called `dbms.security.procedures.whitelist`
2726

2827

29-
4. Restart Neo4j
28+
5. Restart Neo4j
3029

3130

3231
[[neo4j-server-verify]]
3332
== Verifying installation
3433

35-
To verify your installation, the library version can be printed by entering into the browser in Neo4j Desktop and calling the `gds.version()` function:
34+
To verify your installation, print the version of Graph Data Science by opening Neo4j Browser and running the `gds.version()` function:
3635

3736
[source, cypher, role=noplay]
3837
----
39-
RETURN gds.version()
38+
RETURN gds.version();
4039
----
4140

42-
To list all installed algorithms, run the `gds.list()` procedure:
41+
To list all available procedures, run the `gds.list()` procedure:
4342

4443
[source, cypher, role=noplay]
4544
----
46-
CALL gds.list()
45+
CALL gds.list();
4746
----

0 commit comments

Comments
 (0)