Documented enable_virtual_framebuffer

StarlingUAS · Nov 1, 2021 · a42c820 · a42c820
1 parent 805ae2b
commit a42c820
Showing 1 changed file with 7 additions and 1 deletion.
diff --git 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.
+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.