ericlay
/
ircBridgeV3
1
0
Fork 0
Code Pull Requests Activity

Update README.md

This commit is contained in:
Eric Lay 2025-05-18 17:10:15 -05:00
parent fdeab05e3a
commit 18d7d3fe92
1 changed files with 8 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -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.** **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:** **Includes:**
- User verification and validation - User verification and validation
- Staff channel management - Staff channel management
- Cross application communications - Cross application communications
**Depends:**
- Redis server (This set up uses an alternate port and password set in redis.conf)
**To install:** **To install:**
>[!NOTE] >[!NOTE]
>These instructions are set up to install the app into it's own virtual environment >These instructions are set up to install the app into it's own virtual environment
- Clone the project - Clone the project
- Move the service file to `/etc/systemd/system/ircbridge.service` - Move the service files to `/etc/systemd/system/<filename>.service`
- Set appropriate settings in config.yml and gunicorn_config.py - Set appropriate settings in config.yml and gunicorn_config.py
- Set up python venv in dir - Set up python venv in dir
- `$ cd <directory>` - `$ cd <directory>`
@ -25,8 +28,8 @@ V3 - Breaks all the parts into modular scripts to help with debugging and future
- `$ source venv/bin/activate` - `$ source venv/bin/activate`
- `$ pip install -r requirements.txt` - `$ pip install -r requirements.txt`
- `$ deactivate` - `$ deactivate`
- Edit the service file to reflect proper paths - Edit the service files to reflect proper paths
- Enable and start the service - Enable and start the service
- `$ sudo systemctl enable ircbridge.service` - `$ sudo systemctl enable ircbridge.service ircbridgebot.service`
- `$ sudo systemctl start ircbridge.service` - `$ sudo systemctl start ircbridge.service ircbridgebot.service`
- Use `journalctl -u ircbridge -f` to monitor - Use `journalctl -u ircbridge -f` to monitor