SideDoc

Appearance

Interface: S3PersistenceConfig ​

Defined in: application/services/persistence/s3-persistence-provider.ts:6

Configuration for the S3-compatible persistence provider. Requests are signed with AWS Signature V4.

Properties ​

accessKeyId? ​

ts
accessKeyId?: string;

Defined in: application/services/persistence/s3-persistence-provider.ts:14

bucket? ​

ts
bucket?: string;

Defined in: application/services/persistence/s3-persistence-provider.ts:11

credentialStorageKey? ​

ts
credentialStorageKey?: string;

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

sessionStorage key used when persistCredentials is on. Defaults to sidedoc_s3_credentials.

enabled? ​

ts
enabled?: boolean;

Defined in: application/services/persistence/s3-persistence-provider.ts:8

Defaults to true.

endpoint? ​

ts
endpoint?: string;

Defined in: application/services/persistence/s3-persistence-provider.ts:10

Base endpoint URL, for example https://s3.eu-west-1.amazonaws.com. A trailing slash is removed.

forcePathStyle? ​

ts
forcePathStyle?: boolean;

Defined in: application/services/persistence/s3-persistence-provider.ts:17

Put the bucket in the URL path instead of the host name. Defaults to true.

persistCredentials? ​

ts
persistCredentials?: boolean;

Defined in: application/services/persistence/s3-persistence-provider.ts:21

Keep connection settings and keys in sessionStorage after a successful connect. Defaults to false (memory only).

region? ​

ts
region?: string;

Defined in: application/services/persistence/s3-persistence-provider.ts:13

Signing region. Defaults to auto.

secretAccessKey? ​

ts
secretAccessKey?: string;

Defined in: application/services/persistence/s3-persistence-provider.ts:15

snapshotPrefix? ​

ts
snapshotPrefix?: string;

Defined in: application/services/persistence/s3-persistence-provider.ts:19

Object key prefix for snapshots. Defaults to sidedoc-workspace-.