Skip to content

dapi.md

Latest commit

 

History

History
36 lines (28 loc) · 1.65 KB

dapi.md

File metadata and controls

36 lines (28 loc) · 1.65 KB
Raw

DAPI Configuration

DAPI provides API services for Dash Platform, allowing external applications to interact with the platform.

Docker

Option Description Default Example
platform.dapi.api.docker.image Docker image for DAPI dashpay/dapi:${version} dashpay/dapi:latest
platform.dapi.api.docker.build.enabled Enable custom build false true
platform.dapi.api.docker.build.context Build context directory null "/path/to/context"
platform.dapi.api.docker.build.dockerFile Path to Dockerfile null "/path/to/Dockerfile"
platform.dapi.api.docker.build.target Target build stage in multi-stage builds null "dapi"
platform.dapi.api.docker.deploy.replicas Number of DAPI replicas 1 3

The docker.build object allows for custom build settings:

{
  "build": {
    "enabled": true,
    "context": "/path/to/build/context",
    "dockerFile": "/path/to/Dockerfile",
    "target": "dapi"
  }
}

These settings allow you to build the DAPI API Docker image from source. If enabled is set to true, Dashmate will build the Docker image using the specified context directory and Dockerfile.

Other

Option Description Default Example
platform.dapi.api.waitForStResultTimeout Timeout for state transitions (ms) 120000 240000

This timeout setting controls how long DAPI will wait for state transition results before returning a timeout error to the client. It is specified in milliseconds.