Skip to content

feat: S3 support path style urls #10472

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

Open
darthhexx wants to merge 10 commits into
base: main
Choose a base branch
from
+20 −0
Open

feat: S3 support path style urls #10472

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
feba250
Expose forcePathStyle config option with a new AWS_FORCE_PATH_STYLE e…
darthhexx Nov 13, 2025
05081bc
Include the path length when substring-ing the url when using forcePa…
darthhexx Nov 13, 2025
12b2d60
Ensure an empty string if env var not set
darthhexx Feb 18, 2026
2d11668
This codepath isn't necessary
darthhexx Feb 18, 2026
18eb7ca
Lint
darthhexx Feb 18, 2026
5fe1db5
Fix typo
darthhexx Feb 18, 2026
60b6b3c
Lint spacing
darthhexx Feb 18, 2026
e1cd889
Actually use lint --fix :)
darthhexx Feb 18, 2026
af03105
Should be zero
darthhexx Feb 20, 2026
38222ba
Improve comment and no need for double forcePathStyle
darthhexx Feb 20, 2026
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
16 changes: 16 additions & 0 deletions api/server/services/Files/S3/crud.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,12 @@
DeleteObjectCommand,
} = require('@aws-sdk/client-s3');

const endpoint = process.env.AWS_ENDPOINT_URL;
const bucketName = process.env.AWS_BUCKET_NAME;
const defaultBasePath = 'images';
const forcePathStyle = ['1', 'true', 'yes'].includes(
(process.env.AWS_FORCE_PATH_STYLE ?? '').toLowerCase(),
);

let s3UrlExpirySeconds = 2 * 60; // 2 minutes
let s3RefreshExpiryMs = null;
Expand Down Expand Up @@ -252,8 +256,20 @@

try {
const url = new URL(fileUrlOrKey);

if (endpoint?.trim() && forcePathStyle) {
const endpointUrl = new URL(endpoint);
const startPos =
endpointUrl.pathname.length +
(endpointUrl.pathname.endsWith('/') ? 0 : 1) +
bucketName.length +
1;

return url.pathname.substring(startPos);
}

return url.pathname.substring(1);
} catch (error) {

Check warning on line 272 in api/server/services/Files/S3/crud.js

View workflow job for this annotation

GitHub Actions / Run ESLint Linting 

'error' is defined but never used. Allowed unused caught errors must match /^_/u
const parts = fileUrlOrKey.split('/');

if (parts.length >= 3 && !fileUrlOrKey.startsWith('http') && !fileUrlOrKey.startsWith('/')) {
Expand Down
4 changes: 4 additions & 0 deletions packages/api/src/cdn/s3.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,13 @@ export const initializeS3 = (): S3Client | null => {
const endpoint = process.env.AWS_ENDPOINT_URL;
const accessKeyId = process.env.AWS_ACCESS_KEY_ID;
const secretAccessKey = process.env.AWS_SECRET_ACCESS_KEY;
const forcePathStyle = ['1', 'true', 'yes'].includes(
(process.env.AWS_FORCE_PATH_STYLE ?? '').toLowerCase(),
);

const config = {
region,
forcePathStyle, // Conditionally enable path-style addressing
// Conditionally add the endpoint if it is provided
...(endpoint ? { endpoint } : {}),
};
Expand Down