Merge pull request #3 from airbornelamb/master

added docker support

Author: tt2468

Dockerfile

@@ -0,0 +1,4 @@
+From python:3
+COPY main.py entrypoint.sh ./
+RUN pip install simpleobsws aiohttp
+ENTRYPOINT [ "sh", "./entrypoint.sh" ]

README.md

@@ -9,6 +9,12 @@ A Python-based program that provides HTTP endpoints for obs-websocket
 - CD into the `obs-websocket-http` directory
 - Run with `python3.7 main.py`
 
+## Running with Docker
+
+- Clone/download the repository
+- Edit `docker-compose.yml` to have the correct IPs and ports for this machine and the one running OBS Studio (it may be the same machine). You do NOT need to edit `config.ini` if using docker because it will be created by the container from the values in `docker-compose.yml`.
+- Start obs-websocket-http by running `docker-compose up -d && docker-compose logs -f`. This will give you log output and you can press `Ctrl-C` when you wish to return to terminal and the container will run in the background.
+
 ## Protocol:
 This code contains two request endpoints. `/emit/{requesttype}` and `/call/{requesttype}`.
 - `/emit/{requesttype}` sends off a websocket event without waiting for a response, and immediately returns a generic `{"status":"ok"}` json response after sending the event, regardless of whether it errors out on the OBS instance.

docker-compose.yml

@@ -0,0 +1,15 @@
+version: '2.1'
+
+services:
+  obswebsocket:
+    build: .
+    restart: unless-stopped
+    environment:
+      - API_ADDRESS=127.0.0.1   # Address of this machine
+      - API_PORT=4445           # Port you wish to use for API
+      - API_KEY=                # Auth key you wish to set
+      - OBS_ADDRESS=127.0.0.1   # IP of machine running OBS Studio
+      - OBS_PORT=4444           # OBS port
+      - OBS_PASSWORD=           # OBS password, if used
+    ports:
+      - "4445:4445"             # Set to same value as API_PORT

entrypoint.sh

@@ -0,0 +1,24 @@
+#!/usr/bin/env sh
+
+# Create config.ini
+cat << EOF > ./config.ini
+[http]
+bind_to_address = @api_address@
+bind_to_port = @api_port@
+authentication_key = @api_key@
+
+[obsws]
+ws_address = @obs_address@
+ws_port = @obs_port@
+ws_password = @obs_password@
+EOF
+sed -i "s|@api_address@|${API_ADDRESS}|" ./config.ini
+sed -i "s|@api_port@|${API_PORT}|" ./config.ini
+sed -i "s|@api_key@|${API_KEY}|" ./config.ini
+
+sed -i "s|@obs_address@|${OBS_ADDRESS}|" ./config.ini
+sed -i "s|@obs_port@|${OBS_PORT}|" ./config.ini
+sed -i "s|@obs_password@|${OBS_PASSWORD}|" ./config.ini
+
+# Start the server
+python3 ./main.py