Skip to content

Add S3_FORCE_PATH_STYLE and MinIO docs #47

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 12, 2025
Merged

Add S3_FORCE_PATH_STYLE and MinIO docs #47

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions ...ost/customize-deployment/configure-lightdash-to-use-external-object-storage.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,23 @@ To export your S3 credentials, you need to follow these steps:

Check [this guide](https://docs.aws.amazon.com/general/latest/gr/s3.html) to see what's the right `S3_ENDPOINT` for your bucket

## Configure cloud storage using MinIO

Creating a bucket in MinIO

- Login to the MinIO console and click on "Buckets" in the side bar
- Click on "Create Bucket"
- Give your bucket a name and click "Create Bucket"

Creating access credentials in MinIO

- Click on "Access Keys" in the side bar
- Click "Create access key"
- Give a name to your new access key and click "Create"
- Download the JSON file containing both your Access Key ID and Secret Access Key

MinIO needs path style bucket URLs, for this you will need to set `S3_FORCE_PATH_STYLE: true` in your environment variables.

## Configure Lightdash to use S3 credentials

Now you have the bucket and the S3 credentials for your cloud storage, you can provide the following ENV variables to Lightdash so it can use the cloud storage using S3 library
Expand Down
21 changes: 11 additions & 10 deletions self-host/customize-deployment/environment-variables.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,16 +85,17 @@ These variables enable you to control Single Sign On (SSO) functionality.

## S3

These variables allow you to configure [S3 Object Storage](/self-host/customize-deployment/configure-lightdash-to-use-external-object-storage).

| Variable | Description | Required? | Default |
| :------------------- | :----------------------------------------------- | :-------------------------------------------: | :---------: |
| `S3_ENDPOINT` | S3 endpoint for storing cached results | <Icon icon="square-check" iconType="solid" /> | |
| `S3_BUCKET` | Name of the S3 bucket for storing files | <Icon icon="square-check" iconType="solid" /> | |
| `S3_REGION` | Region where the S3 bucket is located | <Icon icon="square-check" iconType="solid" /> | |
| `S3_ACCESS_KEY` | Access key for authenticating with the S3 bucket | | |
| `S3_SECRET_KEY` | Secret key for authenticating with the S3 bucket | | |
| `S3_EXPIRATION_TIME` | Expiration time for scheduled deliveries files | | 259200 (3d) |
These variables allow you to configure [S3 Object Storage](/self-host/customize-deployment/configure-lightdash-to-use-external-object-storage).

| Variable | Description | Required? | Default |
| :-------------------- | :---------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------: | :---------: |
| `S3_ENDPOINT` | S3 endpoint for storing cached results | <Icon icon="square-check" iconType="solid" /> | |
| `S3_BUCKET` | Name of the S3 bucket for storing files | <Icon icon="square-check" iconType="solid" /> | |
| `S3_REGION` | Region where the S3 bucket is located | <Icon icon="square-check" iconType="solid" /> | |
| `S3_ACCESS_KEY` | Access key for authenticating with the S3 bucket | | |
| `S3_SECRET_KEY` | Secret key for authenticating with the S3 bucket | | |
| `S3_EXPIRATION_TIME` | Expiration time for scheduled deliveries files | | 259200 (3d) |
| `S3_FORCE_PATH_STYLE` | Force path style addressing, needed for MinIO setup e.g. `http://your.s3.domain/BUCKET/KEY` instead of `http://BUCKET.your.s3.domain/KEY` | | `false` |

## Cache

Expand Down