1
0
Fork 0

Doc - Improve MacOS Installation page (#7744)

This commit is contained in:
maxkernbach 2018-12-24 17:18:34 +01:00 committed by sleto-it
parent 2ad638cb45
commit 76f98429e6
2 changed files with 55 additions and 31 deletions

View File

@ -1,30 +1,41 @@
Installing ArangoDB on MacOS Installing ArangoDB on MacOS
============================ ============================
The preferred method for installing ArangoDB under MacOS is ArangoDB under MacOS can be installed via:
[_homebrew_](#homebrew). However, in case you are not using _homebrew_, we
provide a [command-line app](#command-line-app) or [graphical
app](#graphical-app) which contains all the executables.
{% hint 'info' %} Starting from version 3.4.0 in addition to 1. [Homebrew](#homebrew)
_homebrew_ and the _dmg_ package a _tar.gz_ archive is available. 2. [_DMG_ Package](#package-installation)
{% endhint %} 3. [_tar.gz_ Archive](#installing-using-the-archive) (starting from v3.4.0)
Homebrew Homebrew
-------- --------
{% hint 'info' %}
When installing ArangoDB via the MacOS package manager Homebrew,
only the Community Edition is available.
{% endhint %}
{% hint 'warning' %}
The Homebrew installation is updated a few days after the
official release of a new version.
{% endhint %}
If you are using [_homebrew_](http://brew.sh/), If you are using [_homebrew_](http://brew.sh/),
then you can install the latest released stable version of ArangoDB using *brew* as follows: then you can install the latest released stable version of ArangoDB using *brew* as follows:
brew install arangodb ```
brew install arangodb
```
This will install the current stable version of ArangoDB and all This will install the current stable version of ArangoDB and all
dependencies within your Homebrew tree. Note that the server will be dependencies within your Homebrew tree. Note that the server will be
installed as: installed as:
/usr/local/sbin/arangod ```
/usr/local/Cellar/arangodb/3.4.0/sbin/arangod
```
You can start the server by running the command `/usr/local/sbin/arangod &`. You can start the server by running the command `/usr/local/Cellar/arangodb/3.4.0/sbin/arangod &`.
Configuration file is located at Configuration file is located at
@ -32,28 +43,37 @@ Configuration file is located at
The ArangoDB shell will be installed as: The ArangoDB shell will be installed as:
/usr/local/bin/arangosh ```
/usr/local/Cellar/arangodb/3.4.0/bin/arangosh
```
You can uninstall ArangoDB using: You can uninstall ArangoDB using:
brew uninstall arangodb ```
brew uninstall arangodb
```
However, in case you started ArangoDB using the _launchctl_, you However, in case you started ArangoDB using the _launchctl_, you
need to unload it before uninstalling the server: need to unload it before uninstalling the server:
launchctl unload ~/Library/LaunchAgents/homebrew.mxcl.arangodb.plist ```
launchctl unload ~/Library/LaunchAgents/homebrew.mxcl.arangodb.plist
```
Then remove the LaunchAgent: Then remove the LaunchAgent:
rm ~/Library/LaunchAgents/homebrew.mxcl.arangodb.plist ```
rm ~/Library/LaunchAgents/homebrew.mxcl.arangodb.plist
```
**Note**: If the latest ArangoDB Version is not shown in homebrew, you {% hint 'tip' %}
also need to update homebrew: If the latest ArangoDB version is not shown in Homebrew, you
also need to update Homebrew executing the command `brew update`.
brew update {% endhint %}
### Known issues ### Known issues
- The ArangoDB Starter is not included in v3.4.0. This issue will be fixed in a later 3.4.x version.
- The Commandline argument parsing does not accept blanks in filenames; the CLI version below does. - 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 - 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.: file and uncomment line with endpoint needed, e.g.:
@ -61,20 +81,20 @@ also need to update homebrew:
[server] [server]
endpoint = tcp://0.0.0.0:8529 endpoint = tcp://0.0.0.0:8529
Graphical App Package Installation
------------- --------------------
In case you are not using _homebrew_, we also provide a graphical app. You can
download it from [here](https://www.arangodb.com/download).
Choose *Mac OS X*. Download and install the application *ArangoDB* in Visit the official [Download](https://www.arangodb.com/download) page of the
ArangoDB website and download the *DMG* Package for MacOS.
### Graphical App
We provide a graphical app. You can install the application *ArangoDB* in
your application folder. your application folder.
Command line App ### Command line App
----------------
In case you are not using _homebrew_, we also provide a command-line app. You can
download it from [here](https://www.arangodb.com/download).
Choose *Mac OS X*. Download and install the application *ArangoDB-CLI* We provide a command-line app. You can install the application *ArangoDB-CLI*
in your application folder. in your application folder.
Starting the application will start the server and open a terminal window Starting the application will start the server and open a terminal window
@ -104,5 +124,9 @@ the port used.
Installing using the archive Installing using the archive
---------------------------- ----------------------------
Starting from 3.4.0 a _tar.gz_ package is also available for MacOS. To install ArangoDB Starting from v3.4.0 a _tar.gz_ package is also available for MacOS.
using the `tar.gz` archive, just extract it.
Visit the official [Download](https://www.arangodb.com/download) page of the ArangoDB
website and download the _tar.gz_ archive for MacOS.
To install, just extract the archive.

View File

@ -20,7 +20,7 @@ tracking most of the community contributions (including new or updated images) i
our newsletter: https://www.arangodb.com/category/newsletter/ our newsletter: https://www.arangodb.com/category/newsletter/
- [Linux](Linux.md) - [Linux](Linux.md)
- [Mac OS X](MacOSX.md) - [MacOS](MacOSX.md)
- [Windows](Windows.md) - [Windows](Windows.md)
If you prefer to compile ArangoDB from source, please refer to the [Compiling](Compiling.md) If you prefer to compile ArangoDB from source, please refer to the [Compiling](Compiling.md)