Datasource

This page will document the configuration options available for the datasource.

Must be one of the following values:

• local - Local file storage through a directory
• s3 - S3 compatible storage (AWS, Cloudflare R2, Minio, etc.)

DATASOURCE_TYPE=local
DATASOURCE_TYPE=s3

The directory where files will be stored. This directory must be writable by the Zipline server. If no value is provided, the default value is ./uploads which will map to the uploads directory in the Zipline root directory.

Paths are resolved relative to the Zipline root directory, so you can use ./ to specify the root directory, or even ../ to specify a directory outside of the Zipline root directory. It also supports absolute paths, such as /uploads.

DATASOURCE_LOCAL_DIRECTORY=./uploads

The access key ID for the S3 bucket.

DATASOURCE_S3_ACCESS_KEY_ID=access_key_id

The secret access key for the S3 bucket.

DATASOURCE_S3_SECRET_ACCESS_KEY=secret

The name of the S3 bucket. The bucket must have read/write access with the credentials provided. The bucket does not have to be public for Zipline to access it.

DATASOURCE_S3_BUCKET=zipline

If your S3 provider requires a specific region, you can specify it here (it will default to us-east-1). AWS, for example, requires a region to be specified.

• Cloudflare R2: Must be us-east-1 or auto - cloudflare R2 doesn't use regions since they are automatically determined, us-east-1 is an alias for auto.
• Backblaze B2: Region provided when creating your account and bucket, it may look like us-west-004.
• Hetzner Object Storage: One of fs1, nbg1, hel1.

DATASOURCE_S3_REGION=us-west-2

This option can be used if you are using a different provider other than Amazon AWS S3.

• Cloudflare R2: https://<account_id>.r2.cloudflarestorage.com
• Backblaze B2: https://s3.<region>.backblazeb2.com
• Hetzner Object Storage: https://<region>.your-objectstorage.com/

DATASOURCE_S3_ENDPOINT=https://123abc.r2.cloudflarestorage.com # Cloudflare R2
DATASOURCE_S3_ENDPOINT=https://s3.us-west-004.backblazeb2.com # Backblaze B2
DATASOURCE_S3_ENDPOINT=https://fs1.your-objectstorage.com # Hetzner Object Storage
DATASOURCE_S3_ENDPOINT=https://s3.us-west-2.amazonaws.com # AWS S3
DATASOURCE_S3_ENDPOINT=http://localhost:9000 # something like a locally hosted minio server

This option can be used if your S3 provider requires path-style requests. This isn't needed for any of the example providers you may see above, but it might be needed for something like a locally hosted minio server.

DATASOURCE_S3_FORCE_PATH_STYLE=true