From 2f13ffabe94a3054a3434c73ff57845792929987 Mon Sep 17 00:00:00 2001 From: Lili Date: Wed, 18 Jan 2023 10:57:05 +0100 Subject: [PATCH] readme: more domain changes to .example, wording --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index c6a009c..5f5360a 100644 --- a/README.md +++ b/README.md @@ -131,7 +131,7 @@ it will work because the ngrok connection is https. **External Action config example:** ``` -URL: MyTlapbotServer.com/dashboard +URL: MyTlapbotServer.example/dashboard Action Title: Redeems Dashboard ``` #### Note about https and reverse proxying @@ -142,14 +142,14 @@ The Owncast documentation about SSL and Reverse proxying is here: https://owncas If your followed the [Owncast recommendation to use Caddy](https://owncast.online/docs/sslproxies/caddy/) you'd only need to include this in your caddyfile to make the tlapbot dashboard work: ``` -MyTlapbotServer.com { +MyTlapbotServer.example { reverse_proxy localhost:8000 } ``` -then MyTlapbotServer.com/owncastWebhook is the URL for webhooks, -and MyTlapbotServer.com/dashboard is the URL for the dashboard. +then MyTlapbotServer.example/owncastWebhook is the URL for webhooks, +and MyTlapbotServer.example/dashboard is the URL for the dashboard. -(And, obviously, you'd need to own the MyTlapbotServer.com domain, and have an A record pointing to your server's IP address.) +(And, obviously, you'd need to own the MyTlapbotServer.example domain, and have an A record pointing to your server's IP address.) ## Running the bot ### Running in debug: Set the FLASK_APP variable: @@ -223,7 +223,7 @@ This command only changes counters, so if you want to clear the queue with list #### clear-refresh Does the same as `clear-queue` and `refresh-counters` together. -Only run this if you're adding/removing counters, want to reset them to zero and want to clear all redeems as well. +Run this if you're adding/removing counters, want to reset them to zero and want to clear all redeems as well. ## Configuration files ### config.py Values you can include in `config.py` to change how the bot behaves.