Skip to content

Latest commit

 

History

History
91 lines (68 loc) · 3.45 KB

README.md

File metadata and controls

91 lines (68 loc) · 3.45 KB
Raw

Superdesk Publisher

Overview

This is a plugin for superdesk. The Superdesk Publisher is an API-centric delivery tool for all digital platforms. Written from scratch in 2016, it utilizes the knowledge gained from 17 years of delivering digital news at scale with Newscoop. The Publisher is designed to work with any editorial system. Naturally, it works the best with our in-house newsroom management system, Superdesk. Therefore, it allows independent maintenance, upgrade and change of the editorial back-end system.

Configure Superdesk

In order for Superdesk to expose the Publisher module, you must configure it in client config files.

Client

Add the dependency to your instance of superdesk. In superdesk/client/package.json add superdesk-publisher to the dependencies (replacing #a79d428 with the specific commit you require):

"dependencies": {
    ....,
    "superdesk-publisher": "superdesk/superdesk-publisher#a79d428"
}

After that, run npm install to install additional dependencie.

Don't forget to add publisher to your superdesk config in superdesk/client/superdesk.config.js, and to enable the publisher feature:

apps: [
    ....,
    'superdesk-publisher'
],
publisher: {
    protocol: 'http',                /* http or https */
    tenant: 'tenant-1',              /* tenant - semantically subdomain, '' is allowed */
    domain: 'website.com',           /* domain name for the publisher */
    base: 'api/v2',                  /* api base path */

    wsProtocol: 'wss',                /* ws or wss (websocket); if unspecified or '' defaults to 'wss' */
    wsDomain: 'WebSocketDomain.com',  /* domain name (usually domain as above) */
                                      /* e.g.: example.com, abc.example.com */
                                      /* tenant, as above, is NOT used for websocket */
    wsPath: '/ws',                    /* path to websocket root dir */
    wsPort: '8080',                   /* if not specified: defaults to 443 for wss, 80 for ws */
    hideContentRoutesInPublishPane: false, /* hides routes of type "content" from select box in publish panes in monitoring view as well as in output control. If not specified: defaults to false */
    hideCustomRoutesInPublishPane: false   /* hides routes of type "custom" from select box in publish panes in monitoring view as well as in output control. If not specified: defaults to false */
},

publisher.tenant - publisher tenant name publisher.domain - publisher domain publisher.base - publisher base url

publisher.wsDomain - publisher websocket domain address publisher.wsPort - publisher websocket path publisher.wsPort - publisher websocket port

This will import the superdesk-publisher node module and load the superdesk.publisher angular module in the main angular application.

Install for Development

First you will need to clone the repo from GitHub. In the root folder where your current superdesk folder is, run the following:

git clone git@github.com:superdesk/superdesk-publisher.git

Client

Running the following will link the superdesk-publisher module in development mode:

cd superdesk/client
npm install
npm link ../../superdesk-publisher
cd ../..

Testing

Running the following will run tests:

npm run test // single run
npm run test:watch // runs every time content of files changes
npm run test:debug // runs in debug mode
npm run test:updateSnapshot // updates component snapshots