Nextly Config Reference

import { defineConfig } from '@nextlyhq/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],

  // User model extensions
  users: {
    fields: [
      text({ name: 'company', label: 'Company' }),
      select({ name: 'department', options: [/* ... */] }),
    ],
  },

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

  // Cloud storage
  storage: [
    s3Storage({
      bucket: process.env.S3_BUCKET!,
      region: process.env.AWS_REGION!,
      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
  rateLimit: {
    enabled: true,
    readLimit: 100,
    writeLimit: 30,
    windowMs: 60000,
  },

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

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

users: {
  fields: [
    text({ name: 'phoneNumber', label: 'Phone Number' }),
    text({ name: 'company', label: 'Company' }),
    select({ name: 'department', options: [/* ... */] }),
  ],
  admin: {
    listFields: ['company', 'department'],
  },
}

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

storage: [
  s3Storage({
    bucket: process.env.S3_BUCKET!,
    region: process.env.AWS_REGION!,
    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,
      },
    },
  }),
]

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,
  },
}

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

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

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

const formBuilderPlugin = formBuilder();

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

admin: {
  pluginOverrides: {
    'form-builder': {
      placement: AdminPlacement.SETTINGS,
      order: 80,
      appearance: { icon: 'FileText' },
    },
  },
}