Customize the Notation configuration file

This guide demonstrates how to customize the Notation system configuration in config.json and signing key in signingkeys.json respectively. By default, you don’t need to create or modify them since Notation has default system settings and signing key configuration unless you want to customize them.

Location

The configuration file config.json location is different per operating system. signingkeys.json will be generated and stored in the same directory with config.json. You can use the Notation CLI or libraries to alter locations through the XDG_CONFIG_HOME environment variable.

Linux

config.json should be manually created and placed in ~/.config/notation/config.json.

Windows

config.json should be manually created and placed in ~/AppData/Roaming/notation/config.json.

Darwin / macOS

config.json should be manually created and placed in ~/Library/Application Support/notation/config.json.

Sample of config.json

You can follow the example below to customize the Notation configuration in config.json

{
    "credsStore": "pass",
    "credHelpers": {
        "registry.io": "pass"
    },
    "signatureFormat": "jws",
    "insecureRegistries": [
        "registry.wabbit-networks.io"
    ]
}

This table explains the properties in config.json.

Sample of signingkeys.json

Users only needs to interact with notation key command, which will generate/update this signingkeys.json file. An example of generated signingkeys.json is shown below.

{
    "default": "wabbit-networks",
    "keys": [
        {
            "name": "wabbit-networks",
            "id": "some-remote-key-id",
            "pluginName": "io.cncf.notary.v2.some.plugin"
        },
        {
            "name": "import.acme-rockets",
            "keyPath": "/home/demo/.config/notation/localkeys/import.acme-rockets.key",
            "certPath": "/home/demo/.config/notation/localkeys/import.acme-rockets.crt"
        }
    ]
}

This table explains the properties in signingkeys.json.