From 18d7d3fe92469497dd954f1b8ac4390fcbffb47b Mon Sep 17 00:00:00 2001 From: Eric Lay Date: Sun, 18 May 2025 17:10:15 -0500 Subject: [PATCH] Update README.md --- README.md | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index cb5d525..62c2a22 100644 --- a/README.md +++ b/README.md @@ -6,18 +6,21 @@ **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. +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 file to `/etc/systemd/system/ircbridge.service` +- Move the service files to `/etc/systemd/system/.service` - Set appropriate settings in config.yml and gunicorn_config.py - Set up python venv in dir - `$ cd ` @@ -25,8 +28,8 @@ V3 - Breaks all the parts into modular scripts to help with debugging and future - `$ source venv/bin/activate` - `$ pip install -r requirements.txt` - `$ deactivate` -- Edit the service file to reflect proper paths +- Edit the service files to reflect proper paths - Enable and start the service - - `$ sudo systemctl enable ircbridge.service` - - `$ sudo systemctl start ircbridge.service` + - `$ sudo systemctl enable ircbridge.service ircbridgebot.service` + - `$ sudo systemctl start ircbridge.service ircbridgebot.service` - Use `journalctl -u ircbridge -f` to monitor \ No newline at end of file