omnibar-moderation

Moderation tool for items to be shown on the omnibar

Installation

Requirements:

• Node >= 8.x
• yarn

1. Clone the app into a folder.
2. run yarn install
3. Create a file called settings.json It has to define at least the following:

{
  "twitch": {
    "clientID": "<your client ID>",
    "channels": [
      {
        "id": "54739364",
        "name": "esamarathon"
      }
    ]
  }
}

But can overwrite any properties from ./shared/src/settings.default.json (such as admins, channels etc.)

DO NOT SET SECRETS IN settings.json! (see step 4)

4. Create a file caled setings.backend.json Here you set your secrets and other things only relevant to the backend, at least defining the following:

{
  "auth": {
    "secret": "<your encryption secret>"
  },
  "twitch": {
    "clientSecret": "<your client secret>"
  },
  "repeater": {
    "endpoint": "https://127.0.0.1:1234/omnibar_mod?key=<your omnibar secret>"
  }
}

Where the repeater endpoint points to where the socket repeater is serving the omnibar moderation POST endpoint from (usually /omnibar_mod?key=some_secret_key).

This can also be used to define differing ports for the backend and frontend, depending on your setup.

5. run yarn build
6. serve static files from ./dist/frontend
7. add a systemd service that runs yarn start

Docker Usage

Dockerfiles are available as Dockerfile.backend and Dockerfile.frontend; we have split it up into 2 different builds for ease of use. Our own Docker images are available under "Packages" (tagged latest-frontend and latest-backend respectively).

For the backend, our image will work but you will need to supply your own settings.backend.json file either via volume mounting or Docker Configs, mounted as /home/node/app/settings.backend.json. You also need to mount a volume that stores some persistent files at /home/node/app/backend/dist/state. There are also a limited amount of settings that you can supply via environment variables:

environment:
  - TWITTER_SEARCHTERMS=@esamarathon,#ESASummer18

The frontend requires being built yourself as some variables are hardcoded at build time, otherwise they will use the defaults, these settings specifically:

{
  "twitch": {
    "clientID": "<your client ID>"
  },
  "api": {
    "baseurl": "http://127.0.0.1:8081/"
  }
}

To do this, just create a settings.json file in the root directory before you build.

You may also need to change the public path the assets are served from, which is currently located at frontend/config/index.js#L53, currently set to "/mods/"

If you wish to use docker-compose, an example docker-compose.yaml file has been supplied that may help.