Skip to content

Deploying a Strapi App

Strapi is a leading open-source headless CMS built on Node.js, designed for building customizable APIs quickly and efficiently. It features a powerful admin panel, flexible content modeling, and support for REST and GraphQL, making it ideal for modern content-driven applications.

This guide explains how to deploy a Strapi application to Klutch.sh, both with and without a Dockerfile. It also covers installation and provides sample code to get started.

Prerequisites

  • Node.js 18+
  • Git and GitHub account
  • Klutch.sh account

Getting Started: Install Strapi

  1. Create a new Strapi app:
    Terminal window
    npx create-strapi-app@latest my-strapi-app --quickstart
    cd my-strapi-app
    This will install dependencies and start Strapi locally.
  2. Start the development server:
    Terminal window
    npm run develop
    Your app should be running at http://localhost:1337.

Sample Code (src/api/home/controllers/home.js)

Add a simple controller to your Strapi project:

module.exports = {
async index(ctx) {
ctx.send('Hello from Strapi on Klutch.sh!');
}
};

Deploying Without a Dockerfile

  1. Push your Strapi app to a GitHub repository.
  2. Log in to Klutch.sh.
  3. Create a new project and give it a name.
  4. Create a new app:
    • Select your Strapi GitHub repository and branch
    • Set the port to route traffic (usually 1337 for Strapi)
    • Choose region, compute, number of instances, and add any environment variables
  5. Add a start script in your package.json:
    "scripts": {
    "start": "strapi start"
    }
  6. Make sure your server listens on the port provided by Klutch.sh via the PORT environment variable:
    const port = process.env.PORT || 1337;
    // Strapi will use this port if set in config/server.js
    In config/server.js:
    module.exports = ({ env }) => ({
    port: env.int('PORT', 1337),
    });
  7. Click “Create” to deploy. Klutch.sh will build and deploy your app automatically.

Deploying With a Dockerfile

  1. Add a Dockerfile to your project root. Example:
    # Use official Node.js image
    FROM node:18-alpine
    # Set working directory
    WORKDIR /app
    # Copy package files and install dependencies
    COPY package*.json ./
    RUN npm install --production
    # Copy app source
    COPY . .
    # Build Strapi app
    RUN npm run build
    # Expose port (match your Strapi app)
    EXPOSE 1337
    # Start the app
    CMD ["npm", "start"]
  2. Push your code (with Dockerfile) to GitHub.
  3. In Klutch.sh, follow the same steps to create a project and app, but select the Dockerfile option when prompted.
  4. Set the service details and environment variables as needed.
  5. Click “Create” to deploy. Klutch.sh will build your Docker image and deploy your app.

Note: Your Strapi app should always listen on the PORT environment variable as shown above.


Resources


Deploying to Klutch.sh is simple and flexible. Choose the method that best fits your workflow and project requirements.