1
0
deadtom 1 месяц назад
Родитель
Сommit
ce63a694d3
1 измененных файлов с 11 добавлено и 2 удалено
  1. 11 2
      README.md

+ 11 - 2
README.md

@@ -6,6 +6,7 @@ A feature rich chatbot for Owncast.
 ## Table of Contents
 - [Features](#features)
 - [Screenshots](#screenshots)
+- [Requirements](#requirements)
 - [Installation](#installation)
 - [Upgrading](#upgrading)
 - [Running OwnchatBot](#running-ownchatbot)
@@ -61,8 +62,15 @@ A feature rich chatbot for Owncast.
 <a href=https://git.deadtom.me/deadtom/OwnchatBot/src/master/screenshots/mgmtpanel06.png><img src=https://git.deadtom.me/deadtom/OwnchatBot/raw/master/screenshots/mgmtpanel06.png width=100></a>&nbsp;&nbsp;
 <a href=https://git.deadtom.me/deadtom/OwnchatBot/src/master/screenshots/mgmtpanel07.png><img src=https://git.deadtom.me/deadtom/OwnchatBot/raw/master/screenshots/mgmtpanel07.png width=100></a>&nbsp;&nbsp;
 
+## Requirements
+* Git
+* A recent version of Python.
+  * If using Debian, make sure python3-venv is installed.
+* Your Owncast instance must be running in https for IndieAuth authentication to function correctly.
+* It is HIGHLY recommended to run OwnchatBot behind a reverse proxy.
+ * If your Owncast instance has a reverse proxy, you'll need a separate reverse-proxy for OwnchatBot.
+
 ## Installation
-#### These instructions assume that you have git, and a recent version of python installed.
 1. You can simply download the zip/tar file from the git repo, and decompress it, but I recommend cloning the repo instead. It will make upgrading to future versions much easier.
     ```bash
     git clone https://git.deadtom.me/deadtom/OwnchatBot.git
@@ -110,7 +118,8 @@ env/bin/python -m gunicorn --error-logfile ownchatbot.log -b 0.0.0.0:8081 -w 1 '
 **A caveat here:** Some features are managed by a module called apscheduler. I chose this for its simplicity, however, it doesn't play well when trying to run the app with more than one worker. The "-w 1" option in the gunicorn command specifies just one worker. If you run it with more, it will multiply the jobs that apscheduler manages. For example, "-w 4" will start four workers, and every job apscheduler performs will get run four times. OCB will continue to function fine, but you'll see fun things like announcements getting repeated four times, and viewers getting awarded four times your configured points awards. OCB isn't yet so huge that it really needs more than one worker, but at some point I might try to move away from apscheduler.
 
 ## Final configuration
-Once OwnchatBot is running, you can start setting up your rewards and other options via the Management Panel at the URL provided by the install script. Authentication is handled using your Owncast server as an IndieAuth server. Your login credentials are the same credentials you use to log into your Owncast Admin page.
+Once OwnchatBot is running, you can start setting up your rewards and other options ```/mgmt```.
+Authentication is handled using your Owncast server as an IndieAuth server, so your login credentials are the same credentials you use to log into your Owncast Admin page.
 
 The first thing you'll want to visit is the settings page. Each option is explained in detail. Then you'll need to get it talking to your Owncast instance, and Kofi if you'll be using it, both covered below.