Lucid CMS - Node Runtime

The official Node runtime for Lucid CMS

The Lucid CMS Node runtime allows you to run your CMS on any Node.js environment. This is ideal for traditional server deployments, VPS hosting, and development environments where you have full control over the runtime.

Using this runtime is the most flexible way to run Lucid CMS. Out of the box, it supports the most features without additional configuration, and it can be extended with any of the current plugins.

Installation

npm install @lucidcms/runtime-node

Setup

Use the Node runtime in your lucid.config.ts file.

import { configureLucid } from "@lucidcms/core";
import { node } from "@lucidcms/runtime-node";
import { sqlite } from "@lucidcms/db-sqlite";

export default configureLucid({
	runtime: node,
	db: sqlite,
	config: () => ({
		// ...other config
	}),
});

Configuration

The node function accepts a single parameter, options, which is either an optional object or a callback that receives Lucid's resolved env object.

| Property | Type | Description | |----------|------|-------------| | server | { port?: number; hostname?: string } | The server options. The lucidcms dev and lucidcms serve scripts use these when serving the Node server |

export default configureLucid({
	runtime: node((env) => ({
		server: {
			port: Number(env.PORT ?? 6543),
		},
	})),
	db: sqlite,
	config: () => ({
		// ...other config
	}),
});

Media Storage

When using the Node runtime, you have several options for media storage:

• Filesystem - Store files directly on your server's file system (ideal for development or single-server deployments)
• S3 - Use AWS S3, Cloudflare R2, or any S3-compatible storage service

Sending Emails

For sending emails with the Node runtime, you can use either:

• Nodemailer - Use any SMTP server or email service provider
• Resend - Use Resend's API for simple emails