# Secret frameworks

## `http-header`

| Name | default | Description |
| --- | --- | --- |
| `allow-http` | `false` | When set to true, this secret can be transmitted over an insecure HTTP connection.  Setting this to true can expose your secret to others on the network, and is not advised for use outside of a private network. |
| `allow-subdomains` | `false` | Use this secret with subdomains of the `hostname` it applies to.  For example, if `hostname` is `riskscape.nz`, then the secret will also apply to `sites.riskscape.nz`. |
| `header-name` |  | The name of the HTTP header to add, e.g. `Authorization` |
| `hostname` |  | The `hostname` of the remote server that this secret applies to, i.e. this secret is used for authenticating with this server. If not provided the INI file section header, .e.g. `[riskscape.nz]` will be used instead. |
| `id` |  | Identifies this secret uniquely.  This is taken from the INI file section header, .e.g. `[riskscape.nz]` |
| `secret-header-value` |  | The actual secret value to pass in the header, such as an API token. |
Use an HTTP header to authenticate.  A well known header is used to pass your secret to the server each time you fetch data from the server.

## `koordinates`

| Name | default | Description |
| --- | --- | --- |
| `allow-http` | `false` | When set to true, this secret can be transmitted over an insecure HTTP connection.  Setting this to true can expose your secret to others on the network, and is not advised for use outside of a private network. |
| `allow-subdomains` | `false` | Use this secret with subdomains of the `hostname` it applies to.  For example, if `hostname` is `riskscape.nz`, then the secret will also apply to `sites.riskscape.nz`. |
| `api-key` |  |  |
| `hostname` |  | The `hostname` of the remote server that this secret applies to, i.e. this secret is used for authenticating with this server. If not provided the INI file section header, .e.g. `[riskscape.nz]` will be used instead. |
| `id` |  | Identifies this secret uniquely.  This is taken from the INI file section header, .e.g. `[riskscape.nz]` |


## `platform`

| Name | default | Description |
| --- | --- | --- |
| `allow-http` | `false` | When set to true, this secret can be transmitted over an insecure HTTP connection.  Setting this to true can expose your secret to others on the network, and is not advised for use outside of a private network. |
| `allow-subdomains` | `false` | Use this secret with subdomains of the `hostname` it applies to.  For example, if `hostname` is `riskscape.nz`, then the secret will also apply to `sites.riskscape.nz`. |
| `hostname` | `riskscape.nz` | The `hostname` of the remote server that this secret applies to, i.e. this secret is used for authenticating with this server. |
| `id` |  | Identifies this secret uniquely.  This is taken from the INI file section header, .e.g. `[riskscape.nz]` |
| `token` |  | Your RiskScape Platform `WebDAV` token.  Get one from from https://riskscape.nz/user/profile. |
Use a WebDAV Token for accessing files stored in the RiskScape Platform.