Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.keephq.dev/llms.txt

Use this file to discover all available pages before exploring further.

Keep supports various deployment and provisioning strategies to accommodate different environments and use cases, from development setups to production deployments.

​
Provisioning Options

Keep offers three main provisioning options:
  1. Provider Provisioning - Set up and manage data providers with their deduplication rules for Keep.
  2. Workflow Provisioning - Configure and manage workflows within Keep.
  3. Dashboard Provisioning - Configure and manage dashboards within Keep.
Choosing the right provisioning strategy depends on your specific use case, deployment environment, and scalability requirements. You can read more about each provisioning option in their respective sections.

​
How To Configure Provisioning

Some provisioning options require additional environment variables. These will be covered in detail on the specific provisioning pages.
Provisioning in Keep is controlled through environment variables and configuration files. The main environment variables for provisioning are:
Provisioning TypeEnvironment VariablePurpose
ProviderKEEP_PROVIDERSJSON string containing provider configurations with deduplication rules
WorkflowKEEP_WORKFLOWOne workflow to provision right from the env variable.
WorkflowsKEEP_WORKFLOWS_DIRECTORYDirectory path containing workflow configuration files
DashboardKEEP_DASHBOARDSJSON string containing dashboard configurations
Hint: use the script to get 1-liner from the workflow file for KEEP_WORKFLOW: 
Use `cat workflow_file.yaml | awk '{printf "%s\\n", $0}' | tr -d '\n'; echo` to get the workflow in 1-string format.
For more details on each provisioning strategy, including setup instructions and implications, refer to the respective sections.