mirror of https://github.com/docker/docs.git
Added documentation for the notary signer configuration file.
Signed-off-by: Ying Li <ying.li@docker.com>
This commit is contained in:
Ying Li
parent
e9d0e68b97
commit
2e8721564d
|
|
@ -0,0 +1,224 @@
|
|||
<!--[metadata]>
|
||||
+++
|
||||
title = "Notary Signer Configuration File"
|
||||
description = "Specifies the configuration file for Notary Signer"
|
||||
keywords = ["docker, notary, notary-signer, configuration"]
|
||||
[menu.main]
|
||||
parent="mn_notary"
|
||||
+++
|
||||
<![end-metadata]-->
|
||||
|
||||
# Notary Signer Configuration File
|
||||
|
||||
An example (full) server configuration file.
|
||||
|
||||
```json
|
||||
{
|
||||
"server": {
|
||||
"http_addr": ":4444",
|
||||
"grpc_addr": ":7899",
|
||||
"cert_file": "./fixtures/notary-signer.crt",
|
||||
"key_file": "./fixtures/notary-signer.key",
|
||||
"client_ca_file": "./fixtures/notary-server.crt"
|
||||
},
|
||||
"logging": {
|
||||
"level": 2
|
||||
},
|
||||
"storage": {
|
||||
"backend": "mysql",
|
||||
"db_url": "dockercondemo:dockercondemo@tcp(notarymysql:3306)/dockercondemo"
|
||||
},
|
||||
"reporting": {
|
||||
"bugsnag": {
|
||||
"api_key": "c9d60ae4c7e70c4b6c4ebd3e8056d2b8",
|
||||
"release_stage": "staging",
|
||||
"endpoint": "https://bugsnag.internal:49000/"
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## `server` section (required)
|
||||
|
||||
Example:
|
||||
|
||||
```json
|
||||
"server": {
|
||||
"http_addr": ":4444",
|
||||
"grpc_addr": ":7899",
|
||||
"cert_file": "./fixtures/notary-signer.crt",
|
||||
"key_file": "./fixtures/notary-signer.key",
|
||||
"client_ca_file": "./fixtures/notary-server.crt"
|
||||
}
|
||||
```
|
||||
<table>
|
||||
<tr>
|
||||
<th>Parameter</th>
|
||||
<th>Required</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td valign="top"><code>http_addr</code></td>
|
||||
<td valign="top">yes</td>
|
||||
<td valign="top">The TCP address (IP and port) to listen for HTTP
|
||||
traffic on. Examples:
|
||||
<ul>
|
||||
<li><code>":4444"</code> means listen on port 4444 on all IPs (and
|
||||
hence all interfaces, such as those listed when you run
|
||||
<code>ifconfig</code>)</li>
|
||||
<li><code>"127.0.0.1:4444"</code> means listen on port 4444 on
|
||||
localhost only. That means that the server will not be
|
||||
acessible except locally (via SSH tunnel, or just on a local
|
||||
terminal)</li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td valign="top"><code>grpc_addr</code></td>
|
||||
<td valign="top">yes</td>
|
||||
<td valign="top">The TCP address (IP and port) to listen for GRPC
|
||||
traffic (which Notary Server uses) on. Examples:
|
||||
<ul>
|
||||
<li><code>":7899"</code> means listen on port 7899 on all IPs (and
|
||||
hence all interfaces, such as those listed when you run
|
||||
<code>ifconfig</code>)</li>
|
||||
<li><code>"127.0.0.1:7899"</code> means listen on port 7899 on
|
||||
localhost only. That means that the server will not be
|
||||
acessible except locally (via SSH tunnel, or just on a local
|
||||
terminal)</li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td valign="top"><code>key_file</code></td>
|
||||
<td valign="top">yes</td>
|
||||
<td valign="top"> Specifies the private key to use for HTTPS.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td valign="top"><code>cert_file</code></td>
|
||||
<td valign="top">yes</td>
|
||||
<td valign="top"> Specifies the certificate to use for HTTPS.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td valign="top"><code>client_ca_file</code></td>
|
||||
<td valign="top">no</td>
|
||||
<td valign="top">The root cert (or just the public cert) to trust for
|
||||
mutual authentication. If provided, a client certificate will be
|
||||
required for any client certificates connecting to Notary Signer.
|
||||
If not provided, mutual authentication will not be required.</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
## `logging` section (optional)
|
||||
|
||||
The logging section sets the log level of the server. If not provided, or if
|
||||
any part of this section is invalid, the server defaults to an ERROR logging
|
||||
level.
|
||||
|
||||
Example:
|
||||
|
||||
```json
|
||||
"logging": {
|
||||
"level": 2
|
||||
}
|
||||
```
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<th>Parameter</th>
|
||||
<th>Required</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td valign="top"><code>level</code></td>
|
||||
<td valign="top">yes</td>
|
||||
<td valign="top">An integer between 0 and 5, representing values
|
||||
<code>"debug"</code> (5), <code>"info"</code> (4),
|
||||
<code>"warning"</code> (3), <code>"error"</code>(2),
|
||||
<code>"fatal"</code> (1), or <code>"panic"</code>(0)</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
## `storage` section (optional)
|
||||
|
||||
The storage section sets the storage options for the server. If not provided,
|
||||
an in-memory store will be used. Currently, the only DB supported is MySQL.
|
||||
|
||||
DB storage example:
|
||||
|
||||
```json
|
||||
"storage": {
|
||||
"backend": "mysql",
|
||||
"db_url": "dockercondemo:dockercondemo@tcp(notarymysql:3306)/dockercondemo"
|
||||
}
|
||||
```
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<th>Parameter</th>
|
||||
<th>Required</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td valign="top"><code>backend</code></td>
|
||||
<td valign="top">yes</td>
|
||||
<td valign="top">Must be <code>"mysql"</code>; all other values will
|
||||
result in an in-memory store (and the rest of the parameters will
|
||||
be ignored)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td valign="top"><code>db_url</code></td>
|
||||
<td valign="top">yes</td>
|
||||
<td valign="top">The URL used to access the DB, which includes both the
|
||||
endpoint anusername/credentials</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
## `reporting` section (optional)
|
||||
|
||||
The reporting section contains any configuration for reporting errors, etc. to
|
||||
services via [logrus hooks](https://github.com/Sirupsen/logrus). Currently the
|
||||
only supported services is [Bugsnag](https://bugsnag.com). (See
|
||||
[bugsnag-go](https://github.com/bugsnag/bugsnag-go/) for more information about
|
||||
configuration.
|
||||
|
||||
```json
|
||||
"reporting": {
|
||||
"bugsnag": {
|
||||
"api_key": "c9d60ae4c7e70c4b6c4ebd3e8056d2b8",
|
||||
"release_stage": "staging",
|
||||
"endpoint": "https://bugsnag.internal:49000/"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### `bugsnag` subsection (optional)
|
||||
|
||||
This section specifies parameters for Bugsnag reporting.
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<th>Parameter</th>
|
||||
<th>Required</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td valign="top"><code>api_key</code></td>
|
||||
<td valign="top">yes</td>
|
||||
<td>The API key to use to report errors - if this value is not set,
|
||||
no errors will be reported to Bugsnag.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td valign="top"><code>release_stage</code></td>
|
||||
<td valign="top">no</td>
|
||||
<td>The current release stage, such as "production" (which is the
|
||||
default), used to filter errors in the Bugsnag dashboard.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td valign="top"><code>endpoint</code></td>
|
||||
<td valign="top">no</td>
|
||||
<td>The current release stage, such as "production" (which is the
|
||||
default), used to filter errors in the Bugsnag dashboard.</td>
|
||||
</tr>
|
||||
</table>
|
||||
Loading…
Reference in New Issue