DMehaffy 024b337b09
Update node version requirements for v10 to v12 (#7409)
Signed-off-by: Derrick Mehaffy <derrickmehaffy@gmail.com>
2020-09-02 17:11:59 +02:00

8.6 KiB

Deployment

Strapi gives you many possible deployment options for your project or application. Strapi can be deployed on traditional hosting servers or services such as Heroku, AWS, Azure and others. The following documentation covers how to develop locally with Strapi and deploy Strapi with various hosting options.

::: tip Deploying databases along with Strapi is covered in the Databases Guide. :::

Hosting Provider Guides

Manual guides for deployment on various platforms, for One-click and docker please see the installation guides.

Amazon AWS Step by step guide for deploying on AWS EC2
Azure Step by step guide for deploying on Azure
DigitalOcean Manual step by step guide for deploying on DigitalOcean droplets
Google App Engine Manual step by step guide for deploying on GCP's App Engine
Heroku Step by step guide for deploying on Heroku

Optional Software Guides

Additional guides for optional software additions that compliment or improve the deployment process when using Strapi in a production or production-like environment.

Caddy Overview of proxying Strapi with Caddy
HAP HAProxy Overview of proxying Strapi with HAProxy
Nginx Overview of proxying Strapi with Nginx

To provide the best possible environment for Strapi there are a few requirements, these apply in both a development (local) as well as a staging and production workflow.

  • Node LTS (v10 or V12) Note that Node v14 is not currently supported
  • Typical standard build tools for your OS (the build-essentials package on most Debian-based systems)
  • At least 1 CPU core (Highly recommended at least 2)
  • At least 2 GB of RAM (Moderately recommended 4)
  • Minimum required storage space recommended by your OS or 32 GB of free space
  • A supported database version
    • MySQL >= 5.6
    • MariaDB >= 10.1
    • PostgreSQL >= 10
    • SQLite >= 3
    • MongoDB >= 3.6
  • A supported operating system
    • Ubuntu >= 18.04 (LTS-Only)
    • Debian >= 9.x
    • CentOS/RHEL >= 8
    • macOS Mojave or newer (ARM not supported)
    • Windows 10
    • Docker - docker repo

Application Configuration

1. Configure

We always recommend you use environment variables to configure your application based on the environment. Here is an example:

Path — ./config/server.js.

module.exports = ({ env }) => ({
  host: env('APP_HOST', '0.0.0.0'),
  port: env.int('NODE_PORT', 1337),
});

Then you can create a .env file or directly use the deployment platform you use to set environment variables:

Path — .env.

APP_HOST=10.0.0.1
NODE_PORT=1338

::: tip To learn more about configuration you can read the documentation here :::

2. Launch the server

Before running your server in production you need to build your admin panel for production

:::: tabs

::: tab yarn

NODE_ENV=production yarn build

:::

::: tab npm

NODE_ENV=production npm run build

:::

::: tab Windows

npm install cross-env

Then in your package.json scripts section:

"production": "cross-env NODE_ENV=production npm run build"

:::

::::

Run the server with the production settings.

:::: tabs

::: tab yarn

NODE_ENV=production yarn start

:::

::: tab npm

NODE_ENV=production npm start

:::

::: tab Windows

npm install cross-env

Then in your package.json scripts section:

"production": "cross-env NODE_ENV=production npm start"

:::

::::

::: warning We highly recommend using pm2 to manage your process. :::

If you need a server.js file to be able to run node server.js instead of npm run start then create a ./server.js file as follows:

const strapi = require('strapi');

strapi(/* {...} */).start();

Advanced configurations

If you want to host the administration on another server than the API, please take a look at this dedicated section.