From 54c7de5bd6ee975e4a3db129de4efeaf730cb0b5 Mon Sep 17 00:00:00 2001 From: Ying Li Date: Mon, 30 Nov 2015 14:32:03 -0800 Subject: [PATCH] Update the server and signer docs to reflect new code changes. Signed-off-by: Ying Li --- cmd/notary-server/main.go | 4 +- cmd/notary-signer/main.go | 4 +- docs/notary-server-config.md | 313 +++++++++++++++++------------------ docs/notary-server.md | 62 ++++--- docs/notary-signer-config.md | 131 ++++++++++++--- docs/notary-signer.md | 80 ++++++--- 6 files changed, 360 insertions(+), 234 deletions(-) diff --git a/cmd/notary-server/main.go b/cmd/notary-server/main.go index 044da76108..7b970fe54e 100644 --- a/cmd/notary-server/main.go +++ b/cmd/notary-server/main.go @@ -244,8 +244,8 @@ func usage() { // endpoints. The addr should not be exposed externally. For most of these to // work, tls cannot be enabled on the endpoint, so it is generally separate. func debugServer(addr string) { - logrus.Info("Debug server listening on", addr) + logrus.Infof("Debug server listening on %s", addr) if err := http.ListenAndServe(addr, nil); err != nil { - logrus.Fatal("error listening on debug interface: ", err) + logrus.Fatalf("error listening on debug interface: %v", err) } } diff --git a/cmd/notary-signer/main.go b/cmd/notary-signer/main.go index ee0ed63613..2d22aaffe0 100644 --- a/cmd/notary-signer/main.go +++ b/cmd/notary-signer/main.go @@ -240,8 +240,8 @@ func usage() { // endpoints. The addr should not be exposed externally. For most of these to // work, tls cannot be enabled on the endpoint, so it is generally separate. func debugServer(addr string) { - log.Println("Debug server listening on", addr) + logrus.Infof("Debug server listening on %s", addr) if err := http.ListenAndServe(addr, nil); err != nil { - log.Fatalf("error listening on debug interface: %v", err) + logrus.Fatalf("error listening on debug interface: %v", err) } } diff --git a/docs/notary-server-config.md b/docs/notary-server-config.md index 2fbd7754af..a9241b438f 100644 --- a/docs/notary-server-config.md +++ b/docs/notary-server-config.md @@ -15,18 +15,9 @@ An example (full) server configuration file. ```json { "server": { - "addr": ":4443", + "http_addr": ":4443", "tls_key_file": "./fixtures/notary-server.key", "tls_cert_file": "./fixtures/notary-server.crt", - "auth": { - "type": "token", - "options": { - "realm": "https://auth.docker.io/token", - "service": "notary-server", - "issuer": "auth.docker.io", - "rootcertbundle": "/path/to/auth.docker.io/cert" - } - } }, "trust_service": { "type": "remote", @@ -37,17 +28,27 @@ An example (full) server configuration file. "tls_client_cert": "./fixtures/notary-server.crt", "tls_client_key": "./fixtures/notary-server.key" }, + "storage": { + "backend": "mysql", + "db_url": "user:pass@tcp(notarymysql:3306)/databasename?parseTime=true" + }, + "auth": { + "type": "token", + "options": { + "realm": "https://auth.docker.io/token", + "service": "notary-server", + "issuer": "auth.docker.io", + "rootcertbundle": "/path/to/auth.docker.io/cert" + } + }, "logging": { "level": "debug" }, - "storage": { - "backend": "mysql", - "db_url": "dockercondemo:dockercondemo@tcp(notarymysql:3306)/dockercondemo" - }, "reporting": { - "bugsnag": "yes", - "bugsnag_api_key": "c9d60ae4c7e70c4b6c4ebd3e8056d2b8", - "bugsnag_release_stage": "notary-server" + "bugsnag": { + "api_key": "c9d60ae4c7e70c4b6c4ebd3e8056d2b8", + "release_stage": "production" + } } } ``` @@ -58,7 +59,7 @@ Example: ```json "server": { - "addr": ":4443", + "http_addr": ":4443", "tls_key_file": "./fixtures/notary-server.key", "tls_cert_file": "./fixtures/notary-server.crt" } @@ -70,7 +71,7 @@ Example: Description - addr + http_addr yes The TCP address (IP and port) to listen on. Examples: