lukechilds
/
docs
mirror of https://github.com/lukechilds/docs.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

Updating the configuration reference 

Signed-off-by: Mary Anthony <mary@blockstack.com>
feat/clarity-updates
Mary Anthony 5 years ago
parent
f88737a785
commit
2d4b41958d
1 changed files with 209 additions and 95 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 260
      _storage/config-schema.md

260
_storage/config-schema.md
View File

@ -5,103 +5,217 @@ permalink: /:collection/:path.html
---
# Hub configuration parameters
The following JSON schema details the possible parameters for a hub configuration:
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"servername": { "type": "string" },
"port": { "type": "integer" },
"driver": { "type": "string" },
"bucket": { "type": "string" },
"readURL": { "type": "string" },
"requireCorrectHubUrl": { "type": "string" },
"awsCredentials": {
"type": "object",
"argsTransport": {
"additionalProperties": false,
"properties": {
"endpoint": { "type": "string"},
"accessKeyId": { "type": "string"},
"secretAccessKey": { "type": "string"}
"colorize": {
"default": true,
"type": "boolean"
},
"required": [
"endpoint",
"accessKeyId",
"secretAccessKey"
]
"handleExceptions": {
"default": true,
"type": "boolean"
},
"proofsConfig": {
"type": "object",
"json": {
"default": false,
"type": "boolean"
},
"level": {
"default": "warn",
"enum": [
"debug",
"error",
"info",
"verbose",
"warn"
],
"type": "string"
},
"timestamp": {
"default": true,
"type": "boolean"
}
},
"type": "object"
},
"authTimestampCacheSize": {
"default": 50000,
"type": "integer"
},
"awsCredentials": {
"additionalProperties": false,
"description": "Required if `driver` is `aws`",
"properties": {
"proofsRequired": { "type": "string"}
"accessKeyId": {
"type": "string"
},
"required": [
"proofsRequired"
]
"endpoint": {
"type": "string"
},
"secretAccessKey": {
"type": "string"
},
"sessionToken": {
"type": "string"
}
},
"type": "object"
},
"azCredentials": {
"type": "object",
"additionalProperties": false,
"description": "Required if `driver` is `azure`",
"properties": {
"accountName": { "type": "string"},
"accountKey": { "type": "string"}
"accountKey": {
"type": "string"
},
"required": [
"accountName",
"accountKey"
]
"accountName": {
"type": "string"
}
},
"gcCredentials": {
"type": "object",
"properties": {
"keyFilename": { "type": "string"}
"type": "object"
},
"required": [
"keyFilename"
]
"bucket": {
"default": "hub",
"type": "string"
},
"cacheControl": {
"default": "public, max-age=1",
"type": "string"
},
"diskSettings": {
"type": "object",
"additionalProperties": false,
"description": "Required if `driver` is `disk`",
"properties": {
"storageRootDirectory": { "type": "string"}
"storageRootDirectory": {
"type": "string"
}
},
"required": [
"storageRootDirectory"
]
"type": "object"
},
"pageSize": { "type": "integer"},
"argsTransport": {
"type": "object",
"driver": {
"enum": [
"aws",
"azure",
"disk",
"google-cloud"
],
"type": "string"
},
"gcCredentials": {
"additionalProperties": false,
"description": "Required if `driver` is `google-cloud`",
"properties": {
"level": { "type": "string"},
"handleExceptions": { "type": "boolean" },
"stringify": { "type": "boolean" },
"timestamp": { "type": "boolean" },
"colorize": { "type": "boolean" },
"json":{ "type": "boolean" }
"credentials": {
"additionalProperties": false,
"properties": {
"client_email": {
"type": "string"
},
"required": [
"level",
"handleExceptions",
"stringify",
"timestamp",
"colorize",
"json"
]
"private_key": {
"type": "string"
}
},
"type": "object"
},
"email": {
"type": "string"
},
"keyFilename": {
"type": "string"
},
"projectId": {
"type": "string"
}
},
"type": "object"
},
"maxFileUploadSize": {
"default": 20,
"description": "The maximum allowed POST body size in megabytes. \nThe content-size header is checked, and the POST body stream \nis monitoring while streaming from the client. \n[Recommended] Minimum 100KB (or approximately 0.1MB)",
"minimum": 0.1,
"type": "number"
},
"pageSize": {
"default": 100,
"maximum": 4096,
"minimum": 1,
"type": "integer"
},
"port": {
"default": 3000,
"maximum": 65535,
"minimum": 0,
"type": "integer"
},
"proofsConfig": {
"additionalProperties": false,
"properties": {
"proofsRequired": {
"default": 0,
"type": "integer"
}
},
"type": "object"
},
"readURL": {
"type": "string"
},
"requireCorrectHubUrl": {
"default": false,
"type": "boolean"
},
"serverName": {
"default": "gaia-0",
"description": "Domain name used for auth/signing challenges. \nIf `requireCorrectHubUrl` is true then this must match the hub url in an auth payload.",
"type": "string"
},
"validHubUrls": {
"description": "If `requireCorrectHubUrl` is true then the hub specified in an auth payload can also be\ncontained within in array.",
"items": {
"type": "string"
},
"type": "array"
},
"whitelist": {
"description": "List of ID addresses allowed to use this hub. Specifying this makes the hub private \nand only accessible to the specified addresses. Leaving this unspecified makes the hub \npublicly usable by any ID.",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"servername",
"port",
"driver",
"bucket",
"readURL",
"requireCorrectHubUrl",
"awsCredentials",
"proofsConfig",
"azCredentials",
"gcCredentials",
"diskSettings",
"pageSize",
"argsTransport"
]
"port"
],
"type": "object"
}
```
The following is an simple example of a Gaia hub configuration:
```json
{
"port": 3000,
"driver": "",
"bucket": "",
"readURL": "",
"argsTransport": {
"level": "debug",
"handleExceptions": true,
"timestamp": true,
"colorize": false,
"json": true
}
}
```
A full list of example can be found in [the Gaia repository on GitHub](https://github.com/blockstack/gaia/tree/master/hub).
Write Preview
Loading…
Cancel
Save