Skip to content

Latest commit

 

History

History
69 lines (51 loc) · 3.27 KB

database.md

File metadata and controls

69 lines (51 loc) · 3.27 KB
title displayed_sidebar description canonicalUrl
Database
cloudSidebar
Configure your own database on Strapi Cloud.

Database

Strapi Cloud provides a pre-configured PostgreSQL database by default. However, you can also configure it to utilize an external SQL database, if needed.

:::prerequisites

  • A local Strapi project running on v4.8.2+.
  • Credentials for external database.
  • If using an existing database, the schema must match the Strapi project schema. :::

:::caution While it's possible to use an external database with Strapi Cloud, you should do it while keeping in mind the following considerations:

  • Strapi Cloud already provides a managed database that is optimized for Strapi.
  • Using an external database may result in unexpected behavior and/or performance issues (e.g., network latency may impact performance). For performance reasons, it's recommended to host your external database close to the region where your Strapi Cloud project is hosted. You can find where your Strapi Cloud project is hosted in your Project Settings (see Project Settings > General > Selected Region).
  • Strapi can't provide security or support with external databases used with Strapi Cloud. :::

Configuration

The project ./config/database.js or ./config/database.ts file must match the configuration found in the environment variables in database configurations section.

Before pushing changes, add environment variables to the Strapi Cloud project:

  1. Log into Strapi Cloud and click on the corresponding project on the Projects page.

  2. Click on the Settings tab and choose Variables in the left menu.

  3. Add the following environment variables:

    Variable Value
    DATABASE_CLIENT your_db
    DATABASE_HOST your_db_host
    DATABASE_PORT your_db_port
    DATABASE_NAME your_db_name
    DATABASE_USERNAME your_db_username
    DATABASE_PASSWORD your_db_password
    DATABASE_SSL_REJECT_UNAUTHORIZED false
    DATABASE_SCHEMA public

  4. Click Save.

:::caution To ensure a smooth deployment, it is recommended to not change the names of the environment variables. :::

Deployment

To deploy the project and utilize the external database, push the changes from earlier. This will trigger a rebuild and new deployment of the Strapi Cloud project.

<ThemedImage alt="Deployment" sources={{ light: '/img/assets/cloud/deploy-logs.png', dark: '/img/assets/cloud/deploy-logs_DARK.png', }} />

Once the application finishes building, the project will use the external database.

Reverting to the default database

To revert back to the default database, remove the previously added environment variables related to the external database from the Strapi Cloud project dashboard, and save. For the changes to take effect, you must redeploy the Strapi Cloud project.