OSC mirror

A derivative of webRTCgui which uses the websockets to channel OSC messages through the network. This allows to circumvent many network restrictions such as Firewalls which may make it hard to exchange OSC messages directly. It aims to reproduce the core API of OSCGroups.

The project consists of two parts written in TypeScript,

1. a server which needs to run on a remote machine and
2. a client, which serves as the translation layer between the WebSocket connection and our OSC messages from e.g. SuperCollider. This needs to run on your local machine.

Setup client

To run the client locally you need to have node or Docker installed and have the repository cloned to your local computer via

git clone https://github.com/capital-G/oscMirror.git
cd oscMirror

Make sure you have already started OscGroups.enable because otherwise you will may not be able to receive remote commands because of port clashes.

Node

Assuming you have node installed you first need to install the necessary dependencies via

npm install

After this you can connect your local client to the central server via

BACKEND_AUTH_TOKEN=xenakisBirthdayBoy \
BACKEND_ADDRESS="https://mirror.dennis-scheiba.com" \
npm run client

If everything went well you should see a "Connected to server" message after some time.

Docker

• This will not work for Linux, please use the native Node/npm version above
• Note that on some platforms it is docker-compose and on others it is docker compose

BACKEND_AUTH_TOKEN=xenakisBirthdayBoy \
BACKEND_ADDRESS="https://mirror.dennis-scheiba.com" \
docker compose -f docker-compose.client.yml up --build

Setup server

Clone the repo, install Docker and run

BACKEND_AUTH_TOKEN=xenakisBirthdayBoy \
docker-compose -f docker-compose.server.yml up --build -d

and put a reverse proxy on port 4000. Make sure you have activated the websocket support on your reverse proxy!

License

GPL-2.0