GithubHelp home page GithubHelp logo

colorless-chat's Introduction

Colorless Chat

Based on: Express, Socket.io, Webpack and React.js

Uses Redis as session store and Redis pubsub for potential scalability. If Redis goes down chat goes into local-only mode wherein new connections cannot be authenticated but established ones can keep chatting to each other as long as they're on the same app instance.

Deployable via Docker:

docker run -d --restart=unless-stopped \
  -e BRAND="The Colorless" \
  -e BASE_URL="http://thecolorless.net" \
  -e REDIS_HOST="127.0.0.1" \
  -e REDIS_PORT=6379 \
  -e PORT=3000 \
  --net=host \
  gargron/colorless-chat

The above command will start a new docker container with the chat app that will always be restarted unless you manually stop the container, in the background, using the host's network interface (so the specified port will actually be taken up on the host system).

Options:

  • BRAND: Name of the site displayed in the title and in the header
  • BASE_URL: Used to generate links to the homepage and user profiles
  • FAVICON_URL: URL of the page icon (usually .ico file)
  • CHANNELS: List of channels in the header in the format Name:id;Name:id, by default: /main/:default;/ru/:russian
  • PORT: Which port the chat application will bind to
  • REDIS_PORT: Which Redis port to use
  • REDIS_HOST: Which Redis host to use
  • CLEAN_SLATE: Clean up all chat-related keys from Redis before starting
  • CSS_URL: If set, this stylesheet will be embedded after the default one
  • JS_URL: If set, this JS will be loaded after the default ones

colorless-chat's People

Contributors

gargron avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar

Forkers

adbelle

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.