mqp-server

About

The base for creating a self-hosted pad.

Deploying musiqpad manually

1. Make sure you have installed NodeJS on the hosting computer with version 4.0.0 or later.
2. Download all the required files. To do so clone the server github repository using your preferred git client or click the "Download ZIP" button on the repo page.
3. Run npm install in the directory where your extracted files are located. This will install all the required node modules.
4. Copy the serverconfig.example.js to create the file serverconfig.js and make sure this is located in the root musiqpad folder.
5. Start the server by running node start.js or npm start file using node.
6. If everything went well, there should be no error messages.

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
		}
	}
}

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.