Skip to main content

Workspace Provider

Workspaces are where files are stored and manipulated in Obot. The default installation uses a local disk directory to provide workspaces. For production deployments, we recommend using cloud object stores like AWS S3 or Azure Blob Storage to ensure adequate storage capacity and high availability.

This section describes the configuration of the workspace provider.

Provider Type Configuration

Environment VariableDescriptionAvailable Options
OBOT_WORKSPACE_PROVIDER_TYPEThe type of provider to usedirectory, s3, azure

Note: The s3 provider is compatible with S3-compatible services like CloudFlare R2. The azure provider is for Azure Blob Storage.

Directory Provider Configuration

Environment VariableDescriptionDefault
WORKSPACE_PROVIDER_DATA_HOMEDirectory where workspaces are nested$XDG_CONFIG_HOME/obot/workspace-provider

S3 Provider Configuration

Environment VariableRequiredDescription
AWS_ACCESS_KEY_IDYesAWS access key ID
AWS_SECRET_ACCESS_KEYYesAWS secret access key
AWS_REGIONYesAWS region
WORKSPACE_PROVIDER_S3_BUCKETYesS3 bucket name
WORKSPACE_PROVIDER_S3_BASE_ENDPOINTOptional*Base endpoint URL for S3-compatible services

*Required when using S3-compatible services like CloudFlare R2

Azure Provider Configuration

Environment VariableRequiredDescription
WORKSPACE_PROVIDER_AZURE_CONTAINERYesAzure Blob Storage container name
WORKSPACE_PROVIDER_AZURE_CONNECTION_STRINGYesAzure Blob Storage connection string