Skip to content

Commit ffdec55

Browse files
authored
docs: added list of restricted envs and subdomains (medusajs#12810)
1 parent 316a325 commit ffdec55

File tree

3 files changed

+42
-3
lines changed

3 files changed

+42
-3
lines changed

www/apps/cloud/app/environments/page.mdx

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,7 @@ To create a long-lived environment:
6868
- Select the branch you want to associate with this environment. For example, `staging`.
6969
- If you don't see the branch you want to use, refresh the page to load the latest branches from your repository.
7070
- Set the custom subdomain for the environment. All environments are subdomains of `medusajs.app`. So, if you set the subdomain to `staging-my-project`, the environment's URL will be `staging-my-project.medusajs.app`.
71+
- Refer to the [Subdomain Restrictions](../projects/page.mdx#subdomain-restrictions) guide for reserved subdomains and restrictions.
7172
3. Once you're done, click the "Create" button.
7273

7374
![Side window with the form to create an environment](https://res.cloudinary.com/dza7lstvk/image/upload/v1749812846/Cloud/CleanShot_2025-06-13_at_14.04.53_2x_apb634.png)
@@ -186,6 +187,32 @@ Learn more in the [Logs guide](../logs/page.mdx).
186187

187188
In an environment's "Settings" tab, you can manage the environment's variables.
188189

190+
### Restricted Environment Variable Names
191+
192+
The following environment variable names are reserved by Cloud and you can't use them in your environment:
193+
194+
- `NODE_ENV`
195+
- `EXECUTION_CONTEXT`
196+
- `DATABASE_URL`
197+
- `REDIS_URL`
198+
- `MEDUSA_WORKER_MODE`
199+
- `PORT`
200+
- `K_SERVICE`
201+
- `K_CONFIGURATION`
202+
- `K_REVISION`
203+
- `K_CONTAINER_NAME`
204+
- `K_INTERNAL_POD_NAME`
205+
- `K_INTERNAL_POD_NAMESPACE`
206+
- `K_LOCAL_ADDR`
207+
- `K_PROTOCOL`
208+
- `SESSION_STORE`
209+
- `DYNAMO_DB_SESSIONS_TABLE`
210+
- `DYNAMO_DB_SESSIONS_HASH_KEY`
211+
- `DYNAMO_DB_SESSIONS_PREFIX`
212+
- `AWS_ACCESS_KEY_ID`
213+
- `AWS_SECRET_ACCESS_KEY`
214+
- `AWS_REGION`
215+
189216
### Add Environment Variables
190217

191218
To add environment variables to an environment:

www/apps/cloud/app/projects/page.mdx

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ To create a project:
6464

6565
6. In the next step, configure the project's settings:
6666
- Enter the name of the project.
67-
- Enter a custom subdomain for the project. All projects are subdomains of `medusajs.app`. For example, if you enter `my-project`, the project will be accessible at `my-project.medusajs.app`.
67+
- Enter a custom subdomain for the project. All projects are subdomains of `medusajs.app`. For example, if you enter `my-project`, the project will be accessible at `my-project.medusajs.app`. Refer to the [subdomain restrictions](#subdomain-restrictions) section for more details.
6868

6969
![The project settings step in the project creation flow with the settings filled in](https://res.cloudinary.com/dza7lstvk/image/upload/v1749741990/Cloud/CleanShot_2025-06-12_at_18.26.15_2x_kyxggl.png)
7070

@@ -109,6 +109,18 @@ If you encounter any issues while creating a project:
109109
- [Check the build and runtime logs of the project's production deployment](../logs/page.mdx).
110110
- [Contact support for help](../support/page.mdx).
111111

112+
### Subdomain Restrictions
113+
114+
When you choose a subdomain for your project, it must be at least five characters long. It also can't be one of the following reserved subdomains:
115+
116+
- `medusa`
117+
- `admin`
118+
- `staging`
119+
- `production`
120+
- `preview`
121+
- `development`
122+
- `proxy`.
123+
112124
---
113125

114126
## Access Deployed Project

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
export const generatedEditDates = {
22
"app/page.mdx": "2025-06-20T07:56:00.893Z",
33
"app/organization/page.mdx": "2025-06-12T14:43:20.772Z",
4-
"app/projects/page.mdx": "2025-06-19T14:17:06.679Z",
5-
"app/environments/page.mdx": "2025-06-19T14:15:00.389Z",
4+
"app/projects/page.mdx": "2025-06-24T11:17:17.668Z",
5+
"app/environments/page.mdx": "2025-06-24T11:18:00.011Z",
66
"app/deployments/page.mdx": "2025-06-19T14:14:31.740Z",
77
"app/organizations/page.mdx": "2025-06-19T14:15:13.990Z",
88
"app/notifications/page.mdx": "2025-06-17T12:29:18.819Z",

0 commit comments

Comments
 (0)