Nextly Config Reference

import { defineConfig } from "nextly";
import { s3Storage } from "@nextlyhq/storage-s3";
import Posts from "./src/collections/posts";
import Media from "./src/collections/media";
import SiteSettings from "./src/singles/site-settings";
import Header from "./src/singles/header";
import Footer from "./src/singles/footer";
import { Seo, Hero } from "./src/components";

export default defineConfig({
  // Content model
  collections: [Posts, Media],
  singles: [SiteSettings, Header, Footer],
  components: [Seo, Hero],

  // Built-in user model extensions
  users: {
    fields: [
      // imported from "nextly"
      // text({ name: "company", label: "Company" }),
    ],
  },

  // Output paths
  typescript: {
    outputFile: "./src/types/generated/payload-types.ts",
    declare: true,
  },
  db: {
    schemasDir: "./src/db/schemas/collections",
    migrationsDir: "./src/db/migrations",
  },

  // Cloud storage (optional — defaults to local disk under ./public/uploads/)
  storage: [
    s3Storage({
      bucket: process.env.S3_BUCKET!,
      region: process.env.AWS_REGION!,
      credentials: {
        accessKeyId: process.env.AWS_ACCESS_KEY_ID!,
        secretAccessKey: process.env.AWS_SECRET_ACCESS_KEY!,
      },
      collections: {
        media: true,
      },
    }),
  ],

  // Security
  security: {
    cors: {
      origin: ["https://example.com"],
      credentials: true,
    },
    sanitization: { enabled: true },
  },

  // Rate limiting (enabled by default — opt out with enabled: false)
  rateLimit: {
    enabled: true,
    readLimit: 100,
    writeLimit: 30,
    windowMs: 60_000,
  },

  // Per-API-key rate limit
  apiKeys: {
    rateLimit: { requestsPerHour: 1000, windowMs: 3_600_000 },
  },

  // Auth opt-in flags
  auth: {
    revealRegistrationConflict: false,
  },

  // Email
  email: {
    providerConfig: {
      provider: "resend",
      apiKey: process.env.RESEND_API_KEY!,
    },
    from: "My App <noreply@example.com>",
    baseUrl: "https://example.com",
  },

  // Admin panel branding & plugin overrides
  admin: {
    branding: {
      logoUrl: "/logo.svg",
      logoText: "My App",
      favicon: "/favicon.ico",
      colors: {
        primary: "#6366f1",
        accent: "#f59e0b",
      },
    },
  },
});

collections?: CollectionConfig[];

import Posts from "./src/collections/posts";
import Media from "./src/collections/media";

export default defineConfig({
  collections: [Posts, Media],
});

singles?: SingleConfig[];

import SiteSettings from "./src/singles/site-settings";

export default defineConfig({
  singles: [SiteSettings],
});

components?: ComponentConfig[];

import { Seo, Hero } from "./src/components";

export default defineConfig({
  components: [Seo, Hero],
});

users?: UserConfig;

import { text, select, option } from "nextly";

export default defineConfig({
  users: {
    fields: [
      text({ name: "company", label: "Company" }),
      select({
        name: "department",
        options: [option("Engineering"), option("Sales"), option("Marketing")],
      }),
    ],
    admin: {
      // Show these custom columns in the user list
      listFields: ["company", "department"],
      // Override the form-section group label (default: "Additional Information")
      group: "Profile",
    },
  },
});

typescript?: { outputFile?: string; declare?: boolean };

db?: { schemasDir?: string; migrationsDir?: string };

rateLimit?: RateLimitingConfig;

rateLimit: {
  enabled: true,
  readLimit: 100,
  writeLimit: 30,
  collections: {
    media: { readLimit: 50, writeLimit: 10 },
    logs: { readLimit: 200 },
  },
}

apiKeys?: { rateLimit?: { requestsPerHour?: number; windowMs?: number } };

auth?: { revealRegistrationConflict?: boolean };

storage?: StoragePlugin[];

import { s3Storage } from "@nextlyhq/storage-s3";

export default defineConfig({
  storage: [
    s3Storage({
      bucket: process.env.S3_BUCKET!,
      region: process.env.AWS_REGION!,
      credentials: {
        accessKeyId: process.env.AWS_ACCESS_KEY_ID!,
        secretAccessKey: process.env.AWS_SECRET_ACCESS_KEY!,
      },
      collections: {
        media: true,
        "private-docs": {
          prefix: "private/",
          signedDownloads: true,
          clientUploads: true,
        },
      },
    }),
  ],
});

plugins?: PluginDefinition[];

import { formBuilder } from "@nextlyhq/plugin-form-builder";

const formBuilderPlugin = formBuilder();

export default defineConfig({
  plugins: [formBuilderPlugin.plugin],
  collections: [Posts],
});

email?: EmailConfig;

email: {
  providerConfig: {
    provider: "resend",
    apiKey: process.env.RESEND_API_KEY!,
  },
  from: "My App <noreply@example.com>",
  baseUrl: "https://example.com",
}

security?: SecurityConfig;

security: {
  cors: {
    origin: ["https://example.com", "https://app.example.com"],
    credentials: true,
  },
  headers: {
    contentSecurityPolicy: "default-src 'self'",
  },
  uploads: {
    additionalMimeTypes: ["application/xml"],
  },
  sanitization: {
    enabled: true,
    stripHtmlFromText: true,
  },
  limits: {
    multipart: "20mb",
    fileSize: "5mb",
  },
  authRateLimit: {
    requestsPerHour: 30,
  },
  trustProxy: true,
}

admin?: AdminConfig;

import { AdminPlacement } from "nextly";

admin: {
  pluginOverrides: {
    "form-builder": {
      placement: AdminPlacement.SETTINGS, // "collections" | "singles" | "users" | "settings" | "plugins" | "standalone"
      order: 80,
      after: "settings",
      appearance: { icon: "FileText" },
    },
  },
}