Skip to content

Commit df9ebec

Browse files
authored
Merge pull request #1713 from swirlai/DS-4821b
Added migration info DS-4821
2 parents 02b84a3 + aa203b6 commit df9ebec

File tree

1 file changed

+64
-2
lines changed

1 file changed

+64
-2
lines changed

docs/Quick-Start-Enterprise.md

Lines changed: 64 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -165,6 +165,10 @@ These methods **preserve** the SWIRL database. If you don't need to save data, p
165165
166166
## Optional Steps
167167
168+
- Customize SWIRL for any organization
169+
- [Upload a branding configuration](Admin-Guide.html#changing-the-galaxy-logos-and-branding) including logos and Galaxy control labels
170+
- [Customize the AI Search RAG prompt](AI-Search.html#customizing-the-ai-search-rag-prompt) and the [AI Search Assistant prompt](AI-Search-Assistant.html#customizing-the-ai-search-assistant-prompts)
171+
168172
- Manage SWIRL via **Galaxy UI**:
169173
- Click the profile avatar (top-right corner).
170174
- Click **Manage SWIRL** ([http://localhost:8000/swirl/](http://localhost:8000/swirl/)).
@@ -186,10 +190,10 @@ For additional support, please [contact SWIRL](Quick-Start-Enterprise-1.md#suppo
186190
To connect SWIRL with **Google Workspace**, you need:
187191
188192
- **Admin access** to the Google Workspace tenant.
189-
- **App registration** in Google Workspace TBD.
193+
- **App registration** in Google Workspace.
190194
- **App ID and secrets** added to SWIRL.
191195
192-
Setup takes ~1 hour. Follow the guide: [Google Workspace Integration Guide](TBD)
196+
Setup takes ~1 hour. Follow the guide: [Google Workspace Integration Guide](GoogleWorkspace-Guide.html)
193197
194198
For additional support, please [contact SWIRL](Quick-Start-Enterprise-1.md#support).
195199
@@ -241,6 +245,64 @@ python swirl.py <swirl-command>
241245
242246
Example: `python manage.py makemigrations`
243247
248+
## Migrating from SWIRL Community
249+
250+
### Migrating SearchProviders
251+
252+
Before migrating, consider [deleting the preloaded SearchProviders](SP-Guide.html#editing-a-searchprovider) in the SWIRL Enterprise installation.
253+
254+
1. Locate the `migrate_sp.py` script. As of SWIRL 4.4, this is located in the `DevUtils` folder. If you are running an earlier version please [request it from support](#support)
255+
256+
2. Go to the `swirl/SearchProviders` endpoint on the SWIRL server. Copy the entire JSON list to the clipboard, then paste this into a text file. Save the text file - for example, to `mySPs.json`
257+
258+
3. Run the script:
259+
`python migrate_sp.py myCommunitySPs.json myEnterpriseSPs.json`
260+
261+
4. Open the output file. Copy and paste the contents into the input box at the bottom of the same endpoint `/swirl/SearchProviders` of your SWIRL Enterprise installation. Click the `PUT` button.
262+
263+
5. The page should refresh and show you the new SearchProviders. (If there were already SearchProviders loaded, the new ones will be later in the list.)
264+
265+
Note any errors, and feel free to [contact support](#support) for assistance.
266+
267+
### Migrating OpenAI/Azure OpenAI settings
268+
269+
1. Go to the `/swirl/aiproviders/` endpoint in the SWIRL Enterprise installation.
270+
271+
![SWIRL AI Providers](images/swirl_aiproviders.png)
272+
273+
2. Locate the OpenAI or AzureOpenAI preloaded configuration.
274+
275+
3. Copy the API key from the Community `.env` file, or the appropriate environment
276+
variable, to the `credentials` field in the Enterprise AI Provider. For example:
277+
278+
For OpenAI:
279+
```
280+
% echo $OPENAI_API_KEY
281+
<your-key-here>
282+
```
283+
284+
For Azure/OpenAI:
285+
```
286+
% echo $AZURE_OPENAI_KEY
287+
<your-api-key>
288+
% echo AZURE_OPENAI_ENDPOINT
289+
<your-azure-openai-endpoint-url>
290+
% echo $AZURE_MODEL
291+
<your-azure-openai-model>
292+
```
293+
294+
Set the Enterprise AI Provider configuration `active` to `true. Set the `tags` and `default` lists to include `rag` and `chat`.
295+
296+
4. Refresh the Galaxy UI. The `Generate AI Insights` switch in the [Galaxy Search UI](https://docs.swirlaiconnect.com/User-Guide-Enterprise.html#the-ai-search-form-explained) should now be available, and the `SWIRL AI Assistant` (at `/galaxy/chat`), or use the link under the profile icon (top/right).
297+
298+
### Migrating M365 Authentication
299+
300+
1. Go to the `swirl/authenticators/Microsoft` endpoint in the SWIRL Enterprise installation.
301+
302+
2. Copy the `Client Id` and `Client Secret` from the [M365 Azure App Registration](https://portal.azure.com/#view/Microsoft_AAD_RegisteredApps/ApplicationsListBlade) or your Community `.env` file as noted here in the [Microsoft 365 Integration Guide](https://docs.swirlaiconnect.com/M365-Guide.html#configure-the-microsoft-authenticator).
303+
304+
Note that you may have to modify the existing app registration if URL of the SWIRL server is changing.
305+
244306
## Updating SWIRL
245307
246308
{: .warning }

0 commit comments

Comments
 (0)