diff --git a/Documentation/Books/Manual/GettingStarted/Installing/Linux.mdpp b/Documentation/Books/Manual/GettingStarted/Installing/Linux.mdpp index dd5eaca23a..816f392442 100644 --- a/Documentation/Books/Manual/GettingStarted/Installing/Linux.mdpp +++ b/Documentation/Books/Manual/GettingStarted/Installing/Linux.mdpp @@ -1,11 +1,35 @@ !CHAPTER Linux -You can find binary packages for the most common Linux distributions -[here](http://www.arangodb.com/install/). +- Visit the official [ArangoDB install page](https://www.arangodb.com/install) + and download the correct package for your Linux distribution. You can find + binary packages for the most common distributions there. +- Follow the instructions to use your favorite package manager for the + major distributions. After setting up the ArangoDB repository you can + easily install ArangoDB using yum, aptitude, urpmi or zypper. +- Alternatively, see [Compiling](Compiling.md) if you want to build ArangoDB + yourself. +- Start up the database server, normally this is done by + executing `etc/init.d/arangod start`. The exact command + depends on your Linux distribution + +After these steps there should be a running instance of *_arangod_* - +the ArangoDB database server. + + unix> ps auxw | fgrep arangod + arangodb 14536 0.1 0.6 5307264 23464 s002 S 1:21pm 0:00.18 /usr/local/sbin/arangod + +If there is no such process, check the log file +*/var/log/arangodb/arangod.log* for errors. If you see a log message like + + 2012-12-03T11:35:29Z [12882] ERROR Database directory version (1) is lower than server version (1.2). + 2012-12-03T11:35:29Z [12882] ERROR It seems like you have upgraded the ArangoDB binary. If this is what you wanted to do, please restart with the --database.upgrade option to upgrade the data in the database directory. + 2012-12-03T11:35:29Z [12882] FATAL Database version check failed. Please start the server with the --database.upgrade option + +make sure to start the server once with the *--database.upgrade* option. + +Note that you may have to enable logging first. If you start the server +in a shell, you should see errors logged there as well. -Follow the instructions to use your favorite package manager for the -major distributions. After setting up the ArangoDB repository you can -easily install ArangoDB using yum, aptitude, urpmi or zypper. !SUBSECTION Linux Mint diff --git a/Documentation/Books/Manual/GettingStarted/Installing/MacOSX.mdpp b/Documentation/Books/Manual/GettingStarted/Installing/MacOSX.mdpp index 02abdf2cf7..f281f4b876 100644 --- a/Documentation/Books/Manual/GettingStarted/Installing/MacOSX.mdpp +++ b/Documentation/Books/Manual/GettingStarted/Installing/MacOSX.mdpp @@ -18,6 +18,8 @@ installed as: /usr/local/sbin/arangod +You can start the server by running the command `/usr/local/sbin/arangod &`. + The ArangoDB shell will be installed as: /usr/local/bin/arangosh @@ -41,6 +43,7 @@ also need to update homebrew: brew update !SUBSECTION Known issues + - Performance - the LLVM delivered as of Mac OS X El Capitan builds slow binaries. Use GCC instead, until this issue has been fixed by Apple. - the Commandline argument parsing doesn't accept blanks in filenames; the CLI version below does. diff --git a/Documentation/Books/Manual/GettingStarted/Installing/README.mdpp b/Documentation/Books/Manual/GettingStarted/Installing/README.mdpp index ed539681e9..11fc0a7c66 100644 --- a/Documentation/Books/Manual/GettingStarted/Installing/README.mdpp +++ b/Documentation/Books/Manual/GettingStarted/Installing/README.mdpp @@ -2,8 +2,10 @@ This chapter describes how to install ArangoDB under various operation systems. -First of all download and install the corresponding RPM or Debian package or use homebrew on MacOS X. -You can find packages for various operation systems at our [install](https://www.arangodb.com/download) section. +First of all, download and install the corresponding RPM or Debian package or use +homebrew on MacOS X. You can find packages for various operation systems at our +[install](https://www.arangodb.com/download) section, including an installer +for Windows. In this chapter you will also learn how to compile ArangoDB from scratch. diff --git a/Documentation/Books/Manual/GettingStarted/Installing/Windows.mdpp b/Documentation/Books/Manual/GettingStarted/Installing/Windows.mdpp index b93064cb97..ad05e88983 100644 --- a/Documentation/Books/Manual/GettingStarted/Installing/Windows.mdpp +++ b/Documentation/Books/Manual/GettingStarted/Installing/Windows.mdpp @@ -1,6 +1,6 @@ !CHAPTER Windows -The default installation directory is *C:\Program Files\ArangoDB-3.x.y*. During the +The default installation directory is *C:\Program Files\ArangoDB-3.x.x*. During the installation process you may change this. In the following description we will assume that ArangoDB has been installed in the location *<ROOTDIR>*. @@ -16,28 +16,28 @@ Installing for multiple users: Keep the default directory. After the installation edit the file *<ROOTDIR>\etc\ArangoDB\arangod.conf*. Adjust the *directory* and *app-path* so that these paths point into your home directory. - [database] - directory = @HOMEDRIVE@\@HOMEPATH@\arangodb\databases + [database] + directory = @HOMEDRIVE@\@HOMEPATH@\arangodb\databases - [javascript] - app-path = @HOMEDRIVE@\@HOMEPATH@\arangodb\apps + [javascript] + app-path = @HOMEDRIVE@\@HOMEPATH@\arangodb\apps - Create the directories for each user that wants to use ArangoDB. +Create the directories for each user that wants to use ArangoDB. Installing as Service: Keep the default directory. After the installation open a command line as administrator (search for *cmd* and right click *run as administrator*). - cmd> arangod --install-service - INFO: adding service 'ArangoDB - the multi-model database' (internal 'ArangoDB') - INFO: added service with command line '"C:\Program Files (x86)\ArangoDB 1.4.4\bin\arangod.exe" --start-service' + cmd> arangod --install-service + INFO: adding service 'ArangoDB - the multi-model database' (internal 'ArangoDB') + INFO: added service with command line '"C:\Program Files (x86)\ArangoDB 3.x.x\bin\arangod.exe" --start-service' - Open the service manager and start ArangoDB. In order to enable logging - edit the file "\etc\arangodb\arangod.conf" and uncomment the file - option. +Open the service manager and start ArangoDB. In order to enable logging +edit the file "\etc\arangodb\arangod.conf" and uncomment the file +option. - [log] - file = @ROOTDIR@\var\log\arangodb\arangod.log + [log] + file = @ROOTDIR@\var\log\arangodb\arangod.log !SUBSECTION Client, Server and Lock-Files diff --git a/Documentation/Books/stash/GettingFamiliar.mdpp b/Documentation/Books/stash/GettingFamiliar.mdpp deleted file mode 100644 index ebdce12d9c..0000000000 --- a/Documentation/Books/stash/GettingFamiliar.mdpp +++ /dev/null @@ -1,40 +0,0 @@ -!CHAPTER Getting familiar with ArangoDB - -First of all download and install the corresponding RPM or Debian package or use -homebrew on the MacOS X. See the [installation manual](Installing/README.md) for more details. - -!SUBSECTION For Linux - -* Visit the official [ArangoDB install page](https://www.arangodb.com/install) - and download the correct package for your Linux distribution -* Install the package using your favorite package manager -* Start up the database server, normally this is done by - executing */etc/init.d/arangod start*. The exact command - depends on your Linux distribution - -!SUBSECTION For MacOS X - -* Execute *brew install arangodb* -* And start the server using */usr/local/sbin/arangod &* - -!SUBSECTION For Microsoft Windows - -* Visit the official [ArangoDB install page](https://www.arangodb.com/install) - and download the installer for Windows -* Start up the database server - -After these steps there should be a running instance of *_arangod_* - -the ArangoDB database server. - - unix> ps auxw | fgrep arangod - arangodb 14536 0.1 0.6 5307264 23464 s002 S 1:21pm 0:00.18 /usr/local/sbin/arangod - -If there is no such process, check the log file -*/var/log/arangodb/arangod.log* for errors. If you see a log message -like - - 2012-12-03T11:35:29Z [12882] ERROR Database directory version (1) is lower than server version (1.2). - 2012-12-03T11:35:29Z [12882] ERROR It seems like you have upgraded the ArangoDB binary. If this is what you wanted to do, please restart with the --database.upgrade option to upgrade the data in the database directory. - 2012-12-03T11:35:29Z [12882] FATAL Database version check failed. Please start the server with the --database.upgrade option - -make sure to start the server once with the *--database.upgrade* option.