SyncLounge Socket Server
This is the socket server that goes along with the SyncLounge webapp. 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
Installation
npm install -g syncloungesocket
Usage
syncloungesocket
If you want to also serve the webapp:
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
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.
syncloungesocket --static_path /apps/synclounge/dist# OR STATIC_PATH='/apps/synclounge/dist' syncloungesocket
Base URL
Default is '/'
syncloungesocket --base_url '/somebase'# OR BASE_URL='/somebase' syncloungesocket
Ping Interval
Default is 10000 ms
syncloungesocket --ping_interval 10000# OR PING_INTERVAL=10000 syncloungesocket
Manual Building
You can also clone the repository to build it yourself or
git clone https://github.com/ttshivers/syncloungesocket.gitcd syncloungesocketnpm installnpm run build
Then you can run it
npm run start