moved configurations page
This commit is contained in:
Shahed Nasser committed
1 parent
5a5da0d6a1
commit
ac989a6ed1
30 files changed
+11817
-9814
No files matched your search
File diff suppressed because it is too large.
Load diff
File renamed without changes.
@@ -51,7 +51,7 @@ The `workerMode` configuration determines which mode the Medusa application runs
|
||||
|
||||
When you deploy the Medusa application, you deploy two instances: one in server mode, and one in worker mode.
|
||||
|
||||
Learn more about the `workerMode` configuration in [this document](!resources!/references/medusa-config#workermode).
|
||||
Learn more about the `workerMode` configuration in [this document](../../configurations/medusa-config/page.mdx#workermode).
|
||||
|
||||
So, add the following configuration in `medusa-config.ts`:
|
||||
|
||||
@@ -87,7 +87,7 @@ The `redisUrl` configuration specifies the connection URL to Redis to store the
|
||||
|
||||
<Note>
|
||||
|
||||
Learn more in the [Medusa Configuration documentation](!resources!/references/medusa-config#redisurl).
|
||||
Learn more in the [Medusa Configuration documentation](../../configurations/medusa-config/page.mdx#redisurl).
|
||||
|
||||
</Note>
|
||||
|
||||
|
||||
@@ -146,9 +146,9 @@ You may need to retrieve data before your component is rendered, or you may need
|
||||
|
||||
In your admin customizations, you can use the following global variables:
|
||||
|
||||
- `__BASE__`: The base path of the Medusa Admin, as set in the [admin.path](!resources!/references/medusa-config#path) configuration in `medusa-config.ts`.
|
||||
- `__BACKEND_URL__`: The URL to the Medusa backend, as set in the [admin.backendUrl](!resources!/references/medusa-config#backendurl) configuration in `medusa-config.ts`.
|
||||
- `__STOREFRONT_URL__`: The URL to the storefront, as set in the [admin.storefrontUrl](!resources!/references/medusa-config#storefrontUrl) configuration in `medusa-config.ts`.
|
||||
- `__BASE__`: The base path of the Medusa Admin, as set in the [admin.path](../../../configurations/medusa-config/page.mdx#path) configuration in `medusa-config.ts`.
|
||||
- `__BACKEND_URL__`: The URL to the Medusa backend, as set in the [admin.backendUrl](../../../configurations/medusa-config/page.mdx#backendurl) configuration in `medusa-config.ts`.
|
||||
- `__STOREFRONT_URL__`: The URL to the storefront, as set in the [admin.storefrontUrl](../../../configurations/medusa-config/page.mdx#storefrontUrl) configuration in `medusa-config.ts`.
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -36,7 +36,7 @@ This allows the `http://localhost:7001` origin to access the Admin API Routes, a
|
||||
|
||||
<Note title="Tip">
|
||||
|
||||
Learn more about the CORS configurations in [this resource guide](!resources!/references/medusa-config#http).
|
||||
Learn more about the CORS configurations in [this resource guide](../../../configurations/medusa-config/page.mdx#http).
|
||||
|
||||
</Note>
|
||||
|
||||
|
||||
@@ -117,7 +117,7 @@ The Medusa application uses the following predefined environment variables that
|
||||
|
||||
<Note title="Tip">
|
||||
|
||||
You should opt for setting configurations in `medusa-config.ts` where possible. For a full list of Medusa configurations, refer to [this documenation](!resources!/references/medusa-config).
|
||||
You should opt for setting configurations in `medusa-config.ts` where possible. For a full list of Medusa configurations, refer to the [Medusa Configurations chapter](../../configurations/medusa-config/page.mdx).
|
||||
|
||||
</Note>
|
||||
|
||||
@@ -143,49 +143,49 @@ You should opt for setting configurations in `medusa-config.ts` where possible.
|
||||
<Table.Row>
|
||||
<Table.Cell>`DATABASE_URL`</Table.Cell>
|
||||
<Table.Cell>
|
||||
The URL to connect to the PostgreSQL database. Only used if [projectConfig.databaseUrl](!resources!/references/medusa-config#databaseurl) isn't set in `medusa-config.ts`.
|
||||
The URL to connect to the PostgreSQL database. Only used if [projectConfig.databaseUrl](../../configurations/medusa-config/page.mdx#databaseurl) isn't set in `medusa-config.ts`.
|
||||
</Table.Cell>
|
||||
<Table.Cell> `postgres://localhost/medusa-starter-default` </Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>`STORE_CORS`</Table.Cell>
|
||||
<Table.Cell>
|
||||
URLs of storefronts that can access the Medusa backend's Store APIs. Only used if [projectConfig.http.storeCors](!resources!/references/medusa-config#http-storeCors-1-1) isn't set in `medusa-config.ts`.
|
||||
URLs of storefronts that can access the Medusa backend's Store APIs. Only used if [projectConfig.http.storeCors](../../configurations/medusa-config/page.mdx#http-storeCors-1-1) isn't set in `medusa-config.ts`.
|
||||
</Table.Cell>
|
||||
<Table.Cell> `http://localhost:8000` </Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>`ADMIN_CORS`</Table.Cell>
|
||||
<Table.Cell>
|
||||
URLs of admin dashboards that can access the Medusa backend's Admin APIs. Only used if [projectConfig.http.adminCors](!resources!/references/medusa-config#http-adminCors-1-2) isn't set in `medusa-config.ts`.
|
||||
URLs of admin dashboards that can access the Medusa backend's Admin APIs. Only used if [projectConfig.http.adminCors](../../configurations/medusa-config/page.mdx#http-adminCors-1-2) isn't set in `medusa-config.ts`.
|
||||
</Table.Cell>
|
||||
<Table.Cell> `http://localhost:7000,http://localhost:7001,http://localhost:5173` </Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>`AUTH_CORS`</Table.Cell>
|
||||
<Table.Cell>
|
||||
URLs of clients that can access the Medusa backend's authentication routes. Only used if [projectConfig.http.authCors](!resources!/references/medusa-config#http-authCors-1-0) isn't set in `medusa-config.ts`.
|
||||
URLs of clients that can access the Medusa backend's authentication routes. Only used if [projectConfig.http.authCors](../../configurations/medusa-config/page.mdx#http-authCors-1-0) isn't set in `medusa-config.ts`.
|
||||
</Table.Cell>
|
||||
<Table.Cell> `http://localhost:7000,http://localhost:7001,http://localhost:5173` </Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>`JWT_SECRET`</Table.Cell>
|
||||
<Table.Cell>
|
||||
A random string used to create authentication tokens in the http layer. Only used if [projectConfig.http.jwtSecret](!resources!/references/medusa-config#http-jwtSecret-1-3) isn't set in `medusa-config.ts`.
|
||||
A random string used to create authentication tokens in the http layer. Only used if [projectConfig.http.jwtSecret](../../configurations/medusa-config/page.mdx#http-jwtSecret-1-3) isn't set in `medusa-config.ts`.
|
||||
</Table.Cell>
|
||||
<Table.Cell> \- </Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>`COOKIE_SECRET`</Table.Cell>
|
||||
<Table.Cell>
|
||||
A random string used to create cookie tokens in the http layer. Only used if [projectConfig.http.cookieSecret](!resources!/references/medusa-config#http-cookieSecret-1-5) isn't set in `medusa-config.ts`.
|
||||
A random string used to create cookie tokens in the http layer. Only used if [projectConfig.http.cookieSecret](../../configurations/medusa-config/page.mdx#http-cookieSecret-1-5) isn't set in `medusa-config.ts`.
|
||||
</Table.Cell>
|
||||
<Table.Cell> \- </Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>`MEDUSA_BACKEND_URL`</Table.Cell>
|
||||
<Table.Cell>
|
||||
The URL to the Medusa backend. Only used if [admin.backendUrl](!resources!/references/medusa-config#backendurl) isn't set in `medusa-config.ts`.
|
||||
The URL to the Medusa backend. Only used if [admin.backendUrl](../../configurations/medusa-config/page.mdx#backendurl) isn't set in `medusa-config.ts`.
|
||||
</Table.Cell>
|
||||
<Table.Cell> \- </Table.Cell>
|
||||
</Table.Row>
|
||||
|
||||
@@ -126,7 +126,7 @@ This directory is the central place for your custom development. It includes the
|
||||
|
||||
### medusa-config.ts
|
||||
|
||||
This file holds your [Medusa configurations](!resources!/references/medusa-config), such as your PostgreSQL database configurations.
|
||||
This file holds your [Medusa configurations](../configurations/medusa-config/page.mdx), such as your PostgreSQL database configurations.
|
||||
|
||||
|
||||
---
|
||||
@@ -135,7 +135,7 @@ This file holds your [Medusa configurations](!resources!/references/medusa-confi
|
||||
|
||||
By default, your Medusa application is equipped with the basic configuration to start your development.
|
||||
|
||||
If you run into issues with configurations, such as CORS configurations, or need to make changes to the default configuration, refer to [this guide on all available configurations](!resources!/references/medusa-config).
|
||||
If you run into issues with configurations, such as CORS configurations, or need to make changes to the default configuration, refer to [this guide on all available configurations](../configurations/medusa-config/page.mdx).
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -48,8 +48,8 @@ export const generatedEditDates = {
|
||||
"app/learn/fundamentals/scheduled-jobs/execution-number/page.mdx": "2024-10-21T13:30:21.371Z",
|
||||
"app/learn/fundamentals/api-routes/parameters/page.mdx": "2025-02-14T08:34:03.184Z",
|
||||
"app/learn/fundamentals/api-routes/http-methods/page.mdx": "2024-10-21T13:30:21.367Z",
|
||||
"app/learn/fundamentals/admin/tips/page.mdx": "2025-03-06T07:30:06.322Z",
|
||||
"app/learn/fundamentals/api-routes/cors/page.mdx": "2024-12-09T13:04:04.357Z",
|
||||
"app/learn/fundamentals/admin/tips/page.mdx": "2025-03-11T08:54:12.028Z",
|
||||
"app/learn/fundamentals/api-routes/cors/page.mdx": "2025-03-11T08:54:26.281Z",
|
||||
"app/learn/fundamentals/admin/ui-routes/page.mdx": "2025-02-24T09:35:11.752Z",
|
||||
"app/learn/fundamentals/api-routes/middlewares/page.mdx": "2025-03-04T10:16:15.029Z",
|
||||
"app/learn/fundamentals/modules/isolation/page.mdx": "2024-12-09T11:02:38.087Z",
|
||||
@@ -100,14 +100,13 @@ export const generatedEditDates = {
|
||||
"app/learn/introduction/architecture/page.mdx": "2025-01-16T10:25:10.780Z",
|
||||
"app/learn/fundamentals/data-models/infer-type/page.mdx": "2024-12-09T15:54:08.713Z",
|
||||
"app/learn/fundamentals/custom-cli-scripts/seed-data/page.mdx": "2024-12-09T14:38:06.385Z",
|
||||
"app/learn/fundamentals/environment-variables/page.mdx": "2025-03-06T07:30:22.986Z",
|
||||
"app/learn/fundamentals/environment-variables/page.mdx": "2025-03-11T08:55:03.343Z",
|
||||
"app/learn/build/page.mdx": "2024-12-09T11:05:17.383Z",
|
||||
"app/learn/deployment/general/page.mdx": "2025-03-06T09:15:35.452Z",
|
||||
"app/learn/deployment/general/page.mdx": "2025-03-11T08:53:37.292Z",
|
||||
"app/learn/fundamentals/workflows/multiple-step-usage/page.mdx": "2024-11-25T16:19:32.169Z",
|
||||
"app/learn/installation/page.mdx": "2025-01-31T13:16:57.883Z",
|
||||
"app/learn/installation/page.mdx": "2025-03-11T08:55:12.967Z",
|
||||
"app/learn/fundamentals/data-models/check-constraints/page.mdx": "2024-12-06T14:34:50.384Z",
|
||||
"app/learn/fundamentals/module-links/link/page.mdx": "2025-01-06T09:27:25.604Z",
|
||||
"app/learn/conventions/ts-aliases/page.mdx": "2025-01-23T15:01:15.403Z",
|
||||
"app/learn/fundamentals/workflows/store-executions/page.mdx": "2025-02-11T15:56:03.835Z",
|
||||
"app/learn/fundamentals/plugins/create/page.mdx": "2025-02-12T15:48:25.439Z",
|
||||
"app/learn/fundamentals/plugins/page.mdx": "2025-01-22T10:14:10.433Z",
|
||||
@@ -119,5 +118,7 @@ export const generatedEditDates = {
|
||||
"app/learn/fundamentals/admin/routing/page.mdx": "2025-02-24T09:50:37.495Z",
|
||||
"app/learn/resources/contribution-guidelines/admin-translations/page.mdx": "2025-02-11T16:57:46.726Z",
|
||||
"app/learn/resources/contribution-guidelines/docs/page.mdx": "2025-03-06T09:32:26.010Z",
|
||||
"app/learn/resources/usage/page.mdx": "2025-02-26T13:35:34.824Z"
|
||||
"app/learn/resources/usage/page.mdx": "2025-02-26T13:35:34.824Z",
|
||||
"app/learn/configurations/medusa-config/page.mdx": "2025-03-11T08:50:04.239Z",
|
||||
"app/learn/configurations/ts-aliases/page.mdx": "2025-02-11T16:57:46.683Z"
|
||||
}
|
||||
@@ -6,7 +6,6 @@ export const generatedSidebars = [
|
||||
{
|
||||
"loaded": true,
|
||||
"isPathHref": true,
|
||||
"initialOpen": false,
|
||||
"type": "category",
|
||||
"title": "1. Get Started",
|
||||
"children": [
|
||||
@@ -47,7 +46,6 @@ export const generatedSidebars = [
|
||||
{
|
||||
"loaded": true,
|
||||
"isPathHref": true,
|
||||
"initialOpen": false,
|
||||
"type": "category",
|
||||
"title": "2. Customization Tutorial",
|
||||
"children": [
|
||||
@@ -232,7 +230,6 @@ export const generatedSidebars = [
|
||||
{
|
||||
"loaded": true,
|
||||
"isPathHref": true,
|
||||
"initialOpen": false,
|
||||
"type": "category",
|
||||
"title": "3. Framework",
|
||||
"children": [
|
||||
@@ -912,7 +909,6 @@ export const generatedSidebars = [
|
||||
{
|
||||
"loaded": true,
|
||||
"isPathHref": true,
|
||||
"initialOpen": false,
|
||||
"type": "category",
|
||||
"title": "4. Admin Development",
|
||||
"children": [
|
||||
@@ -1006,13 +1002,11 @@ export const generatedSidebars = [
|
||||
"children": [],
|
||||
"number": "5."
|
||||
}
|
||||
],
|
||||
"initialOpen": false
|
||||
]
|
||||
},
|
||||
{
|
||||
"loaded": true,
|
||||
"isPathHref": true,
|
||||
"initialOpen": false,
|
||||
"type": "category",
|
||||
"title": "6. Configurations",
|
||||
"children": [
|
||||
@@ -1026,6 +1020,16 @@ export const generatedSidebars = [
|
||||
"chapterTitle": "6.1. Environment Variables",
|
||||
"number": "6.1."
|
||||
},
|
||||
{
|
||||
"loaded": true,
|
||||
"isPathHref": true,
|
||||
"type": "link",
|
||||
"title": "Medusa Configuations",
|
||||
"path": "/learn/configurations/medusa-config",
|
||||
"children": [],
|
||||
"chapterTitle": "6.2. Medusa Configuations",
|
||||
"number": "6.2."
|
||||
},
|
||||
{
|
||||
"loaded": true,
|
||||
"isPathHref": true,
|
||||
@@ -1033,8 +1037,8 @@ export const generatedSidebars = [
|
||||
"title": "Type Aliases",
|
||||
"path": "/learn/conventions/ts-aliases",
|
||||
"children": [],
|
||||
"chapterTitle": "6.2. Type Aliases",
|
||||
"number": "6.2."
|
||||
"chapterTitle": "6.3. Type Aliases",
|
||||
"number": "6.3."
|
||||
}
|
||||
],
|
||||
"chapterTitle": "6. Configurations",
|
||||
@@ -1043,7 +1047,6 @@ export const generatedSidebars = [
|
||||
{
|
||||
"loaded": true,
|
||||
"isPathHref": true,
|
||||
"initialOpen": false,
|
||||
"type": "category",
|
||||
"title": "7. Debugging & Testing",
|
||||
"children": [
|
||||
@@ -1170,13 +1173,11 @@ export const generatedSidebars = [
|
||||
],
|
||||
"number": "8."
|
||||
}
|
||||
],
|
||||
"initialOpen": false
|
||||
]
|
||||
},
|
||||
{
|
||||
"loaded": true,
|
||||
"isPathHref": true,
|
||||
"initialOpen": false,
|
||||
"type": "category",
|
||||
"title": "9. Upgrade",
|
||||
"children": [
|
||||
@@ -1207,7 +1208,6 @@ export const generatedSidebars = [
|
||||
{
|
||||
"loaded": true,
|
||||
"isPathHref": true,
|
||||
"initialOpen": false,
|
||||
"type": "category",
|
||||
"title": "10. Resources",
|
||||
"children": [
|
||||
|
||||
+10638
-9724
File diff suppressed because it is too large.
Load diff
@@ -534,6 +534,11 @@ export const sidebars = [
|
||||
title: "Environment Variables",
|
||||
path: "/learn/fundamentals/environment-variables",
|
||||
},
|
||||
{
|
||||
type: "link",
|
||||
title: "Medusa Configuations",
|
||||
path: "/learn/configurations/medusa-config",
|
||||
},
|
||||
{
|
||||
type: "link",
|
||||
title: "Type Aliases",
|
||||
|
||||
@@ -123,6 +123,11 @@ const redirects = async () => {
|
||||
destination: "/learn/resources/contribution-guidelines/docs",
|
||||
permanent: true,
|
||||
},
|
||||
{
|
||||
source: "/learn/conventions/:path*",
|
||||
destination: "/learn/configurations/:path*",
|
||||
permanent: true,
|
||||
},
|
||||
]
|
||||
}
|
||||
|
||||
|
||||
Reference in new issue
Block a user