部署到 DigitalOcean 应用平台
本指南的目的是让用户在 DigitalOcean 应用平台上部署 Strapi 应用程序。本指南使用 DigitalOcean 提供的 PostgreSQL 开发数据库,因此可以在已部署的环境中测试应用程序。指南的最后介绍了如何将 Strapi 应用程序连接到 DigitalOcean 托管数据库。DigitalOcean 文档和其他部署主题的其他信息,请参阅 DigitalOcean 文档。
Strapi 维护部署指南,以帮助用户部署项目。由于 Strapi 和托管提供商平台经常更新,指南有时会过时。如果您在按照本指南部署项目时遇到问题,请在 GitHub 上打开问题或提交拉取请求以改进文档。
Prepare the deployment
Prior to starting the deployment process each user needs:
- a DigitalOcean account (The Strapi referral link for DigitalOcean provides $200 in credits.),
- a GitHub account and Git version control,
- an existing Strapi application.
Setup a Strapi project for deployment
Strapi uses environment configurations to maintain multiple environments inside a single application. This section describes how to setup a production environment in a Strapi application.
- Add a production configuration environment by creating a sub-directory
./config/env/production
. - Create
database.js
inside the./config/env/production
directory. - Add the code snippet to the
database
configuration file:
module.exports = ({ env }) => ({
connection: {
client: 'postgres',
connection: {
host: env('DATABASE_HOST'),
port: env.int('DATABASE_PORT'),
database: env('DATABASE_NAME'),
user: env('DATABASE_USERNAME'),
password: env('DATABASE_PASSWORD'),
ssl: {
rejectUnauthorized: env.bool('DATABASE_SSL_SELF', false),
},
},
debug: false,
},
})
export default ({ env }) => ({
connection: {
client: 'postgres',
connection: {
host: env('DATABASE_HOST'),
port: env.int('DATABASE_PORT'),
database: env('DATABASE_NAME'),
user: env('DATABASE_USERNAME'),
password: env('DATABASE_PASSWORD'),
ssl: {
rejectUnauthorized: env.bool('DATABASE_SSL_SELF', false),
},
},
debug: false,
},
})
- Create
server.js
inside the./config/env/production
directory. - Add the code snippet to the
server
configuration file:
module.exports = ({ env }) => ({
proxy: true,
url: env('APP_URL'), // Sets the public URL of the application.
app: {
keys: env.array('APP_KEYS')
},
})
export default ({ env }) => ({
proxy: true,
url: env('APP_URL'), // Sets the public URL of the application.
app: {
keys: env.array('APP_KEYS')
},
})
- Add PostgreSQL dependencies by installing
pg
package:
yarn add pg
npm install pg
- Verify that all of the new and modified files are saved locally.
- Commit the project to a remote repository:
git add .
git commit -m "commit message"
git push
Create and configure a DigitalOcean App
Deploying on the DigitalOcean App Platform requires creating an App, connecting the App to a development database, and setting environment variables. At the end of the following steps a Strapi application should be successfully deployed.
Create a DigitalOcean App
From the DigitalOcean website create and App and connect it to a GitHub repository:
- Click on the Create button and select Apps.
- Select GitHub and authorize access to the correct repository.
- Select the branch.
- (optional) Select the source directory.
- Choose whether or not to "Autodeploy" when an update is pushed to the GitHub repository.
- Click the Next button.
Connect an App to a database
After creating an App attach a development database. To add a development database on the following screen:
- Click Add Resource.
- Select Database and click Add.
- Select Dev Database and name the database. The default database name is "db" and is used to prefix the database values in the global environment table. If another database name is used, it should be substituted for "db".
- Click the Create and Attach button.
- Click the Next button to set the Environment Variables (Env Vars).
Add environment variables
In the DigitalOcean App Platform there are Global and Component-level environment variables. Strapi applications in production need Global-level variables to set the database connection, and can use either Component or Global-level variables for secrets storage. The following procedure is to add the database variables at the Global level and store the Strapi secrets at the Component level.
- Add the database, URL, and NODE_ENV variables to the global environment table:
Variable name Value APP_URL
${APP_URL}
DATABASE_HOST
${db.HOSTNAME}
DATABASE_PORT
${db.PORT}
DATABASE_NAME
${db.DATABASE}
DATABASE_USERNAME
${db.USERNAME}
DATABASE_PASSWORD
${db.PASSWORD}
NODE_ENV
production
You can use the Bulk Editor button in the App Platform to add the preceding variables by copying and pasting the following code block:
bashAPP_URL=${APP_URL} DATABASE_HOST=${db.HOSTNAME} DATABASE_PORT=${db.PORT} DATABASE_NAME=${db.DATABASE} DATABASE_USERNAME=${db.USERNAME} DATABASE_PASSWORD=${db.PASSWORD} NODE_ENV=production
- Add the key-value pairs for the Strapi secrets to the component environment variables table:
Variable name value APP_KEYS
"unique user-generated secrets here"
API_TOKEN_SALT
"unique user-generated secret here"
ADMIN_JWT_SECRET
"unique user-generated secret here"
JWT_SECRET
"unique user-generated secret here"
(optional) TRANSFER_TOKEN_SALT
"unique user-generated secret here"
- Click Next.
It is possible to copy the secrets from the local .env
file or to generate new secrets using a random secret generator. Examples can be found at OpenSSL.
- (optional) Edit the App name and Region and click Save
- Click Next.
- Click Create Resources to create the App and database.
Deploy and access a Strapi application
When the preceding steps are completed DigitalOcean should automatically try to build and deploy the application. The Strapi admin panel is accessed at {your App domain}/admin
once the application is successfully deployed.
If the build does not start, click the Actions button and select force rebuild and deploy.
Add a managed database
DigitalOcean managed databases are a production-scale database solution for a deployed Strapi application. Switching from a development database to a managed database requires modifying the Strapi application and modifying the settings on DigitalOcean:
- removing the development database and database environment variables,
- installing the
pg-connection-string
dependency, - changing the production
database
configuration file, - creating and attaching the database in the DigitalOcean platform.
Modify the Strapi application
When a managed database is attached to a Strapi application, the connection parameters are passed directly from the database to the application .yaml
file (App Spec in the DigitalOcean settings). This requires a modification to the config/env/production/database
file and the addition of the pg-connection-string
dependency.
To add the pg-connection-string
dependency navigate to the project directory and install pg-connection-string
:
yarn add pg-connection-string
npm install pg-connection-string
To switch to a managed database modify the config/env/production/database
file to be able to parse the DATABASE_URL
:
const parse = require('pg-connection-string').parse
const { host, port, database, user, password } = parse(
process.env.DATABASE_URL
)
module.exports = ({ env }) => ({
connection: {
client: 'postgres',
connection: {
host,
port,
database,
user,
password,
ssl: {
rejectUnauthorized: false,
},
},
debug: false,
},
})
const parse = require('pg-connection-string').parse
const { host, port, database, user, password } = parse(
process.env.DATABASE_URL
)
export default ({ env }) => ({
connection: {
client: 'postgres',
connection: {
host,
port,
database,
user,
password,
ssl: {
ca: env('DATABASE_CA'),
},
},
debug: false,
},
})
Create a managed database on DigitalOcean
Changing the settings on the DigitalOcean App Platform to incorporate a managed database requires creating and attaching the database to an existing Strapi application. Additionally, the database environment variables must be removed, as managed databases propagate the connection properties automatically.
- Click on the Create button from any DigitalOcean page and select Databases.
- Select a location (use the same location as the application location).
- Select the PostgreSQL database engine.
- Select a database configuration.
- Click the Create a Database Cluster button.
Attach the managed database to an App
After creating the managed database, navigate to the application page:
- Click on the Create button and select Create/Attach Database.
- Select Previously Created DigitalOcean Database.
- Use the picklist to select the previously created database.
- Click Attach Database.
Configure environment variables for production-ready managed database
Remove the previously added 'DATABASE_*' global variables added for connecting to the dev database, then set the following environment variables, inserting your database name (e.g. db-postgresql-nyc3-1234
) in place of dbClusterName
:
Variable name | Value |
---|---|
DATABASE_URL | ${dbClusterName.DATABASE_URL} |
DATABASE_CA | ${dbClusterName.CA_CERT} |
After attaching the database, DigitalOcean will attempt to auto-deploy the application. If the deployment is successful a link to the application will be provided at the top of the application page.
The environmental variables for the development and managed database are handled differently by DigitalOcean. When connected to a managed database DigitalOcean passes the environmental variables automatically. If the App build fails due to database connection errors check the .yaml
file (App Spec in the DigitalOcean Settings) to confirm the database settings are set at the top of the file and that there are no database environment variables in the file. If there are database environment variables, download the file, delete the environment variables and upload the edited file to DigitalOcean.