diff --git a/README.md b/README.md index 861549d40..93d1fc517 100644 --- a/README.md +++ b/README.md @@ -49,12 +49,29 @@ Run: ```bash docker run -it -p 8000:80 asyncapi/studio -docker run -it -p 8000:80 -v "$(pwd)/another/path/to/asyncapi:/usr/share/nginx/html/docs/asyncapi" asyncapi/studio ``` and then go to [http://localhost:8000](http://localhost:8000). -Also feel free to check out the [docker-compose.yml](./docker-compose.yml) example. +To mount a specification, use the command: + +```bash +docker run -it -p 8000:80 -v "$(pwd)/another/path/to/asyncapi:/usr/share/nginx/html/docs/asyncapi" asyncapi/studio +``` + +> **NOTE**: The file should be named `asyncapi.yaml` or `asyncapi.json` in the specified location. + +Also docker-compose can be used: + +```yaml +services: + async-studio: + image: asyncapi/studio + ports: + - "8000:80" + volumes: + - ./another/path/to/asyncapi:/usr/share/nginx/html/docs/asyncapi +``` The `asyncapi/studio` image is based on the official `nginx` image. Please refer to the [Nginx documentation](https://registry.hub.docker.com/_/nginx/) to learn how to e.g. pass a custom `nginx` configuration or plug in additional volumes.