# floor-manager

> Stage TEN Signalling Server for Switcher

Latest version **2.6.0-alpha.4** (published 2022-12-14) · UNLICENSED license · 0 weekly downloads

## Install

```sh
npm install floor-manager
pnpm add floor-manager
yarn add floor-manager
bun add floor-manager
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.6.0-alpha.4 |
| Published | 2022-12-14 |
| First published | 2022-03-17 |
| Weekly downloads | 0 |
| License | UNLICENSED |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 12.18.0 <17.0.0 |
| Dependencies | 45 |
| Unpacked size | 1.1 MB |
| Known vulnerabilities | 0 (+29 in 5 direct dependencies) |
| Install scripts | no |
| Author | rd@stageten.tv |
| Maintainers | lee-stageten |

## Links

- npm: https://www.npmjs.com/package/floor-manager
- Repository: git@github.com:lazarentertainment/floor-manager
- npm.io page: https://npm.io/package/floor-manager

## Dependencies (45)

- [cors](https://npm.io/package/cors.md) ^2.8.5
- [rxjs](https://npm.io/package/rxjs.md) ^6.6.7
- [snyk](https://npm.io/package/snyk.md) ^1.1042.0
- [uuid](https://npm.io/package/uuid.md) ^8.3.2
- [axios](https://npm.io/package/axios.md) ^0.27.2
- [debug](https://npm.io/package/debug.md) ^4.3.4
- [eiows](https://npm.io/package/eiows.md) ~4.1.2
- [bullmq](https://npm.io/package/bullmq.md) 1.87.2
- [config](https://npm.io/package/config.md) ^3.3.8
- [dotenv](https://npm.io/package/dotenv.md) ^16.0.3
- [lodash](https://npm.io/package/lodash.md) ^4.17.21
- [rascal](https://npm.io/package/rascal.md) ^16.1.2
- [amqplib](https://npm.io/package/amqplib.md) ^0.10.3
- [express](https://npm.io/package/express.md) ^4.18.2
- [fortune](https://npm.io/package/fortune.md) ^5.5.18
- [hashids](https://npm.io/package/hashids.md) ^2.2.10
- [ioredis](https://npm.io/package/ioredis.md) ^4.28.5
- [redlock](https://npm.io/package/redlock.md) ^4.2.0
- [winston](https://npm.io/package/winston.md) ^3.4.0
- [inflected](https://npm.io/package/inflected.md) ^2.1.0
- [inversify](https://npm.io/package/inversify.md) 5.1.1
- [socket.io](https://npm.io/package/socket.io.md) ~4.5.4
- [axios-retry](https://npm.io/package/axios-retry.md) ^3.3.1
- [prom-client](https://npm.io/package/prom-client.md) ^14.1.0
- [@sentry/node](https://npm.io/package/@sentry/node.md) ^6.19.7
- [errorhandler](https://npm.io/package/errorhandler.md) ^1.5.1
- [jsonwebtoken](https://npm.io/package/jsonwebtoken.md) ^8.5.1
- [cache-manager](https://npm.io/package/cache-manager.md) ^3.6.3
- [fortune-redis](https://npm.io/package/fortune-redis.md) ^2.1.0
- [analytics-node](https://npm.io/package/analytics-node.md) ^6.1.0
- [@bull-board/api](https://npm.io/package/@bull-board/api.md) ^4.6.1
- [class-validator](https://npm.io/package/class-validator.md) ^0.13.2
- [express-session](https://npm.io/package/express-session.md) ^1.17.3
- [reflect-metadata](https://npm.io/package/reflect-metadata.md) ^0.1.13
- [class-transformer](https://npm.io/package/class-transformer.md) ^0.5.1
- [humanize-duration](https://npm.io/package/humanize-duration.md) ^3.27.3
- [jsonapi-serializer](https://npm.io/package/jsonapi-serializer.md) ^3.6.7
- [@bull-board/express](https://npm.io/package/@bull-board/express.md) ^4.6.1
- [cache-manager-ioredis](https://npm.io/package/cache-manager-ioredis.md) ^2.1.0
- [@socket.io/redis-adapter](https://npm.io/package/@socket.io/redis-adapter.md) ^7.2.0
- [@socket.io/redis-emitter](https://npm.io/package/@socket.io/redis-emitter.md) ~4.1.1
- [@lazarentertainment/rigging-core](https://npm.io/package/@lazarentertainment/rigging-core.md) 0.4.0-beta.11
- [@lazarentertainment/redis-objects](https://npm.io/package/@lazarentertainment/redis-objects.md) ^0.3.0
- [@lazarentertainment/rigging-config](https://npm.io/package/@lazarentertainment/rigging-config.md) 0.4.0-beta.11
- [@lazarentertainment/rigging-logging](https://npm.io/package/@lazarentertainment/rigging-logging.md) 0.4.0-beta.11

## Recent versions

- 2.6.0-alpha.4 (latest) — 2022-12-14
- 2.6.0-alpha.3 — 2022-12-14
- 2.6.0-alpha.1 — 2022-12-14
- 2.6.0-alpha.2 — 2022-12-14
- 2.5.7-alpha.2 — 2022-12-14
- 2.5.6 — 2022-12-14
- 2.5.7-alpha.1 — 2022-12-13
- 2.5.0 — 2022-06-27
- 2.3.0 — 2022-06-07
- 2.0.1 — 2022-03-17

## README

A websocket-based signalling server to manage and coordinate Broadcasts and Participants between the Switcher and Performer clients, and request back-end services to support a Broadcast.

## Table of Contents

1. [Naming](#naming)
1. [Configuration](#configuration)
1. [Running](#running)
1. [Docker](#docker-deployment)

## Naming
 ["Floor Manager"?](https://en.wikipedia.org/wiki/Studio_floor_manager)

## Configuration

To run locally, with out without other components of the system, copy `config/example.local.json`
to `config/local.json`, and customize its values as needed.

### TURN Configuration

To enable turn server support, customize the example config in example.local.json

## Running
Running the server requires:

1) Install [node.js](https://nodejs.org/en/), v14.16.0

1) yarn install

1) run the server using "yarn start"

1) In the console you will see a message which tells you where the server is running:

 "[Application] is listening on port 8008 in development mode"

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