Adds documentation to IRC bots, moves TWITCH_APP_ID env var to TWITCH_CLIENT_ID, but allows old TWITCH_APP_ID to still work.

FiniteSingularity · FiniteSingularity · commit 6a94cc8bae40 · 2022-10-20T18:22:06.000Z
diff --git a/.env_sample b/.env_sample
@@ -4,7 +4,7 @@
 # app on this page:
 # https://dev.twitch.tv/console/apps
 
-TWITCH_APP_ID=
+TWITCH_CLIENT_ID=
 
 
 ##########################################################
diff --git a/.env_single_container_sample b/.env_single_container_sample
@@ -6,7 +6,7 @@ DJANGO_SECRET_KEY=<RANDOM STRING>
 
 PORT=80
 
-TWITCH_APP_ID=<TWITCH APP ID>
+TWITCH_CLIENT_ID=<TWITCH APP ID>
 TWITCH_CLIENT_SECRET=<TWITCH CLIENT SECRET>
 TWITCH_WEBHOOK_SECRET=<RANDOM STRING>
 
diff --git a/README.md b/README.md
@@ -37,6 +37,16 @@ will help TAU become more stable and secure. Use at your own risk._
 _Note 2- TAU is written using django/python, however, acting as an
 API proxy, you can connect any codebase to its websockets._
 
+_Note 3- If when starting up TAU, you see the error:
+```
+ bash: ./scripts/start.sh: /bin/bash^M: bad interpreter: No such file or directory
+```
+This is due to windows git changing your line endings from `lf` to `crlf`.  Use the command:
+```
+git config --global core.autocrlf input
+```
+Turn off autoclrf, and re-clone the repository.
+
 # :star: Features
 
 - Easy to use UI to manage Twitch events
@@ -58,8 +68,7 @@ First thing you'll need to do is to clone or download this repo to a local folde
 
 ## Twitch Setup
 
-Because TAU depends heavily on Twitch, it is necessary to obtain a Twitch App ID and
-secret. The steps below will help you do this.
+Because TAU depends heavily on Twitch, it is necessary to obtain a Twitch Client ID and Client Secret. The steps below will help you do this.
 
 1. Determine the port you want to run TAU on. By default this is port 8000. Use this value for `PORT` in the following steps.
 1. Visit the [Twitch Developer Applications Console](https://dev.twitch.tv/console/apps).
@@ -79,7 +88,7 @@ Now that you've obtained your Client ID and Client Secret, it is time to set up
 
 Fill in values for:
 
-- TWITCH_APP_ID (The Twitch Client ID you just generated)
+- TWITCH_CLIENT_ID (The Twitch Client ID you just generated)
 - TWITCH_CLIENT_SECRET (The Twitch Client Secret you just generated)
 - TWITCH_WEBHOOK_SECRET (a random string)
 - POSTGRES_PW Root Password
diff --git a/docs/api/connecting.md b/docs/api/connecting.md
@@ -11,7 +11,7 @@ A TAU token is required for both the realtime websocket API and the REST API.  T
 TAU exposes a websocket endpoint at `ws://localhost:PORT/ws/twitch-events/` for a local deployment or `wss://yourdomain:PORT/ws/twitch-events/` for a served deployment.  After connecting your client to the websocket, you must send a message containing the following json object:
 ```
 { 
-    token: 'YOUR TOKEN HERE'
+    "token": "YOUR TOKEN HERE"
 }
 ```
 After receiving your token, TAU will begin to broadcast incoming twitch events to your client.
@@ -22,3 +22,23 @@ TAU also provides 2 separate REST APIs.  A passthrough of the Twitch Helix API a
 Authorization: Token YOUR-TOKEN-HERE
 ```
 The Update Token Scopes page from the dashboard will allow you to add scopes to the Twitch token used by TAU.
+
+## Connecting to Chat Bot Websockets
+TAU also provides websockets for your streamer user chat, and any chat bots you have set up at `ws/chat-bots/<chat-bot-username>/` where `<chat-bot-username>` is the all-lowercase twitch username of your streamer account or any chat-bot accounts you have set up in TAU.
+
+After connecting your client to the websocket, you must send a message containing the following json object:
+
+```
+{ 
+    "token": "YOUR TOKEN HERE"
+}
+```
+
+After receiving your token, TAU will begin to broadcast incoming twitch chat events to your client.  You can also send outgoing messages to be posted in chat by your bot.  Simply send the following payload to the endpoint of the bot you would like to have "speak":
+
+```
+{
+    "irc_channel": "channel_to_send_to",
+    "message": "message to post in channel."
+}
+```
diff --git a/docs/deployment/local.md b/docs/deployment/local.md
@@ -4,7 +4,7 @@ The simplest way to deploy TAU is locally, using Docker.  Setting TAU up locally
 1. [Get a Twitch Client ID and Client Secret](./twitch_dev.md)
 1. Copy `.env_sample` to `.env`
 1. Open and edit the newly created `.env` file. Set the following values.  Please do not use the `#` character in any of your passwords or secret keys.
-1. `TWITCH_APP_ID` Set your twitch app client id. This is the "Client ID" available by clicking the "Manage" button for your app on this page: [https://dev.twitch.tv/console/apps](https://dev.twitch.tv/console/apps)
+1. `TWITCH_CLIENT_ID` Set your twitch app client id. This is the "Client ID" available by clicking the "Manage" button for your app on this page: [https://dev.twitch.tv/console/apps](https://dev.twitch.tv/console/apps)
 1. `TWITCH_CLIENT_SECRET` Set your twitch app secret. This is the "Client Secret" available by clicking the "Manage" button for your  app on this page: [https://dev.twitch.tv/console/apps](https://dev.twitch.tv/console/apps) If you don't already one (or you no longer have your  original one), click "New Secret". You'll only be able to see it when you first make it so put it in your password manager.
 1. `TWITCH_WEBHOOK_SECRET` This secret is required for Twitch EventSub. It's one that you generate yourself (i.e. it's not the app client secret from the [dev.twitch.tv](https://dev.twitch.tv) page).  The secret must be between 10-100 characters. You can use this one, or genrate one yourself. 
 1. `POSTGRES_PW` This is the root password which will be set for your Postgres container. You can use the password set here but it is more secure to set your own strong password. You likely wont need to directly use this password at all.
diff --git a/docs/deployment/railway.md b/docs/deployment/railway.md
@@ -2,7 +2,7 @@
 
 [Railway](https://railway.app/) is a cost effective way to run TAU 24/7 in the cloud. The following steps should get you started! These instructions assume you have cloned the TAU repo to your local drive, and that you have npm installed (the railway CLI app requires npm).
 
-<!-- [![Deploy on Railway](https://railway.app/button.svg)](https://railway.app/new/template?template=https%3A%2F%2Fgithub.com%2FTeam-TAU%2Ftau%2Ftree%2Fdocumentation-railway-docs&plugins=postgresql%2Credis&envs=TWITCH_APP_ID%2CTWITCH_CLIENT_SECRET%2CTWITCH_WEBHOOK_SECRET%2CDJANGO_DB_PW%2CDJANGO_SECRET_KEY%2CDJANGO_CONFIGURATION%2CPORT&TWITCH_APP_IDDesc=Your+Twitch+TAU+app+id.&TWITCH_CLIENT_SECRETDesc=Your+Twitch+TAU+client+secret.&TWITCH_WEBHOOK_SECRETDesc=Random+string+of+10-100+characters.&DJANGO_DB_PWDesc=A+password+you+would+like+to+use+for+your+TAU+postgres+database.&DJANGO_SECRET_KEYDesc=Random+string+of+10-100+characters.&DJANGO_CONFIGURATIONDesc=DO+NOT+CHANGE&PORTDesc=DO+NOT+CHANGE&DJANGO_CONFIGURATIONDefault=Railway&PORTDefault=443&referralCode=TAU) -->
+<!-- [![Deploy on Railway](https://railway.app/button.svg)](https://railway.app/new/template?template=https%3A%2F%2Fgithub.com%2FTeam-TAU%2Ftau%2Ftree%2Fdocumentation-railway-docs&plugins=postgresql%2Credis&envs=TWITCH_CLIENT_ID%2CTWITCH_CLIENT_SECRET%2CTWITCH_WEBHOOK_SECRET%2CDJANGO_DB_PW%2CDJANGO_SECRET_KEY%2CDJANGO_CONFIGURATION%2CPORT&TWITCH_CLIENT_IDDesc=Your+Twitch+TAU+app+id.&TWITCH_CLIENT_SECRETDesc=Your+Twitch+TAU+client+secret.&TWITCH_WEBHOOK_SECRETDesc=Random+string+of+10-100+characters.&DJANGO_DB_PWDesc=A+password+you+would+like+to+use+for+your+TAU+postgres+database.&DJANGO_SECRET_KEYDesc=Random+string+of+10-100+characters.&DJANGO_CONFIGURATIONDesc=DO+NOT+CHANGE&PORTDesc=DO+NOT+CHANGE&DJANGO_CONFIGURATIONDefault=Railway&PORTDefault=443&referralCode=TAU) -->
 
 1. [Create a railway account/login](https://railway.app/login)
 1. [Go to your railway dashboard](https://railway.app/dashboard)
@@ -24,10 +24,10 @@
 
 ## Sample .env data.
 
-All `.env` data should come from your local install of TAU (see your existing `.env`). The first 6 values must be set. `TWITCH_APP_ID` and `TWITCH_CLIENT_SECRET` come from the Twitch developer settings above, `TWITCH_WEBHOOK_SECRET` should be a random string of characters 10-100 characters long. `DJANGO_DB_PW` can be any password you want to set for the Django databse user, `DJANGO_SECRET_KEY` should be a different random string of characters 10-100 characters long, and `PUBLIC_URL` should be the deployment domain, e.g.- `tau-twitchname.up.railway.app`. The last two values (`DJANGO_CONFIGURATION` and `PORT`) should use the provided values below.
+All `.env` data should come from your local install of TAU (see your existing `.env`). The first 6 values must be set. `TWITCH_CLIENT_ID` and `TWITCH_CLIENT_SECRET` come from the Twitch developer settings above, `TWITCH_WEBHOOK_SECRET` should be a random string of characters 10-100 characters long. `DJANGO_DB_PW` can be any password you want to set for the Django databse user, `DJANGO_SECRET_KEY` should be a different random string of characters 10-100 characters long, and `PUBLIC_URL` should be the deployment domain, e.g.- `tau-twitchname.up.railway.app`. The last two values (`DJANGO_CONFIGURATION` and `PORT`) should use the provided values below.
 
 ```
-TWITCH_APP_ID=
+TWITCH_CLIENT_ID=
 TWITCH_CLIENT_SECRET=
 TWITCH_WEBHOOK_SECRET=
 DJANGO_DB_PW=
diff --git a/docs/env_options.md b/docs/env_options.md
@@ -19,6 +19,6 @@ The following environment variables can be used to manipulate your Tau install.
 | DJANGO_DB_PW          | Password for the `DJANGO_DB_USER`                                                | ''            |
 | DJANGO_CONFIGURATION  | Configuration django uses                                                        | Local         |
 | DJANGO_SECRET_KEY     | Key used by Django for keeping your data stored securely                         | None          |
-| TWITCH_APP_ID         | Application ID for connecting to twitch                                          | ''            |
+| TWITCH_CLIENT_ID         | Application ID for connecting to twitch                                          | ''            |
 | TWITCH_CLIENT_SECRET  | Used for communicating with the twitch API                                       | ''            |
 | TWITCH_WEBHOOK_SECRET | Used for signing the webhooks from twitch to validate they are legitimate        | ''            |
diff --git a/docs/irc_bot_setup.md b/docs/irc_bot_setup.md
@@ -0,0 +1,20 @@
+# IRC Chatbot Setup
+
+TAU automatically connects your streamer user to chat if you have the User IRC option enabled in the Config panel.
+
+If you would like to enable IRC Bots with different accounts (e.g.- YourBotName) you can do so by following the instructions below.
+
+Once your bot accounts are set up, you can subscribe to their websocket connection following the instructions here [link to instructions]
+
+## IRC Bot Setup
+
+1. Go to ChatBots tab in the dashboard.
+1. Click the [+] button in the upper right corner of the Chat Bot Status card.
+1. Click "Copy URL" in the resulting modal.
+1. Open a new browser instance (preferably private/incognito mode) and paste the url in the address bar.
+1. Log in as the bot account you want to enable, and click "Authorize"
+1. Close this browser window when instructed to do so, and refresh the TAU dashboard.
+1. You should now see your bot listed.
+1. Click add next to your bot's name to add a channel for the bot to join.  In the resulting modal, enter the Twitch User's channel for the bot.
+1. Your bot should now be ready to do all of its bot things.
+1. Go to [link to instructions] to link up your bot code to TAU.
diff --git a/tau/chatbots/models.py b/tau/chatbots/models.py
@@ -6,6 +6,7 @@
 
 from django.db import models
 from django.utils import timezone
+from django.conf import settings
 
 
 # Create your models here.
@@ -29,7 +30,7 @@ def is_token_expired(self):
 
     def renew_token(self):
         refresh_token = self.refresh_token
-        client_id = os.environ.get('TWITCH_APP_ID', None)
+        client_id = settings.TWITCH_CLIENT_ID
         client_secret = os.environ.get('TWITCH_CLIENT_SECRET', None)
         req = requests.post('https://id.twitch.tv/oauth2/token', data={
             'client_id': client_id,
diff --git a/tau/chatbots/views.py b/tau/chatbots/views.py
@@ -43,7 +43,7 @@ def status_keep_alive(self, request):
     def twitch_auth_link(self, request):
         state = uuid4()
         config.TWITCH_AUTH_STATE = str(state)
-        client_id = os.environ.get('TWITCH_APP_ID', None)
+        client_id = settings.TWITCH_CLIENT_ID
         scope = 'chat:read chat:edit channel:moderate'
         url = f'https://id.twitch.tv/oauth2/authorize?' \
             f'client_id={client_id}&' \
@@ -69,7 +69,7 @@ def twitch_callback(self, request):
         print(f'stored: {config.TWITCH_AUTH_STATE}')
         if state != config.TWITCH_AUTH_STATE:
             return HttpResponseForbidden()
-        client_id = os.environ.get('TWITCH_APP_ID', None)
+        client_id = settings.TWITCH_CLIENT_ID
         client_secret = os.environ.get('TWITCH_CLIENT_SECRET', None)
         auth_r = requests.post('https://id.twitch.tv/oauth2/token', data={
             'client_id': client_id,
diff --git a/tau/config/common.py b/tau/config/common.py
@@ -15,6 +15,8 @@ class Common(Configuration):  # pylint: disable=no-init
     BEHIND_PROXY = (os.environ.get("BEHIND_PROXY", "false").lower() == "true")
     BASE_DIR = BASE_DIR
 
+    TWITCH_CLIENT_ID = os.environ.get("TWITCH_APP_ID", os.environ.get("TWITCH_CLIENT_ID", None))
+
     if BASE_PORT not in [80, 443] and not BEHIND_PROXY:
         BASE_URL = BASE_URL + f":{BASE_PORT}"
 
diff --git a/tau/core/utils.py b/tau/core/utils.py
@@ -36,7 +36,7 @@ def check_access_token_expired():
 
 def refresh_access_token():
     refresh_token = config.TWITCH_REFRESH_TOKEN
-    client_id = os.environ.get('TWITCH_APP_ID', None)
+    client_id = settings.TWITCH_CLIENT_ID
     client_secret = os.environ.get('TWITCH_CLIENT_SECRET', None)
     req = requests.post('https://id.twitch.tv/oauth2/token', data={
         'client_id': client_id,
@@ -141,7 +141,7 @@ def streamer_payload(base_url, status, streamer_id):
 
 def init_webhook(payload, url=None, worker_token=None, instance_id=None):
     webhook_headers = {
-        'Client-ID': os.environ.get('TWITCH_APP_ID', None),
+        'Client-ID': settings.TWITCH_CLIENT_ID,
         'Authorization': f'Bearer {config.TWITCH_APP_ACCESS_TOKEN}',
     }
     if instance_id is not None:
@@ -213,7 +213,7 @@ def teardown_webhooks(worker_token):
     active_subs = TwitchEventSubSubscription.objects.filter(subscription__isnull=False)
     # Get subscriptions
     headers = {
-        'Client-ID': os.environ.get('TWITCH_APP_ID', None),
+        'Client-ID': settings.TWITCH_CLIENT_ID,
         'Authorization': f'Bearer {config.TWITCH_APP_ACCESS_TOKEN}',
     }
 
@@ -271,7 +271,7 @@ def teardown_webhooks(worker_token):
 
 def cleanup_webhooks():
     headers = {
-        'Client-ID': os.environ.get('TWITCH_APP_ID', None),
+        'Client-ID': settings.TWITCH_CLIENT_ID,
         'Authorization': f'Bearer {config.TWITCH_APP_ACCESS_TOKEN}',
     }
 
@@ -295,7 +295,7 @@ def cleanup_webhooks():
 
 def cleanup_remote_webhooks():
     headers = {
-        'Client-ID': os.environ.get('TWITCH_APP_ID', None),
+        'Client-ID': settings.TWITCH_CLIENT_ID,
         'Authorization': f'Bearer {config.TWITCH_APP_ACCESS_TOKEN}',
     }
 
@@ -321,7 +321,7 @@ def cleanup_remote_webhooks():
 
 def teardown_all_acct_webhooks():
     headers = {
-        'Client-ID': os.environ.get('TWITCH_APP_ID', None),
+        'Client-ID': settings.TWITCH_CLIENT_ID,
         'Authorization': f'Bearer {config.TWITCH_APP_ACCESS_TOKEN}',
     }
 
diff --git a/tau/core/views.py b/tau/core/views.py
@@ -84,7 +84,7 @@ def helix_view(request, helix_path=None):
     except TwitchHelixEndpoint.DoesNotExist:
         token = config.TWITCH_ACCESS_TOKEN
     body = request.data
-    client_id = os.environ.get('TWITCH_APP_ID', None)
+    client_id = settings.TWITCH_CLIENT_ID
     headers = {
         'Authorization': f'Bearer {token}',
         'Client-Id': client_id
@@ -182,7 +182,7 @@ def get_channel_name_view(request):
             # Process the data
             config.CHANNEL = form.cleaned_data['channel_name']
             scope = ' '.join(settings.TOKEN_SCOPES)
-            client_id = os.environ.get('TWITCH_APP_ID', None)
+            client_id = settings.TWITCH_CLIENT_ID
             url = f'https://id.twitch.tv/oauth2/authorize?' \
                   f'client_id={client_id}&' \
                   f'redirect_uri={settings.BASE_URL}/twitch-callback/&' \
@@ -198,7 +198,7 @@ def get_channel_name_view(request):
         return HttpResponse(template.render({}, request))
 
 def refresh_token_scope(request):
-    client_id = os.environ.get('TWITCH_APP_ID', None)
+    client_id = settings.TWITCH_CLIENT_ID
 
     helix_scopes = list(
         TwitchAPIScope.objects.filter(
@@ -268,7 +268,7 @@ def reset_webhooks(request):
 def authenticate_bot(request):
     params = request.GET
     bot_id = params['bot']
-    client_id = os.environ.get('TWITCH_APP_ID', None)
+    client_id = settings.TWITCH_CLIENT_ID
     scope = 'chat:read chat:edit'
 
     url = f'https://id.twitch.tv/oauth2/authorize?' \
@@ -285,7 +285,7 @@ def process_twitch_callback_view(request):
     params = request.GET
     auth_code = params['code']
     bot_id = params.get('state', None)
-    client_id = os.environ.get('TWITCH_APP_ID', None)
+    client_id = settings.TWITCH_CLIENT_ID
     client_secret = os.environ.get('TWITCH_CLIENT_SECRET', None)
     auth_r = requests.post('https://id.twitch.tv/oauth2/token', data={
         'client_id': client_id,
diff --git a/tau/streamers/signals.py b/tau/streamers/signals.py
@@ -16,7 +16,7 @@
 def streamer_deleted(sender, instance, **kwargs):
     if instance.online_subscription is not None:
         headers = {
-            'Client-ID': os.environ.get('TWITCH_APP_ID', None),
+            'Client-ID': settings.TWITCH_CLIENT_ID,
             'Authorization': f'Bearer {config.TWITCH_APP_ACCESS_TOKEN}',
         }
         sub_id = instance.online_subscription['id']
@@ -40,7 +40,7 @@ def streamer_deleted(sender, instance, **kwargs):
 @receiver(post_save, sender=Streamer)
 def streamer_saved(sender, instance, created, **kwargs):
     if created:
-        client_id = os.environ.get('TWITCH_APP_ID', None)
+        client_id = settings.TWITCH_CLIENT_ID
         headers = {
             'Authorization': f'Bearer {config.TWITCH_ACCESS_TOKEN}',
             'Client-Id': client_id
@@ -63,7 +63,7 @@ def streamer_saved(sender, instance, created, **kwargs):
         elif not instance.streams.filter(ended_at__isnull=True).exists():
             # create new stream object
             # 1. Fetch stream data from twitch
-            client_id = os.environ.get('TWITCH_APP_ID', None)
+            client_id = settings.TWITCH_CLIENT_ID
             headers = {
                 'Authorization': f'Bearer {config.TWITCH_ACCESS_TOKEN}',
                 'Client-Id': client_id
diff --git a/tau/streamers/utils.py b/tau/streamers/utils.py
@@ -3,6 +3,8 @@
 
 from constance import config
 
+from django.conf import settings
+
 from .models import Streamer
 
 def update_all_streamers():
@@ -15,7 +17,7 @@ def update_all_streamers():
     streamer_ids = [streamer.twitch_id for streamer in streamers]
     streamer_ids_param = '&'.join([f'user_id={id}' for id in streamer_ids])
 
-    client_id = os.environ.get('TWITCH_APP_ID', None)
+    client_id = settings.TWITCH_CLIENT_ID
     headers = {
         'Authorization': f'Bearer {config.TWITCH_ACCESS_TOKEN}',
         'Client-Id': client_id
