Skip to content

Commit

Permalink
Move website content under docs and add README.md.
Browse files Browse the repository at this point in the history
  • Loading branch information
rgooch committed Jun 11, 2020
1 parent adb3906 commit 8315b39
Show file tree
Hide file tree
Showing 7 changed files with 7 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,10 @@ For the service operators it requires adding the Keymaster certificates to the s

In general, the relationship between components is shown here:

![keymaster-keymasterd interaction image](website/overview.png)
![keymaster-keymasterd interaction image](docs/website/overview.png)

Please see the
[design document](website/DesignDoc.md) for more information.
[design document](docs/website/DesignDoc.md) for more information.

## Getting Started
Pre-build binaries (both RPM and DEB) can be found here: [releases page](https://github.com/Cloud-Foundations/keymaster/releases) or you can build it from source (please see instructions below). The RPM and DEB packages contain both server and client binaries. The tarballs only contain the client binaries.
Expand Down Expand Up @@ -75,7 +75,7 @@ Keymaster supports SQLite and PostgreSQL to store u2f tokens or username and pas

##### Openid Connect IDP
To use keymasterd as an openid connect IDP please consult the documents
[here](website/openidc-idp.md)
[here](docs/website/openidc-idp.md)

#### keymaster-unlocker
The `keymaster-unlocker` binary allows you to 'unseal' the Keymaster environment. This binary requires a client side certificate signed by the adminCA.
Expand Down
File renamed without changes.
4 changes: 4 additions & 0 deletions docs/website/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Documentation for inclusion in website

The files here are automatically copied/compiled for use in the
[website](https://www.cloud-foundations.org/Keymaster/DesignDoc.html)
File renamed without changes
File renamed without changes.
File renamed without changes
File renamed without changes

0 comments on commit 8315b39

Please sign in to comment.