From a42c820ed9b3fb2e47546f218141f9d69d678872 Mon Sep 17 00:00:00 2001 From: mickey li Date: Mon, 1 Nov 2021 14:01:19 +0000 Subject: [PATCH] Documented enable_virtual_framebuffer --- docs/docker-images/sim-base-core.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/docker-images/sim-base-core.md b/docs/docker-images/sim-base-core.md index 1dca051..f6c03d0 100644 --- a/docs/docker-images/sim-base-core.md +++ b/docs/docker-images/sim-base-core.md @@ -10,4 +10,10 @@ This image acts as a base to build other simulation environments on. To ease the expansion of this image, a mechanism has been built to enable expansion by volume mount. As part of the entrypoint, the image will look for any folders in `/ros.env.d` that contain a `setup.bash` file. Any such file will be sourced as part of the entrypoint. This allows for arbitrary expansion of the entrypoint by adding additional volume -mounts. \ No newline at end of file +mounts. + +## Environment Variables + +Name | Default Value | Description +----------------------|------------------------------|------------ +`ENABLE_VIRTUAL_FRAMEBUFFER` | true | Enables the `setup_display.sh` script and starts a virtual X server. Use for simulated vehicles which have cameras on them. \ No newline at end of file