Workspace Provider
In Orion101, a workspace is a storage location where files are created, stored, and manipulated by users. By default, workspaces are directories on the local disk. However, for server-based or distributed applications, local storage may not be suitable. To address this, Orion101 introduces the concept of a workspace provider, which abstracts the workspace mechanism and supports alternative storage solutions.
Workspace Provider Configuration
The workspace provider is configured using the ORION101_WORKSPACE_PROVIDER_TYPE environment variable. Currently, Orion101 supports two types of workspace providers:
Directory: Stores workspaces in a local directory on the host machine.
S3: Utilizes an S3 or S3-compatible service (e.g., Cloudflare R2) as the storage backend for workspaces.
Directory Provider Configuration
If the workspace provider type is set to directory, the following configuration is available:
WORKSPACE_PROVIDER_DATA_HOME:
Specifies the root directory where workspaces will be nested. The default location is:
$XDG_CONFIG_HOME/orion101/workspace-provider
This setup is simple and ideal for local or development environments.
S3 Provider Configuration
When the workspace provider type is set to s3, the following environment variables are required for proper configuration:
AWS_ACCESS_KEY_ID:Your access key for the S3-compatible service.AWS_SECRET_ACCESS_KEY:Your secret key for the S3-compatible service.AWS_REGION:The region where your S3 bucket resides.WORKSPACE_PROVIDER_S3_BUCKET:The name of the S3 bucket to be used as the workspace storage.
Additionally, if you are using an S3-compatible service like Cloudflare R2, you must specify the following:
WORKSPACE_PROVIDER_S3_BASE_ENDPOINT: The base endpoint URL of the S3-compatible service.
Last updated