Skip to content

Commit

Permalink
[DOCS] Removes redundant file realm settings (#30192)
Browse files Browse the repository at this point in the history
  • Loading branch information
lcawl authored May 1, 2018
1 parent b34e5cf commit 846783c
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 26 deletions.
27 changes: 1 addition & 26 deletions x-pack/docs/en/security/authentication/file-realm.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -57,32 +57,7 @@ xpack:
[[file-realm-settings]]
===== File Realm Settings

[cols="4,^3,10"]
|=======================
| Setting | Required | Description
| `type` | yes | Indicates the realm type. Must be set to `file`.
| `order` | no | Indicates the priority of this realm within the
realm chain. Realms with a lower order are
consulted first. Although not required, we
recommend explicitly setting this value when you
configure multiple realms. Defaults to
`Integer.MAX_VALUE`.
| `enabled` | no | Indicates whether this realm is enabled or
disabled. Enables you to disable a realm without
removing its configuration. Defaults to `true`.
| `cache.ttl` | no | Specifies the time-to-live for cached user entries.
A user's credentials are cached for this period of
time. Specify the time period using the standard
Elasticsearch {ref}/common-options.html#time-units[time units].
Defaults to `20m`.
| `cache.max_users` | no | Specifies the maximum number of user entries that
can be stored in the cache at one time. Defaults
to 100,000.
| `cache.hash_algo` | no | Specifies the hashing algorithm that is used for
the cached user credentials. See <<cache-hash-algo,
Cache hash algorithms>> for the possible values.
(Expert Setting).
|=======================
See {ref}/security-settings.html#ref-users-settings[File Realm Settings].

==== A Look Under the Hood

Expand Down
4 changes: 4 additions & 0 deletions x-pack/docs/en/settings/security-settings.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -168,6 +168,10 @@ in-memory cached user credentials. For possible values, see
[float]
===== File realm settings

The `type` setting must be set to `file`. In addition to the
<<ref-realm-settings,settings that are valid for all realms>>, you can specify
the following settings:

`cache.ttl`::
The time-to-live for cached user entries. A user and a hash of its credentials
are cached for this configured period of time. Defaults to `20m`. Specify values
Expand Down

0 comments on commit 846783c

Please sign in to comment.