Skip to content

audiopump/cms-pipeline-example

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 

Repository files navigation

AudioPump CMS Pipeline Example

Quick Start

Prerequisites

Firstly, you need Node.js installed. This code has been tested against Node.js v24.

API Access

It is recommended that you create a specific CMS user for the Pipeline to run as. This user should have the pipeline role, and should have its own access token. If your CMS installation does not already have a Pipeline user, please contact support for help in adding one.

Next, configure the API URL and access token with environment variables:

APCMS_API_ROOT = "https://audiopump-cms.example.com"
APCMS_API_TOKEN = "AP3zzzzzzzzzzzzzzzzz…"

Configuring Pipeline Task on Asset Upload

Pipeline tasks are automatically queued when new assets are uploaded via the CMS web interface. However, the pipeline label(s) need to be configured. You may choose any label for your pipeline. It simply needs to match what pipeline task types your pipeline script requests.

In your CMS configuration (generally config.js in your CMS web root):

window.config = {
  

  pipelines: [
    'example'
  ],}

Note: Using multiple pipeline labels requires CMS API v1.12.0 or later.

Running the Pipeline

Finally, you can run the script like any other:

node index.js

License

Copyright 2025 AudioPump, Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Support

Contact AudioPump, Inc. support at [email protected].

About

Source code sample for creating a custom pipeline for processing CMS assets.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published