Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document hypervisor auth states. #131

Merged
merged 2 commits into from
Jan 27, 2020
Merged

Document hypervisor auth states. #131

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
74712f8
Document hypervisor auth states.
Jan 27, 2020
79d3148
Fixed hypervisor README.
Jan 27, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions cmd/hypervisor/README.md
View file
Open in desktop
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.
2 changes: 1 addition & 1 deletion vendor/modules.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# github.com/SkycoinProject/dmsg v0.0.0-20200116114634-91be578a1895 => ../dmsg
# github.com/SkycoinProject/dmsg v0.0.0-20200116114634-91be578a1895
github.com/SkycoinProject/dmsg
github.com/SkycoinProject/dmsg/cipher
github.com/SkycoinProject/dmsg/disc
Expand Down