The deployment to Qovery rely on Docker. However, support and maintenance for Docker has been dropped in the [Medusa backend's default starter](https://github.com/medusajs/medusa-starter-default). So, the steps in this guide may not work as expected or can reference files that no longer exist in your step. It's kept for reference and to support previous deployments of Medusa to Qovery.
:::
In this document, you'll learn how to deploy your Medusa backend on Qovery with the help of Terraform.
[Qovery](https://www.qovery.com/) is a Continuous Deployment Platform that provides you with the developer experience of Heroku on top of your cloud provider (For example, AWS, DigitalOcean).
[Terraform](https://www.terraform.io/) is an open source infrastructure as code software (IaC) tool that allows you to easily deploy apps like Medusa and the resources it needs to Qovery using a single script.
:::note
This tutorial explains how to deploy Medusa to a Qovery organization with an AWS cluster. If you want to use a cloud provider other than AWS, you need to make changes to some of the keys and variables used in the tutorial.
:::
## Prerequisites
### Medusa Backend
It is assumed that you already have a Medusa backend installed locally. If you don’t, please follow the [quickstart guide](../../development/backend/install.mdx).
Furthermore, your Medusa backend should be configured to work with PostgreSQL and Redis. You can follow the [Configure your Backend documentation](../../development/backend/configurations.md) to learn how to do that.
### Needed Accounts
- A [Qovery](https://start.qovery.com/) account with a created organization. Qovery provides a free plan that you can use.
- An [AWS](https://aws.amazon.com/) account that you’ll connect to a Qovery cluster.
- A [GitHub](https://github.com/) account to create a repository to host your backend's codebase.
:::tip
If you want to use another [Git Provider supported by Qovery](https://hub.qovery.com/docs/useful-resources/faq/#what-git-providers-do-you-support), it’s possible to follow along with this guide but you’ll have to perform the equivalent steps in your Git Provider.
:::
### Required Tools
- Git’s CLI tool. You can follow[this documentation to learn how to install it for your operating system](../../development/backend/prepare-environment.mdx#git).
- Terraform’s CLI tool. You can follow [this guide to install it based on your operating system](https://www.terraform.io/downloads).
- Qovery’s CLI tool. You can follow [this guide to install it based on your operating system](https://hub.qovery.com/docs/using-qovery/interface/cli/#install).
---
## Create GitHub Repository
Before you can deploy your Medusa backend you need to create a GitHub repository and push the code base to it.
On GitHub, click the plus icon at the top right, then click New Repository.
You’ll then be redirected to a new page with a form. In the form, enter the Repository Name then scroll down and click Create repository.
### Push Code to GitHub Repository
The next step is to push the code to the GitHub repository you just created.
After creating the repository, you’ll be redirected to the repository’s page. On that page, you should see a URL that you can copy to connect your repository to a local directory.
Copy the link. Then, open your terminal in the directory that holds your Medusa backend codebase and run the following commands:
```bash
git init
git remote add origin <GITHUB_URL>
```
Where `<GITHUB_URL>` is the URL you just copied.
Then, add, commit, and push the changes into the repository:
```bash
git add .
git commit -m "initial commit"
git push
```
After pushing the changes, you can find the files in your GitHub repository.
---
## Deploy to Qovery
In this section, you’ll learn how to deploy your Medusa backend to Qovery with the help of Terraform.
### Sign in Using Qovery CLI
If you haven’t logged in to your Qovery account using the Qovery CLI tool yet, run the following command:
```bash
qovery auth
```
This opens a new page in your browser to log in to Qovery.
### Retrieve Qovery Access Token
Terraform needs an access token from Qovery so that it can deploy to your Qovery organization.
Run the following command to retrieve a Qovery access token:
```bash
qovery token
```
You’ll be prompted to choose an organization and add a name and description for the token. Once the command finishes executing, you’ll be given an access token. Save it to use in the next steps.
### Add Terraform Variables
You need to add some variables to use for your Medusa deployment to Qovery.
In the root directory of your Medusa backend, create the file `variables.tf` with the following content:
```tf
variable"qovery_organization_id"{
type=string
nullable=false
description="ID of Qovery organization"
}
variable"qovery_create_cluster"{
type=bool
nullable=false
default=true
description="Whether to create a new cluster or not"
}
variable"qovery_cluster_id"{
type=string
nullable=true
default=""
description="The ID of the cluster you want to use if you don't want to create a new one. You can get the Cluster ID using this endpoint: https://api-doc.qovery.com/#tag/Clusters/operation/listOrganizationCluster"
}
variable"qovery_access_token"{
type=string
sensitive=true
nullable=false
description="Qovery's access token generated with the command 'qovery token'"
}
variable"aws_access_key_id"{
type=string
sensitive=true
nullable=true
description="Necessary only if creating a new cluster"
}
variable"aws_secret_access_key"{
type=string
sensitive=true
nullable=true
description="Necessary only if creating a new cluster"
}
variable"aws_region"{
type=string
nullable=false
default="us-east-2"
description="Necessary only if creating a new cluster"
}
variable"medusa_jwt_secret"{
type=string
default="your-super-secret" # TO CHANGE FOR PRODUCTION
sensitive=true
nullable=false
description="The JWT Secret to use in Medusa"
}
variable"medusa_cookie_secret"{
type=string
default="your-super-secret-pt2" # TO CHANGE FOR PRODUCTION
sensitive=true
nullable=false
description="The Cookie Secret to use in Medusa"
}
variable"git_url"{
type=string
nullable=false
description="The Git repo associated with the qovery app. Make sure it ends with '.git'."
}
variable"git_branch"{
type=string
nullable=false
default="master"
description="The branch of the Git repo. Default is master"
}
variable"git_root_path"{
type=string
nullable=false
default="/"
description="The base directory to run the app from. Default is /"
}
```
This defines the required variables and sets some of them as `secret` to ensure their values aren’t printed in the console during deployment.
Next, to set the values of these variables, create the file `terraform.tfvars` with the following content:
```bash
qovery_organization_id=""
# Optional
qovery_create_cluster=true
# Optional
qovery_cluster_id= null
qovery_access_token=""
# Optional
aws_access_key_id= null
# Optional
aws_secret_access_key= null
# Optional
aws_region= null
# Optional
medusa_jwt_secret="secret"
# Optional
medusa_cookie_secret="secret"
git_url=""
# Optional
git_branch="master"
# Optional
git_root_path="/"
```
Here’s an explanation of each of the variables and how to retrieve their variables:
-`qovery_organization_id`: The ID of the Qovery organization to deploy the backend to. It can be found by logging into your [Qovery Console](https://console.qovery.com/). You’ll be redirected to the organization’s main page with a URL of the format `https://console.qovery.com/platform/organization/<ORGANIZATION_ID>/projects`. Copy the `<ORGANIZATION_ID>` in the URL to use as the value of this field.
-`qovery_create_cluster`: A boolean value indicating whether a new cluster should be created or not. If you already have a cluster that you want to use, you can set the value to `false` and set the value of `qovery_cluster_id`. Otherwise, set the value to `true` and set the values of `aws_access_key_id`, `aws_secret_access_key`, and `aws_region`.
-`qovery_cluster_id`: The ID of the existing cluster to use (if `qovery_create_cluster` is set to `false`). You can use [Qovery’s REST API](https://api-doc.qovery.com/#tag/Clusters/operation/listOrganizationCluster) to retrieve the cluster ID. You can use the token you generated earlier for the Bearer authorization token as explained [here](https://hub.qovery.com/docs/using-qovery/interface/cli/#generate-api-token).
-`aws_access_key_id`, `aws_secret_access_key`, and `aws_region`: The credentials used to create the cluster (if `qovery_create_cluster` is set to `true`). You can refer to [this guide](https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys) to learn how to retrieve the `aws_access_key_id` and `aws_secret_access_key`.
-`medusa_jwt_secret`: The value of the JSON Web Token (JWT) Secret on your Medusa backend. It’s recommended to use a strong randomly generated string.
-`medusa_cookie_secret`: The value of the Cookie Secret on your Medusa backend. It’s recommended to use a strong randomly generated string.
-`git_url`: The URL of the Git repository you created earlier. Make sure it ends with `.git`.
-`git_branch`: The branch to use in the GitHub repo. By default it’s `master`.
-`git_root_path`: The root path of the Medusa backend. By default, it’s `/`. If you are hosting your Medusa backend in a monorepo in a nested directory, you need to change the value of this variable.
:::note
If you're using modules that require setting up other variables, you can add them here.
:::
### Add Terraform Configuration File
In the root directory of your Medusa backend, create the file `main.tf` with the following content:
```bash
# Install the Qovery Terraform provider
terraform {
required_providers {
qovery={
source="qovery/qovery"
}
}
}
# Set the access token
provider "qovery"{
token= var.qovery_access_token
}
# Create the AWS credentials if qovery_create_cluster is true
resource "qovery_aws_credentials""my_aws_creds"{
organization_id= var.qovery_organization_id
name="My AWS Creds"
access_key_id= var.aws_access_key_id
secret_access_key= var.aws_secret_access_key
count= var.qovery_create_cluster ? 1 : 0
}
# Create a new cluster if qovery_create_cluster is true
If you're using modules that require setting up other resources, make sure to add them here.
:::
This is a Terraform configuration file that creates all the resources necessary to deploy Medusa to Qovery. If you set `qovery_create_cluster` to `true`, it will create new credentials and a cluster in your Qovery organization using the AWS credentials you set in the variables.
Next, it creates a new project, environment, PostgreSQL database, and a Redis database in your Qovery organization.
Finally, it creates the Medusa app and sets all the necessary environment variables needed to run it.
### Change develop.sh
The `Dockerfile` runs the file `develop.sh` to start the backend. Change the content of `develop.sh` to the following:
```bash
#!/bin/bash
# Run migrations to ensure the database is updated
medusa migrations run
# Run backend
medusa start
```
This makes sure the production backend is started and not a development backend.
### Initialize Terraform
In your terminal, run the following command to initialize Terraform:
```bash
terraform init
```
This will install the Qovery Terraform provider and have everything ready before the deployment.
### Deploy the Medusa App
Finally, run the following command to deploy your Medusa app:
```bash
terraform apply
```
You’ll be asked to confirm creating all the necessary resources in Qovery. Enter `yes` and the deployment will start.
The deployment can take up to thirty minutes to finish. You’ll be able to track its status both in your terminal and in the [Qovery Console](https://console.qovery.com/).
:::tip
If you run into any errors while running this command, you can just re-run it after fixing the errors and it will pick up from where it left off. For example, if an error occurred after the creation of the PostgreSQL database, terraform continues from the next task and does not recreate the PostgreSQL database.
:::
---
## Test the Backend
Once the command finishes and the deployment is successful, you can access your backend in the [Qovery Console](https://console.qovery.com/). Go to the project, environment, then the app that you created using Terraform and Qovery. In the app, click the Open button at the top right to open your website in a new tab.
You can access any of the endpoints on your backend using the backend URL. For example, you can get the list of products using the endpoint `/store/products`.
### Testing the Admin
:::note
Make sure to either set the `autoRebuild` option of the admin plugin to `true` or add its [build](../../admin/configuration.md#build-command-options) command as part of the start command of your backend.
:::
If you deployed the admin dashboard alongside the backend, you can test it by going to `<YOUR_APP_URL>/app`. If you changed the admin path, make sure to change `/app` to the path you've set.
---
## Run Commands on the Backend
To run commands on the backend, run the following command:
```bash
qovery shell
```
You’ll be asked to either confirm the existing context or choose a new context.
After choosing your Medusa app in the context, you should be able to execute any command in the directory of your Medusa backend. For example, you can run the [`user` command using Medusa’s CLI tool to create a new user](../../cli/reference.mdx#user):
```bash
npm install @medusajs/medusa-cli -g
medusa user --email <EMAIL> --password <PASSWORD>
```
---
## Add Environment Variables
You’ll likely need to add environment variables later such as Admin Cross-Origin Resource Sharing (CORS) and Store CORS variables.
To add environment variables, in your [Qovery Console](https://console.qovery.com/) go to the Medusa app and choose Environment Variables from the sidebar. You can add environment variables here at any point later on.
---
## See Also
- [Deploy the Medusa Admin](../admin/index.mdx)
- [Deploy the Storefront](../storefront/index.mdx)
description:"General steps for all hosting providers."
addHowToData:true
---
# General Deployment Guide for Medusa Backend
In this guide, you’ll learn the general steps you need to take when deploying your Medusa backend. This is useful when the [platform-specific deployment guides](./index.mdx) do not include your selected hosting provider.
## Prerequisites
It’s assumed you already have a Medusa backend installed and configured on your local machine. If not, check out the [create-medusa-app guide](../../create-medusa-app.mdx) to install a Medusa project.
---
## (Optional) Step 1: Create GitHub Repository
Many hosting providers allow you to deploy your project directly from GitHub. This makes it easier for you to push changes and updates without having to manually trigger the update in the hosting provider.
If your hosting provider supports that, create a GitHub repository and push your backend’s code to it.
---
## Step 2: Start Script in package.json
Make sure the `start` script in your `package.json` runs migrations, the `build` command, and the `medusa start` command:
```json title=package.json
"start": "npm run build && medusa migrations run && medusa start"
```
---
## Step 3: Set ssl Database Option
In production, it’s recommended to set the [database_extra option](../../development/backend/configurations.md#database_extra) in `medusa-config.js` to disable the `ssl.rejectUnauthorized` option:
Your Medusa backend must connect to a remote PostgreSQL database. If your hosting provider doesn’t support creating a PostgreSQL database, you can use [Neon](https://neon.tech/).
Once you set up your PostgreSQL database, make sure to have the connection URL to the database at hand so that you can set it later in your environment variables.
Aside from PostgreSQL, you may be using modules or plugins that require some additional architectural setup. For example, if you’re using the [Redis Events Module](../../development/events/modules/redis.md), you must set up a Redis database and obtain a connection URL to it.
---
## Step 6: Deploy your Backend
You can deploy your backend now to your hosting provider. During or after the deployment process, based on your hosting provider, you need to add the following environment variables:
```bash
DATABASE_TYPE=postgres
DATABASE_URL=<YOUR_DB_URL>
JWT_SECRET=<RANDOM_SECRET>
COOKIE_SECRET=<RANDOM_SECRET>
NODE_ENV=production
NPM_CONFIG_PRODUCTION=false
```
Where:
- `<YOUR_DB_URL>` is the connection URL to the PostgreSQL database you set up in [step 4](#step-4-setup-postgresql-database).
- `<RANDOM_SECRET>` is a random string that will be used to create authentication and cookie tokens. Make sure to set different ones for `JWT_SECRET` and `COOKIE_SECRET`.
Make sure to also add any other environment variables relevant to your backend. For example, if you’ve setup Redis as explained in [step 5](#optional-step-5-setup-architectural-services), make sure to add an environment variable for the Redis connection URL.
---
## Step 7: Test it Out
After you’ve deployed your backend, you can test it out in different ways:
- Go to `<BACKEND_URL>/health`, where `<BACKEND_URL>` is the URL to your deployed backend. If the deployment was successful, you should see `OK` printed in your browser.
- If you deployed the admin dashboard, you can go to `<BACKEND_URL>/app` to view the admin dashboard. If you changed the value of the admin plugin’s `path` configuration, make sure to replace `app` with that instead.
---
## Set Up CORS Configuration
To connect your storefront and, if deployed separately, your admin dashboard to your deployed Medusa backend, make sure to set up the [admin_cors and store_cors configuration](../../development/backend/configurations.md#admin_cors-and-store_cors) in `medusa-config.js` accordingly.
---
## Create Admin User
If your hosting provider gives you access to execute commands in your deployed Medusa backend project, you can create a new admin user by running the following command in the root directory of your deployed Medusa backend:
```bash
npx medusa user --email admin@medusa-test.com --password supersecret
Blocking a user prevents them from interacting with repositories, such as opening or commenting on pull requests or issues. Learn more about blocking a user.
Shahed Nasser
