From 2b664f78ed6186b56866603d707267d31623ba0a Mon Sep 17 00:00:00 2001 From: Randall Morey Date: Tue, 15 Sep 2020 15:32:28 -0400 Subject: [PATCH] docs: add blurb in dev mode doc about UI passthrough (#362) --- website/pages/docs/installing/dev-mode.mdx | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/website/pages/docs/installing/dev-mode.mdx b/website/pages/docs/installing/dev-mode.mdx index e368ad545..e63f6958d 100644 --- a/website/pages/docs/installing/dev-mode.mdx +++ b/website/pages/docs/installing/dev-mode.mdx @@ -66,3 +66,16 @@ An example using these values to configure your Terraform provider instance for ``` Note in the example above we're setting `base_url` to `http` and not `https` as the Boundary server does not use TLS in development mode. + +## User Interface + +The UI is normally compiled into the Boundary binary at build time. +However, it would be impractical to rebuild the binary on every change when +actively developing the UI. To make UI development more convenient, the binary +supports a _passthrough directory_. This is an arbitrary local +directory from which UI assets are served. Note this option is only available +in dev mode. For example: + +```bash +BOUNDARY_DEV_PASSTHROUGH_DIRECTORY=../boundary-ui/ui/core/dist ./boundary dev +```