Skip to main content

Installation

info

Flowgine supports Strapi v4.16+, and requires Node.js 18 or 20 (active LTS versions). Use your preferred package manager (npm or yarn).

Follow these steps to connect your Strapi instance to Flowgine.

1. Grab a Flowgine license​

Visit flowgine.io and request a license. You’ll receive a personal license code via email that allows you to to install Flowgine.

2. Install the Flowgine package with npm/yarn​

Configure a .npmrc file or .yarnrc.yml file and place it in the root of your Strapi project. This file provides you permissions to pull the Flowgine library from our private npm proxy. If you do not have a license code yet, please claim one first via https://flowgine.io/. Without a license Flowgine won't work and you won't be able to install it.

@flowgine:registry=https://registry.flowgine.io
//registry.flowgine.io/:_authToken=YOUR-LICENSE-KEY
always-auth=true

Replace YOUR-LICENSE-KEY with your personal Flowgine license code

3. Add the license key to your environment​

Expose the key so Flowgine can validate your instance at runtime:

# .env
FLOWGINE_LICENSE_KEY=your-license-key

You can also set the key inside config/plugins.js, but the environment variable keeps things simple across environments.

4. Install the required packages​

Flowgine depends on Redis for queues and scheduled jobs, so make sure the Strapi Redis plugin is installed alongside Flowgine:

npm install @flowgine/flowgine strapi-plugin-redis

After installation:

  1. Ensure Redis is reachable from your Strapi environment (locally and in production).
  2. Configure strapi-plugin-redis in config/plugins.js with the Redis connection details below.
  3. Rebuild and restart Strapi (yarn build && yarn develop or npm run build && npm run develop).

config/plugins.js

export default () => ({
  redis: {
    enabled: true,
    config: {
      connections: {
        default: {
          connection: {
            host: '127.0.0.1',
            port: 6379,
            db: 0,
            maxRetriesPerRequest: null,
          },
          settings: {
            debug: true,
          },
        },
      },
    },
  },
});

Once Strapi boots up you’ll see Flowgine in the admin sidebar. Open it to start building workflows.

🎉 Congratulations! You have just installed Flowgine into your Strapi project.