This fixes #16

* Slight modification to Dockerfile to include `requirements.txt`, as
  well as modify copy/`pip` locations to reduce reinstalling on every
change/build. Speeds up dev cycle a bit.
* Updated `requirements.txt` to include `aiohttp_cors`
* Server port updated from 4445 -> 4456 to keep in vain of ws+1
* `config.ini` Changes:
	* Changed port 4444 -> 4455 to match obs-websocket v5 default
	* Added `cors_domains`, which is a comma-separated list
* `docker-compose.yml` Changes:
	* Moved comments as they were getting long
	* Updated values to match new `config.ini` changes
	* Added `extra_hosts` section to properly route DNS to local
	  Host IP, allowing easier connectivity
* `entrypoint.sh` Changes:
	* Updated to add and sed replace `cors_domains`
* `main.py` Changes:
	* Added Parser configs for `cors_domains`, defaulting to
	  wildcard (`*`)
	* Added some logging to show CORS domains accepted
	* Added some logging to show bindAddress and port for user's
	  sake
	* ***Re-added loop***... I know this was removed, but after
	  looking at how aiohttp works, it will create it's own event
loop and mess everything up if not included. Since the main event loop
is being used to run `init`, it's necessary to inject into `web.run_app`
to use the same event loop or all requests to obs will timeout. Maybe
there's a better way to do this, but I am not a Python dev to know
better.
	* Added method to iterate over supplied CORS Domains and add the
	  routes as accepted from said domains.

You can test this from a codepen example I built getting the OBS
version: https://codepen.io/CodexHere/full/ZEqYLVX

To validate, simply set `cors_domains` to any invalid value, such as
"none" and restart the server.

Author: CodexHere

Dockerfile

@@ -1,4 +1,5 @@
 From python:3
-COPY main.py entrypoint.sh ./
+COPY entrypoint.sh requirements.txt ./
 RUN pip install -r requirements.txt
+COPY main.py ./
 ENTRYPOINT [ "sh", "./entrypoint.sh" ]

README.md

@@ -34,8 +34,14 @@ A request type is always required, however the request body is optional, and is
 For a list of request types, refer to the [obs-websocket protocol docs](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#requests)
 
 ## Example cURL commands:
-- `curl -XPOST -H 'Authorization: pp123' -H "Content-type: application/json" -d '{"sceneName": "Scene 5"}' 'http://127.0.0.1:4445/emit/SetCurrentProgramScene'`
-- `curl -XPOST -H "Content-type: application/json" 'http://127.0.0.1:4445/call/GetCurrentProgramScene'`
+- `curl -XPOST -H 'Authorization: pp123' -H "Content-type: application/json" -d '{"sceneName": "Scene 5"}' 'http://127.0.0.1:4456/emit/SetCurrentProgramScene'`
+- `curl -XPOST -H "Content-type: application/json" 'http://127.0.0.1:4456/call/GetCurrentProgramScene'`
+`
+## CORS Errors/Setup
+
+If you receive errors about CORS and not having `Access-Control-Allow-Origin` header for the endpoint, be sure to modify `config.ini` or `docker-compose.yml` to properly set `cors_domains`.
+
+> A domain of `*` will allow *ALL* domains privileges to make successful requests, so use it at your own risk. Either configure appropriately, or use an Auth key for the HTTP configuration.
 
 ## IRLTookit Links
 

config.ini

@@ -1,10 +1,12 @@
 [http]
-bind_to_address = 0.0.0.0
-bind_to_port = 4445
+bind_to_address=0.0.0.0
+bind_to_port=4456
+cors_domains=*
 #Leave empty if no authentication is required.
-authentication_key = 
+authentication_key=
 
 [obsws]
-ws_url = ws://127.0.0.1:4444
+#obs-websocket v5 uses port 4455 by default
+ws_url=ws://127.0.0.1:4455 
 #Only necessary if "Enable authentication" is checked in the obs-websocket settings menu.
-ws_password = 
+ws_password =

docker-compose.yml

@@ -5,10 +5,22 @@ services:
     build: .
     restart: unless-stopped
     environment:
-      - API_ADDRESS=0.0.0.0         # Address of this machine
-      - API_PORT=4445               # Port you wish to use for API
-      - API_KEY=                    # Auth key you wish to set
-      - OBS_URL=ws://127.0.0.1:4444 # WebSocket Connect URL
-      - OBS_PASSWORD=               # OBS password, if used
+      # Address of this machine
+      - API_ADDRESS=0.0.0.0
+      # Port you wish to use for API
+      - API_PORT=4456
+      # Auth key you wish to set
+      - API_KEY=
+      # WebSocket Connect URL
+      - OBS_URL=ws://host.docker.internal:4455
+      # OBS password, if used
+      - OBS_PASSWORD=
+      # CORS Domains to accept requests from (comma separated, no spaces. *=all domains)
+      - CORS_DOMAINS=*
     ports:
-      - "4445:4445"             # Set to same value as API_PORT
+      # Set to same value as API_PORT
+      - '4456:4456'
+    extra_hosts:
+      # Allows routing from docker container to Host OS (see: https://stackoverflow.com/a/43541681)
+      - 'host.docker.internal:host-gateway'
+

entrypoint.sh

@@ -5,6 +5,7 @@ cat << EOF > ./config.ini
 [http]
 bind_to_address = @api_address@
 bind_to_port = @api_port@
+cors_domains = @cors_domains@
 authentication_key = @api_key@
 
 [obsws]
@@ -14,6 +15,7 @@ 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|@cors_domains@|${CORS_DOMAINS}|" ./config.ini
 
 sed -i "s|@obs_url@|${OBS_URL}|" ./config.ini
 sed -i "s|@obs_password@|${OBS_PASSWORD}|" ./config.ini

main.py

@@ -7,9 +7,9 @@
 import simpleobsws
 import aiohttp
 from aiohttp import web
+import aiohttp_cors
 from configparser import ConfigParser
 
-loop = asyncio.get_event_loop()
 app = web.Application()
 ws = None
 
@@ -79,7 +79,8 @@ async def emit_request_callback(request):
     return await request_callback(request, True)
 
 async def init():
-    logging.info('Connecting to obs-websocket...')
+    logging.info('Connecting to obs-websocket: {}'.format(wsUrl))
+    
     try:
         await ws.connect()
     except ConnectionRefusedError:
@@ -100,22 +101,38 @@ async def shutdown(app):
     else:
         logging.info('Not connected to obs-websocket, not disconnecting.')
 
+def setup_cors(corsDomains):
+    cors_settings = {
+        "allow_credentials": True,
+        "expose_headers": "*",
+        "allow_headers": "*"
+    }
+
+    resource_options = aiohttp_cors.ResourceOptions(**cors_settings)
+    defaults = {domain: resource_options for domain in corsDomains}
+    cors = aiohttp_cors.setup(app, defaults=defaults)
+
+    for route in list(app.router.routes()):
+        cors.add(route)
+
 if __name__ == '__main__':
     config = ConfigParser()
     config.read('config.ini')
 
     # Command line args take priority, with fallback to config.ini, and further fallback to defaults.
     parser = argparse.ArgumentParser(description='A Python-based program that provides HTTP endpoints for obs-websocket')
     parser.add_argument('--http_bind_addres', dest='http_bind_addres', default=config.get('http', 'bind_to_address', fallback='0.0.0.0'))
-    parser.add_argument('--http_bind_port', dest='http_bind_port', type=int, default=config.getint('http', 'bind_to_port', fallback=4445))
+    parser.add_argument('--http_bind_port', dest='http_bind_port', type=int, default=config.getint('http', 'bind_to_port', fallback=4456))
+    parser.add_argument('--cors_domains', dest='cors_domains', default=config.get('http', 'cors_domains', fallback='*'))
     parser.add_argument('--http_auth_key', dest='http_auth_key', default=config.get('http', 'authentication_key', fallback=''))
-    parser.add_argument('--ws_url', dest='ws_url', default=config.get('obsws', 'ws_url', fallback='ws://127.0.0.1:4444'))
+    parser.add_argument('--ws_url', dest='ws_url', default=config.get('obsws', 'ws_url', fallback='ws://127.0.0.1:4455'))
     parser.add_argument('--ws_password', dest='ws_password', default=config.get('obsws', 'ws_password', fallback=''))
     args = parser.parse_args()
 
     httpAddress = args.http_bind_addres
     httpPort = args.http_bind_port
     httpAuthKey = args.http_auth_key
+    corsDomains = args.cors_domains.split(',')
     wsUrl = args.ws_url
     wsPassword = args.ws_password
 
@@ -125,12 +142,22 @@ async def shutdown(app):
         logging.info('HTTP server will start without authentication.')
         httpAuthKey = None
 
+    logging.info('CORS Domains Accepted: {}'.format(", ".join(corsDomains)))
+    logging.info('HTTP Server Running: {}:{}'.format(httpAddress, httpPort))
+
     ws = simpleobsws.WebSocketClient(url=wsUrl, password=wsPassword)
 
+    loop = asyncio.get_event_loop()
     if not loop.run_until_complete(init()):
         os._exit(1)
 
-    app.add_routes([web.post('/call/{requestType}', call_request_callback), web.post('/emit/{requestType}', emit_request_callback)])
+    app.add_routes([
+        web.post('/call/{requestType}', call_request_callback), 
+        web.post('/emit/{requestType}', emit_request_callback)
+    ])
+
     app.on_cleanup.append(shutdown)
 
-    web.run_app(app, host=httpAddress, port=httpPort)
+    setup_cors(corsDomains)
+
+    web.run_app(app, host=httpAddress, port=httpPort, loop=loop)

requirements.txt

@@ -1,3 +1,4 @@
 simpleobsws>=1.3.1
 aiohttp
 configparser
+aiohttp_cors