From 6e7928062f5bb93769d2960c77af95d5959a64a4 Mon Sep 17 00:00:00 2001
From: Florian Dold <florian@dold.me>
Date: Mon, 31 Oct 2022 13:10:33 +0100
Subject: demobank-ui: handle per-deployment customization

---
 packages/demobank-ui/README.md | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)

(limited to 'packages/demobank-ui/README.md')

diff --git a/packages/demobank-ui/README.md b/packages/demobank-ui/README.md
index 5c68d127e..7f582c5ba 100644
--- a/packages/demobank-ui/README.md
+++ b/packages/demobank-ui/README.md
@@ -19,3 +19,31 @@ This can be changed for testing by setting the URL via local storage (via your b
 ```
 localStorage.setItem("bank-base-url", OTHER_URL);
 ```
+
+## Customizing Per-Deployment Settings
+
+To customize per-deployment settings, make sure that the
+`demobank-ui-settings.js` file is served alongside the UI.
+
+This file is loaded before the SPA and can do customizations by
+changing `globalThis.`.
+
+For example, the following settings would correspond
+to the default settings:
+
+```
+globalThis.talerDemobankSettings = {
+  allowRegistrations: true,
+  bankName: "Taler Bank",
+  // Show explainer text and navbar to other demo sites
+  showDemoNav: true,
+  // Names and links for other demo sites to show in the navbar
+  demoSites: [
+    ["Landing", "https://demo.taler.net/"],
+    ["Bank", "https://bank.demo.taler.net/"],
+    ["Essay Shop", "https://shop.demo.taler.net/"],
+    ["Donations", "https://donations.demo.taler.net/"],
+    ["Survey", "https://donations.demo.taler.net/"],
+  ],
+};
+```
-- 
cgit v1.2.3