prometheus/cadvisor
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Merge pull request #348 from incredlabs/httpdocs

Browse Source 
Update web UI docs to reflect authentication feature
This commit is contained in:
Victor Marmol 2014-12-12 03:17:17 +08:00
commit 3dc78668d9
1 changed files with 22 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
docs/web.md
View File

@ -5,3 +5,25 @@ cAdvisor exposes a web UI at its port:
`http://<hostname>:<port>/` `http://<hostname>:<port>/`
This UI has one primary resource at `/containers` which exports live information about all containers on the machine. This UI has one primary resource at `/containers` which exports live information about all containers on the machine.
## Web UI authentication
You can add authentication to the web UI by either HTTP basic or HTTP digest authentication.
### HTTP basic authentication
You will need to add a *http_auth_file* parameter with a HTTP basic auth file generated using htpasswd to enable HTTP basic auth. By default the auth realm is set as localhost.
`./cadvisor --http_auth_file test.htpasswd --http_auth_realm localhost`
The [test.htpasswd](../test.htpasswd) file provided has a username and password already added (admin:password1) for testing purposes.
### HTTP Digest authentication
You will need to add a *http_digest_file* parameter with a HTTP digest auth file generated using htdigest to enable HTTP Digest auth. By default the auth realm is set as localhost.
`./cadvisor --http_digest_file test.htdigest --http_digest_realm localhost`
The [test.htdigest](../test.htdigest) file provided has a username and password already added (admin:password1) for testing purposes.
**Note** : You can use either type of authentication, incase you decide to use both files in the arguments only HTTP basic auth will be enabled.