From 8a43bdd3c6f25bcf8e66e8ccfaa499bf5446ce32 Mon Sep 17 00:00:00 2001 From: Aiden <68633820+awils27@users.noreply.github.com> Date: Sun, 10 May 2026 13:13:25 +1000 Subject: [PATCH] clear instructions --- README.md | 57 ++++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 56 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 3295edd..8d44412 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,61 @@ Source project: `https://framagit.org/jean-emmanuel/open-stage-control` +## Getting Started + +If you just want to run Open Stage Control, use the prebuilt image: + +`git.f-40.com/aiden/osc-docker:latest` + +### Option 1: Docker Run + +1. Create folders for config and session files: + +```bash +mkdir config data +``` + +2. Start the container: + +```bash +docker run --rm \ + --name open-stage-control \ + -p 8080:8080/tcp \ + -p 8080:8080/udp \ + -v "${PWD}/config:/config" \ + -v "${PWD}/data:/data" \ + git.f-40.com/aiden/osc-docker:latest +``` + +3. Open this in your browser: + +`http://localhost:8080` + +### Option 2: Docker Compose + +1. Make sure `compose.yaml` is in the folder you are working from. + +2. Create folders for persistent data: + +```bash +mkdir config data +``` + +3. Start it: + +```bash +docker compose up -d +``` + +4. Open: + +`http://localhost:8080` + +### Where Your Files Go + +- `./config`: Open Stage Control config and cache data +- `./data`: sessions, themes, and other files you want Open Stage Control to access + ## Build ```bash @@ -24,7 +79,7 @@ docker build \ -t open-stage-control . ``` -## Run +## Run From Source Image ```bash docker run --rm \