Neoclassical Piano Montage

    syncloungeserver

    8.0.61 • Public • Published

    SyncLounge

    npm Docker Version Docker Size Docker Pulls Release Dependencies Dev Dependencies Optional Dependencies License

    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 syncloungeserver

    Usage

    syncloungeserver

    If you want to also serve the webapp:

    syncloungeserver --static_path /path/to/syncloungewebapp/dist
    # OR
    STATIC_PATH='/path/to/syncloungewebapp/dist' syncloungeserver

    Options

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

    Port

    Default is 8088

    syncloungeserver --port 1234
    # OR
    PORT=1234 syncloungeserver

    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.

    syncloungeserver --static_path /apps/synclounge/dist
    # OR
    STATIC_PATH='/apps/synclounge/dist' syncloungeserver

    Base URL

    Default is '/'

    syncloungeserver --base_url '/somebase'
    # OR
    BASE_URL='/somebase' syncloungeserver

    Ping Interval

    Default is 10000 ms

    syncloungeserver --ping_interval 10000
    # OR
    PING_INTERVAL=10000 syncloungeserver

    Manual Building

    You can also clone the repository to build it yourself or

    git clone https://github.com/synclounge/syncloungeserver.git
    cd syncloungeserver
    npm install
    npm run build

    Then you can run it

    npm run start

    Keywords

    Install

    npm i syncloungeserver

    DownloadsWeekly Downloads

    515

    Version

    8.0.61

    License

    MIT

    Unpacked Size

    40.8 kB

    Total Files

    11

    Last publish

    Collaborators

    • gcordalis
    • ttshivers