You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+38-3Lines changed: 38 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,6 +7,29 @@
7
7
8
8
Run [SlimeVR Server](https://github.com/SlimeVR/SlimeVR-Server) and its Web GUI in Docker with a setup that works across Linux, macOS, and Windows, plus an optimized Linux hotplug mode for direct USB tracker usage.
9
9
10
+
## Quick Start (Linux)
11
+
12
+
1. Install Docker + Compose (`docker compose version` should work).
13
+
2. Run:
14
+
15
+
```bash
16
+
docker compose up -d --build
17
+
```
18
+
19
+
3. Open:
20
+
21
+
```text
22
+
http://localhost:8080
23
+
```
24
+
25
+
Stop:
26
+
27
+
```bash
28
+
docker compose down
29
+
```
30
+
31
+
This repo defaults to Linux USB hotplug mode, so no extra `-f ...` flags are needed.
32
+
10
33
## Features
11
34
12
35
- Auto-downloads `slimevr.jar` and `slimevr-gui-dist.tar.gz` from official releases
@@ -43,12 +66,24 @@ Edit `.env`:
43
66
```env
44
67
SLIMEVR_VERSION=19.0.0-rc.1
45
68
WEBGUI_PORT=8080
69
+
COMPOSE_FILE=docker-compose.linux.yml
46
70
```
47
71
72
+
`COMPOSE_FILE` selects which compose file is used by default.
73
+
74
+
> On Linux, keep this enabled for direct USB tracker access.
75
+
> On macOS/Windows, change it to `COMPOSE_FILE=docker-compose.yml`.
0 commit comments