A Payload CMS plugin that integrates with Dub to automatically create and manage shortlinks for your content. This plugin synchronizes your Payload collections with Dub.co, ensuring that every published document gets a corresponding shortlink, tag, and color configuration.
Dub is the modern, open-source link attribution platform for short links, conversion tracking, and affiliate programs.
Create a free Dub account: Dub
pnpm add @rubixstudios/payload-dub// payload.config.ts import { buildConfig } from 'payload/config' import { payloadDub } from '@rubixstudios/payload-dub' export default buildConfig({ plugins: [ payloadDub({ collections: [ { docs: 'posts', slugOverride: 'post' }, // Custom slug used for folder and shortlinks { docs: 'insights', slugOverride: 'insight' }, // Custom slug only { docs: 'news' }, // Default behavior ], dubApiKey: process.env.DUB_API_KEY!, siteUrl: process.env.NEXT_PUBLIC_SITE_URL!, domain: 'mycustomdomain.com', // Optional: assign a custom domain tenantId: '12345', // Optional: tenant identifier for workspace isPro: false, // Optional: pro flag to enable/disable pro features // Optional: overrides of dubCollection dubCollection: { overrides: { access: { read: ({ req }) => !!req.user, create: ({ req }) => !!req.user, }, admin: { group: 'Marketing', defaultColumns: ['shortLink', 'externalId'], }, }, }, dubTagCollection: { overrides: { access: { read: ({ req }) => !!req.user, }, admin: { group: 'Marketing', defaultColumns: ['name', 'color'], }, }, }, }), ], })If you do not provide optional overrides, the plugin defaults to:
- Links readable by all
- Tags are readable, editable, and deletable by all logged in users
- Automation: Generates and updates shortlinks when documents are published or slugs change.
- Folders: Collections are organised in folders (Pro).
- Tags: Tags can be created and removed directly in Payload.
- Sync: Keeps Payload and Dub data consistent with minimal overhead.
- Configurable: Supports per-collection overrides for color, slug, and URL base.
- Access Control: Access, field and admin overrides for complete CMS control.
This project is licensed under the MIT License - see the LICENSE file for details.
For support or inquiries:
- LinkedIn: rubixvi
- Website: Rubix Studios
Rubix Studios Pty. Ltd.
https://rubixstudios.com.au
