diff --git a/docs/cli.md b/docs/cli.md index 6fdf9ff966..15579b5932 100644 --- a/docs/cli.md +++ b/docs/cli.md @@ -1,5 +1,6 @@ # List of Notary Documentation -* [Overview of Docker Notary](overview.md) -* [Notary CLI](cli.md) +* [Server Architecture](notary-server.md) +* [Signer](notary-signer.md) +* [Server Configuration File](notary-server-config.md) +* [Signer Configuration File](notary-signer-config.md) diff --git a/docs/notary-server-config.md b/docs/notary-server-config.md index 29784f9910..800d896d4e 100644 --- a/docs/notary-server-config.md +++ b/docs/notary-server-config.md @@ -1,10 +1,11 @@ diff --git a/docs/notary-server.md b/docs/notary-server.md index 0ac1e549d1..7ef7169220 100644 --- a/docs/notary-server.md +++ b/docs/notary-server.md @@ -1,6 +1,6 @@ -# Notary Server +# Notary Server Architecture The Notary Server stores and updates the signed [TUF metadata files]( @@ -35,7 +35,7 @@ and a cert bundle from this authorization server containing the public key it uses to sign tokens. If token authentication is enabled on Notary Server, then any client that -does not have a token will be redirected to the authoriziation server. +does not have a token will be redirected to the authorization server. The client will log in, obtain a token, and then present the token to Notary Server on future requests. @@ -66,7 +66,7 @@ certificates for your deployment of Notary Server, please make sure that the certificates **are not CAs**. Otherwise if the server is compromised, it can sign any number of other client certs. -As an example, please see [this script](opensslCertGen.sh) to see how to +As an example, please see [this script](https://github.com/docker/notary/blob/master/docs/opensslCertGen.sh) to see how to generate client SSL certs with basic constraints using OpenSSL. ### How to configure and run Notary Server diff --git a/docs/notary-signer-config.md b/docs/notary-signer-config.md index 424126ba9d..2e9221ee9e 100644 --- a/docs/notary-signer-config.md +++ b/docs/notary-signer-config.md @@ -1,10 +1,11 @@ diff --git a/docs/notary-signer.md b/docs/notary-signer.md index 2d235bcb2d..513eb32699 100644 --- a/docs/notary-signer.md +++ b/docs/notary-signer.md @@ -1,6 +1,6 @@