README.md

mqp-server

About

The base for creating a self-hosted pad.

• musiqpad.com
• Latest Release
• Discord
• Feedback / Issues

Quick Start Install

1. Make sure you have installed NodeJS on the hosting computer with version 4.0.0 or later.
2. Download the latest stable version
3. Unzip it in the location you want to install
4. Open a terminal and npm install --production it
5. Start the server by running npm start
6. If everything went well, there should be no error messages!

To change the settings, edit the config.hjson file!

If you want to start musiqpad using an application manager like forever, start the app.js file. To see server logs, run npm run log You can also download the latest pre-release here (rc = release candidate, exp = experimental)

Deploying musiqpad using NPM

1. Make sure you have installed NodeJS on the hosting computer with version 4.0.0 or later.
2. Run npm install mqp-server in your chosen directory.
3. Copy the serverconfig.example.js to create the file serverconfig.js and make sure this is located in the root musiqpad folder.
4. Create a javascript file in your directory called 'start.js' and inside the file put:

var mqpServer = require('mqp-server');

var server = new mqpServer();

server.start();

5. Start the server by running node start.js.

6. If everything went well, there should be no error messages.

mqpServer.start(params)

Params:

{
    forever: {
        enabled: false,
        options: {
            root: './logs',
            pidPath: './pids',
            sockPath: './sock',
            debug: false,
            stream: false
        }
    },
    config: fs.readFileSync('config.hjson'), // example config: config.example.hjson
}

API

Please Refer to the API Documentation for the Events, Actions and Data API's.

Support

Please email [email protected] if you have any questions or queries.