Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
sebinjohn committed Aug 12, 2023
1 parent 223cc53 commit 247fc81
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 0 deletions.
32 changes: 32 additions & 0 deletions website/content/docs/agent-and-proxy/autoauth/methods/ldap.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
layout: docs
page_title: Vault Auto-Auth LDAP Method
description: LDAP Method for Vault Auto-Auth
---

# Vault Auto-Auth LDAP Method

The `ldap` method reads in a password from a file and sends it to the [LDAP Auth
method](/vault/docs/auth/ldap).

## Configuration

- `password_file_path` `(string: required)` - The path to the password file

- `username` `(string: required)` - The username to authenticate against on Vault

- `remove_password_after_reading` `(bool: optional, defaults to true)` -
This can be set to `false` to disable the default behavior of removing the
password after it's been read.

- `remove_password_follows_symlinks` `(bool: optional, defaults to false)` -
This can be set to `true` to follow symlinks when removing the password after
it has been read when executing the `remove_password_after_reading` behaviour.
If set to false, it will delete the symlink, not the password file. Does
nothing if `remove_password_after_reading` is false.

- `password_read_period` `(duration: "0.5s", optional)` - The duration after which
auto-auth will attempt to read the password stored at `password_file_path`.
Defaults to `1m` if `remove_password_after_reading` is set to `true`, or `0.5s`
otherwise. Uses [duration format
strings](/vault/docs/concepts/duration-format).
4 changes: 4 additions & 0 deletions website/data/docs-nav-data.json
Original file line number Diff line number Diff line change
Expand Up @@ -1008,6 +1008,10 @@
"title": "JWT",
"path": "agent-and-proxy/autoauth/methods/jwt"
},
{
"title": "LDAP",
"path": "agent-and-proxy/autoauth/methods/ldap"
},
{
"title": "Kerberos",
"path": "agent-and-proxy/autoauth/methods/kerberos"
Expand Down

0 comments on commit 247fc81

Please sign in to comment.