部署到 Heroku

本指南的目的是让用户在 Heroku 上部署 Strapi 应用程序。本指南使用 Heroku CLI 工具和 Heroku 提供的 PostgreSQL 数据库。Heroku 文档 中提供了有关如何部署到 Heroku 的其他选项。

在开始部署过程之前，每个用户都需要：

• 一个 Heroku 帐户，
• Git 版本控制，
• 一个现有的 Strapi 应用程序。

设置 Strapi 项目以进行部署

Strapi 使用 环境配置 在单个应用程序内维护多个环境。本节介绍如何在 Strapi 应用程序中设置生产环境。

1. 通过创建子目录 ./config/env/production 添加生产配置环境。
2. 在 ./config/env/production 目录中创建 database.js。
3. 将以下代码片段添加到 database 配置文件中：

// path: ./config/env/production/database.js

const { parse } = require('pg-connection-string')

module.exports = ({ env }) => {
  const { host, port, database, user, password } = parse(env('DATABASE_URL'))

  return {
    connection: {
      client: 'postgres',
      connection: {
        host,
        port,
        database,
        user,
        password,
        ssl: { rejectUnauthorized: false },
      },
      debug: false,
    },
  }
}

// path: ./config/env/production/database.ts

import { parse } from 'pg-connection-string'
const config = parse(process.env.DATABASE_URL)

export default ({ env }) => ({
  connection: {
    client: 'postgres',
    connection: {
      host: config.host,
      port: config.port,
      database: config.database,
      user: config.user,
      password: config.password,
      ssl: {
        rejectUnauthorized: false
      },
    },
    debug: false,
  },
})

4. Create server.js inside the ./config/env/production directory.
5. Add the following code snippet to the server configuration file:

// Path: ./config/env/production/server.js
// starting from Strapi v 4.6.1 server.js has to be the following

module.exports = ({ env }) => ({
  proxy: true,
  host: '0.0.0.0',
  port: process.env.PORT,
  url: env('MY_HEROKU_URL'),
  app: {
    keys: env.array('APP_KEYS')
  },
  admin: {
    auth: {
      secret: env('ADMIN_JWT_SECRET'),
    },
  },
})

// Path: ./config/env/production/server.js`
export default ({ env }) => ({
  proxy: true,
  url: env('MY_HEROKU_URL'), // Sets the public URL of the application.
  app: {
    keys: env.array('APP_KEYS')
  },
})

6. Add PostgreSQL dependencies by installing pg package and pg-connection-string package:

yarn add pg && yarn add pg-connection-string

npm install pg && npm install pg-connection-string

7. Add package-lock.json to the end of the .gitignore file at the root of the Strapi project:

# path: ./.gitignore
package-lock.json

8. Verify that all of the new and modified files are saved locally.
9. Commit the project to a local repository:

git init
git add .
git commit -m "commit message"

Create and configure a Heroku App

Deploying to Heroku requires installing the CLI tool, creating an App, connecting the App to a database, and setting environment variables. At the end of the following steps, a Strapi application should be successfully deployed.

Install and use the Heroku CLI

1. Use the following OS-specific installation instructions to install the Heroku CLI tool:

curl https://cli-assets.heroku.com/install-ubuntu.sh | sh

brew tap heroku/brew && brew install heroku

2. Login to Heroku from the CLI, following the command-line instructions:

heroku login

Create a Heroku project

Create a new Heroku project by running the following command in the root directory of the Strapi project:

# path: ./my-project/
heroku create

To initialize a local project folder with an existing Heroku project use the following command:

# path: ./my-project/
heroku git:remote -a your-heroku-app-name

The local development environment is now set up and configured to work with Heroku.

Create a Heroku database

The following command creates and connects a PostgreSQL database with the Heroku project. Consult the Heroku documentation for database plan names and costs.

# path: ./my-project/
heroku addons:create heroku-postgresql:<PLAN_NAME>

The database credentials are stored as a string with the config variable name DATABASE_URL. The database credentials can be retrieved using the following command in the terminal:

# path: ./my-project/
heroku config

The command output has the form DATABASE_URL: postgres://ebitxebvixeeqd:dc59b16dedb3a1eef84d4999sb4baf@ec2-50-37-231-192.compute-2.amazonaws.com: 5432/d516fp1u21ph7b. The string has the structure postgres://USERNAME:PASSWORD@HOST:PORT/DATABASE_NAME

Populate the environment variables

Strapi requires the following environment variables to be set for the remote instance:

• NODE_ENV,
• MY_HEROKU_URL,
• JWT_SECRET,
• ADMIN_JWT_SECRET,
• API_TOKEN_SALT,
• APP_KEYS.

The following tabs detail how to either set new values for the secrets or transfer the values from the local .env file. Creating new values is the best practice.

heroku config:set APP_KEYS=$(openssl rand -base64 32)
heroku config:set API_TOKEN_SALT=$(openssl rand -base64 32)
heroku config:set ADMIN_JWT_SECRET=$(openssl rand -base64 32)
heroku config:set JWT_SECRET=$(openssl rand -base64 32)
heroku config:set MY_HEROKU_URL=$(heroku info -s | grep web_url | cut -d= -f2)
heroku config:set NODE_ENV=production

heroku config:set APP_KEYS=$(cat .env | grep APP_KEYS | cut -d= -f2-)
heroku config:set API_TOKEN_SALT=$(cat .env | grep API_TOKEN_SALT | cut -d= -f2)
heroku config:set ADMIN_JWT_SECRET=$(cat .env | grep ADMIN_JWT_SECRET | cut -d= -f2)
heroku config:set JWT_SECRET=$(cat .env | grep -w JWT_SECRET | cut -d= -f2)
heroku config:set MY_HEROKU_URL=$(heroku info -s | grep web_url | cut -d= -f2)
heroku config:set NODE_ENV=production

Deploy an application to Heroku

In the project root directory run the git push heroku HEAD:main CLI command to push the project to the Heroku server:

# path: ./my-project/`
git push heroku HEAD:main

The deployment may take a few minutes. At the end, logs will display the URL of the project (e.g. https://mighty-taiga-80884.herokuapp.com). The project can also be opened from the command line:

# path: ./my-project/`
heroku open

The Strapi Welcome page indicates that the project is correctly set up, configured, and deployed on Heroku. Next, set up an admin user as the production database is brand-new and empty. Add /admin to the end of the website address to access the signup page.

Update your project

Modifications that require writing to model creation or other JSON files, such as creating or changing content types, require making those changes on the local development environment and then pushing the changes to Heroku. See the documentation FAQ for PaaS and the FAQ for content-types in production for more information.

Further development can benefit from version control, or continue using git push heroku HEAD:main to commit and push changes to Heroku directly.

Path: ./my-project/

git add .
git commit -am "Changes to my-project noted"
git push heroku HEAD:main
heroku open

Upload Files

Like with project updates on Heroku, the file system doesn't support local uploading of files as they are deleted when Heroku "cycles" the dyno. This type of file system is called ephemeral, which means the file system only lasts until the dyno is restarted (with Heroku this happens any time the application is redeployed or during the regular restart which can happen every few hours or every day).

Due to Heroku's filesystem, an upload provider such as AWS S3 or Cloudinary is required. Additional details are available in the installing providers documentation. The Strapi Market contains providers from both Strapi and the community. Additional community providers are available from npmjs.com.