https://github.com/realizehit/server-ws

realizehit websocket server
https://github.com/realizehit/server-ws

Last synced: about 1 month ago
JSON representation

realizehit websocket server

• Host: GitHub
• URL: https://github.com/realizehit/server-ws
• Owner: realizehit
• License: gpl-3.0
• Created: 2015-05-20T12:12:27.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2016-01-25T19:28:45.000Z (almost 9 years ago)
• Last Synced: 2024-11-08T02:12:56.372Z (about 2 months ago)
• Language: JavaScript
• Size: 43.9 KB
• Stars: 5
• Watchers: 2
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# realizehit-server-ws [![Build Status](https://travis-ci.org/realizehit/server-ws.svg?branch=master)](https://travis-ci.org/realizehit/server-ws)

realizehit socket server

Probably you might want to use [realizehit/realizehit](https://github.com/realizehit/realizehit) instead.

## Usage

#### Run as NPM module

```bash

npm i -g realizehit-server-ws

```

```javascript

var ApiServer = require( 'realizehit-server-ws' )

var server = new ApiServer({

    httpPort: '8080'

})

```

#### Run with Docker

```bash

docker run -d --name=redis redis

docker run -d \

    --name=realizehit-server-ws \

    -p 8080:8080 \

    -e REDIS_URI="redis://redis:6379" \

    --link redis:redis \

    realizehit/server-ws

```

## Environment Variables

So here is a list of appliable variables:

#### `REDIS_URI`

Defaults to `redis://localhost:6379`

You should always specify a way to this communicate with redis.

#### `SERVER_HOST`

Defaults to `0.0.0.0`

#### `SERVER_WS_PORT`

Defaults to `8080`

#### `ENDPOINT_WS`

Defaults to `http://{{SERVER_HOST}}:{{SERVER_WS_PORT}}`

Here you should define the URI of the public accessible endpoint.

## Contributing

### Running with node

```bash

npm install

npm start

```

### Running with docker

```bash

docker build -t realizehit/server-ws:dev .

docker run -d -p 8080:8080 realizehit/server-ws:dev

```