From b9a14d25ac024d1c3268ec0df6991195ada87db4 Mon Sep 17 00:00:00 2001 From: Randall Morey Date: Mon, 24 Aug 2020 11:46:25 -0400 Subject: [PATCH] docs: add UI passthrough example to README (#299) --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 7a6fb11f3..df69ac6b7 100644 --- a/README.md +++ b/README.md @@ -98,6 +98,16 @@ variable. For example: ```UI_COMMITISH=feature-branch make dev``` +#### UI Development + +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: + + ```BOUNDARY_DEV_PASSTHROUGH_DIRECTORY=/boundary-ui/ui/core/dist ~/go/bin/boundary dev``` + ### Download and Run from Release Page Download the latest release of the server binary and appropriate desktop