Example chat post:
User documentation is in the wiki.
Detailed documentation for setting up and running SmokeDetector is in the wiki.
To set up, please use
git clone https://github.com/Charcoal-SE/SmokeDetector.git cd SmokeDetector git config user.email "firstname.lastname@example.org" git config user.name "SmokeDetector" git checkout deploy sudo pip3 install -r requirements.txt --upgrade pip3 install --user -r user_requirements.txt --upgrade
config.sample to a new file called
config, and edit the values required.
To run, use
python3 nocrash.py (preferably in a daemon-able mode, like a
You can also use
python3 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.)
SmokeDetector only supports Stack Exchange logins, and runs on Python 3.5 or higher, 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.