Skip to content

Commit 7ba2223

Browse files
authored
Improve docs for macOS installation (#2497) (#2621)
1 parent 6aa0fd3 commit 7ba2223

File tree

2 files changed

+68
-23
lines changed

2 files changed

+68
-23
lines changed
163 KB
Loading

modules/ROOT/pages/installation/osx.adoc

Lines changed: 68 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -3,38 +3,32 @@
33
= macOS installation
44

55
Before you install Neo4j on macOS, check xref:installation/requirements.adoc[System Requirements] to see if your setup is suitable.
6-
6+
If it is not already installed, get link:https://openjdk.org/[OpenJDK 21] or link:https://www.azul.com/downloads/[ZuluJDK 21].
77

88
[[osx-console]]
9-
== Unix console application
9+
== Install and start Neo4j
1010

11-
. If it is not already installed, get link:https://openjdk.org/[OpenJDK 21] or link:https://www.azul.com/downloads/[ZuluJDK 21].
12-
. Download the latest release from link:{neo4j-download-center-uri}[Neo4j Deployment Center].
13-
+
14-
Select the appropriate tar.gz distribution for your platform.
15-
. Make sure to download Neo4j from link:{neo4j-download-center-uri}[Neo4j Deployment Center] and always check that the SHA hash of the downloaded file is correct:
16-
.. To find the correct SHA hash, go to Neo4j Deployment Center and click on `SHA-256` which will be located below your downloaded file.
17-
.. Using the appropriate commands for your platform, display the `SHA-256` hash for the file that you downloaded.
18-
.. Ensure that the two are identical.
19-
. Extract the contents of the archive, using `tar -xf` <filename>.
20-
For example, `tar -xf neo4j-community-{neo4j-version-exact}-unix.tar.gz`.
11+
You can install Neo4j on macOS either by downloading and extracting a TAR archive or by using the Homebrew package manager.
12+
13+
=== Install Neo4j using a 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.
2117
. 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.
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.
2319
+
2420
[NOTE]
2521
====
2622
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.
2723
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.
2824
====
29-
. Accept either the commercial or the evaluation license agreement before running the Neo4j Enterprise Edition.
25+
. label:enterprise[Enterprise Edition] Accept either the commercial or the evaluation license agreement.
3026
If you are using Community Edition, you can skip this step.
3127
* Use one of the following options to accept the commercial license agreement.
3228
See the link:https://legal.neo4j.com/[Neo4j licensing] page for details on the available agreements.
33-
+
3429
** Set the environment variable `NEO4J_ACCEPT_LICENSE_AGREEMENT=yes`.
3530
** Run `$NEO4J_HOME/bin/neo4j-admin server license --accept-commercial`
3631
* Use one of the following options to accept the link:https://neo4j.com/terms/enterprise_us/[Neo4j Evaluation Agreement for Neo4j Software]:
37-
+
3832
** Set the environment variable `NEO4J_ACCEPT_LICENSE_AGREEMENT=eval`.
3933
** Run `$NEO4J_HOME/bin/neo4j-admin server license --accept-evaluation`.
4034
. 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`.
@@ -45,18 +39,69 @@ For more information, see xref:configuration/set-initial-password.adoc[].
4539
. Start Neo4j:
4640
* To run Neo4j as a console application, use: `$NEO4J_HOME/bin/neo4j console`.
4741
* To run Neo4j in a background process, use: `$NEO4J_HOME/bin/neo4j start`.
48-
. Open _\http://localhost:7474/_ in your web browser.
49-
. Connect using the username `neo4j` with your password or the default password `neo4j`.
50-
You will then be prompted to change the password.
51-
. Stop the server by typing `Ctrl-C` in the console.
5242

53-
When Neo4j runs in console mode, logs are printed to the terminal.
43+
=== Install Neo4j as a macOS service
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]).
46+
47+
. Install Neo4j using Homebrew:
48+
+
49+
[source, shell]
50+
----
51+
brew install neo4j
52+
----
53+
+
54+
This command installs Neo4j Community Edition and sets it up as a service that can be managed using Homebrew.
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`.
56+
If already started, changes to the configuration file will not take effect until you restart the Neo4j service using `brew services restart neo4j`.
57+
. Start Neo4j as a macOS service:
58+
+
59+
[source, shell]
60+
----
61+
brew services start neo4j
62+
----
63+
+
64+
This command starts the Neo4j service and sets it to launch automatically at system startup.
65+
. To check the status of the Neo4j service, use:
66+
+
67+
[source, shell]
68+
----
69+
brew services list
70+
----
5471

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.
5573

56-
== macOS service
74+
== Access Neo4j
5775

58-
Use the standard macOS system tools to create a service based on the `neo4j` command.
76+
By default, Neo4j Community Edition does not include graph tools such as visualization, data exploration, and monitoring.
77+
However, you can use the Neo4j Aura console to access these features for free.
78+
No subscription is required.
5979

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.
88+
+
89+
image::aura-add-deployment.png[width=800,alt=Aura add self-managed deployment]
90+
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+
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`.
97+
If the default password is used, you will be prompted to change it upon first login.
98+
99+
== Logging
100+
101+
Neo4j logs are written to the _logs_ directory under _NEO4J_HOME_.
102+
For detailed information about the log files, see xref:monitoring/logging.adoc[Logging].
103+
104+
When Neo4j runs in console mode, logs are printed to the terminal.
60105

61106
== macOS file descriptor limits
62107

0 commit comments

Comments
 (0)