From 8f97af0d9123e4b3c77e199479e322d67cc14ad3 Mon Sep 17 00:00:00 2001 From: Shahed Nasser Date: Tue, 28 May 2024 15:52:03 +0300 Subject: [PATCH] docs: update config to be camel case (#7501) --- www/apps/book/app/basics/scheduled-jobs/page.mdx | 2 +- .../app/deployment/medusa-application/digitalocean/page.mdx | 4 ++-- .../app/deployment/medusa-application/general/page.mdx | 4 ++-- .../app/deployment/medusa-application/heroku/page.mdx | 4 ++-- .../app/troubleshooting/_sections/database-errors/docker.mdx | 2 +- .../troubleshooting/_sections/database-errors/privileges.mdx | 2 +- 6 files changed, 9 insertions(+), 9 deletions(-) diff --git a/www/apps/book/app/basics/scheduled-jobs/page.mdx b/www/apps/book/app/basics/scheduled-jobs/page.mdx index 1523f4a847..0e8cbad00e 100644 --- a/www/apps/book/app/basics/scheduled-jobs/page.mdx +++ b/www/apps/book/app/basics/scheduled-jobs/page.mdx @@ -67,7 +67,7 @@ To test out your scheduled job: const projectConfig = { // ... // Uncomment the following lines to enable REDIS - redis_url: REDIS_URL, + redisUrl: REDIS_URL, } ``` diff --git a/www/apps/resources/app/deployment/medusa-application/digitalocean/page.mdx b/www/apps/resources/app/deployment/medusa-application/digitalocean/page.mdx index 59a7e0b5a1..1b7d300b26 100644 --- a/www/apps/resources/app/deployment/medusa-application/digitalocean/page.mdx +++ b/www/apps/resources/app/deployment/medusa-application/digitalocean/page.mdx @@ -105,13 +105,13 @@ const DATABASE_URL = `@${DB_HOST}:${DB_PORT}/${DB_DATABASE}` ``` -In addition, add to the `projectConfig` property in the exported object a new property `database_extra`: +In addition, add to the `projectConfig` property in the exported object a new property `databaseExtra`: ```js title="medusa-config.js" module.exports = { projectConfig: { // ... - database_extra: { ssl: { rejectUnauthorized: false } }, + databaseExtra: { ssl: { rejectUnauthorized: false } }, }, } ``` diff --git a/www/apps/resources/app/deployment/medusa-application/general/page.mdx b/www/apps/resources/app/deployment/medusa-application/general/page.mdx index 13f9bf2c7e..ff0531954d 100644 --- a/www/apps/resources/app/deployment/medusa-application/general/page.mdx +++ b/www/apps/resources/app/deployment/medusa-application/general/page.mdx @@ -32,13 +32,13 @@ Make sure the `start` script in your `package.json` runs migrations, the `build` ## Set SSL Database Option -In production, it’s recommended to set the [database_extra option](/references/medusa-config#database_extra) in `medusa-config.js` to disable the `ssl.rejectUnauthorized` option: +In production, it’s recommended to set the [databaseExtra option](/references/medusa-config#databaseExtra) in `medusa-config.js` to disable the `ssl.rejectUnauthorized` option: ```js title="medusa-config.js" highlights={[["4"]]} module.exports = { projectConfig: { // ... - database_extra: process.env.NODE_ENV !== "development" ? + databaseExtra: process.env.NODE_ENV !== "development" ? { ssl: { rejectUnauthorized: false, diff --git a/www/apps/resources/app/deployment/medusa-application/heroku/page.mdx b/www/apps/resources/app/deployment/medusa-application/heroku/page.mdx index f55dac0fce..d894e1a906 100644 --- a/www/apps/resources/app/deployment/medusa-application/heroku/page.mdx +++ b/www/apps/resources/app/deployment/medusa-application/heroku/page.mdx @@ -186,13 +186,13 @@ Update the `scripts` in `package.json` to include the following scripts: ### Changes to medusa-config.js -Add to the `projectConfig` property in the exported object a new property `database_extra`: +Add to the `projectConfig` property in the exported object a new property `databaseExtra`: ```js title="medusa-config.js" module.exports = { projectConfig: { // ... - database_extra: { ssl: { rejectUnauthorized: false } }, + databaseExtra: { ssl: { rejectUnauthorized: false } }, }, } ``` diff --git a/www/apps/resources/app/troubleshooting/_sections/database-errors/docker.mdx b/www/apps/resources/app/troubleshooting/_sections/database-errors/docker.mdx index 91bf825465..478619c365 100644 --- a/www/apps/resources/app/troubleshooting/_sections/database-errors/docker.mdx +++ b/www/apps/resources/app/troubleshooting/_sections/database-errors/docker.mdx @@ -22,4 +22,4 @@ npx create-medusa-app@latest --db-url "postgres://user:password@localhost:` is the exposed port if it's different than `5432`. -Refer to the [database_url configuration documentation](/references/medusa-config#database_url) to learn how to set the database URL for an installed Medusa backend. +Refer to the [databaseUrl configuration documentation](/references/medusa-config#databaseUrl) to learn how to set the database URL for an installed Medusa backend. diff --git a/www/apps/resources/app/troubleshooting/_sections/database-errors/privileges.mdx b/www/apps/resources/app/troubleshooting/_sections/database-errors/privileges.mdx index 3ae0b9d1e7..7238c18397 100644 --- a/www/apps/resources/app/troubleshooting/_sections/database-errors/privileges.mdx +++ b/www/apps/resources/app/troubleshooting/_sections/database-errors/privileges.mdx @@ -1,3 +1,3 @@ -The database user you use in the `database_url` Medusa backend configuration must have create privileges. Otherwise, you'll face problems when running migrations. +The database user you use in the `databaseUrl` Medusa backend configuration must have create privileges. Otherwise, you'll face problems when running migrations. If you're using the `postgres` superuser, then it should have these privileges by default. Otherwise, make sure to grant your user create privileges. You can learn how to do that in [PostgreSQL's documentation](https://www.postgresql.org/docs/current/ddl-priv.html).