ArangoDB v3.4 reached End of Life (EOL) and is no longer supported.

This documentation is outdated. Please see the most recent version here: Latest Docs

Installing ArangoDB on macOS

ArangoDB under macOS can be installed via:

  1. Homebrew
  2. DMG Package
  3. tar.gz Archive (starting from v3.4.0)

Homebrew

When installing ArangoDB via the macOS package manager Homebrew, only the Community Edition is available.

The Homebrew installation is updated a few days after the official release of a new version.

If you are using homebrew, then you can install the latest released stable version of ArangoDB using brew as follows:

brew install arangodb

This will install the current stable version of ArangoDB and all dependencies within your Homebrew tree. Note that the server will be installed as:

/usr/local/Cellar/arangodb/<VERSION>/sbin/arangod

<VERSION> is a placeholder for the actual version number, e.g. 3.4.0.

You can start the server by running the command:

/usr/local/Cellar/arangodb/<VERSION>/sbin/arangod &

Configuration file is located at:

/usr/local/etc/arangodb3/arangod.conf

The ArangoDB shell will be installed as:

/usr/local/Cellar/arangodb/<VERSION>/bin/arangosh

You can uninstall ArangoDB using:

brew uninstall arangodb

However, in case you started ArangoDB using the launchctl, you need to unload it before uninstalling the server:

launchctl unload ~/Library/LaunchAgents/homebrew.mxcl.arangodb.plist

Then remove the LaunchAgent:

rm ~/Library/LaunchAgents/homebrew.mxcl.arangodb.plist

If the latest ArangoDB version is not shown in Homebrew, you also need to update Homebrew executing the command brew update.

Known issues

  • The ArangoDB Starter is not included in v3.3.x, but shipped with all 3.4.x versions.
  • The Commandline argument parsing does not accept blanks in filenames; the CLI version below does.
  • If you need to change server endpoint while starting homebrew version, you can edit arangod.conf file and uncomment line with endpoint needed, e.g.:

    [server]
    endpoint = tcp://0.0.0.0:8529
    

Package Installation

We provide a command-line app called ArangoDB-CLI. Visit the official Download page of the ArangoDB website and download the DMG Package for macOS.

You can install the application in your application folder.

Starting the application will start the server and open a terminal window showing you the log-file.

ArangoDB server has been started

The database directory is located at
   '/Users/<user>/Library/ArangoDB/var/lib/arangodb3'

The log file is located at
   '/Users/<user>/Library/ArangoDB/var/log/arangodb3/arangod.log'

You can access the server using a browser at 'http://127.0.0.1:8529/'
or start the ArangoDB shell
   '/Applications/ArangoDB3-CLI.app/Contents/Resources/arangosh'

Switching to log-file now, killing this windows will NOT stop the server.


2018-03-16T09:37:01Z [13373] INFO ArangoDB (version 3.3.4 [darwin]) is ready for business. Have fun!

Note that it is possible to install both, the homebrew version and the command-line app. You should, however, edit the configuration files of one version and change the port used.

Installing using the archive

Starting from v3.4.0 a tar.gz package is also available for macOS.

Visit the official Download page of the ArangoDB website and download the tar.gz archive for macOS.

To install, just extract the archive.