ericlay
/
ircBridgeV3
1
0
Fork 0
Code Pull Requests Activity
version 3 of the ircBridge
33 Commits 1 Branch 0 Tags 62 KiB
Python 100%
Go to file
Eric Lay 237e3b094b Update gunicorn_config.py 2025-07-31 19:59:47 -05:00
README.md Update README.md 2025-05-18 17:10:15 -05:00
auth_db.py Add auth_db.py 2025-05-04 20:02:56 -05:00
config.py Update config.py 2025-05-18 16:46:55 -05:00
config.yml Update config.yml 2025-07-31 19:59:05 -05:00
gunicorn_config.py Update gunicorn_config.py 2025-07-31 19:59:47 -05:00
irc_bot.py Update irc_bot.py 2025-07-31 19:56:05 -05:00
irc_runner.py Add irc_runner.py 2025-05-18 16:54:46 -05:00
ircbridge.service Add ircbridge.service 2025-05-04 20:11:39 -05:00
ircbridgebot.service Add ircbridgebot.service 2025-05-18 16:51:51 -05:00
requirements.txt Update requirements.txt 2025-05-18 17:11:14 -05:00
utils.py Add utils.py 2025-05-04 20:04:34 -05:00
web_app.py Update web_app.py 2025-07-31 19:56:36 -05:00
web_runner.py Add web_runner.py 2025-05-18 16:54:05 -05:00

README.md

ircBridgeV3

WORK IN PROGRESS

IRC bridge to site chatbox

Version 3

This app is built to join and listen on the selected IRC channel handling cross communications between the channel and site chatbox.

V3 - Breaks all the parts into modular scripts to help with debugging and future proofing. The main solution it provides is running a single bot listener but four gunicorn workers for multi-threaded handling of API calls through the use of a Redis publishing system. This allows for a much more active chat as the site grows.

Includes:

  • User verification and validation
  • Staff channel management
  • Cross application communications

Depends:

  • Redis server (This set up uses an alternate port and password set in redis.conf)

To install:

[!NOTE] These instructions are set up to install the app into it's own virtual environment

  • Clone the project
  • Move the service files to /etc/systemd/system/<filename>.service
  • Set appropriate settings in config.yml and gunicorn_config.py
  • Set up python venv in dir
    • $ cd <directory>
    • $ python -m venv venv
    • $ source venv/bin/activate
    • $ pip install -r requirements.txt
    • $ deactivate
  • Edit the service files to reflect proper paths
  • Enable and start the service
    • $ sudo systemctl enable ircbridge.service ircbridgebot.service
    • $ sudo systemctl start ircbridge.service ircbridgebot.service
    • Use journalctl -u ircbridge -f to monitor