xParserDaemon

Daemon for xParser package MODX Revolution.

The daemon must be run on the same server on which xParser runs!

Helpful Links

• Post on modx.pro
• xParser docs
• Buy xParser

Table of Contents

• Installation
• Documentation
  • Config
  • Usage
  • Dependences
• Credits
• License

Installation

Create a folder for the daemon on your server mkdir /dir/path/ and go to it cd /dir/path/. Then you need to install application:

$ yarn add xparser-daemon
or
$ npm install xparser-daemon

Documentation

In addition to configuring the daemon, you need to configure the xParser application itself.

All actions described below we perform from under sudo user.

Config

Create a file app.js in the daemon folder and set your port for the daemon socket:

require('xparser-daemon').run({
    socket: {
        PORT: 3007,
    },
});

Usage

Install process manager pm2. This is to make the daemon run in the background and run when the server starts.

$ npm install pm2 -g

Run the daemon via pm2:

pm2 start app.js --name=xParserDaemon

And save process list:

pm2 save

After that you can register start of the daemon at start of your server:

pm2 startup upstart

You can check the daemon startup status with the command:

pm2 monit

Dependences

For stable work of the daemon requires xParser 1.8.5.

Credits

• Pavel Gvozdb

License

This software is open-source licensed under the MIT license.