Merge pull request #302 from bento-platform/more-bento-public-brandin…

…g-options add Bento Public flags for showing/hiding header links
bento-platform · Jan 21, 2025 · 79db013 · 79db013
2 parents 1e18d87 + ca96660
commit 79db013
Show file tree

Hide file tree

Showing 5 changed files with 36 additions and 4 deletions.
diff --git a/docs/migrating_to_18.md b/docs/migrating_to_18.md
@@ -19,7 +19,25 @@ TODO
   above location, or copy `branding.png` to `branding.lightbg.png`
 
 
-## 3. Enabling MinIO
+## 3. If desired, disable Bento Public sign in / portal links
+
+Version 18 includes two new Bento Public environment variables for customizing an instance:
+
+* `BENTO_PUBLIC_SHOW_PORTAL_LINK`: Whether to show a link to the private data portal in the header
+* `BENTO_PUBLIC_SHOW_SIGN_IN`: Whether to show a "Sign In" button in the header
+
+Both of these are set to `true` by default. If desired, they can be toggled to `false` by setting them in `local.env`,
+for example:
+
+```bash
+# ...
+BENTO_PUBLIC_SHOW_PORTAL_LINK='false'
+BENTO_PUBLIC_SHOW_SIGN_IN='false'
+# ...
+```
+
+
+## 4. Enabling MinIO
 
 To enable the deployment of a MinIO server for S3 storage, refer to the documentation on 
 [configuring MinIO for Bento](/docs/minio.md).

diff --git a/etc/bento_deploy.env b/etc/bento_deploy.env
@@ -16,8 +16,12 @@ BENTO_GOHAN_ENABLED='true'
 BENTO_MONITORING_ENABLED='false'
 BENTO_MINIO_ENABLED='false'
 
-#  - Switch to enable French translation in Bento Public
+#  - Display flags for Bento portals
+#    - Switch to enable French translation in Bento Public
 BENTO_PUBLIC_TRANSLATED='true'
+#    - Switches to enable various links in the Bento Public header (these default to being on)
+BENTO_PUBLIC_SHOW_PORTAL_LINK='true'
+BENTO_PUBLIC_SHOW_SIGN_IN='true'
 
 # Feature switches end ------------------------------------------------
 

diff --git a/etc/bento_dev.env b/etc/bento_dev.env
@@ -16,8 +16,12 @@ BENTO_GOHAN_ENABLED='true'
 BENTO_MONITORING_ENABLED='false'
 BENTO_MINIO_ENABLED='false'
 
-#  - Switch to enable French translation in Bento Public
+#  - Display flags for Bento portals
+#    - Switch to enable French translation in Bento Public
 BENTO_PUBLIC_TRANSLATED='true'
+#    - Switches to enable various links in the Bento Public header (these default to being on)
+BENTO_PUBLIC_SHOW_PORTAL_LINK='true'
+BENTO_PUBLIC_SHOW_SIGN_IN='true'
 
 # Feature switches end ------------------------------------------------
 

diff --git a/etc/default_config.env b/etc/default_config.env
@@ -21,8 +21,12 @@ BENTO_GOHAN_ENABLED='true'
 BENTO_MONITORING_ENABLED='false'
 BENTO_MINIO_ENABLED='false'
 
-#  - Switch to enable French translation in Bento Public
+#  - Display flags for Bento portals
+#    - Switch to enable French translation in Bento Public
 BENTO_PUBLIC_TRANSLATED='true'
+#    - Switches to enable various links in the Bento Public header (these default to being on)
+BENTO_PUBLIC_SHOW_PORTAL_LINK='true'
+BENTO_PUBLIC_SHOW_SIGN_IN='true'
 
 # Feature switches end ------------------------------------------------
 

diff --git a/lib/public/docker-compose.public.yaml b/lib/public/docker-compose.public.yaml
@@ -13,6 +13,8 @@ services:
       - BENTO_PUBLIC_CLIENT_NAME
       - BENTO_PUBLIC_PORTAL_URL
       - BENTO_PUBLIC_TRANSLATED
+      - BENTO_PUBLIC_SHOW_PORTAL_LINK
+      - BENTO_PUBLIC_SHOW_SIGN_IN
       - BENTO_BEACON_UI_ENABLED
       - BENTO_BEACON_NETWORK_ENABLED
       - BEACON_URL=${BENTOV2_PUBLIC_URL}/api/beacon