You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: modules/ROOT/pages/installation/osx.adoc
+30-49Lines changed: 30 additions & 49 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,23 +8,24 @@ If it is not already installed, get link:https://openjdk.org/[OpenJDK 21] or lin
8
8
[[osx-console]]
9
9
== Install and start Neo4j
10
10
11
-
You can run Neo4j as a console application on macOS.
11
+
You can install Neo4j on macOS either by downloading and extracting a TAR archive or by using the Homebrew package manager.
12
12
13
-
. Download the Linux/Mac Executable {neo4j-version-exact} (tar) release from link:{neo4j-download-center-uri}[Neo4j Deployment Center].
14
-
. Verify the integrity of the downloaded file by checking the SHA-256 hash.
15
-
It must match the hash provided on the download page below the download link.
16
-
. Extract the contents of the archive, using `tar -xf` <filename> or by double-clicking the archive in Finder.
13
+
=== Install Neo4j from the tar archive
14
+
15
+
. Download the Linux/Mac Executable {neo4j-version-exact} (TAR) release from link:{neo4j-download-center-uri}[Neo4j Deployment Center].
16
+
. Extract the contents of the archive, using `tar -xf` <filename> or by double-clicking the file.
17
17
. 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.
18
-
. (Optional) 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.
18
+
. (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.
19
19
+
20
20
[NOTE]
21
21
====
22
22
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.
23
23
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.
24
24
====
25
-
. label:enterprise[Enterprise Edition] Accept either the commercial or the evaluation license agreement by one of the following methods:
25
+
. label:enterprise[Enterprise Edition] Accept either the commercial or the evaluation license agreement.
26
+
If you are using Community Edition, you can skip this step.
26
27
* Use one of the following options to accept the commercial license agreement.
27
-
See the link:https://legal.neo4j.com/[Neo4j licensing] page for details on the available agreements.:
28
+
See the link:https://legal.neo4j.com/[Neo4j licensing] page for details on the available agreements.
28
29
** Set the environment variable `NEO4J_ACCEPT_LICENSE_AGREEMENT=yes`.
29
30
** Run `$NEO4J_HOME/bin/neo4j-admin server license --accept-commercial`
30
31
* Use one of the following options to accept the link:https://neo4j.com/terms/enterprise_us/[Neo4j Evaluation Agreement for Neo4j Software]:
@@ -39,7 +40,7 @@ For more information, see xref:configuration/set-initial-password.adoc[].
39
40
* To run Neo4j as a console application, use: `$NEO4J_HOME/bin/neo4j console`.
40
41
* To run Neo4j in a background process, use: `$NEO4J_HOME/bin/neo4j start`.
41
42
42
-
== Install Neo4j as a macOS service
43
+
=== Install Neo4j as a macOS service
43
44
44
45
The easiest way to install Neo4j as a service on macOS is to use the Homebrew package manager (see https://brew.sh/[Homebrew installation instructions]).
45
46
@@ -51,7 +52,7 @@ brew install neo4j
51
52
----
52
53
+
53
54
This command installs Neo4j Community Edition and sets it up as a service that can be managed using Homebrew.
54
-
. (Optional) If you want to change the default directories or other settings, you can do so in the `neo4j.conf` file located at `/opt/homebrew/Cellar/neo4j/{neo4j-version-exact}/libexec/conf/neo4j.conf`.
55
+
. (Recommended) If you want to change the default directories or other settings, you can do so in the `neo4j.conf` file located at `/opt/homebrew/Cellar/neo4j/{neo4j-version-exact}/libexec/conf/neo4j.conf`.
55
56
If already started, changes to the configuration file will not take effect until you restart the Neo4j service using `brew services restart neo4j`.
56
57
. Start Neo4j as a macOS service:
57
58
+
@@ -70,53 +71,33 @@ brew services list
70
71
71
72
Alternatively, if you want to install Neo4j Enterprise or prefer native service control, you can use the standard macOS system tools, such as `launchd`, to create a service based on the `neo4j` command.
72
73
73
-
74
74
== Access Neo4j
75
75
76
-
After starting Neo4j, you can access it using the Neo4j Aura console, Neo4j Browser, or Cypher Shell.
77
-
78
-
=== Using the Neo4j Aura console
79
-
80
76
By default, Neo4j Community Edition does not include graph tools such as visualization, data exploration, and monitoring.
81
-
However, you can use the Neo4j Aura console to access these features in a cloud environment.
82
-
83
-
. Log in to the Aura Console at https://console.neo4j.io/.
84
-
. Connect to your Neo4j server by entering the connection details, such as the server address and port.
85
-
//To add an example.
86
-
. Type the username `neo4j` with your password or the default password `neo4j`.
87
-
If the default password is used, you will be prompted to change it upon first login.
88
-
. Once connected, you can use the Aura Console to run Cypher queries, visualize graphs, and monitor your local Neo4j in the cloud environment.
77
+
However, you can use the Neo4j Aura console to access these features for free.
78
+
No subscription is required.
79
+
80
+
. Sign up or log in to the link:http://console-preview.neo4j.io/self-managed[Aura Console].
81
+
. On the *Instances* page, click the *Self-managed* tab and then *+ Add deployment* button.
82
+
. Select *URL Connection*.
83
+
. Provide a *Name* and *Connection URL*.
84
+
If you have installed Neo4j locally on your system, you can connect to _\http://localhost:7474_.
85
+
. Click the *Connect* dropdown to launch various graph tools such as *Query*, *Explore*, and *Dashboards*.
86
+
. Type the username `neo4j` and your password or the default password `neo4j`.
87
+
You will be prompted to change the latter upon first login.
The Neo4j Browser is a web-based user interface for interacting with Neo4j.
92
-
To access the Neo4j Browser, open a web browser and navigate to:
91
+
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.
92
+
For details, see link:https://neo4j.com/docs/getting-started/#_work_with_data[Get started with Neo4j].
93
93
94
-
. _\http://localhost:7474/_ or the URL specified in your configuration.
95
-
. Connect using the username `neo4j` with your password or the default password `neo4j`.
94
+
Alternatively, you can use the Neo4j Browser, a web-based user interface for interacting with Neo4j that is included with the Neo4j installation.
95
+
To access the Neo4j Browser, open a web browser and navigate to _\http://localhost:7474_.
96
+
Connect using the username `neo4j` with your password or the default password `neo4j`.
96
97
If the default password is used, you will be prompted to change it upon first login.
97
98
98
-
=== Using Cypher Shell
99
-
100
-
Cypher Shell is a command-line tool for executing Cypher queries against a Neo4j database.
101
-
To use Cypher Shell, run the following command in your terminal:
0 commit comments