Ceramic Daemon options for configuring behavior related to the HTTP API.

Hierarchy

  • DaemonHTTPApiConfig

Constructors

Properties

adminDids?: string[]

An array of DIDs with access to Admin API (represented as strings). This contains the DID strings describing DIDs that be used to send requests to the Ceramic server to perform admin operations. This should not be confused with the node DID set via the "node.private-seed-url" config. When specifying in a config file, use the name 'admin-dids'.

corsAllowedOrigins?: RegExp[]

Origins to restrict access to the HTTP api to, using CORS. Leaving this unset means the api is open to all origins. When specifying in a config file, use the name 'cors-allowed-origins'.

hostname?: string

Hostname to bind to and listen on.

port?: number

Port to listen on. jsonMember type needs to be AnyT vs Number to allow for non-number instantiation of the config before type coercion and value validation is triggered via the subsequent validatePort() helper function in ceramic-daemon.ts during the daemon startup.