Skip to content

Commit 223ccb4

Browse files
authored
docs: docs for next release (medusajs#14110)
1 parent e4513fa commit 223ccb4

File tree

24 files changed

+1196
-27
lines changed

24 files changed

+1196
-27
lines changed

www/apps/book/app/learn/fundamentals/admin/environment-variables/page.mdx

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
import { Table } from "docs-ui"
2+
13
export const metadata = {
24
title: `${pageNumber} Environment Variables in Admin Customizations`,
35
}
@@ -88,6 +90,70 @@ Learn more about other Vite environment variables in the [Vite documentation](ht
8890
8991
---
9092
93+
## Predefined Environment Variables
94+
95+
You can further customize the Medusa Admin behavior using the following predefined environment variables. You can set the environment variables in your `.env` file or in your deployment platform.
96+
97+
<Note>
98+
99+
The following pre-defined environment variables are available starting [Medusa v2.12.0](https://github.com/medusajs/medusa/releases/tag/v2.12.0).
100+
101+
</Note>
102+
103+
<Table>
104+
<Table.Header>
105+
<Table.Row>
106+
<Table.HeaderCell>
107+
Environment Variable
108+
</Table.HeaderCell>
109+
<Table.HeaderCell>
110+
Description
111+
</Table.HeaderCell>
112+
<Table.HeaderCell>
113+
Default
114+
</Table.HeaderCell>
115+
</Table.Row>
116+
</Table.Header>
117+
<Table.Body>
118+
<Table.Row>
119+
<Table.Cell>
120+
121+
`ADMIN_AUTH_TYPE`
122+
123+
</Table.Cell>
124+
<Table.Cell>
125+
126+
A string indicating the authentication method that the JS SDK instance uses in the Medusa Admin. Possible values are `session` and `jwt`. Learn more in the [JS SDK Authentication guide](!resources!/js-sdk/auth/overview).
127+
128+
</Table.Cell>
129+
<Table.Cell>
130+
131+
`session`
132+
133+
</Table.Cell>
134+
</Table.Row>
135+
<Table.Row>
136+
<Table.Cell>
137+
138+
`ADMIN_JWT_TOKEN_STORAGE_KEY`
139+
140+
</Table.Cell>
141+
<Table.Cell>
142+
143+
A string indicating the key used to store the authentication JWT token in the browser's local storage. Only applicable if `ADMIN_AUTH_TYPE` is set to `jwt`.
144+
145+
</Table.Cell>
146+
<Table.Cell>
147+
148+
`medusa_auth_token`
149+
150+
</Table.Cell>
151+
</Table.Row>
152+
</Table.Body>
153+
</Table>
154+
155+
---
156+
91157
## Environment Variables in Production
92158
93159
When you build the Medusa application, including the Medusa Admin, with the `build` command, the environment variables are inlined into the build. This means that you can't change the environment variables without rebuilding the application.

www/apps/book/app/learn/fundamentals/admin/page.mdx

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ The next chapters will cover these two topics in detail.
3737

3838
### What You Can't Customize in the Medusa Admin
3939

40-
You can't customize the admin dashboard's layout, design, or the content of the existing pages (aside from injecting widgets). You also can't customize the login page, the authentication flow, or change the Medusa logo used in the admin dashboard.
40+
You can't customize the admin dashboard's layout, design, or the content of the existing pages (aside from injecting widgets). You also can't change the Medusa logo used in the admin dashboard.
4141

4242
If your use case requires heavy customization of the admin dashboard, you can build a custom admin dashboard using Medusa's [Admin API routes](!api!/admin).
4343

@@ -51,6 +51,8 @@ Refer to the [Medusa UI documentation](https://docs.medusajs.com/ui) to learn ho
5151

5252
---
5353

54-
## Admin Components List
54+
## Admin How-to Guides
5555

56-
To build admin customizations that match the Medusa Admin's designs and layouts, refer to [this guide](!resources!/admin-components) to find common components.
56+
The [Admin How-to Guides](!resources!/how-to-tutorials#admin) provides guides that walk you through common admin customizations, such as [building common admin components](!resources!/admin-components), or [adding third-party authentication to the admin](!resources!/how-to-tutorials/how-to/admin/auth).
57+
58+
Refer to these guides for practical examples of customizing the Medusa Admin dashboard.

www/apps/book/app/learn/fundamentals/environment-variables/page.mdx

Lines changed: 35 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ Learn more in the [Admin Environment Variables](../admin/environment-variables/p
113113

114114
## Predefined Medusa Environment Variables
115115

116-
The Medusa application uses the following predefined environment variables that you can set:
116+
You can further customize the Medusa application behavior using the following predefined environment variables. You can set the environment variables in your `.env` file or in your deployment platform.
117117

118118
<Note title="Tip">
119119

@@ -306,5 +306,39 @@ You should opt for setting configurations in `medusa-config.ts` where possible.
306306
\-
307307
</Table.Cell>
308308
</Table.Row>
309+
<Table.Row>
310+
<Table.Cell>
311+
312+
`ADMIN_AUTH_TYPE` ([v2.12.0+](https://github.com/medusajs/medusa/releases/tag/v2.12.0))
313+
314+
</Table.Cell>
315+
<Table.Cell>
316+
317+
A string indicating the authentication method that the JS SDK instance uses in the Medusa Admin. Possible values are `session` and `jwt`. Learn more in the [JS SDK Authentication guide](!resources!/js-sdk/auth/overview).
318+
319+
</Table.Cell>
320+
<Table.Cell>
321+
322+
`session`
323+
324+
</Table.Cell>
325+
</Table.Row>
326+
<Table.Row>
327+
<Table.Cell>
328+
329+
`ADMIN_JWT_TOKEN_STORAGE_KEY` ([v2.12.0+](https://github.com/medusajs/medusa/releases/tag/v2.12.0))
330+
331+
</Table.Cell>
332+
<Table.Cell>
333+
334+
A string indicating the key used to store the authentication JWT token in the browser's local storage. Only applicable if `ADMIN_AUTH_TYPE` is set to `jwt`.
335+
336+
</Table.Cell>
337+
<Table.Cell>
338+
339+
`medusa_auth_token`
340+
341+
</Table.Cell>
342+
</Table.Row>
309343
</Table.Body>
310344
</Table>

www/apps/book/generated/edit-dates.mjs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ export const generatedEditDates = {
2929
"app/learn/fundamentals/events-and-subscribers/emit-event/page.mdx": "2025-11-26T13:00:24.625Z",
3030
"app/learn/fundamentals/workflows/conditions/page.mdx": "2025-09-04T15:57:00.934Z",
3131
"app/learn/fundamentals/modules/module-link-directions/page.mdx": "2024-07-24T09:16:01+02:00",
32-
"app/learn/fundamentals/admin/page.mdx": "2025-07-25T12:46:15.466Z",
32+
"app/learn/fundamentals/admin/page.mdx": "2025-11-26T10:47:12.412Z",
3333
"app/learn/fundamentals/workflows/long-running-workflow/page.mdx": "2025-08-01T07:16:21.736Z",
3434
"app/learn/fundamentals/workflows/constructor-constraints/page.mdx": "2025-08-01T13:11:18.823Z",
3535
"app/learn/fundamentals/data-models/write-migration/page.mdx": "2025-10-28T16:01:36.609Z",
@@ -92,7 +92,7 @@ export const generatedEditDates = {
9292
"app/learn/introduction/architecture/page.mdx": "2025-07-18T15:52:35.513Z",
9393
"app/learn/fundamentals/data-models/infer-type/page.mdx": "2025-03-18T07:41:01.936Z",
9494
"app/learn/fundamentals/custom-cli-scripts/seed-data/page.mdx": "2025-09-15T16:02:51.362Z",
95-
"app/learn/fundamentals/environment-variables/page.mdx": "2025-05-26T15:06:07.800Z",
95+
"app/learn/fundamentals/environment-variables/page.mdx": "2025-11-26T11:05:38.863Z",
9696
"app/learn/build/page.mdx": "2025-10-27T09:30:26.957Z",
9797
"app/learn/deployment/general/page.mdx": "2025-10-21T07:39:08.998Z",
9898
"app/learn/fundamentals/workflows/multiple-step-usage/page.mdx": "2025-08-01T14:59:59.501Z",
@@ -105,7 +105,7 @@ export const generatedEditDates = {
105105
"app/learn/customization/reuse-customizations/page.mdx": "2025-09-04T15:45:52.047Z",
106106
"app/learn/update/page.mdx": "2025-01-27T08:45:19.030Z",
107107
"app/learn/fundamentals/module-links/query-context/page.mdx": "2025-09-15T16:09:58.104Z",
108-
"app/learn/fundamentals/admin/environment-variables/page.mdx": "2025-08-01T13:16:25.172Z",
108+
"app/learn/fundamentals/admin/environment-variables/page.mdx": "2025-11-26T08:24:17.689Z",
109109
"app/learn/fundamentals/api-routes/parse-body/page.mdx": "2025-08-20T09:58:37.704Z",
110110
"app/learn/fundamentals/admin/routing/page.mdx": "2025-07-25T07:35:18.038Z",
111111
"app/learn/resources/contribution-guidelines/admin-translations/page.mdx": "2025-02-11T16:57:46.726Z",

0 commit comments

Comments
 (0)