Add instructions for enabling the auth first

This commit is contained in:
Seth Vargo 2015-05-07 13:41:23 -04:00
parent 1697cf2a8c
commit 87e25f4300
4 changed files with 70 additions and 2 deletions

View file

@ -71,6 +71,21 @@ The endpoint for the App ID login is `/login`.
## Configuration
First you must enable the App ID auth backend:
```
$ vault auth-enable app-id
Successfully enabled 'app-id' at 'app-id'!
```
Now when you run `vault auth -methods`, the App ID backend is available:
```
Path Type Description
app-id/ app-id
token/ token token based credentials
```
To use the App ID auth backend, an operator must configure it with
the set of App IDs, user IDs, and the mapping between them. An
example is shown below, use `vault help` for more details.

View file

@ -25,6 +25,21 @@ if there is a matching trusted certificate to authenticate the client.
## Configuration
First, you must enable the certificate auth backend:
```
$ vault auth-enable cert
Successfully enabled 'cert' at 'cert'!
```
Now when you run `vault auth -methods`, the certificate backend is available:
```
Path Type Description
cert/ cert
token/ token token based credentials
```
To use the "cert" auth backend, an operator must configure it with
trusted certificates that are allowed to authenticate. An example is shown below.
Use `vault help` for more details.

View file

@ -30,19 +30,41 @@ The endpoint for the GitHub login is `/login`.
## Configuration
First, you must enable the GitHub auth backend:
```
$ vault auth-enable github
Successfully enabled 'github' at 'github'!
```
Now when you run `vault auth -methods`, the GitHub backend is available:
```
Path Type Description
github/ github
token/ token token based credentials
```
Prior to using the GitHub auth backend, it must be configured. To
configure it, use the `/config` endpoint and pass in the following arguments:
configure it, use the `/config` endpoint with the following arguments:
* `organization` (string, required) - The organization name a user must
be a part of to authenticate.
For example:
```
$ vault write auth/github/config organization=hashicorp
Success! Data written to: auth/github/config
```
After configuring that, you must map the teams of that organization to
policies within Vault. Use the `map/teams/<team>` endpoints to do that.
Example:
```
$ vault write auth/github/map/teams/owners value=root
...
Success! Data written to: auth/github/map/teams/owners
```
The above would make anyone in the "owners" team a root user in Vault

View file

@ -34,6 +34,22 @@ The endpoint for the login is `/login/USERNAME`.
## Configuration
First, you must enable the username/password auth backend:
```
$ vault auth-enable userpass
Successfully enabled 'userpass' at 'userpass'!
```
Now when you run `vault auth -methods`, the username/password backend is
available:
```
Path Type Description
token/ token token based credentials
userpass/ userpass
```
To use the "userpass" auth backend, an operator must configure it with
users that are allowed to authenticate. An example is shown below.
Use `vault help` for more details.