docs: update config to be camel case (#7501)

This commit is contained in:
Shahed Nasser authored and GitHub committed 2024-05-28 15:52:03 +03:00
1 parent 82be054a1a
commit 8f97af0d91
6 files changed
+9 -9

No files matched your search

@@ -67,7 +67,7 @@ To test out your scheduled job:
const projectConfig = { const projectConfig = {
// ... // ...
// Uncomment the following lines to enable REDIS // Uncomment the following lines to enable REDIS
redis_url: REDIS_URL, redisUrl: REDIS_URL,
} }
``` ```
@@ -105,13 +105,13 @@ const DATABASE_URL =
`@${DB_HOST}:${DB_PORT}/${DB_DATABASE}` `@${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" ```js title="medusa-config.js"
module.exports = { module.exports = {
projectConfig: { projectConfig: {
// ... // ...
database_extra: { ssl: { rejectUnauthorized: false } }, databaseExtra: { ssl: { rejectUnauthorized: false } },
}, },
} }
``` ```
@@ -32,13 +32,13 @@ Make sure the `start` script in your `package.json` runs migrations, the `build`
## Set SSL Database Option ## 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"]]} ```js title="medusa-config.js" highlights={[["4"]]}
module.exports = { module.exports = {
projectConfig: { projectConfig: {
// ... // ...
database_extra: process.env.NODE_ENV !== "development" ? databaseExtra: process.env.NODE_ENV !== "development" ?
{ {
ssl: { ssl: {
rejectUnauthorized: false, rejectUnauthorized: false,
@@ -186,13 +186,13 @@ Update the `scripts` in `package.json` to include the following scripts:
### Changes to medusa-config.js ### 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" ```js title="medusa-config.js"
module.exports = { module.exports = {
projectConfig: { projectConfig: {
// ... // ...
database_extra: { ssl: { rejectUnauthorized: false } }, databaseExtra: { ssl: { rejectUnauthorized: false } },
}, },
} }
``` ```
@@ -22,4 +22,4 @@ npx create-medusa-app@latest --db-url "postgres://user:password@localhost:<YOUR_
Where `<YOUR_PORT>` is the exposed port if it's different than `5432`. Where `<YOUR_PORT>` 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.
@@ -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). 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).