Skip to content
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

docs: updates to local file module provider documentation #8030

Merged
merged 3 commits into from
Jul 9, 2024
Merged

docs: updates to local file module provider documentation #8030

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a3eb2c0
docs: updates to local file module provider documentation
shahednasser Jul 9, 2024
bf6c049
Merge branch 'develop' into docs/file-provider-changes
shahednasser Jul 9, 2024
72b5cd8
Merge branch 'develop' into docs/file-provider-changes
shahednasser Jul 9, 2024
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: 11 additions & 5 deletions www/apps/resources/app/architectural-modules/file/local/page.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,12 @@ export const metadata = {

The Local File Module Provider stores files uploaded to your Medusa application in the `/uploads` directory.

<Note type="warning">

The Local File Module Provider is only for development purposes. Use the [S3 File Module Provider](../s3/page.mdx) in production instead.

</Note>

---

## Install the Local File Module
Expand Down Expand Up @@ -77,29 +83,29 @@ module.exports = {
</Table.Cell>
<Table.Cell>

The directory to upload files to.
The directory to upload files to. Medusa exposes the content of the `static` directory publically. If you change the directory, it must be served and publically accessible.

</Table.Cell>
<Table.Cell>

`uploads`
`static`

</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>

`upload_dir`
`backend_url`

</Table.Cell>
<Table.Cell>

The URL of the Medusa application.
The URL that serves the files.

</Table.Cell>
<Table.Cell>

`http://localhost:9000`
`http://localhost:9000/static`

</Table.Cell>
</Table.Row>
Expand Down
Loading