From 18e5f884eb60da55abb708f1e30c74fb04cad98b Mon Sep 17 00:00:00 2001 From: Frank Celler Date: Thu, 6 Dec 2012 16:58:13 +0100 Subject: [PATCH] added troubleshooting, fixed css, fixed OBS --- .../InstallationManual/InstallationManual.md | 12 + .../InstallationManual/Installing.md | 95 +++ .../InstallationManual/InstallingTOC.md | 10 + Documentation/Makefile.files | 7 +- Documentation/Manual/Upgrading.md | 57 +- Documentation/Manual/UpgradingTOC.md | 1 + Documentation/UserManual/UserManual.md | 1 - Documentation/arango.template.in | 7 +- Documentation/arangodb.css | 57 +- Installation/OBS/clean-repo.sh | 1 + Installation/OBS/index.html | 568 ++++++++---------- Makefile.in | 7 +- arangod/Documentation/install-manual.dox | 213 ------- 13 files changed, 464 insertions(+), 572 deletions(-) create mode 100644 Documentation/InstallationManual/InstallationManual.md create mode 100644 Documentation/InstallationManual/Installing.md create mode 100644 Documentation/InstallationManual/InstallingTOC.md diff --git a/Documentation/InstallationManual/InstallationManual.md b/Documentation/InstallationManual/InstallationManual.md new file mode 100644 index 0000000000..be3de15ece --- /dev/null +++ b/Documentation/InstallationManual/InstallationManual.md @@ -0,0 +1,12 @@ +ArangoDB's Installation Manual (@VERSION) {#InstallManual} +========================================================== + +@NAVIGATE_InstallManual + +@if LATEX +- @ref Installing +- @ref Compiling +@else +@CHAPTER_REF{Installing} +@CHAPTER_REF{Compiling} +@endif diff --git a/Documentation/InstallationManual/Installing.md b/Documentation/InstallationManual/Installing.md new file mode 100644 index 0000000000..09593ef2f3 --- /dev/null +++ b/Documentation/InstallationManual/Installing.md @@ -0,0 +1,95 @@ +Installing ArangoDB {#Installing} +================================= + +@NAVIGATE_Installing +@EMBEDTOC{InstallingTOC} + +Linux {#InstallingLinux} +======================== + +You can find binary packages for various Linux distributions here: + + @EXTREF{http://www.arangodb.org/download/,http://www.arangodb.org/download/} + +We provide packages for + +- Centos +- Debian +- Fedora +- Mandriva +- OpenSUSE +- RedHat RHEL +- SUSE SLE +- Ubuntu + +Using a Package Manager to install ArangoDB {#InstallingLinuxPackageManager} +---------------------------------------------------------------------------- + +Follow the instructions on the download page to use your favorite package manager +for the major distributions. After setting up the ArangoDB repository you can then +easily install ArangoDB using yum, aptitude, urpmi, or zypper. + +### Linux-Mint {#InstallingDebian} + +Download and import GPG-PublicKey + + wget -O RPM-GPG-KEY-www.arangodb.org http://www.arangodb.org/repositories/PublicKey + apt-key add RPM-GPG-KEY-www.arangodb.org + +Add the corresponding repository in file `/etc/apt/sources.list`: + + deb http://www.arangodb.org/repositories LinuxMint-13 main + +Update the repository data: + + aptitude update + +Now you should be able to search for arangodb: + + aptitude search arangodb + +In order to install arangodb: + + aptitude install arangodb + +### Gentoo + +Please use the +@EXTREF_S{https://github.com/mgiken/portage-overlay/tree/master/dev-db/ArangoDB,portage} +provided by @@mgiken. + +Mac OS X {#InstallingMacOSX} +============================ + +You can find the Mac OS X packages here: + + http://www.arangodb.org/repositories/MacOSX + +Homebrew {#InstallingMacOSXHomebrew} +------------------------------------ + +If you are using @EXTREF{http://mxcl.github.com/homebrew/,homebrew}, +then you can install the 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/sbin/arangod + +The ArangoDB shell will be install as + + /usr/local/bin/arangosh + +If you want to install the latest version use: + + brew install --HEAD arangodb + +Apples App Store {#InstallingMacOSXAppStore} +-------------------------------------------- + +ArangoDB is available in Apple's App-Store. Please note, that it +sometimes take a few days or weeks until the latest versions will be +available. diff --git a/Documentation/InstallationManual/InstallingTOC.md b/Documentation/InstallationManual/InstallingTOC.md new file mode 100644 index 0000000000..8787e15c07 --- /dev/null +++ b/Documentation/InstallationManual/InstallingTOC.md @@ -0,0 +1,10 @@ +TOC {#InstallingTOC} +==================== + +- @ref Installing + - @ref InstallingLinux + - @ref InstallingLinuxPackageManager + - @ref InstallingDebian + - @ref InstallingMacOSX + - @ref InstallingMacOSXHomebrew + - @ref InstallingMacOSXAppStore diff --git a/Documentation/Makefile.files b/Documentation/Makefile.files index 596b4fa1bc..702e5828b2 100644 --- a/Documentation/Makefile.files +++ b/Documentation/Makefile.files @@ -9,6 +9,7 @@ ################################################################################ DOXYGEN_TOC = \ + Documentation/InstallationManual/InstallationManual.md \ Documentation/Manual/Home.md \ Documentation/UserManual/UserManual.md @@ -156,13 +157,11 @@ Doxygen/xml/%.md: Doxygen/xml/%.xml .PHONY: doxygen-toc doxygen-toc: - rm -f Doxygen/toc.doxy - $(MAKE) Doxygen/toc.doxy - -Doxygen/toc.doxy: python @top_srcdir@/Documentation/Scripts/generateTOC.py $(DOXYGEN_TOC) >> Doxygen/toc.doxy.tmp cmp -s Doxygen/toc.doxy Doxygen/toc.doxy.tmp || mv Doxygen/toc.doxy.tmp Doxygen/toc.doxy +Doxygen/toc.doxy: doxygen-toc + ################################################################################ ### @brief doxygen ################################################################################ diff --git a/Documentation/Manual/Upgrading.md b/Documentation/Manual/Upgrading.md index 95abff9a29..486237f350 100644 --- a/Documentation/Manual/Upgrading.md +++ b/Documentation/Manual/Upgrading.md @@ -18,7 +18,8 @@ downwards-compatible to ArangoDB 1.0. Existing users of ArangoDB 1.0 should read the list carefully and make sure they have undertaken all necessary steps and precautions before -upgrading from ArangoDB 1.0 to ArangoDB 1.1. +upgrading from ArangoDB 1.0 to ArangoDB 1.1. Also check +@ref UpgradingTroubleshooting. New Dependencies {#UpgradingNewDependencies} -------------------------------------------- @@ -263,6 +264,60 @@ messages will be sent to the syslog only if the server is started with the `--log.syslog` option and a non-empty string (the log facility) is given to it. This is in accordance with the 1.0 documentation. +Troubleshooting {#UpgradingTroubleshooting} +=========================================== + +If you cannot find a solution here, please ask the Google-Group at +http://groups.google.com/group/arangodb + +Problem: ArangoDB does not start after upgrade +---------------------------------------------- + +- Check the logfile `/var/log/arangodb/arangod.log` + +- Check the permissions of these directories: + + - `/var/lib/arangodb/` + - `/var/run/arangodb/` + - `/var/log/arangodb/` + + These directories and all files have to be readable and writable for the user + "arangodb" and group "arangodb" (not for MacOSX). Double check that the user + is "arangodb" not "arango". + + Change the permissions using: + + unix> chown -R arangodb:arangodb /var/lib/arangodb/ /var/run/arangodb/ /var/log/arangodb/ + +- Check the configuration file in: + + /etc/arangodb/arangod.conf + +Problem: Packet manager finds no upgrade +---------------------------------------- + +- Check the name of the repository here: + + http://www.arangodb.org/download + +Problem: Database is empty +-------------------------- + +Check that the database file + + /var/lib/arangodb + +contains your collections. If it is empty, check the old location +of the database at + + /var/arangodb + +If necessary, stop the server, copy the files using + + cp /var/arangodb/* /var/lib/arangodb + +and start the server agaib. + Removed Features {#UpgradingRemovedFeatures} ============================================ diff --git a/Documentation/Manual/UpgradingTOC.md b/Documentation/Manual/UpgradingTOC.md index 01f449533f..1088d04360 100644 --- a/Documentation/Manual/UpgradingTOC.md +++ b/Documentation/Manual/UpgradingTOC.md @@ -9,5 +9,6 @@ TOC {#UpgradingTOC} - @ref UpgradingCollectionTypes - @ref UpgradingShellImport - @ref UpgradingSyslog +- @ref UpgradingTroubleshooting - @ref UpgradingRemovedFeatures - @ref UpgradingRemovedDependencies diff --git a/Documentation/UserManual/UserManual.md b/Documentation/UserManual/UserManual.md index f7ac35b31e..6b9ea3d39e 100644 --- a/Documentation/UserManual/UserManual.md +++ b/Documentation/UserManual/UserManual.md @@ -28,4 +28,3 @@ ArangoDB's User Manual (@VERSION) {#UserManual} @CHAPTER_REF{UserManualActions} @CHAPTER_REF{CommandLine} @endif - diff --git a/Documentation/arango.template.in b/Documentation/arango.template.in index 79c1b49ee7..21b4c13f70 100644 --- a/Documentation/arango.template.in +++ b/Documentation/arango.template.in @@ -720,10 +720,11 @@ WARN_LOGFILE = # directories like "/usr/src/myproject". Separate the files or directories # with spaces. -INPUT = @srcdir@/Documentation/UserManual \ - @srcdir@/Documentation/DbaManual \ +INPUT = @srcdir@/Documentation/DbaManual \ + @srcdir@/Documentation/InstallationManual \ @srcdir@/Documentation/Manual \ - @srcdir@/Doxygen/js \ + @srcdir@/Documentation/UserManual \ + @srcdir@/Doxygen/js \ @srcdir@/arangod \ @srcdir@/lib diff --git a/Documentation/arangodb.css b/Documentation/arangodb.css index 3e5b5e1157..2d5f54c8aa 100644 --- a/Documentation/arangodb.css +++ b/Documentation/arangodb.css @@ -89,23 +89,6 @@ margin-bottom: 0px; } -/* ************************************************************************** */ -/* pre */ -/* ************************************************************************** */ - -#content div.arangodb pre { - background-color: #FBFCFD !important; - border: 1px solid #C4CFE5 !important; - font-family: monospace,fixed; - font-size: 105%; - font-size: 15px; - line-height: 21px; - margin: 4px 8px 24px 2px; - overflow: auto; - padding: 4px 6px; - word-wrap: break-word; -} - /* ************************************************************************** */ /* function signature */ /* ************************************************************************** */ @@ -154,9 +137,35 @@ } /* ************************************************************************** */ -/* code */ +/* pre & code */ /* ************************************************************************** */ +#content div.arangodb pre { + background-color: #FBFCFD !important; + border: 1px solid #C4CFE5 !important; + font-family: monospace,fixed; + font-size: 105%; + font-size: 15px; + line-height: 21px; + margin: 4px 8px 24px 2px; + overflow: auto; + padding: 4px 6px; + word-wrap: break-word; +} + +#content div.arangodb div.fragment { + background-color: #FBFCFD !important; + border: 1px solid #C4CFE5 !important; + font-family: monospace,fixed; + font-size: 105%; + font-size: 15px; + line-height: 21px; + margin: 4px 8px 24px 2px; + overflow: auto; + padding: 4px 6px; + word-wrap: break-word; +} + #content div.arangodb code { background-color: #FFFFFF !important; border: 0px !important; @@ -168,18 +177,6 @@ font-family: monospace,fixed; } -#content div.arangodb div.fragment { - background-color: #FFFFFF !important; - border: 1px solid #C4CFE5 !important; - margin: 0px 0px 0px 0px; - padding: 8px 8px; - overflow: auto; - line-height: 11px; - font-size: 15px; - font-family: monospace,fixed; - white-space: pre; -} - /* ************************************************************************** */ /* other */ /* ************************************************************************** */ diff --git a/Installation/OBS/clean-repo.sh b/Installation/OBS/clean-repo.sh index da0002613c..1b9f50d1ec 100755 --- a/Installation/OBS/clean-repo.sh +++ b/Installation/OBS/clean-repo.sh @@ -7,6 +7,7 @@ test -d stable || mkdir stable || exit 1 mv download/repositories/home:/fceller/* stable || exit 1 rm -rf 'download' +rm -rf 'stable/xUbuntu_10.04' rm -rf 'stable/CentOS_CentOS-5' rm -rf 'stable/RedHat_RHEL-5' rm -rf 'stable/SLE_10_SDK' diff --git a/Installation/OBS/index.html b/Installation/OBS/index.html index 9aadfdd23d..cd41a71879 100644 --- a/Installation/OBS/index.html +++ b/Installation/OBS/index.html @@ -3,8 +3,6 @@ - - - @@ -65,8 +62,6 @@ - -

Select Your Operating System

@@ -172,355 +165,298 @@
+ -
-

Add repository and install manually

-
-
-

For xUbuntu 12.04 run the following as root:

- 
echo 'deb http://www.arangodb.org/repositories/stable/repositories/xUbuntu_12.04/ /' >> /etc/apt/sources.list.d/arangodb.list 
+    

+      
Add repository and install manually

+      

+	  

+	    
For Ubuntu 12.04 run the following as root:

+	    
echo 'deb http://www.arangodb.org/repositories/stable/xUbuntu_12.04/ /' >> /etc/apt/sources.list.d/arangodb.list 
 apt-get update
 apt-get install arangodb

-
-        
You can add the repository key to apt like this: 

-       
wget http://www.arangodb.org/repositories/stable/repositories/xUbuntu_12.04/Release.key
+	    
You can add the repository key to apt like this: 

+	   
wget http://www.arangodb.org/repositories/stable/xUbuntu_12.04/Release.key
 apt-key add - < Release.key  

-
-      

-      

-        
For xUbuntu 11.10 run the following as root:

-        
echo 'deb http://www.arangodb.org/repositories/stable/repositories/xUbuntu_11.10/ /' >> /etc/apt/sources.list.d/arangodb.list 
+	  

+	  

+	    
For Ubuntu 11.10 run the following as root:

+	    
echo 'deb http://www.arangodb.org/repositories/stable/xUbuntu_11.10/ /' >> /etc/apt/sources.list.d/arangodb.list 
 apt-get update
 apt-get install arangodb

-
-        
You can add the repository key to apt like this: 

-       
wget http://www.arangodb.org/repositories/stable/repositories/xUbuntu_11.10/Release.key
+	    
You can add the repository key to apt like this: 

+	   
wget http://www.arangodb.org/repositories/stable/xUbuntu_11.10/Release.key
 apt-key add - < Release.key  

-
-      

-      

-        
For xUbuntu 11.04 run the following as root:

-        
echo 'deb http://www.arangodb.org/repositories/stable/repositories/xUbuntu_11.04/ /' >> /etc/apt/sources.list.d/arangodb.list 
+	  

+	  

+	    
For Ubuntu 11.04 run the following as root:

+	    
echo 'deb http://www.arangodb.org/repositories/stable/xUbuntu_11.04/ /' >> /etc/apt/sources.list.d/arangodb.list 
 apt-get update
 apt-get install arangodb

-
-        
You can add the repository key to apt like this: 

-       
wget http://www.arangodb.org/repositories/stable/repositories/xUbuntu_11.04/Release.key
+	    
You can add the repository key to apt like this: 

+	   
wget http://www.arangodb.org/repositories/stable/xUbuntu_11.04/Release.key
 apt-key add - < Release.key  

-
-      

-      

-        
For xUbuntu 10.04 run the following as root:

-        
echo 'deb http://www.arangodb.org/repositories/stable/repositories/xUbuntu_10.04/ /' >> /etc/apt/sources.list.d/arangodb.list 
-apt-get update
-apt-get install arangodb

-
-        
You can add the repository key to apt like this: 

-       
wget http://www.arangodb.org/repositories/stable/repositories/xUbuntu_10.04/Release.key
-apt-key add - < Release.key  

-
-      

-      

-        
For openSUSE Tumbleweed run the following as root:

-        
zypper addrepo http://www.arangodb.org/repositories/stable/repositories/openSUSE_Tumbleweed/arangodb.repo
+	  

+	  

+	    
For openSUSE Tumbleweed run the following as root:

+	    
zypper addrepo http://www.arangodb.org/repositories/stable/openSUSE_Tumbleweed/arangodb.repo
 zypper refresh
 zypper install arangodb

-
-
-      

-      

-        
For openSUSE Factory run the following as root:

-        
zypper addrepo http://www.arangodb.org/repositories/stable/repositories/openSUSE_Factory/arangodb.repo
+	  

+	  

+	    
For openSUSE Factory run the following as root:

+	    
zypper addrepo http://www.arangodb.org/repositories/stable/openSUSE_Factory/arangodb.repo
 zypper refresh
 zypper install arangodb

-
-
-      

-      

-        
For openSUSE 12.2 run the following as root:

-        
zypper addrepo http://www.arangodb.org/repositories/stable/repositories/openSUSE_12.2/arangodb.repo
+	  

+	  

+	    
For openSUSE 12.2 run the following as root:

+	    
zypper addrepo http://www.arangodb.org/repositories/stable/openSUSE_12.2/arangodb.repo
 zypper refresh
 zypper install arangodb

-
-
-      

-      

-        
For openSUSE 12.1 run the following as root:

-        
zypper addrepo http://www.arangodb.org/repositories/stable/repositories/openSUSE_12.1/arangodb.repo
+	  

+	  

+	    
For openSUSE 12.1 run the following as root:

+	    
zypper addrepo http://www.arangodb.org/repositories/stable/openSUSE_12.1/arangodb.repo
 zypper refresh
 zypper install arangodb

-
-
-      

-      

-        
For openSUSE 11.4 run the following as root:

-        
zypper addrepo http://www.arangodb.org/repositories/stable/repositories/openSUSE_11.4/arangodb.repo
+	  

+	  

+	    
For openSUSE 11.4 run the following as root:

+	    
zypper addrepo http://www.arangodb.org/repositories/stable/openSUSE_11.4/arangodb.repo
 zypper refresh
 zypper install arangodb

-
-
-      

-      

-        
For SLE 11 SP2 run the following as root:

-        
zypper addrepo http://www.arangodb.org/repositories/stable/repositories/SLE_11_SP2/arangodb.repo
+	  

+	  

+	    
For SLE 11 SP2 run the following as root:

+	    
zypper addrepo http://www.arangodb.org/repositories/stable/SLE_11_SP2/arangodb.repo
 zypper refresh
 zypper install arangodb

-
-
-      

-      

-        
For SLE 11 SP1 run the following as root:

-        
zypper addrepo http://www.arangodb.org/repositories/stable/repositories/SLE_11_SP1/arangodb.repo
+	  

+	  

+	    
For SLE 11 SP1 run the following as root:

+	    
zypper addrepo http://www.arangodb.org/repositories/stable/SLE_11_SP1/arangodb.repo
 zypper refresh
 zypper install arangodb

-
-
-      

-      

-        
For SLE 11 run the following as root:

-        
zypper addrepo http://www.arangodb.org/repositories/stable/repositories/SLE_11/arangodb.repo
+	  

+	  

+	    
For SLE 11 run the following as root:

+	    
zypper addrepo http://www.arangodb.org/repositories/stable/SLE_11/arangodb.repo
 zypper refresh
 zypper install arangodb

-
-
-      

-      

-        
For RedHat RHEL-6 run the following as root:

-        
cd /etc/yum.repos.d/
-wget http://www.arangodb.org/repositories/stable/repositories/RedHat_RHEL-6/arangodb.repo
+	  

+	  

+	    
For RedHat RHEL-6 run the following as root:

+	    
cd /etc/yum.repos.d/
+wget http://www.arangodb.org/repositories/stable/RedHat_RHEL-6/arangodb.repo
 yum install arangodb

-
-
-      

-      

-        
For Mandriva 2011 run the following as root:

-        
urpmi.addmedia arangodb http://www.arangodb.org/repositories/stable/repositories/Mandriva_2011/
+	  

+	  

+	    
For Mandriva 2011 run the following as root:

+	    
urpmi.addmedia arangodb http://www.arangodb.org/repositories/stable/Mandriva_2011/
 urpmi.update -a
 urpmi arangodb

-
-
-      

-      

-        
For Fedora 17 run the following as root:

-        
cd /etc/yum.repos.d/
-wget http://www.arangodb.org/repositories/stable/repositories/Fedora_17/arangodb.repo
+	  

+	  

+	    
For Fedora 17 run the following as root:

+	    
cd /etc/yum.repos.d/
+wget http://www.arangodb.org/repositories/stable/Fedora_17/arangodb.repo
 yum install arangodb

-
-
-      

-      

-        
For Fedora 16 run the following as root:

-        
cd /etc/yum.repos.d/
-wget http://www.arangodb.org/repositories/stable/repositories/Fedora_16/arangodb.repo
+	  

+	  

+	    
For Fedora 16 run the following as root:

+	    
cd /etc/yum.repos.d/
+wget http://www.arangodb.org/repositories/stable/Fedora_16/arangodb.repo
 yum install arangodb

-
-
-      

-      

-        
For Debian 6.0 run the following as root:

-        
echo 'deb http://www.arangodb.org/repositories/stable/repositories/Debian_6.0/ /' >> /etc/apt/sources.list.d/arangodb.list 
+	  

+	  

+	    
For Debian 6.0 run the following as root:

+	    
echo 'deb http://www.arangodb.org/repositories/stable/Debian_6.0/ /' >> /etc/apt/sources.list.d/arangodb.list 
 apt-get update
 apt-get install arangodb

 
-        
You can add the repository key to apt like this: 

-       
wget http://www.arangodb.org/repositories/stable/repositories/Debian_6.0/Release.key
+	    
You can add the repository key to apt like this: 

+	   
wget http://www.arangodb.org/repositories/stable/Debian_6.0/Release.key
 apt-key add - < Release.key  

-
-      

-      

-        
For CentOS-6 run the following as root:

-        
cd /etc/yum.repos.d/
+	  

+	  

+	    
For CentOS-6 run the following as root:

+	    
cd /etc/yum.repos.d/
 wget http://www.arangodb.org/repositories/stable/CentOS_CentOS-6/arangodb.repo
 yum install arangodb

-
+	  

+	  

+	    
For Mac OS X you can use use homebrew to install ArangoDB. Run the following:

+	    
brew install arangodb

+	  

+	  

+	    
A first version of ArangoDB for Windows is available. Please contact us, if you are interested in trying it.
+
-
-

For Mac OS X you can use use homebrew to install ArangoDB. Run the following:

- 
brew install arangodb
+
+
+

Grab binary packages directly

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Packages for Ubuntu 12.04:
Packages for Ubuntu 11.10:
Packages for Ubuntu 11.04:
Packages for openSUSE Tumbleweed:
Packages for openSUSE Factory:
Packages for openSUSE 12.2:
Packages for openSUSE 12.1:
Packages for openSUSE 11.4:
Packages for SLE 11 SP2:
Packages for SLE 11 SP1:
Packages for SLE 11:
Packages for RedHat RHEL-6:
Packages for Mandriva 2011:
Packages for Fedora 17:
Packages for Fedora 16:
Packages for Debian 6.0:
Packages for CentOS-6:
Packages for Mac OS X:
Packages for Windows:
    +
  • Coming Soon
    • +
- -
-
-

A first version of ArangoDB for Windows is available. Please contact us, if you are interested in trying it. - -

-
-
- -
-

Grab binary packages directly

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Packages for xUbuntu 12.04:
Packages for xUbuntu 11.10:
Packages for xUbuntu 11.04:
Packages for xUbuntu 10.04:
Packages for openSUSE Tumbleweed:
Packages for openSUSE Factory:
Packages for openSUSE 12.2:
Packages for openSUSE 12.1:
Packages for openSUSE 11.4:
Packages for SLE 11 SP2:
Packages for SLE 11 SP1:
Packages for SLE 11:
Packages for RedHat RHEL-6:
Packages for Mandriva 2011:
Packages for Fedora 17:
Packages for Fedora 16:
Packages for Debian 6.0:
Packages for CentOS CentOS-6:
Packages for Mac OS X:
    -
  • Coming Soon
    • -
Packages for Windows:
    -
  • Coming Soon
    • -
-
-
- - - + diff --git a/Makefile.in b/Makefile.in index aa8c834c72..945fc459b7 100644 --- a/Makefile.in +++ b/Makefile.in @@ -1628,6 +1628,7 @@ UNITTESTS_SERVER_BITARRAY = $(addprefix --javascript.unit-tests ,$(BITARRAY_COMM ################################################################################ GTAGS_FILES = $(sort $(abspath $(SOURCES) $(HEADERS))) DOXYGEN_TOC = \ + Documentation/InstallationManual/InstallationManual.md \ Documentation/Manual/Home.md \ Documentation/UserManual/UserManual.md @@ -5401,13 +5402,11 @@ Doxygen/xml/%.md: Doxygen/xml/%.xml .PHONY: doxygen-toc doxygen-toc: - rm -f Doxygen/toc.doxy - $(MAKE) Doxygen/toc.doxy - -Doxygen/toc.doxy: python @top_srcdir@/Documentation/Scripts/generateTOC.py $(DOXYGEN_TOC) >> Doxygen/toc.doxy.tmp cmp -s Doxygen/toc.doxy Doxygen/toc.doxy.tmp || mv Doxygen/toc.doxy.tmp Doxygen/toc.doxy +Doxygen/toc.doxy: doxygen-toc + ################################################################################ ### @brief doxygen ################################################################################ diff --git a/arangod/Documentation/install-manual.dox b/arangod/Documentation/install-manual.dox index 071817cca5..864a70a918 100644 --- a/arangod/Documentation/install-manual.dox +++ b/arangod/Documentation/install-manual.dox @@ -25,219 +25,6 @@ /// @author Copyright 2012, triAGENS GmbH, Cologne, Germany //////////////////////////////////////////////////////////////////////////////// -// ----------------------------------------------------------------------------- -// --SECTION-- INSTALLATION MANUAL -// ----------------------------------------------------------------------------- - -//////////////////////////////////////////////////////////////////////////////// -/// @page InstallManual ArangoDB's Installation Manual (@VERSION) -/// -/// @NAVIGATE_InstallManual -/// -/// @if LATEX -/// -/// @else -/// @copydetails InstallingTOC -/// @copydetails CompilingTOC -/// @endif -//////////////////////////////////////////////////////////////////////////////// - -// ----------------------------------------------------------------------------- -// --SECTION-- INSTALLING -// ----------------------------------------------------------------------------- - -//////////////////////////////////////////////////////////////////////////////// -/// @page InstallingTOC -/// -/// -//////////////////////////////////////////////////////////////////////////////// - -//////////////////////////////////////////////////////////////////////////////// -/// @page Installing Installing ArangoDB -/// -/// @EMBEDTOC{InstallingTOC} -/// -/// @section InstallingLinux Linux -////////////////////////////////// -/// -/// You can find binary packages for various Linux distributions here: -/// -/// @LIT{http://www.arangodb.org/repositories/} -/// -/// @subsection InstallingLinuxPackageManager Using a Package Manager to install ArangoDB -///////////////////////////////////////////////////////////////////////////////////////// -/// -/// @subsubsection InstallingCentOS CentoOS -/////////////////////////////////////////// -/// -/// Download and import GPG-PublicKey -/// -/// @code -/// wget -O RPM-GPG-KEY-www.arangodb.org http://www.arangodb.org/repositories/PublicKey -/// rpm --import RPM-GPG-KEY-www.arangodb.org -/// @endcode -/// -/// Add a repository file @LIT{/etc/yum.repos.d/arangodb.repo} -/// -/// @code -/// [ArangoDB] -/// name=ArangoDB Repository for CentOS -/// failovermethod=priority -/// baseurl=http://www.arangodb.org/repositories/CentOS-6 -/// enabled=1 -/// gpgcheck=1 -/// gpgkey=file:///etc/pki/rpm-gpg/RPM-GPG-KEY-www.arangodb.org -/// @endcode -/// -/// Update the repository data: -/// -/// @code -/// yum clean metadata -/// yum update -/// @endcode -/// -/// Search for arangodb: -/// -/// @code -/// yum search arangodb -/// @endcode -/// -/// Install arangodb: -/// -/// @code -/// yum install arangodb -/// @endcode -/// -/// @subsubsection InstallingDebian Debian, Linux-Mint, and Ubuntu -////////////////////////////////////////////////////////////////// -/// -/// Download and import GPG-PublicKey -/// -/// @code -/// wget -O RPM-GPG-KEY-www.arangodb.org http://www.arangodb.org/repositories/PublicKey -/// apt-key add RPM-GPG-KEY-www.arangodb.org -/// @endcode -/// -/// Add the corresponding repository in file @LIT{/etc/apt/sources.list}: -/// @code -/// deb http://www.arangodb.org/repositories Debian-6 main -/// @endcode -/// or -/// @code -/// deb http://www.arangodb.org/repositories LinuxMint-13 main -/// @endcode -/// or -/// @code -/// deb http://www.arangodb.org/repositories Ubuntu-11.10 main -/// @endcode -/// -/// Update the repository data: -/// -/// @code -/// aptitude update -/// @endcode -/// -/// Now you should be able to search for arangodb: -/// -/// @code -/// aptitude search arangodb -/// @endcode -/// -/// In order to install arangodb: -/// -/// @code -/// aptitude install arangodb -/// @endcode -/// -/// @subsubsection Gentoo -///////////////////////// -/// -/// Please use the -/// @EXTREF_S{https://github.com/mgiken/portage-overlay/tree/master/dev-db/ArangoDB,portage} -/// provided by @@mgiken. -/// -/// @subsubsection InstallingOpenSUSE OpenSuSE -////////////////////////////////////////////// -/// -/// Add the repository as follows: -/// -/// @code -/// zypper addrepo -f -t YUM http://www.arangodb.org/repositories/openSUSE-12.1 ArangoDB -/// @endcode -/// -/// Update the repository data: -/// -/// @code -/// zypper refresh -/// @endcode -/// -/// Search for arangodb: -/// -/// @code -/// zypper search arangodb -/// @endcode -/// -/// Install arangodb: -/// -/// @code -/// zypper install arangodb -/// @endcode -/// -/// @section InstallingMacOSX Mac OS X -////////////////////////////////////// -/// -/// You can find the MacOSX packages here: -/// -/// @LIT{http://www.arangodb.org/repositories/MacOSX} -/// -/// @subsection InstallingMacOSXHomebrew Homebrew -///////////////////////////////////////////////// -/// -/// If you are using homebrew, -/// then you can install the ArangoDB using @LIT{brew} as follows: -/// -/// @code -/// brew install arangodb -/// @endcode -/// -/// 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/sbin/arangod -/// -/// The ArangoDB shell will be install as -/// -/// /usr/local/bin/arangosh -/// -/// If you want to install the latest version use: -/// -/// @code -/// brew install --HEAD arangodb -/// @endcode -//////////////////////////////////////////////////////////////////////////////// - // ----------------------------------------------------------------------------- // --SECTION-- COMPILING // -----------------------------------------------------------------------------