docs: rename Architectural Modules to Infrastructure Modules (#12212)

* docs: rename Architectural Modules to Infrastructure Modules * generate again
2025-04-17 13:20:43 +03:00
parent 8618e6ee38
commit eb73bdb478
149 changed files with 12165 additions and 12145 deletions
@@ -0,0 +1,107 @@
+import { Table } from "docs-ui"
+
+export const metadata = {
+  title: `Local File Module Provider`,
+}
+
+# {metadata.title}
+
+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>
+
+---
+
+## Register the Local File Module
+
+<Note>
+
+The Local File Module Provider is registered by default in your application.
+
+</Note>
+
+Add the module into the `providers` array of the File Module:
+
+<Note>
+
+The File Module accepts one provider only.
+
+</Note>
+
+```ts title="medusa-config.ts"
+import { Modules } from "@medusajs/framework/utils"
+
+// ...
+
+module.exports = {
+  // ...
+  modules: [
+    {
+      resolve: "@medusajs/medusa/file",
+      options: {
+        providers: [
+          {
+            resolve: "@medusajs/medusa/file-local",
+            id: "local",
+            options: {
+              // provider options...
+            },
+          },
+        ],
+      },
+    },
+  ],
+}
+```
+
+### Local File Module Options
+
+<Table>
+  <Table.Header>
+    <Table.Row>
+      <Table.HeaderCell>Option</Table.HeaderCell>
+      <Table.HeaderCell>Description</Table.HeaderCell>
+      <Table.HeaderCell>Default</Table.HeaderCell>
+    </Table.Row>
+  </Table.Header>
+  <Table.Body>
+    <Table.Row>
+      <Table.Cell>
+      
+      `upload_dir`
+      
+      </Table.Cell>
+      <Table.Cell>
+      
+      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>
+      
+      `static`
+      
+      </Table.Cell>
+    </Table.Row>
+    <Table.Row>
+      <Table.Cell>
+      
+      `backend_url`
+      
+      </Table.Cell>
+      <Table.Cell>
+      
+      The URL that serves the files.
+      
+      </Table.Cell>
+      <Table.Cell>
+      
+      `http://localhost:9000/static`
+      
+      </Table.Cell>
+    </Table.Row>
+  </Table.Body>
+</Table>