Skip to content

Commit

Permalink
Merge branch 'milestone2' into fix/deregister-tp-#125
Browse files Browse the repository at this point in the history
  • Loading branch information
志宇 authored Jan 28, 2020
2 parents eb75788 + ada8421 commit ccb2ff4
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions cmd/hypervisor/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,12 @@ Hypervisor exposes node management operations via web API.
**Generate config file:**

```bash

$ hypervisor gen-config
```

**Run with mock data:**

```bash
# Generate config file.
$ hypervisor gen-config

# Run.
$ hypervisor --mock
```

Expand All @@ -23,3 +19,9 @@ By default, the RESTful API is served on `:8080`.
## Endpoints Documentation

Endpoints are documented in the provided [Postman](https://www.getpostman.com/) file: `hypervisor.postman_collection.json`.

### Authentication information

- When the authentication cookie is invalid, the hypervisor will return code `401`.
- The default authentication cookie timeout is 12 hours. This can be configured in the hypervisor config file: `cookies.expires_duration`.
- There is currently no enforcement of when a user should change their password.

0 comments on commit ccb2ff4

Please sign in to comment.