Skip to main content

Configuration

A sample .env file is located in the storage repository.

Use this file to configure your environment variables for your Storage server.

General​

ANON_KEY​

A long-lived JWT with anonymous Postgres privileges.

  • Required: true
  • Default: None

SERVICE_KEY​

A long-lived JWT with Postgres privileges to bypass Row Level Security.

  • Required: true
  • Default: None

TENANT_ID​

The ID of a Storage tenant.

  • Required: true
  • Default: None

REGION​

Region of your S3 bucket.

  • Required: true
  • Default: None

GLOBAL_S3_BUCKET​

Name of your S3 bucket.

  • Required: true
  • Default: None

POSTGREST_URL​

The URL of your PostgREST server.

  • Required: true
  • Default: None

PGRST_JWT_SECRET​

A JWT Secret for the PostgREST database.

  • Required: true
  • Default: None

DATABASE_URL​

The URL of your Postgres database.

  • Required: true
  • Default: None

PGOPTIONS​

Additional configuration parameters for Postgres startup.

  • Required: true
  • Default: None

FILE_SIZE_LIMIT​

The maximum file size allowed.

  • Required: true
  • Default: None

STORAGE_BACKEND​

The storage provider.

  • Required: true
  • Default: None

FILE_STORAGE_BACKEND_PATH​

The location storage when the "STORAGE_BACKEND" is set to "file".

  • Required: true
  • Default: None

Multi-tenant​

IS_MULTITENANT​

Operate across multiple tenants.

  • Required: true
  • Default: None

MULTITENANT_DATABASE_URL​

The URL of the multitenant Postgres database.

  • Required: true
  • Default: None

X_FORWARDED_HOST_REGEXP​

TBD.

  • Required: true
  • Default: None

POSTGREST_URL_SUFFIX​

The suffix for the PostgREST instance.

  • Required: true
  • Default: None

ADMIN_API_KEYS​

Secure API key for administrative endpoints.

  • Required: true
  • Default: None

ENCRYPTION_KEY​

An key for encryting/decrypting secrets.

  • Required: true
  • Default: None