Skip to content

Commit b0167a7

Browse files
committed
docs: fix quick start to use playground instead of broken docker run
1 parent 6759748 commit b0167a7

1 file changed

Lines changed: 11 additions & 7 deletions

File tree

docs/index.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -15,21 +15,25 @@
1515

1616
### With Docker
1717

18+
The playground includes a demo API, observability stack (Prometheus, Grafana, Loki, Tempo), and a control plane UI:
19+
1820
```bash
19-
# Compile your OpenAPI spec
20-
docker run --rm -v $(pwd):/work ghcr.io/barbacane-dev/barbacane \
21-
compile --spec /work/api.yaml --manifest /work/barbacane.yaml --output /work/api.bca
21+
git clone https://github.com/barbacane-dev/barbacane.git
22+
cd barbacane/playground
23+
docker-compose up -d
2224

23-
# Run the gateway
24-
docker run --rm -p 8080:8080 -v $(pwd)/api.bca:/config/api.bca \
25-
ghcr.io/barbacane-dev/barbacane serve --artifact /config/api.bca --listen 0.0.0.0:8080
25+
# Gateway: http://localhost:8080
26+
# Grafana: http://localhost:3000 (admin/admin)
27+
# Control Plane: http://localhost:3001
2628
```
2729

2830
### From source
2931

3032
```bash
3133
git clone https://github.com/barbacane-dev/barbacane.git
32-
cd barbacane && cargo build --release
34+
cd barbacane
35+
cargo build --release
36+
make plugins
3337

3438
# Compile your OpenAPI spec
3539
./target/release/barbacane compile --spec api.yaml --manifest barbacane.yaml --output api.bca

0 commit comments

Comments
 (0)