search

kanreisa / reichat

A lovely paint chat application like a PaintChatApp built with Node.
https://r2.ag/reichat-preview/
MIT License
184 stars 23 forks source link

readme

reichat

A lovely paint chat application like a PaintChatApp built with Node.

npm version Linux Build Windows Build Dependency Status devDependency Status

Deploy to Heroku Deploy to Azure

Currently in development. see DEMO (below)

DEMO

Note: They are synchronized using Redis!

Screenshot

Features

Designed for

Powered by

Installing

$ npm install --global reichat

Case: Azure Websites

Deploy to Azure

for Experts

  1. open your Websites Dashboard on Portal.
  2. click Set up deployment from source control
  3. select External repository and next.
  4. repository url is https://github.com/kanreisa/reichat.git.
  5. done.

Case: Heroku

Deploy to Heroku

Updating

$ npm update --global reichat

Case: Azure Websites

  1. open your Websites Dashboard on Portal.
  2. go to the DEPLOYMENTS.
  3. click SYNC to sync latest version.

Server

$ reichat # start simply with default configurations
$ reichat --port 10133 --title "Example PaintChat Room"
$ reichat --version
$ reichat --help

Case: Azure Websites / Heroku

commands don't needed. it works automatically.

Server Configuration

reichat loads option values in the order of argument, config.json and ENV for each options.

option name Argument ENV (app settings) config.json default value
Path to config.json --config - - -
Host --host HOST host 0.0.0.0
Port --port PORT port 10133
Title --title TITLE title PaintChat
Canvas Width --canvas-width CANVAS_WIDTH canvasWidth 1920
Canvas Height --canvas-height CANVAS_HEIGHT canvasHeight 1080
Data Directory --data-dir DATA_DIR dataDir (tmpdir)
Data File Prefix --data-file-prefix DATA_FILE_PREFIX dataFilePrefix reichat_
Redis Host --redis-host REDIS_HOST redisHost -
Redis Port --redis-port REDIS_PORT redisPort 6379
Redis Password --redis-password REDIS_PASSWORD redisPassword -
Redis Key Prefix --redis-key-prefix REDIS_KEY_PREFIX redisKeyPrefix -
Max Paint Log Count --max-paint-log-count MAX_PAINT_LOG_COUNT maxPaintLogCount 2000
Max Chat Log Count --max-chat-log-count MAX_CHAT_LOG_COUNT maxChatLogCount 100
Forwarded Header --forwarded-header FORWARDED_HEADER forwardedHeader -

Forwarded Header

if in trusted proxy you can use this option for logging.

Shortcuts

API

Frequency Asked Questions

Pen Pressure ?

License

MIT