Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • http is the configuration object for the http server
    • publicEndpoint is the URL of the gateway protocol://fqdn:port, which must be accessible in the deployment environment
    • bindAddr is the bind address for the service
    • bindPort is the tcp port for the service
  • web is the configuration object for the GUI web-server
    • bindAddr is the bind address for the Web GUI
    • bindPort is the tcp port for the Web GUI
    • staticDir is the directory where Web GUI source files are located
  • registry.backend is the configuration object for the backend of Registry API
    • type is the registry backend type: Supported backends are memoryleveldb
    • dsn is the Data Source Name for storage backend (ignored for memory, "file:///path/to/ldb" for leveldb)
  • data.backend is the configuration object for the backend of Data API
    • data.backend.type is the data backend type: Supported backend(s) are influxdbmongodb
    • data.backend.dsn is the Data Source Name for storage backend
  • aggregation is currently ignored
  • serviceCatalog is an array of Service Catalogs. The Historical Datastore will be published as a service to each configured Service Catalog (if not empty)
    • discover is a flag enabling automatic discovery of the Service Catalog using DNS-SD
    • endpoint is the URL of the remote Service Catalog API (http://address:port/path)
    • ttl is the TTL for the service registration

...

The auth field configures the Authentication for Historical Datastore:

...

  • enabled is a boolean flag enabling/disabling the authentication
  • provider is the name of a supported auth provider
  • providerURL is the URL of the auth provider endpoint
  • serviceID is the ID of the service in the authentication provider (used for validating auth tokens provided by the clients)
  • basicEnabled is a boolean flag enabling/disabling the Basic Authentication
  • authorization - optional, see authorization configuation

To publish the Historical Datastore to an authenticated Service Catalog, the auth field of that catalog should be set:

...

Sample configuration file (with authentication): historical-datastore-auth.json

LinkSmart Integration

See LinkSmart Integration