From c2121d226c9b589e08f7ca05e3ccbc3f587ac2b5 Mon Sep 17 00:00:00 2001 From: Jan Steemann Date: Wed, 16 Oct 2013 16:15:52 +0200 Subject: [PATCH] updated manual --- Documentation/InstallationManual/Compiling.md | 17 +++++++++++++++-- Documentation/Manual/Upgrading14.md | 7 ++++++- 2 files changed, 21 insertions(+), 3 deletions(-) diff --git a/Documentation/InstallationManual/Compiling.md b/Documentation/InstallationManual/Compiling.md index b14646d058..d981c5b642 100644 --- a/Documentation/InstallationManual/Compiling.md +++ b/Documentation/InstallationManual/Compiling.md @@ -157,10 +157,14 @@ The database will be installed in /var/lib/arangodb -The arango shell will be installed in +The ArangoShell will be installed in /usr/local/bin/arangosh +When upgrading from a previous version of ArangoDB, please make sure you inspect ArangoDB's +log file after an upgrade. It may also be necessary to start ArangoDB with the `--upgrade` +parameter once to perform required upgrade or initialisation tasks. + Devel Version{#CompilingDevel} ============================== @@ -227,7 +231,7 @@ Configure{#CompilingDevelConfigure} In order to configure the build environment please execute - unix> ./configure --disable-all-in-one-v8 --disable-all-in-one-libev --disable-all-in-one-icu + unix> ./configure --enable-all-in-one-v8 --enable-all-in-one-libev --enable-all-in-one-icu to setup the makefiles. This will check for the various system characteristics and installed libraries. @@ -251,6 +255,15 @@ correct versions on your system. The following configuration options exist: +`--enable-relative` will make relative paths be used in the compiled binaries and +scripts. It allows to run ArangoDB from the compile directory directly, without the +need for a `make install` command and specifying much configuration parameters. +When used, you can start ArangoDB using this command: + + bin/arangod /tmp/database-dir + +ArangoDB will then automatically use the configuration from file `etc/relative/arangod.conf`. + `--enable-all-in-one-libev` tells the build system to use the bundled version of LIBEV instead of using the system version. diff --git a/Documentation/Manual/Upgrading14.md b/Documentation/Manual/Upgrading14.md index 9a3b859fa6..1f414b6c28 100644 --- a/Documentation/Manual/Upgrading14.md +++ b/Documentation/Manual/Upgrading14.md @@ -162,7 +162,12 @@ like this: 2013-10-09T19:11:47Z [7121] FATAL no value has been specified for --javascript.app-path. To fix this, you can either specify the value for `--javascript.app-path` on the command-line -or in a configuration file. +or in a configuration file. You then need to start the server with the app path specified and +the `--upgrade` option. This will make ArangoDB create the directory automatically. + +If you want to use the development mode for Foxx applications, it is necessary to also specify +the parameter `--javascript.dev-app-path` when starting with `--upgrade`. This will initialise +the directories for development mode apps, too. Problem: Server does not start ------------------------------