Docker image for strapi version 4 (latest version)

API creation made simple, secure and fast. The most advanced open-source Content Management Framework to build powerful API with no effort.

GitHub repository

Docker Hub

Using Docker Compose, create docker-compose.yml file with the following content:

version: "3"
services:
  strapi:
    container_name: strapi
    image: vshadbolt/strapi
    ports:
      - "1337:1337"
    environment:
      NODE_ENV: development # or production
    # volumes:
    #   - ./app:/srv/app # mount an existing strapi project

or using Docker:

docker run -d -p 1337:1337 vshadbolt/strapi --env NODE_ENV=development

You can find more examples on GitHub.

This image allows you to create a new strapi project or run an existing strapi project.

• for $NODE_ENV = development: The command that will run in your project is strapi develop.
• for $NODE_ENV = production: The command that will run in your project is strapi start.

The Content-Type Builder plugin is disabled WHEN $NODE_ENV = production.

Note that for existing projects, config/admin.js, config/server.js, and config/middlewares.js files will need to be configured correctly not to use http:https://localhost:1337.

When running this image, strapi will check if there is a project in the /srv/app folder of the container. If there is nothing then it will run the strapi new command in the container /srv/app folder.

This command creates a project with an SQLite database. Then starts it on port 1337.

This docker image will also update the config/admin.js, config/server.js, and config/middlewares.js files to accomodate setting image sources, CORS params, admin url(s), and public server url(s) from the docker command. See below for example configurations.

• Add ADMIN_URL: tobemodified to your docker command to set a custom sub/domain for your admin page. Ex. https://api.example.com/admin. Without adding the command, the config will default to http:https://localhost:1337/admin.

The ADMIN_URL default will throw security errors in your browser if your docker host is remote. You'll need to set your docker host IP at the minimum for remote projects. Ex. http:https://192.168.1.1:1337/admin. Ideally use an nginx setup or sub/domain. If your host is not remote, http:https://localhost:1337/admin will work as expected.

• Add PUBLIC_URL: tobemodified to your docker command to set a custom domain for your api endpoint(s). Ex. https://api.example.com. Without adding the command, the config will default to http:https://localhost:1337

The PUBLIC_URL default will throw security errors in your browser if your docker host is remote. You'll need to set your docker host IP at the minimum for remote projects. Ex. http:https://192.168.1.1:1337. Ideally use an nginx setup or sub/domain. If your host is not remote, http:https://localhost:1337 will work as expected.

• Add IMG_ORIGIN: "toBeModified1,toBeModified2" to your docker command to allow new image sources for your project. Ex. 'self',data:,blob:,market-assets.strapi.io,api.example.com. Without adding the command, the config will default to 'self',data:,blob:,market-assets.strapi.io

• Add CORS_ORIGIN: "toBeModified1,toBeModified2" to your docker command to allow new CORS origin sources to your project. Ex. https://myfrontendwebsite.example.com,https://api.example.com. Without adding the command, the config will default to *.

• The official documentation for strapi and these files is linked below.

When creating a new project with this image you can pass in database configurations to the strapi new command. You're also able to add these configurations to your docker command for existing strapi projects

• DATABASE_CLIENT a database provider supported by Strapi: (sqlite, postgres, mysql ,mongo).
• DATABASE_HOST database host.
• DATABASE_PORT database port.
• DATABASE_NAME database name.
• DATABASE_USERNAME database username.
• DATABASE_PASSWORD database password.
• DATABASE_SSL boolean for SSL.
• JWT_SECRET random string ex. JrWfVf/o9TbWQmpMgsJaYp==
• ADMIN_JWT_SECRET random string ex. MCpf2/FMiCJthF5d6Qup6iG==
• APP_KEYS randomstring1,randomstring2 ex. w9/ZTuHUWNF2EP8gdfPcNn==,LqXKC52TsN/z/Y2rUGTa6m==,d7EKo2Tp9SiGf82ZqrmSnB==,TAu2SJx6BDc7aYUyqiwxKs==
• API_TOKEN_SALT random string ex. j43/kBRfXULfPpJnzPCJzi==
• TRANSFER_TOKEN_SALT random string ex. GCX3NkRSyHrDxhfgwnmCm3==
• EXTRA_ARGS pass additional args

To run an existing project, you can mount the project folder in the container at /srv/app. Refer to the environment variables laid out above for additional support.

After modifying these files directly or changing their respective environment variables (ADMIN_URL, PUBLIC_URL, IMG_ORIGIN, CORS_ORIGIN), the project will need to be rebuilt to account for the changes. To do so, add the following configuration to the docker command. Note that not adding this argument will negate any changes made within the /config directory until it is added. It is particularily important for any URL changes or your project will not function as expected. The build will be persisted between container restarts and is specific to /config changes.

• BUILD: true

To update packages in an existing project, pass in the below command. Note that this will potentially upgrade packages across major versions and has the possibility of breaking the project. Please remember to backup responsibly.

• UPGRADE: true

To deploy an existing strapi project to production using Docker, it is recommended to build an image for your project based on node v18.

The official docker documentation for strapi, including example Dockerfiles, is available on https://docs.strapi.io/dev-docs/installation/docker.

• The official documentation of strapi is available on https://docs.strapi.io/.

• The official strapi docker image is available on GitHub (not yet upgraded to v4).