From 4f3ea70e60906ca11999d6f291adb50b1bf735d9 Mon Sep 17 00:00:00 2001 From: Eric Lay Date: Sun, 4 May 2025 20:10:49 -0500 Subject: [PATCH] Update README.md --- README.md | 31 +++++++++++++++++++++++++++++-- 1 file changed, 29 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c87031d..86a948b 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,30 @@ -# ircBridgeV3 +# ircBridgeV3 +## WORK IN PROGRESS -version 3 of the ircBridge \ No newline at end of file +### 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.** + +**Includes:** +- User verification and validation +- Staff channel management +- Cross application communications + +**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` +- Set appropriate settings in config.yml and gunicorn_config.py +- Set up python venv in dir + - `$ cd ` + - `$ python -m venv venv` + - `$ source venv/bin/activate` + - `$ pip install -r requirements.txt` + - `$ deactivate` +- Edit the service file to reflect proper paths +- Enable and start the service + - `$ sudo systemctl enable ircbridge.service` + - `$ sudo systemctl start ircbridge.service` + - Use `journalctl -u ircbridge -f` to monitor \ No newline at end of file