From c86c5eaecc57a01b6312a343f95b696f85c38f08 Mon Sep 17 00:00:00 2001 From: Susmitha Girumala Date: Fri, 29 Jan 2021 16:23:56 -0500 Subject: [PATCH] docs: Add BOUNDARY_DESKTOP_SIGNING_IDENTITY info to readme --- README.md | 3 +++ ui/desktop/README.md | 8 +++++--- 2 files changed, 8 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 732c7491f..af9ca0b99 100644 --- a/README.md +++ b/README.md @@ -116,6 +116,9 @@ yarn install yarn build:ui:desktop ``` +To provide a signing identify for macOS build, use `BOUNDARY_DESKTOP_SIGNING_IDENTITY` +environment variable to set signing certificate name (e.g Developer ID Application: * (*)). + Assets are saved to `ui/desktop/electron-app/out/make/`. DMG packaged desktop UI is available at asset location as `Boundary Desktop.dmg`. diff --git a/ui/desktop/README.md b/ui/desktop/README.md index 45415803a..bd8215112 100644 --- a/ui/desktop/README.md +++ b/ui/desktop/README.md @@ -66,15 +66,17 @@ To run as a desktop app: Before executing a build, be sure to set any environment variables necessary for your target [environment](#environment-variables). To build this UI for -production, run the following commads from this folder: +production, run the following commands from this folder: ```bash yarn install yarn build ``` -The static production assets are saved into the `dist/` folder. +`BOUNDARY_DESKTOP_SIGNING_IDENTITY` environment variable must be provided +to codesign in production. +The static production assets are saved into the `dist/` folder. #### Environment Variables @@ -83,7 +85,7 @@ These environment variables may be used to customized the build. | Variable | Default Value | Description | | -------- | ------------- | ----------- | | `APP_NAME` | Application Name | The user-facing name of the application, appearing in titles, etc. | -| `API_HOST` | | The host of the API, if different than UI (e.g. https://example.net:1234). | +| `BOUNDARY_DESKTOP_SIGNING_IDENTITY` | | The name of the certificate to use when signing (e.g. Developer ID Application: * (*)). | ### Running Tests