Merge pull request #1504 from swirlai/DS-3506

Update how to change logo and branding configuration
swirlai · Jan 18, 2025 · cffc29d · cffc29d
2 parents 2bb0529 + ff6233a
commit cffc29d
Show file tree

Hide file tree

Showing 5 changed files with 42 additions and 32 deletions.
diff --git a/docs/AI-Connect.md b/docs/AI-Connect.md
@@ -158,38 +158,6 @@ To activate this authenticator, a new SWIRL app has to be registered in Azure. R
 
 Please [contact support](#support) to obtain Authenticators for any other systems - including Elastic, OpenSearch, CAS2, Salesforce, ServiceNow, Okta, Auth0 and Ping Federate.
 
-## Changing the Galaxy Logo
-
-To change the logo in SWIRL Galaxy (only) - assuming it is already installed:
-
-1. Prepare at least one logo file (or one each for light and dark mode display)
-* Image file format:  png
-* Dimensions: 818 x 214
-* At least 30 px whitespace around the margin of the logo
-* File name ends with `_logo_highres_positive.png` or `_logo_highres_negative.png`
-
-2. Copy the logo file(s) into the `enterprise/logo` folder in the SWIRL installation.
-
-3. Execute the following command:
-
-```
-python swirl.py logo
-```
-
-SWIRL will ask you to confirm. When you do, it will copy the first two logos it finds that meet the requirements into the Galaxy configuration, reporting on progress:
-
-```
-Scanning folder: enterprise/logo
-Copying enterprise/logo/your_logo_highres_positive.png -> static/galaxy/logo_highres_positive.png ... Ok
-Copying enterprise/logo/your_logo_highres_negative.png -> static/galaxy/logo_highres_negative.png ... Ok
-Restart SWIRL to see the updated logo(s)!
-```
-
-Restart SWIRL to see the new logos:
-```
-python swirl.py restart
-```
-
 # Connecting to Generative AI (GAI) and Large Language Models (LLMs)
 
 ## Roles for Generative AI/Large Language Models

diff --git a/docs/Admin-Guide.md b/docs/Admin-Guide.md
@@ -344,6 +344,48 @@ The services invoked by `swirl.py` are defined in [swirl/services.py](https://gi
 
 Modify the list to start celery-beats automatically.
 
+# Changing the Galaxy Logos and Branding
+
+To change the logo in SWIRL Galaxy, for both the search and chat pages, along with other control labels:
+
+* Go to [the SWIRL home page](http://localhost:8000/admin/)
+
+![SWIRL home page](./images/admin.png)
+
+* Click the "admin" link as shown. This will take you to the admin UI:
+
+![SWIRL admin UI](./images/admin_branding.png)
+
+* Click "Upload a Branding Configuration" as shown. This will take you to the Branding Configuration page:
+
+![SWIRL branding configuration](./images/branding_config.png)
+
+* Fill out the form. "Name" is required, in addition to at least one other item. To change the logo, upload a light mode image. 
+
+The following table describes the remaining options:
+
+| Item | Galaxy Location | Default | 
+| ---- | --------------- | ------- | 
+| Name | Not shown | N/A | 
+| Search button label | On the button | SEARCH |
+| Search bar placeholder | In the search box | What are you searching for today? |
+| AI Response label | Below the search box | Generate AI Response |  
+| Select items label | Below the paging control | Select Items | 
+
+* Click the "Submit" button to save the branding configuration.
+
+* Refresh your browser to see the changes in Galaxy.
+
+Note that this may launch a new RAG or chat session.
+
+### Logo File Requirements
+
+* Image file format: png
+* Dimensions: 818 x 214
+* At least 30 px whitespace around the margin of the logo
+
+Note also that only one branding configuration can be active at a time.
+
 # Managing Django Users
 
 ## Django Admin

diff --git a/docs/images/admin.png b/docs/images/admin.png
diff --git a/docs/images/admin_branding.png b/docs/images/admin_branding.png
diff --git a/docs/images/branding_config.png b/docs/images/branding_config.png