Skip to content

Function: createS3PersistenceServiceFromEnv() ​

ts
function createS3PersistenceServiceFromEnv(env, overrides?): object;

Defined in: application/services/persistence/s3-persistence-env.ts:23

Creates an S3 persistence service from SIDEDOC_S3_* environment variables (ENDPOINT, BUCKET, REGION, ACCESS_KEY_ID, SECRET_ACCESS_KEY, FORCE_PATH_STYLE (default true), PERSIST_CREDENTIALS (default false)). The enabled flag comes from SIDEDOC_ENABLE_S3_PERSISTENCE (default false). Values in overrides take precedence.

Parameters ​

ParameterType
envEnvLike
overrides?Partial<S3PersistenceConfig>

Returns ​

object

getError ​

ts
getError: () => string;

Returns ​

string

provider ​

ts
provider: WorkspacePersistenceProvider;