Skip to main content

Configure your Server

In this document, you’ll learn what configurations you can add to your Medusa server and how to add them.

Prerequisites

This document assumes you already followed along with the “Set up your development environment” documentation and have installed a Medusa server.

Medusa Configurations File

The configurations for your Medusa server are in Copy to Clipboard. This includes database, Redis, and plugin configurations, among other configurations.

Some of the configurations mentioned in this document are already defined in Copy to Clipboard with default values. It’s important that you know what these configurations are used for and how to set them.

Environment Variables

In your configurations, you’ll often use environment variables. For example, when using API keys or setting your database URL.

By default, Medusa loads environment variables from the system’s environment variables. Any different method you prefer to use or other location you’d prefer to load environment variables from you need to manually implement.

This change in how environment variables are loaded was introduced in version 1.3.0. You can learn more in the upgrade guide for version 1.3.0.

Database Configuration

Medusa supports two database types: SQLite and PostgreSQL.

You can use SQLite for development purposes, however, it’s recommended to use PostgreSQL.

SQLite Configurations

For SQLite you mainly need two configurations:

Report Incorrect CodeReport Incorrect CodeReport Incorrect CodeCopy to Clipboard
module.exports = {
projectConfig: {
//...other configurations
database_type: "sqlite",
database_database: "./medusa-db.sql",
},
};
Copy to Clipboard

Where Copy to Clipboard is Copy to Clipboard and Copy to Clipboard is the location you want the SQLite database to be created in.

PostgreSQL Configurations

Before getting started with configuring PostgreSQL, you should have created a PostgreSQL Copy to Clipboard. You can check how to create a database in PostgreSQL's documentation.

For PostgreSQL you mainly need two configurations:

Report Incorrect CodeReport Incorrect CodeReport Incorrect CodeCopy to Clipboard
module.exports = {
projectConfig: {
//...other configurations
database_type: "postgres",
database_url: DATABASE_URL,
},
};
Copy to Clipboard

Where Copy to Clipboard is Copy to Clipboard and Copy to Clipboard is the URL connection string to your PostgreSQL database. You can check out how to format it in PostgreSQL’s documentation.

It is recommended to set the Database URL as an environment variable:

Report Incorrect CodeReport Incorrect CodeReport Incorrect CodeCopy to Clipboard
DATABASE_URL=<YOUR_DATABASE_URL>
Copy to Clipboard

Where Copy to Clipboard is the URL of your PostgreSQL database.

Common Configuration

As Medusa internally uses Typeorm to connect to the database, the following configurations are also available:

  1. Copy to Clipboard: enable or disable logging.
  2. Copy to Clipboard: extra options that you can pass to the underlying database driver.

These configurations are not required and can be omitted.

Report Incorrect CodeReport Incorrect CodeReport Incorrect CodeCopy to Clipboard
module.exports = {
projectConfig: {
//...other configurations
database_logging: true,
database_extra: {}
},
};
Copy to Clipboard

Redis

Medusa uses Redis to handle the event queue, among other usages. You need to set Redis URL in the configurations:

Report Incorrect CodeReport Incorrect CodeReport Incorrect CodeCopy to Clipboard
module.exports = {
projectConfig: {
//...other configurations
redis_url: REDIS_URL
},
};
Copy to Clipboard

Where Copy to Clipboard is the URL used to connect to Redis. The format of the connection string is Copy to Clipboard.

If you omit this configuration, events will not be emitted and subscribers will not work.

By default, the Redis connection string should be Copy to Clipboard unless you made any changes to the default configurations during the installation.

It is recommended to set the Redis URL as an environment variable:

Report Incorrect CodeReport Incorrect CodeReport Incorrect CodeCopy to Clipboard
REDIS_URL=<YOUR_REDIS_URL>
Copy to Clipboard

Where Copy to Clipboard is the URL of your Redis server.

You can learn more about Subscribers and events in the Subscriber documentation.

JWT Secret

Medusa uses JSON Web Token (JWT) to handle user authentication. To set the JWT secret:

Report Incorrect CodeReport Incorrect CodeReport Incorrect CodeCopy to Clipboard
module.exports = {
projectConfig: {
//...other configurations
jwt_secret: "very secure string",
},
};
Copy to Clipboard

Where Copy to Clipboard is the secret used to create the tokens. The more secure it is the better.

It is recommended to set the JWT Secret as an environment variable:

Report Incorrect CodeReport Incorrect CodeReport Incorrect CodeCopy to Clipboard
JWT_SECRET=<YOUR_JWT_SECRET>
Copy to Clipboard

Where Copy to Clipboard is the JWT secret you want to use.

In a development environment, if this option is not set the default secret is “supersecret”. However, in production, if this option is not set an error will be thrown and your server will crash.

This configuration is used to sign the session ID cookie. To set the cookie secret:

Report Incorrect CodeReport Incorrect CodeReport Incorrect CodeCopy to Clipboard
module.exports = {
projectConfig: {
//...other configurations
cookie_secret: "very secure string",
},
};
Copy to Clipboard

Where Copy to Clipboard is the secret used to create the tokens. The more secure it is the better.

It is recommended to set the Cookie secret as an environment variable:

Report Incorrect CodeReport Incorrect CodeReport Incorrect CodeCopy to Clipboard
COOKIE_SECRET=<YOUR_COOKIE_SECRET>
Copy to Clipboard

Where Copy to Clipboard is the Cookie secret you want to use.

In a development environment, if this option is not set the default secret is “supersecret”. However, in production, if this option is not set an error will be thrown and your server will crash.

Admin CORS

Medusa uses Cross-Origin Resource Sharing (CORS) to only allow specific origins to access the server. To make sure your Admin dashboard can access the Medusa server’s admin endpoints, set this configuration:

Report Incorrect CodeReport Incorrect CodeReport Incorrect CodeCopy to Clipboard
module.exports = {
projectConfig: {
//...other configurations
admin_cors: ADMIN_CORS,
},
};
Copy to Clipboard

Where Copy to Clipboard is the URL of your admin dashboard. By default, it’s Copy to Clipboard.

It is recommended to set the Admin CORS as an environment variable:

Report Incorrect CodeReport Incorrect CodeReport Incorrect CodeCopy to Clipboard
ADMIN_CORS=<YOUR_ADMIN_CORS>
Copy to Clipboard

Where Copy to Clipboard is the URL of your admin dashboard.

Make sure that the URL is without a backslash at the end. For example, you should use Copy to Clipboard instead of Copy to Clipboard.

Storefront CORS

Medusa uses CORS to only allow specific origins to access the server. To make sure your Storefront dashboard can access the Medusa server, set this configuration:

Report Incorrect CodeReport Incorrect CodeReport Incorrect CodeCopy to Clipboard
module.exports = {
projectConfig: {
//...other configurations
store_cors: STORE_CORS,
},
};
Copy to Clipboard

Where Copy to Clipboard is the URL of your storefront. By default, it’s Copy to Clipboard.

It is recommended to set the Storefront CORS as an environment variable:

Report Incorrect CodeReport Incorrect CodeReport Incorrect CodeCopy to Clipboard
STORE_CORS=<YOUR_STORE_CORS>
Copy to Clipboard

Where Copy to Clipboard is the URL of your storefront.

Make sure that the URL is without a backslash at the end. For example, you should use Copy to Clipboard instead of Copy to Clipboard.

Plugins

On your Medusa server, you can use Plugins to add custom features or integrate third-party services. For example, installing a plugin to use Stripe as a payment provider.

You can learn more about plugins in the Plugins Overview documentation.

Aside from installing the plugin with NPM, you need to pass the plugin you installed into the Copy to Clipboard array defined in Copy to Clipboard. This array is then exported along with other configurations you’ve added:

Report Incorrect CodeReport Incorrect CodeReport Incorrect CodeCopy to Clipboard
module.exports = {
projectConfig: {
//previous configurations mentioned...
},
plugins,
};
Copy to Clipboard

Add a Plugin Without Configuration

To add a plugin that doesn’t need any configurations, you can simply add its name to the Copy to Clipboard array:

Report Incorrect CodeReport Incorrect CodeReport Incorrect CodeCopy to Clipboard
const plugins = [
//other plugins...
`medusa-my-plugin`,
];
Copy to Clipboard

Add a Plugin With Configuration

To add a plugin with configurations, you need to add an object to the Copy to Clipboard array with the plugin’s name and configurations:

Report Incorrect CodeReport Incorrect CodeReport Incorrect CodeCopy to Clipboard
const plugins = [
//other plugins...
{
resolve: `medusa-my-plugin`,
options: {
apiKey: `test`
}
}
];
Copy to Clipboard

It is recommended to use environment variables to store values of options instead of hardcoding them in Copy to Clipboard.

What’s Next