clear instructions
All checks were successful
Build & Push Docker / build-and-push (push) Successful in 9s
All checks were successful
Build & Push Docker / build-and-push (push) Successful in 9s
This commit is contained in:
57
README.md
57
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 \
|
||||
|
||||
Reference in New Issue
Block a user