payloadcms-plugin-tiegel

Payload Tiegel Plugin

A plugin for Payload CMS to connect to the JAMStack Framework Tiegel

Core features:

• Adds a publish button to the navbar
• Adds websocket connection to the tiegel instance fo updates
• Stores the last 10 build results in the global named tiegel
• Exposes an endpoint /api/tiegel/build to trigger the build for users

Installation

  yarn add payloadcms-plugin-tiegel
  # OR
  npm i payloadcms-plugin-tiegel

Basic Usage

In the plugins array of your Payload config, call the plugin:

import { buildConfig } from 'payload/config';
import tiegel from 'payloadcms-plugin-tiegel';

const config = buildConfig({
  ...
  plugins: [
    tiegel({
      collections: [
        'pages',
      ],
      globals: [
        'general'
      ]
    })
  ]
});

export default config;

Config

In order to configure it correctly you need the following environment variables

/** The WebSocket endpoint to the tiegel builder **/
process.env.PAYLOAD_PUBLIC_TIEGEL_WS

/** The private endpoint in your intranet **/
process.env.TIEGEL_ENDPOINT_PRIVATE

/** The public endpoint reachable from everywhere  **/
process.env.TIEGEL_ENDPOINT

/** The secret used to talk to tiegel (optional)  **/
process.env.TIEGEL_SECRET