Example chat post:
User documentation is in the GitHub wiki.
To set up, use
git config --global user.email "email@example.com" git config --global user.name "Your Name" git clone https://github.com/Charcoal-SE/SmokeDetector.git cd SmokeDetector git submodule init git submodule update sudo pip install -r requirements.txt --upgrade
config.sample to a new file called
config, and edit the values required.
To run, use
python nocrash.py (preferably in a daemon-able mode, like a
You can also use
python ws.py, but then SmokeDetector will be shut down after 6 hours; when running from
nocrash.py, it will be restarted. (This is to be sure that closed websockets, if any, are reopened)
Note that SmokeDetector is written in Python 2, so you may have to explicity run
python2 if Python 3 is the default version of Python on your distro.
You can run
. ChatExchange/setp.sh to set local environment variables so that you don't have to log in every time.
SmokeDetector only supports Stack Exchange OpenIDs for now.
Licensed under either of
- Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)
at your option.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.