Hawkin
/
arangodb
mirror of https://gitee.com/bigwinds/arangodb
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Reflect renames of startup options in docs

This commit is contained in:
Simran Brucherseifer 2016-06-20 11:37:47 +02:00
parent 495ecbff38
commit 5a3ddc4cb4
19 changed files with 37 additions and 38 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Documentation/Books/AQL/ExecutionAndPerformance/QueryCache.mdpp
View File

@ -120,7 +120,7 @@ then the cache will not provide much benefit.
!SECTION Global configuration
The query cache can be configured at server start using the configuration parameter
`--database.query-cache-mode`. This will set the cache mode according to the descriptions
`--query.cache-mode`. This will set the cache mode according to the descriptions
above.
After the server is started, the cache mode can be changed at runtime as follows:
@ -130,7 +130,7 @@ require("@arangodb/aql/cache").properties({ mode: "on" });
```
The maximum number of cached results in the cache for each database can be configured
at server start using the configuration parameter `--database.query-cache-max-results`.
at server start using the configuration parameter `--query.cache-entries`.
This parameter can be used to put an upper bound on the number of query results in
each database's query cache and thus restrict the cache's memory consumption.

17
Documentation/Books/HTTP/General/README.mdpp
View File

@ -40,7 +40,7 @@ ArangoDB will close connections automatically for clients that send requests
using HTTP 1.0, except if they send an *Connection: Keep-Alive* header.
The default Keep-Alive timeout can be specified at server start using the
*--server.keep-alive-timeout* parameter.
*--http.keep-alive-timeout* parameter.
Establishing TCP connections is expensive, since it takes several ping pongs
between the communication parties. Therefore you can use connection keepalive
@ -107,25 +107,26 @@ For details on the subsequent processing
Client authentication can be achieved by using the *Authorization* HTTP header in
client requests. ArangoDB supports HTTP Basic authentication.
Authentication is optional. To enforce authentication for incoming requested,
the server must be started with the option [--server.disable-authentication](../../Manual/Administration/Configuration/Arangod.html).
Authentication is turned on by default, but can be turned off. To enforce
authentication for incoming requested, the server must be started with the option
[--server.authentication](../../Manual/Administration/Configuration/Arangod.html).
Please note that requests using the HTTP OPTIONS method will be answered by
ArangoDB in any case, even if no authentication data is sent by the client or if
the authentication data is wrong. This is required for handling CORS preflight
requests (see [Cross Origin Resource Sharing requests](#cross-origin-resource-sharing-cors-requests)). The response to an HTTP OPTIONS request
will be generic and not expose any private data.
requests (see [Cross Origin Resource Sharing requests](#cross-origin-resource-sharing-cors-requests)).
The response to an HTTP OPTIONS request will be generic and not expose any private data.
Please note that when authentication is turned on in ArangoDB, it will by
default affect all incoming requests.
There is an additional option [--server.authenticate-system-only](../../Manual/Administration/Configuration/Arangod.html)
There is an additional option [--server.authentication-system-only](../../Manual/Administration/Configuration/Arangod.html)
to restrict authentication to requests to the ArangoDB internal APIs and the admin interface.
This option can be used to expose a public API built with ArangoDB to the outside
world without the need for HTTP authentication, but to still protect the usage of the
ArangoDB API (i.e. */_api/*) and the admin interface (i.e. */_admin/*) with
HTTP authentication.
If the server is started with the *--server.authenticate-system-only* parameter set
If the server is started with the *--server.authentication-system-only* parameter set
to *false* (which is the default), all incoming requests need HTTP authentication if the
server is configured to require HTTP authentication. Setting the option to *false* will
make the server require authentication only for requests to the internal functionality at
@ -240,7 +241,7 @@ credentials.
!SECTION HTTP method overriding
ArangoDB provides a startup option *--server.allow-method-override*.
ArangoDB provides a startup option *--http.allow-method-override*.
This option can be set to allow overriding the HTTP request method (e.g. GET, POST,
PUT, DELETE, PATCH) of a request using one of the following custom HTTP headers:

2
Documentation/Books/Manual/Administration/Arangodump.mdpp
View File

@ -24,7 +24,7 @@ or use authentication, you can use the following command-line options:
* *--server.username <string>*: username
* *--server.password <string>*: password to use (omit this and you'll be prompted for the
password)
* *--server.disable-authentication <bool>*: whether or not to use authentication
* *--server.authentication <bool>*: whether or not to use authentication
Here's an example of dumping data from a non-standard endpoint, using a dedicated
[database name](../Appendix/Glossary.md#database-name):

2
Documentation/Books/Manual/Administration/Arangorestore.mdpp
View File

@ -24,7 +24,7 @@ or use authentication, you can use the following command-line options:
* *--server.username <string>*: username
* *--server.password <string>*: password to use (omit this and you'll be prompted for the
password)
* *--server.disable-authentication <bool>*: whether or not to use authentication
* *--server.authentication <bool>*: whether or not to use authentication
Since version 2.6 _arangorestore_ provides the option *--create-database*. Setting this
option to *true* will create the target database if it does not exist. When creating the

4
Documentation/Books/Manual/Administration/Arangosh/README.mdpp
View File

@ -21,7 +21,7 @@ command-line options:
* *--server.endpoint <string>*: endpoint to connect to
* *--server.username <string>*: database username
* *--server.password <string>*: password to use when connecting
* *--server.disable-authentication <bool>*: disable password prompt and authentication
* *--server.authentication <bool>*: whether or not to use authentication
For example, to connect to an ArangoDB server on IP *192.168.173.13* on port
8530 with the user *foo* and using the database *test*, use:
@ -30,7 +30,7 @@ For example, to connect to an ArangoDB server on IP *192.168.173.13* on port
--server.endpoint tcp://192.168.173.13:8530 \
--server.username foo \
--server.database test \
--server.disable-authentication false
--server.authentication true
_arangosh_ will then display a password prompt and try to connect to the
server after the password was entered.

3
Documentation/Books/Manual/Administration/Configuration/Arangod.mdpp
View File

@ -210,8 +210,7 @@ used.
!SUBSECTION SSL protocol
SSL protocol type to use
`--server.ssl-protocolvalue`
SSL protocol type to use `--ssl.protocol value`
Use this option to specify the default encryption protocol to be used.
The following variants are available:

2
Documentation/Books/Manual/Administration/Configuration/README.mdpp
View File

@ -33,7 +33,7 @@ Prints the version of the server and exits.
!SUBSECTION Database Upgrade
`--database.upgrade`
`--database.auto-upgrade`
Specifying this option will make the server perform a database upgrade at start. A database upgrade will first compare the version number stored in the file VERSION in the database directory with the current server version.

2
Documentation/Books/Manual/Administration/Upgrading/README.mdpp
View File

@ -16,7 +16,7 @@ To upgrade an existing ArangoDB database to a newer version of ArangoDB
* Stop the "old" arangod service or binary
* Copy the entire "old" data directory to a safe place (that is, a backup)
* Install the new version of ArangoDB and start the server with
the *--database.upgrade* option once. This might write to the logfile of ArangoDB,
the *--database.auto-upgrade* option once. This might write to the logfile of ArangoDB,
so you may want to check the logs for any issues before going on.
* Start the "new" arangod service or binary regularly and check the logs for any
issues. When you're confident everything went well, you may want to check the

4
Documentation/Books/Manual/GettingStarted/Arangosh.mdpp
View File

@ -30,7 +30,7 @@ STANDARD options:
--pager <string> output pager (default: "less -X -R -F -L")
--pretty-print pretty print values
--quiet no banner
--temp-path <string> path for temporary files (default: "/tmp/arangodb")
--temp.path <string> path for temporary files (default: "/tmp/arangodb")
--use-pager use pager
JAVASCRIPT options:
@ -46,7 +46,7 @@ LOGGING options:
CLIENT options:
--server.connect-timeout <double> connect timeout in seconds (default: 3)
--server.disable-authentication <bool> disable authentication (default: false)
--server.authentication <bool> whether or not to use authentication (default: true)
--server.endpoint <string> endpoint to connect to, use 'none' to start without a server (default: "tcp://127.0.0.1:8529")
--server.password <string> password to use when connecting (leave empty for prompt)
--server.request-timeout <double> request timeout in seconds (default: 300)

6
Documentation/Books/Manual/GettingStarted/Installing/Linux.mdpp
View File

@ -59,10 +59,10 @@ 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
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.auto-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.auto-upgrade option
make sure to start the server once with the *--database.upgrade* option.
make sure to start the server once with the *--database.auto-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.

2
Documentation/Books/Manual/ReleaseNotes/UpgradingChanges30.mdpp
View File

@ -63,7 +63,7 @@ used a pattern `collection-<id>` without the random number.
Unlike ArangoDB 2, ArangoDB 3.0 users are now separated from databases
and you can grant one or more database permission to a user.
If you one to mimic the behavior of ArangoDB, you should name your
If you want to mimic the behavior of ArangoDB, you should name your
users like `username@dbname`.
Users that can access to the *_system* database are allowed to manage users and

4
Documentation/Books/Manual/Troubleshooting/Arangobench.mdpp
View File

@ -47,8 +47,8 @@ Related blog posts:
- *--server.password*: Password to use when connecting. Don't specify this
option to get a password prompt.
- *--server.disable-authentication*: Disable the password prompt and
authentication when connecting to the server.
- *--server.authentication*: Wether or not to show the password prompt and
use authentication when connecting to the server (default: true).
- *--test-case*: Name of test case to perform (default: "version").
Possible values:

9
Documentation/DocuBlocks/databaseDisableQueryTracking.md
View File

@ -1,10 +1,9 @@
@brief disable the query tracking feature
`--database.disable-query-tracking flag`
@brief enable the query tracking feature
`--query.tracking flag`
If *true*, the server's query tracking feature will be disabled by
default.
If *false*, the server's query tracking feature will be disabled.
The default is *false*.
The default is *true*.

2
Documentation/DocuBlocks/foxxQueuesPollInterval.md
View File

@ -1,7 +1,7 @@
@startDocuBlock foxxQueuesPollInterval
@brief poll interval for Foxx queues
`--foxx-queues-poll-interval value`
`--foxx.queues-poll-interval value`
The poll interval for the Foxx queues manager. The value is specified in
seconds. Lower values will mean more immediate and more frequent Foxx

2
Documentation/DocuBlocks/queryCacheMaxResults.md
View File

@ -1,7 +1,7 @@
@brief maximum number of elements in the query cache per database
`--database.query-cache-max-results`
`--query.cache-entries`
Maximum number of query results that can be stored per database-specific
query cache. If a query is eligible for caching and the number of items in

2
Documentation/DocuBlocks/queryCacheMode.md
View File

@ -1,7 +1,7 @@
@brief whether or not to enable the AQL query cache
`--database.query-cache-mode`
`--query.cache-mode`
Toggles the AQL query cache behavior. Possible values are:

2
Documentation/DocuBlocks/serverCafile.md
View File

@ -1,7 +1,7 @@
@brief CA file
`--server.cafile filename`
`--ssl.cafile filename`
This option can be used to specify a file with CA certificates that are
sent

4
Documentation/DocuBlocks/serverEndpoint.md
View File

@ -21,7 +21,7 @@ times.
```
unix> ./arangod --server.endpoint tcp://127.0.0.1:8529
--server.endpoint ssl://127.0.0.1:8530
--server.keyfile server.pem /tmp/vocbase
--ssl.keyfile server.pem /tmp/vocbase
2012-07-26T07:07:47Z [8161] INFO using SSL protocol version 'TLSv1'
2012-07-26T07:07:48Z [8161] INFO using endpoint 'ssl://127.0.0.1:8530' for
http ssl requests
@ -33,7 +33,7 @@ business
```
**Note**: If you are using SSL-encrypted endpoints, you must also supply
the path to a server certificate using the \-\-server.keyfile option.
the path to a server certificate using the `--ssl.keyfile` option.
Endpoints can also be changed at runtime.
Please refer to [HTTP Interface for Endpoints](../../../HTTP/Endpoints/index.html)

2
Documentation/DocuBlocks/serverKeyfile.md
View File

@ -51,6 +51,6 @@ following commands should create a valid keyfile:
For further information please check the manuals of the tools you use to
create the certificate.
**Note**: the \-\-ssl.keyfile option must be set if the server is
**Note**: the `--ssl.keyfile` option must be set if the server is
started with at least one SSL endpoint.