# websocket-conference-server

> An HTTP server with WebSocket upgrade for multiple connection sessions.

Latest version **0.8.2** (published 2015-04-24) · FreeBSD license · 0 weekly downloads

## Install

```sh
npm install websocket-conference-server
pnpm add websocket-conference-server
yarn add websocket-conference-server
bun add websocket-conference-server
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.8.2 |
| Published | 2015-04-24 |
| First published | 2013-05-06 |
| Weekly downloads | 0 |
| License | FreeBSD |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.12.2 |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Dan Houldsworth |
| Maintainers | freelivetutor, danhouldsworth |

## Links

- npm: https://www.npmjs.com/package/websocket-conference-server
- Repository: https://github.com/FreeLiveTutor/websocket-conference-server
- Issues: https://github.com/FreeLiveTutor/websocket-conference-server/issues
- npm.io page: https://npm.io/package/websocket-conference-server

## Dependencies (2)

- [djh-utils](https://npm.io/package/djh-utils.md) >=0.1.20
- [websocket](https://npm.io/package/websocket.md) =1.0.18

## Recent versions

- 0.8.2 (latest) — 2015-04-24
- 0.8.1 — 2015-04-24
- 0.8.0 — 2015-04-24
- 0.7.1 — 2014-11-04
- 0.7.0 — 2014-10-22
- 0.6.0 — 2014-10-16
- 0.5.8 — 2014-10-08
- 0.5.7 — 2014-09-17
- 0.5.6 — 2014-09-17
- 0.5.5 — 2014-09-16
- 0.5.4 — 2014-07-21
- 0.5.3 — 2013-10-28
- 0.5.2 — 2013-10-22
- 0.5.0 — 2013-10-22
- 0.4.5 — 2013-10-22
- … 66 more at https://npm.io/package/websocket-conference-server/versions

## README

## WebSocket Conference Server

A simple out of the box HTTP & WebSocket server for multiple connection sessions. 
Leverages the very excellent [websocket](https://github.com/Worlize/WebSocket-Node) module to make a plug and play conference style server.

While little more than an abstracion layer on top of `websocket` it enables me to rapidly prototype by setting up a new server by:

```
>> Spin up AWS EC2 instance (Arch Linux - core only + ssh) 
>> pacman -S nodejs 
>> npm install websocket-conference-server 
>> node
>> require('websocket-conference-server').start()
```

...and its ready to server http files, and host a WebSocket conference.

It's then easily customisable by passing optional `config` object and `custom_utilities.js` which I need to get around to document but should be fairly clear from the source code.


## Installing the module

With [npm](http://npmjs.org/):

    npm install websocket-conference-server



## Quick usage:

```js
var server = require('websocket-conference-server').start();
```

Defaults to listening on port 8000, for echo-protocol, with logging set to full console debug but no file system records.

All http requests will be served from current directory.


## Custom usage:

```js
var server = require('websocket-conference-server');

// -- Set the optional configuration
var config = {
	verbosity 	: 1,
	protocol 	: my-custom-protocol,
	port 		: 8001,
	logs_path 	    : 'Logs/',
    IP_lookup_path  : 'IPs/',
	logs_suffix : '-alpha.log',
    http_paths  : {
        'ico'   : '../Assets',
        'jpg'   : '../Assets',
        'png'   : '../Assets',
        'html'  : '..',
        'css'   : '..',
        'js'    : '..'  
    }
};
// --

// -- Import any custom handlers, functions
var custom_utilities = require("./my_custom_utilities");
// This should accept, augment and return the utilities object, eg:
// utilities = custom_utilities.augment(utilities);
// --

// -- Boot conference server with custom options, protocol and functions 
server.start( config , custom_utilities );
// --
```

## Patches & Feedback:

https://github.com/FreeLiveTutor/websocket-conference-server

---
_Source: https://npm.io/package/websocket-conference-server · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._