Merge pull request #66 from rgooch/website

Move documents to standard website directory.
Cloud-Foundations · Jun 11, 2020 · 54c10c8 · 54c10c8
2 parents 8ef70f1 + 8315b39
commit 54c10c8
Show file tree

Hide file tree

Showing 7 changed files with 8 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -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](docs/keymaster-overview.png)
+![keymaster-keymasterd interaction image](docs/website/overview.png)
 
 Please see the
-[design document](docs/Keymaster-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.
@@ -74,7 +74,8 @@ Several authentication methods are supported by the `keymasterd` service. You ca
 Keymaster supports SQLite and PostgreSQL to store u2f tokens or username and passwords. The `storage_url` field in `config.yml` contains the connection information for the database. If no `storage_url` is defined Keymaster will use an SQLite database located in the configured data directory for Keymaster. An example of a PostgreSQL url is: `postgresql://dbusername:dbpassword.example.com/keymasterdbname`
 
 ##### Openid Connect IDP
-To use keymasterd as an openid connect IDP please consult the documents [here](docs/keymaster-openidc-idp.md)
+To use keymasterd as an openid connect IDP please consult the documents
+[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.

diff --git a/docs/Keymaster-DesignDoc.md → docs/website/DesignDoc.md b/docs/Keymaster-DesignDoc.md → docs/website/DesignDoc.md
@@ -1,7 +1,6 @@
 # Keymaster: Usable Short-term Credentials with Multi-Factor Authentication
 
 #### Camilo Viecco[[1]](#footnote1), Richard Gooch
-#### Symantec Corporation
 
 [https://github.com/Cloud-Foundations/keymaster]()
 

diff --git a/docs/website/README.md b/docs/website/README.md
@@ -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)
diff --git a/docs/authentication_workflow2.svg → docs/website/authentication_workflow2.svg b/docs/authentication_workflow2.svg → docs/website/authentication_workflow2.svg
diff --git a/docs/keymaster-openidc-idp.md → docs/website/openidc-idp.md b/docs/keymaster-openidc-idp.md → docs/website/openidc-idp.md
diff --git a/docs/keymaster-overview.png → docs/website/overview.png b/docs/keymaster-overview.png → docs/website/overview.png
diff --git a/docs/token_management2.svg → docs/website/token_management2.svg b/docs/token_management2.svg → docs/website/token_management2.svg