# syncloungesocket

> SyncLounge socket server

Latest version **5.3.10** (published 2020-09-26) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install syncloungesocket
pnpm add syncloungesocket
yarn add syncloungesocket
bun add syncloungesocket
```

Provides the command `syncloungesocket`.

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 5.3.10 |
| Published | 2020-09-26 |
| First published | 2020-07-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=14.4.0 |
| Dependencies | 8 |
| Unpacked size | 39.2 KB |
| Known vulnerabilities | 0 (+2 in 2 direct dependencies) |
| Install scripts | no |
| GitHub stars | 5 |
| Author | Travis Shivers |
| Maintainers | ttshivers |
| Keywords | synclounge |

## Links

- npm: https://www.npmjs.com/package/syncloungesocket
- Repository: https://github.com/ttshivers/syncloungesocket
- Homepage: https://github.com/ttshivers/syncloungesocket#readme
- Issues: https://github.com/ttshivers/syncloungesocket/issues
- npm.io page: https://npm.io/package/syncloungesocket

## Dependencies (8)

- [cors](https://npm.io/package/cors.md) ^2.8.5
- [uuid](https://npm.io/package/uuid.md) ^8.3.0
- [nconf](https://npm.io/package/nconf.md) ^0.10.0
- [express](https://npm.io/package/express.md) ^4.17.1
- [url-join](https://npm.io/package/url-join.md) ^4.0.1
- [socket.io](https://npm.io/package/socket.io.md) ^2.3.0
- [bufferutil](https://npm.io/package/bufferutil.md) ^4.0.1
- [utf-8-validate](https://npm.io/package/utf-8-validate.md) ^5.0.2

## Recent versions

- 5.3.10 (latest) — 2020-09-26
- 5.3.9 — 2020-09-19
- 5.3.8 — 2020-09-19
- 5.3.7 — 2020-09-19
- 5.3.6 — 2020-09-19
- 5.3.5 — 2020-09-18
- 5.3.4 — 2020-09-16
- 5.3.3 — 2020-09-13
- 5.3.2 — 2020-09-13
- 5.3.1 — 2020-09-12
- 5.3.0 — 2020-09-11
- 5.2.14 — 2020-09-11
- 5.2.13 — 2020-09-10
- 5.2.12 — 2020-09-10
- 5.2.11 — 2020-09-09
- … 53 more at https://npm.io/package/syncloungesocket/versions

## README

[github-release-badge]: https://img.shields.io/github/workflow/status/ttshivers/syncloungesocket/release?label=release&style=for-the-badge
[docker-version-badge]: https://img.shields.io/docker/v/ttshivers/syncloungesocket?label=Docker&sort=semver&style=for-the-badge
[docker-latest-size-badge]: https://img.shields.io/docker/image-size/ttshivers/syncloungesocket?sort=semver&style=for-the-badge
[docker-pulls-badge]: https://img.shields.io/docker/pulls/ttshivers/syncloungesocket?style=for-the-badge
[npm-badge]: https://img.shields.io/npm/v/syncloungesocket?style=for-the-badge
[dependencies-badge]: https://img.shields.io/david/ttshivers/syncloungesocket?style=for-the-badge
[devdependencies-badge]: https://img.shields.io/david/dev/ttshivers/syncloungesocket?style=for-the-badge
[optionaldependencies-badge]: https://img.shields.io/david/optional/ttshivers/syncloungesocket?style=for-the-badge
[license-badge]: https://img.shields.io/github/license/ttshivers/syncloungesocket?style=for-the-badge

[release-action-link]: https://github.com/ttshivers/syncloungesocket/actions?query=workflow%3Arelease+branch%3Amaster "Release action"
[dockerhub-link]: https://hub.docker.com/r/ttshivers/syncloungesocket "Docker images of SyncLounge"
[dockerhub-tags-link]: https://hub.docker.com/r/ttshivers/syncloungesocket/tags "Docker tags of Synclounge"
[docker-microbadger-link]: https://microbadger.com/images/ttshivers/syncloungesocket "Docker size"
[npm-link]: https://www.npmjs.com/package/syncloungesocket "NPM package"
[dependencies-link]: https://david-dm.org/ttshivers/syncloungesocket
[devdependencies-link]: https://david-dm.org/ttshivers/syncloungesocket?type=dev
[optionaldependencies-link]: https://david-dm.org/ttshivers/syncloungesocket?type=optional
[license-link]: https://opensource.org/licenses/MIT "MIT License"


![SyncLounge](https://app.synclounge.tv/logo-long-dark.png)

[![npm][npm-badge]][npm-link]
[![Docker Version][docker-version-badge]][dockerhub-link]
[![Docker Size][docker-latest-size-badge]][dockerhub-link]
[![Docker Pulls][docker-pulls-badge]][dockerhub-link]
[![Release][github-release-badge]][release-action-link]
[![Dependencies][dependencies-badge]][dependencies-link]
[![Dev Dependencies][devdependencies-badge]][devdependencies-link]
[![Optional Dependencies][optionaldependencies-badge]][optionaldependencies-link]
[![License][license-badge]][license-link]


# SyncLounge Socket Server
This is the socket server that goes along with the [SyncLounge webapp](https://github.com/ttshivers/synclounge). You probably want to check that out unless you just want to run this socket server, since the webapp also includes this.

This socket server can be used as just a binary or can be included as a library, like it is with the [webapp](https://github.com/ttshivers/synclounge/blob/master/server.js)

## Installation
```sh
npm install -g syncloungesocket
```

## Usage
```sh
syncloungesocket
```

If you want to also serve the webapp:
```sh
syncloungesocket --static_path /path/to/syncloungewebapp/dist
# OR
STATIC_PATH='/path/to/syncloungewebapp/dist' syncloungesocket
```

### Options
All options can be provided as either environmental variables or arguments.

#### Port
Default is 8088
```sh
syncloungesocket --port 1234
# OR
PORT=1234 syncloungesocket
```

#### Static Path
No default. If the option isn't provided the server will not serve static files from anywhere.
If it is provided, it will serve assets from the specified directory. This option is useful
for users who want to run both the SyncLounge socket server and the webapp. Since the webapp is
static, you can just point the static path to the dist directory of the webapp and have both apps
served by this.

```sh
syncloungesocket --static_path /apps/synclounge/dist
# OR
STATIC_PATH='/apps/synclounge/dist' syncloungesocket
```


#### Base URL
Default is '/'
```sh
syncloungesocket --base_url '/somebase'
# OR
BASE_URL='/somebase' syncloungesocket
```

#### Ping Interval
Default is 10000 ms
```sh
syncloungesocket --ping_interval 10000
# OR
PING_INTERVAL=10000 syncloungesocket
```

## Manual Building
You can also clone the repository to build it yourself or
```sh
git clone https://github.com/ttshivers/syncloungesocket.git
cd syncloungesocket
npm install
npm run build
```

Then you can run it
```sh
npm run start
```

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