title: "[FEAT] "

labels: enhancement

DEBUG_TWITCH_CALLS: ${DEBUG_TWITCH_CALLS:-False}

TAU provides two different APIs-

1. A websocket that broadcasts realtime Twitch events, test events, and replayed events.

2. A REST API the provides access to a passthrough of the Twitch Helix API, as well as endpoints for accessing the data captured and stored by TAU.

A TAU token is required for both the realtime websocket API and the REST API. To obtain your token, go to the TAU Dashboard, click the hamburger menu, then click `Show Auth Token`

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:

After receiving your token, TAU will begin to broadcast incoming twitch events to your client.

TAU also provides 2 separate REST APIs. A passthrough of the Twitch Helix API at: `/api/twitch/helix`, and access to the data captured and stored by TAU at `/api/v1`. In order to authenticate requests, you must include an Authorization header:

The Update Token Scopes page from the dashboard will allow you to add scopes to the Twitch token used by TAU.

Paragraph that says what we're doing..

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_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.

1. `DJANGO_DB_PW` This is the password used for the django database. You can use the random password already set, but it is more secure to set your own. You likely wont need to directly use this password at all.

1. `DJANGO_SECRET_KEY` This is a random key for Django. You can use this one, but it's more secure to generate your own.

1. `PORT` The default port is 8000. If you need to use another port, change it here.

1. `NGROK_TOKEN` It is recommended that you use a free (or paid) ngrok account and token, as non-account tunnels have more limited connection counts. If you have an ngrok token you would like to use, uncomment the `NGROK_TOKEN` line and provide your token.

1. After saving the .env file, in the root TAU directory execute the command: `docker compose up`

1. Open a web browser and navigate to the url: `http://localhost:PORT/`.

1. Enter in a local TAU username, and password then click "Create Account". This does not need to be your twitch username.

1. Enter in your Twitch username, and click Setup Channel.

1. Authorize TAU to the requested scopes.

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.

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).

1. Log in to your Twitch account if you are not already logged in.

1. In order to manage applications, you will need to enable 2FA for your account.

1. Click "+ Register Your Application".

1. Fill in a name for TAU. I recommend TAU- YourTwitchName.

1. Add `http://localhost:PORT/twitch-callback/` as an OAuth Redirect URL. (Note the trailing slash, this is required)

1. Select a category for what you'll be using TAU for. Chat Bot is what I've used.

1. Click "Create"

1. Click "Manage" for the TAU app.

1. Here is where you can find your Client ID, and generate a Client Secret. You'll need these two values later. Note- you can only see the client secret when you generate it, so make sure you copy it to put in your .env file later. Dont worry if you lose it, you can always generate a new secret.

In order for a Twitch bot or overlay to be interractive, it needs to tap into the realtime events sent over the Twitch APIs. This typically requires setting up multiple protocols: a webhook on the server-side and websockets on the client-side. It also requires you to keep track of multiple Twitch access tokens. This is where TAU comes in! TAU takes care of all this for you and also adds the ability to replay past events and generate test events of your own from a user friendly UI. Additionally, all events are stored in a database.

copyright: Copyright &copy; 2021, <a href="proxy.php?url=https%3A%2F%2Fgithub.com%2Ffinitesingularity">finitesingularity</a>.

dev_addr: 0.0.0.0:8007

- Deployment:

- Local: 'deployment/local.md'

- Cloud: 'deployment/cloud.md'

- Connecting: 'api/connecting.md'

DEBUG_TWITCH_CALLS = os.environ.get("DEBUG_TWITCH_CALLS", "False").lower() == "true"

SECURE_PROXY_SSL_HEADER = ('HTTP_X_FORWARDED_PROTO', 'https')

'DEFAULT_PAGINATION_CLASS': 'rest_framework.pagination.CursorPagination',