Updated docs with install information
authorAnders Henja <anders@henjab.se>
Wed, 8 Jan 2014 14:46:36 +0000 (15:46 +0100)
committerAnders Henja <anders@henjab.se>
Wed, 8 Jan 2014 14:46:36 +0000 (15:46 +0100)
doc/config.dox
doc/install.dox

index aa7cb02..90468bd 100644 (file)
@@ -24,7 +24,7 @@ pre-configured user called \c admin, and this user's password is
 'baltrad'. You have to log on using the web-based user interface and change
 it to something only you know. 
 
-From the main menu placed in the left column, click "User accounts" --> "Edit" 
+From the main menu placed in the left column, click "User accounts" --> "Edit user" 
 link (located in the "Settings" section). There you'll see the \c admin user 
 and a link to the right called "Change" under the heading "Password". 
 Use a safe password, and store it in a safe place that you remember.
index 30f5c29..4a93941 100644 (file)
@@ -283,7 +283,11 @@ Options:
 
 --nodename
     This attribute should really be specified but there is a default value which
-    is the hostname as shown by the command 'hostname'.
+    is the hostname as shown by the command 'hostname'. The node name is a unique
+    identifier that is used for identifying you within the exchange
+    network. The node name should usually explain exactly who you are. A good
+    example is to use the java package naming. For example se.myorg or se.myorg.test or similar. 
+    This node name will also defining what this installations key will be named.
 
 --prefix=<prefix>
     Points out where the system should be installed. 
@@ -404,16 +408,68 @@ Options:
 --with-beamb
     Install the beam blockage detector beamb. Will also cause rave to be installed.
 
+--with-beamb
+    Install the beam blockage detector beamb. Will also cause rave to be installed.
+
+--with-bwrwp
+    Installs the baltrad weather radar wind profile generator. Will also cause rave to be installed.
+    This is a very special product generator that uses fortran code and requires for example gfortran.
+    This product more or less requires that the following options also are specified: --with-blas=,
+    --with-cblas=, --with-lapack= and --with-lapacke=.
+--with-blas=<libblas.a directory>
+    Specifies the directory where the libblas.a library resides. Currently only used when installing bwrwp.
+    NOTE that the library objects must have been compiled with -fPIC or similar for shared object capabilities
+    since it will be linked into a shared library.
+
+--with-cblas=<root> or <cblas.h incdir>,<libcblas.a dir>
+    Specifies where the cblas.h include directory and the libcblas.a directory resides. You can also
+    specify cblas root directory that should contain the include and lib directory.
+    Currently only used when installing bwrwp.
+    NOTE that the library objects must have been compiled with -fPIC or similar for shared object capabilities
+    since it will be linked into a shared library.
+
+--with-lapack=<liblapack.a directory>
+    Specifies the directory where the liblapack.a library resides. Currently only used when installing bwrwp.
+    NOTE that the library objects must have been compiled with -fPIC or similar for shared object capabilities
+    since it will be linked into a shared library.
+
+--with-lapacke=<root> or <lapacke.h incdir>,<liblapacke.a dir>
+    Specifies where the cblas.h include directory and the libcblas.a directory resides. You can also
+    specify cblas root directory that should contain the include and lib directory.
+    Currently only used when installing bwrwp.
+    NOTE that the library objects must have been compiled with -fPIC or similar for shared object capabilities
+    since it will be linked into a shared library.
+
 --with-bdbfs
     Will build and install the baltrad db file system driver
 
 --bdb-port=8090
     BDB server port
 
+--bdb-uri=<uri>
+    The BDB uri, as default this has no use even when specified. It will only be used
+    if subsystems has been specified so that you can specify a different BDB server. Also,
+    if this is specified, bdb-port will not have any meaning.
+    E.g. --bdb-uri=http://somehost:8090
+    [Default: Not used]
+
 --bdb-pool-max-size=<N>
     Set the pool size for bdb connections to <N>
     [default: 10]
 
+--bdb-auth=<authtype>
+    BDB authentication model. Valid values are:
+      * 'noauth' - perform no authentication
+      * 'keyczar' - authenticate using Keyczar, reusing host keys
+    [default: keyczar]
+
+--bdb-storage=<storagetype>
+    BDB storage model. Valid values are:
+      * db - store files in the database with a cache in 
+      * fs - store files in 
+    [default: db]
+
 --rebuild=<module1>,<module2>,...
     Will force a rebuild and installation of the specified modules. To get a 
     list of available modules and their versions. See option --print-modules.
@@ -435,6 +491,22 @@ Options:
     Don't use together with --tomcaturl. 
     [Default 8080]
 
+--keystoredn=<dn>
+    The distinguished name used in the keystore cert for the secure communication.
+    If <dn> is yes, then a number of questions will be asked during the creation of the keystore.
+    If <dn> is no, then a predefined dn will be created with the format
+      "CN=Unknown,OU=Unknown,O=Unknown,L=Unknown,ST=Unknown,C=Unknown"
+    Or you can specify your own DN, just keep the above format. Note, that you can not specify a dn with any
+    spaces in it. If you have that format you will have to use 'yes' instead to get the questions
+    [Default yes]
+
+--keystorepwd=<pwd>
+    Specifies the password that should be used for the key. If this has not been defined, the tomcatpwd will be used.
+
+--tomcatsecureport=<port>
+    Specifies the port on which the tomcat installation should listen on for secure messages.
+    [Default 8443]
+
 --tomcaturl=<url>
     Specifies the tomcat url where the tomcat installation resides. Don't
     use together with --tomcatport. 
@@ -452,6 +524,13 @@ Options:
     or other miscellaneous problems. This might be the option to specify. Some modules
     are currently beeing evaluated if they are stable enough to be used in production
     and by specifying this option these modules will be built instead.
+
+--subsystems=(STANDALONE_RAVE, RAVE ,BDB ,DEX)
+    If you are interested in running a standalone installation of RAVE, BDB or DEX. It
+    is possible to do so by specifying which subsystems that should be installed.
+    Since RAVE is depending on the BALTRAD-DB python client API you are able to specify
+    a specific RAVE module called STANDALONE_RAVE which installs RAVE without any
+    BDB-dependencies.    
     
 \endverbatim