Payload Adsign Plugin

Getting Started

Quick start guide for the Payload Adsign Plugin

Installation

pnpm add @adsign/payload-adsign-plugin

Setup

Add the plugin to your Payload config:

payload.config.ts
import { buildConfig } from 'payload';
import { adsignPlugin } from '@adsign/payload-adsign-plugin';

export default buildConfig({
  // ... other config
  plugins: [
    adsignPlugin({
      siteName: 'My Site',
      domain: 'example.com',
    }),
  ],
});

That's it! The plugin is now active.

Configuration

  • siteName - Site name (required)
  • domain - Domain (required)
  • redirects - Redirects config (optional)
  • revalidation - Cache revalidation config (optional)

See Plugin Configuration for all options.

What's Included

The plugin provides:

  • Fields - Slug, rich text, and roles fields
  • Hooks - Cache revalidation and meta image helper
  • Guides - Automatic redirects and access control setup

On this page