1
0
Fork 0

added documentation for cluster authentication options

This commit is contained in:
Jan Steemann 2014-02-27 19:27:12 +01:00
parent 3eec85f007
commit 8edf96e9aa
3 changed files with 36 additions and 0 deletions

View File

@ -244,6 +244,14 @@ Command-Line Options for Clusters {#CommandLineCluster}
@anchor CommandLineArangoClusterMyAddress
@copydetails triagens::arango::ApplicationCluster::_myAddress
@CLEARPAGE
@anchor CommandLineArangoClusterUsername
@copydetails triagens::arango::ApplicationCluster::_username
@CLEARPAGE
@anchor CommandLineArangoClusterPassword
@copydetails triagens::arango::ApplicationCluster::_password
@CLEARPAGE
Command-Line Options for Communication {#CommandLineScheduler}
==============================================================

View File

@ -49,6 +49,8 @@ TOC {#CommandLineTOC}
- @ref CommandLineArangoClusterAgencyPrefix "cluster.agency-prefix"
- @ref CommandLineArangoClusterMyId "cluster.my-id"
- @ref CommandLineArangoClusterMyAddress "cluster.my-address"
- @ref CommandLineArangoClusterUsername "cluster.username"
- @ref CommandLineArangoClusterPassword "cluster.password"
- @ref CommandLineLogging
- @ref CommandLineLoggingGeneral
- @ref CommandLineLoggingLogFile "log.file"

View File

@ -275,6 +275,19 @@ namespace triagens {
/// @brief username used for cluster-internal communication
///
/// @CMDOPT{\--cluster.username @CA{username}}
///
/// The username used for authorization of cluster-internal requests.
/// This username will be used to authenticate all requests and responses in
/// cluster-internal communication, i.e. requests exchanged between coordinators
/// and individual database servers.
///
/// This option is used for cluster-internal requests only. Regular requests to
/// coordinators are authenticated normally using the data in the `_users`
/// collection.
///
/// If coordinators and database servers are run with authentication turned off,
/// (e.g. by setting the `--server.disable-authentication` option to `true`),
/// the cluster-internal communication will also be unauthenticated.
////////////////////////////////////////////////////////////////////////////////
std::string _username;
@ -283,6 +296,19 @@ namespace triagens {
/// @brief username used for cluster-internal communication
///
/// @CMDOPT{\--cluster.password @CA{password}}
///
/// The password used for authorization of cluster-internal requests.
/// This password will be used to authenticate all requests and responses in
/// cluster-internal communication, i.e. requests exchanged between coordinators
/// and individual database servers.
///
/// This option is used for cluster-internal requests only. Regular requests to
/// coordinators are authenticated normally using the data in the `_users`
/// collection.
///
/// If coordinators and database servers are run with authentication turned off,
/// (e.g. by setting the `--server.disable-authentication` option to `true`),
/// the cluster-internal communication will also be unauthenticated.
////////////////////////////////////////////////////////////////////////////////
std::string _password;