Function parseBaseS3Config

packages/backend/src/config/parseConfig.ts:804–849

()

};

export const parseBaseS3Config = (): LightdashConfig['s3'] => {
    const endpoint = process.env.S3_ENDPOINT;
    const bucket = process.env.S3_BUCKET;
    const region = process.env.S3_REGION;
    const accessKey = process.env.S3_ACCESS_KEY;
    const secretKey = process.env.S3_SECRET_KEY;
    // Browser-facing S3 endpoint used when minting presigned URLs that the
    // browser will fetch directly (e.g. PUT uploads for app images). In local
    // dev the internal Docker hostname (http://minio:9000) is unreachable from
    // the browser, so set this to http://localhost:9000. In production with
    // real S3 this is typically unnecessary — omit it and the internal endpoint
    // is used for signing, which already resolves publicly.
    const publicEndpoint = process.env.S3_PUBLIC_ENDPOINT || undefined;
    const forcePathStyle = process.env.S3_FORCE_PATH_STYLE === 'true';
    const expirationTime = parseInt(
        process.env.S3_EXPIRATION_TIME || '259200', // 3 days in seconds
        10,
    );
    const useCredentialsFromRaw = getArrayFromCommaSeparatedList(
        'S3_USE_CREDENTIALS_FROM',
    );
    const useCredentialsFrom = useCredentialsFromRaw
        .map((v) => v.trim().toLowerCase())
        .filter((v) => v.length > 0);

    if (!endpoint || !bucket || !region) {
        throw new ParseError(
            'S3-compatible storage is required. Set S3_ENDPOINT, S3_BUCKET and S3_REGION (AWS S3, GCS, MinIO, etc.) - https://docs.lightdash.com/self-host/customize-deployment/environment-variables#s3',
            {},
        );
    }

    return {
        endpoint,
        publicEndpoint,
        bucket,
        region,
        accessKey,
        secretKey,
        expirationTime,
        forcePathStyle,
        useCredentialsFrom: useCredentialsFrom.length
            ? useCredentialsFrom
            : undefined,
    };
};

export const parseResultsS3Config = (): LightdashConfig['results']['s3'] => {
    const baseS3Config = parseBaseS3Config();