feat: distinct splash screens for admin/non-admin users in multiuser mode (#116)

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: lstein <111189+lstein@users.noreply.github.com>

Author: Copilot

invokeai/app/api/routers/auth.py

@@ -72,6 +72,7 @@ class SetupStatusResponse(BaseModel):
 
     setup_required: bool = Field(description="Whether initial setup is required")
     multiuser_enabled: bool = Field(description="Whether multiuser mode is enabled")
+    admin_email: str | None = Field(default=None, description="Email of the first active admin user, if any")
 
 
 @auth_router.get("/status", response_model=SetupStatusResponse)
@@ -85,13 +86,14 @@ async def get_setup_status() -> SetupStatusResponse:
 
     # If multiuser is disabled, setup is never required
     if not config.multiuser:
-        return SetupStatusResponse(setup_required=False, multiuser_enabled=False)
+        return SetupStatusResponse(setup_required=False, multiuser_enabled=False, admin_email=None)
 
     # In multiuser mode, check if an admin exists
     user_service = ApiDependencies.invoker.services.users
     setup_required = not user_service.has_admin()
+    admin_email = user_service.get_admin_email()
 
-    return SetupStatusResponse(setup_required=setup_required, multiuser_enabled=True)
+    return SetupStatusResponse(setup_required=setup_required, multiuser_enabled=True, admin_email=admin_email)
 
 
 @auth_router.post("/login", response_model=LoginResponse)

invokeai/app/services/users/users_base.py

@@ -124,3 +124,12 @@ def list_users(self, limit: int = 100, offset: int = 0) -> list[UserDTO]:
             List of users
         """
         pass
+
+    @abstractmethod
+    def get_admin_email(self) -> str | None:
+        """Get the email address of the first active admin user.
+
+        Returns:
+            Email address of the first active admin, or None if no admin exists
+        """
+        pass

invokeai/app/services/users/users_default.py

@@ -249,3 +249,17 @@ def list_users(self, limit: int = 100, offset: int = 0) -> list[UserDTO]:
             )
             for row in rows
         ]
+
+    def get_admin_email(self) -> str | None:
+        """Get the email address of the first active admin user."""
+        with self._db.transaction() as cursor:
+            cursor.execute(
+                """
+                SELECT email FROM users
+                WHERE is_admin = TRUE AND is_active = TRUE
+                ORDER BY created_at ASC
+                LIMIT 1
+                """,
+            )
+            row = cursor.fetchone()
+        return row[0] if row else None

invokeai/frontend/web/public/locales/en.json

@@ -1062,7 +1062,9 @@
         "name": "Name",
         "modelPickerFallbackNoModelsInstalled": "No models installed.",
         "modelPickerFallbackNoModelsInstalled2": "Visit the <LinkComponent>Model Manager</LinkComponent> to install models.",
+        "modelPickerFallbackNoModelsInstalledNonAdmin": "No models installed. Ask your InvokeAI administrator (<AdminEmailLink />) to install some models.",
         "noModelsInstalledDesc1": "Install models with the",
+        "noModelsInstalledAskAdmin": "Ask your administrator to install some.",
         "noModelSelected": "No Model Selected",
         "noMatchingModels": "No matching models",
         "noModelsInstalled": "No models installed",
@@ -2863,6 +2865,7 @@
         "tileOverlap": "Tile Overlap",
         "postProcessingMissingModelWarning": "Visit the <LinkComponent>Model Manager</LinkComponent> to install a post-processing (image to image) model.",
         "missingModelsWarning": "Visit the <LinkComponent>Model Manager</LinkComponent> to install the required models:",
+        "missingModelsWarningNonAdmin": "Ask your InvokeAI administrator (<AdminEmailLink />) to install the required models:",
         "mainModelDesc": "Main model (SD1.5 or SDXL architecture)",
         "tileControlNetModelDesc": "Tile ControlNet model for the chosen main model architecture",
         "upscaleModelDesc": "Upscale (image to image) model",
@@ -2971,6 +2974,7 @@
             },
             "workflows": {
                 "description": "Workflows are reusable templates that automate image generation tasks, allowing you to quickly perform complex operations and get consistent results.",
+                "descriptionMultiuser": "Workflows are reusable templates that automate image generation tasks, allowing you to quickly perform complex operations and get consistent results. You may share your workflows with other users of the system by selecting 'Shared workflow' when you create or edit it.",
                 "learnMoreLink": "Learn more about creating workflows",
                 "browseTemplates": {
                     "title": "Browse Workflow Templates",
@@ -3049,9 +3053,11 @@
         "toGetStartedLocal": "To get started, make sure to download or import models needed to run Invoke. Then, enter a prompt in the box and click <StrongComponent>Invoke</StrongComponent> to generate your first image. Select a prompt template to improve results. You can choose to save your images directly to the <StrongComponent>Gallery</StrongComponent> or edit them to the <StrongComponent>Canvas</StrongComponent>.",
         "toGetStarted": "To get started, enter a prompt in the box and click <StrongComponent>Invoke</StrongComponent> to generate your first image. Select a prompt template to improve results. You can choose to save your images directly to the <StrongComponent>Gallery</StrongComponent> or edit them to the <StrongComponent>Canvas</StrongComponent>.",
         "toGetStartedWorkflow": "To get started, fill in the fields on the left and press <StrongComponent>Invoke</StrongComponent> to generate your image. Want to explore more workflows? Click the <StrongComponent>folder icon</StrongComponent> next to the workflow title to see a list of other templates you can try.",
+        "toGetStartedNonAdmin": "To get started, ask your InvokeAI administrator (<AdminEmailLink />) to install the AI models needed to run Invoke. Then, enter a prompt in the box and click <StrongComponent>Invoke</StrongComponent> to generate your first image. Select a prompt template to improve results. You can choose to save your images directly to the <StrongComponent>Gallery</StrongComponent> or edit them to the <StrongComponent>Canvas</StrongComponent>.",
         "gettingStartedSeries": "Want more guidance? Check out our <LinkComponent>Getting Started Series</LinkComponent> for tips on unlocking the full potential of the Invoke Studio.",
         "lowVRAMMode": "For best performance, follow our <LinkComponent>Low VRAM guide</LinkComponent>.",
-        "noModelsInstalled": "It looks like you don't have any models installed! You can <DownloadStarterModelsButton>download a starter model bundle</DownloadStarterModelsButton> or <ImportModelsButton>import models</ImportModelsButton>."
+        "noModelsInstalled": "It looks like you don't have any models installed! You can <DownloadStarterModelsButton>download a starter model bundle</DownloadStarterModelsButton> or <ImportModelsButton>import models</ImportModelsButton>.",
+        "noModelsInstalledAskAdmin": "Ask your administrator to install some."
     },
     "whatsNew": {
         "whatsNewInInvoke": "What's New in Invoke",

invokeai/frontend/web/src/features/gallery/components/ImageViewer/NoContentForViewer.tsx

@@ -1,24 +1,36 @@
 import type { ButtonProps } from '@invoke-ai/ui-library';
 import { Alert, AlertDescription, AlertIcon, Button, Divider, Flex, Link, Spinner, Text } from '@invoke-ai/ui-library';
+import { useAppSelector } from 'app/store/storeHooks';
 import { IAINoContentFallback } from 'common/components/IAIImageFallback';
 import { InvokeLogoIcon } from 'common/components/InvokeLogoIcon';
+import { selectCurrentUser } from 'features/auth/store/authSlice';
 import { LOADING_SYMBOL, useHasImages } from 'features/gallery/hooks/useHasImages';
 import { setInstallModelsTabByName } from 'features/modelManagerV2/store/installModelsStore';
 import { navigationApi } from 'features/ui/layouts/navigation-api';
 import type { PropsWithChildren } from 'react';
 import { memo, useCallback, useMemo } from 'react';
 import { Trans, useTranslation } from 'react-i18next';
 import { PiArrowSquareOutBold, PiImageBold } from 'react-icons/pi';
+import { useGetSetupStatusQuery } from 'services/api/endpoints/auth';
 import { useMainModels } from 'services/api/hooks/modelsByType';
 
 export const NoContentForViewer = memo(() => {
   const hasImages = useHasImages();
   const [mainModels, { data }] = useMainModels();
+  const { data: setupStatus } = useGetSetupStatusQuery();
+  const user = useAppSelector(selectCurrentUser);
   const { t } = useTranslation();
 
+  const isMultiuser = setupStatus?.multiuser_enabled ?? false;
+  const isAdmin = !isMultiuser || (user?.is_admin ?? false);
+  const adminEmail = setupStatus?.admin_email ?? null;
+
+  const modelsLoaded = data !== undefined;
+  const hasModels = mainModels.length > 0;
+
   const showStarterBundles = useMemo(() => {
-    return data && mainModels.length === 0;
-  }, [mainModels.length, data]);
+    return modelsLoaded && !hasModels && isAdmin;
+  }, [modelsLoaded, hasModels, isAdmin]);
 
   if (hasImages === LOADING_SYMBOL) {
     // Blank bg w/ a spinner. The new user experience components below have an invoke logo, but it's not centered.
@@ -36,10 +48,18 @@ export const NoContentForViewer = memo(() => {
     <Flex flexDir="column" gap={8} alignItems="center" textAlign="center" maxW="400px">
       <InvokeLogoIcon w={32} h={32} />
       <Flex flexDir="column" gap={4} alignItems="center" textAlign="center">
-        <GetStartedLocal />
-        {showStarterBundles && <StarterBundlesCallout />}
-        <Divider />
-        <LowVRAMAlert />
+        {isAdmin ? (
+          // Admin / single-user mode
+          <>
+            {modelsLoaded && hasModels ? <GetStartedWithModels /> : <GetStartedLocal />}
+            {showStarterBundles && <StarterBundlesCallout />}
+            <Divider />
+            <LowVRAMAlert />
+          </>
+        ) : (
+          // Non-admin user in multiuser mode
+          <>{modelsLoaded && hasModels ? <GetStartedWithModels /> : <GetStartedNonAdmin adminEmail={adminEmail} />}</>
+        )}
       </Flex>
     </Flex>
   );
@@ -89,6 +109,32 @@ const GetStartedLocal = () => {
   );
 };
 
+const GetStartedWithModels = () => {
+  return (
+    <Text fontSize="md" color="base.200">
+      <Trans i18nKey="newUserExperience.toGetStarted" components={{ StrongComponent }} />
+    </Text>
+  );
+};
+
+const GetStartedNonAdmin = ({ adminEmail }: { adminEmail: string | null }) => {
+  const AdminEmailLink = adminEmail ? (
+    <Link href={`mailto:${adminEmail}`} color="base.50">
+      {adminEmail}
+    </Link>
+  ) : (
+    <Text as="span" color="base.50">
+      your administrator
+    </Text>
+  );
+
+  return (
+    <Text fontSize="md" color="base.200">
+      <Trans i18nKey="newUserExperience.toGetStartedNonAdmin" components={{ StrongComponent, AdminEmailLink }} />
+    </Text>
+  );
+};
+
 const StarterBundlesCallout = () => {
   const handleClickDownloadStarterModels = useCallback(() => {
     navigationApi.switchToTab('models');

invokeai/frontend/web/src/features/modelManagerV2/hooks/useStarterModelsToast.tsx

@@ -1,10 +1,11 @@
 import { Button, Text, useToast } from '@invoke-ai/ui-library';
 import { useAppSelector } from 'app/store/storeHooks';
-import { selectIsAuthenticated } from 'features/auth/store/authSlice';
+import { selectCurrentUser, selectIsAuthenticated } from 'features/auth/store/authSlice';
 import { setInstallModelsTabByName } from 'features/modelManagerV2/store/installModelsStore';
 import { navigationApi } from 'features/ui/layouts/navigation-api';
 import { useCallback, useEffect, useState } from 'react';
 import { useTranslation } from 'react-i18next';
+import { useGetSetupStatusQuery } from 'services/api/endpoints/auth';
 import { useMainModels } from 'services/api/hooks/modelsByType';
 
 const TOAST_ID = 'starterModels';
@@ -15,6 +16,11 @@ export const useStarterModelsToast = () => {
   const [mainModels, { data }] = useMainModels();
   const toast = useToast();
   const isAuthenticated = useAppSelector(selectIsAuthenticated);
+  const { data: setupStatus } = useGetSetupStatusQuery();
+  const user = useAppSelector(selectCurrentUser);
+
+  const isMultiuser = setupStatus?.multiuser_enabled ?? false;
+  const isAdmin = !isMultiuser || (user?.is_admin ?? false);
 
   useEffect(() => {
     // Only show the toast if the user is authenticated
@@ -33,17 +39,17 @@ export const useStarterModelsToast = () => {
       toast({
         id: TOAST_ID,
         title: t('modelManager.noModelsInstalled'),
-        description: <ToastDescription />,
+        description: isAdmin ? <AdminToastDescription /> : <NonAdminToastDescription />,
         status: 'info',
         isClosable: true,
         duration: null,
         onCloseComplete: () => setDidToast(true),
       });
     }
-  }, [data, didToast, isAuthenticated, mainModels.length, t, toast]);
+  }, [data, didToast, isAuthenticated, isAdmin, mainModels.length, t, toast]);
 };
 
-const ToastDescription = () => {
+const AdminToastDescription = () => {
   const { t } = useTranslation();
   const toast = useToast();
 
@@ -62,3 +68,9 @@ const ToastDescription = () => {
     </Text>
   );
 };
+
+const NonAdminToastDescription = () => {
+  const { t } = useTranslation();
+
+  return <Text fontSize="md">{t('modelManager.noModelsInstalledAskAdmin')}</Text>;
+};

invokeai/frontend/web/src/features/parameters/components/ModelPicker.tsx

@@ -3,6 +3,7 @@ import {
   Button,
   Flex,
   Icon,
+  Link,
   Popover,
   PopoverArrow,
   PopoverBody,
@@ -20,6 +21,7 @@ import { buildGroup, getRegex, isGroup, Picker, usePickerContext } from 'common/
 import { useDisclosure } from 'common/hooks/useBoolean';
 import { typedMemo } from 'common/util/typedMemo';
 import { uniq } from 'es-toolkit/compat';
+import { selectCurrentUser } from 'features/auth/store/authSlice';
 import { selectLoRAsSlice } from 'features/controlLayers/store/lorasSlice';
 import { selectParamsSlice } from 'features/controlLayers/store/paramsSlice';
 import { MODEL_BASE_TO_COLOR, MODEL_BASE_TO_LONG_NAME, MODEL_BASE_TO_SHORT_NAME } from 'features/modelManagerV2/models';
@@ -32,6 +34,7 @@ import { filesize } from 'filesize';
 import { memo, useCallback, useMemo, useRef } from 'react';
 import { Trans, useTranslation } from 'react-i18next';
 import { PiCaretDownBold, PiLinkSimple } from 'react-icons/pi';
+import { useGetSetupStatusQuery } from 'services/api/endpoints/auth';
 import { useGetRelatedModelIdsBatchQuery } from 'services/api/endpoints/modelRelationships';
 import type { AnyModelConfig } from 'services/api/types';
 
@@ -82,6 +85,32 @@ const components = {
 
 const NoOptionsFallback = memo(({ noOptionsText }: { noOptionsText?: string }) => {
   const { t } = useTranslation();
+  const { data: setupStatus } = useGetSetupStatusQuery();
+  const user = useAppSelector(selectCurrentUser);
+
+  const isMultiuser = setupStatus?.multiuser_enabled ?? false;
+  const isAdmin = !isMultiuser || (user?.is_admin ?? false);
+  const adminEmail = setupStatus?.admin_email ?? null;
+
+  if (!isAdmin) {
+    const AdminEmailLink = adminEmail ? (
+      <Link href={`mailto:${adminEmail}`} color="base.200">
+        {adminEmail}
+      </Link>
+    ) : (
+      <Text as="span" color="base.200">
+        your administrator
+      </Text>
+    );
+
+    return (
+      <Flex flexDir="column" gap={4} alignItems="center">
+        <Text color="base.200" textAlign="center">
+          <Trans i18nKey="modelManager.modelPickerFallbackNoModelsInstalledNonAdmin" components={{ AdminEmailLink }} />
+        </Text>
+      </Flex>
+    );
+  }
 
   return (
     <Flex flexDir="column" gap={4} alignItems="center">

invokeai/frontend/web/src/features/settingsAccordions/components/UpscaleSettingsAccordion/UpscaleWarning.tsx

@@ -1,5 +1,6 @@
-import { Button, Flex, ListItem, Text, UnorderedList } from '@invoke-ai/ui-library';
+import { Button, Flex, Link, ListItem, Text, UnorderedList } from '@invoke-ai/ui-library';
 import { useAppDispatch, useAppSelector } from 'app/store/storeHooks';
+import { selectCurrentUser } from 'features/auth/store/authSlice';
 import { selectModel } from 'features/controlLayers/store/paramsSlice';
 import { setInstallModelsTabByName } from 'features/modelManagerV2/store/installModelsStore';
 import {
@@ -10,6 +11,7 @@ import {
 import { navigationApi } from 'features/ui/layouts/navigation-api';
 import { useCallback, useEffect, useMemo } from 'react';
 import { Trans, useTranslation } from 'react-i18next';
+import { useGetSetupStatusQuery } from 'services/api/endpoints/auth';
 import { useControlNetModels } from 'services/api/hooks/modelsByType';
 
 export const UpscaleWarning = () => {
@@ -19,6 +21,12 @@ export const UpscaleWarning = () => {
   const tileControlnetModel = useAppSelector(selectTileControlNetModel);
   const dispatch = useAppDispatch();
   const [modelConfigs, { isLoading }] = useControlNetModels();
+  const { data: setupStatus } = useGetSetupStatusQuery();
+  const user = useAppSelector(selectCurrentUser);
+
+  const isMultiuser = setupStatus?.multiuser_enabled ?? false;
+  const isAdmin = !isMultiuser || (user?.is_admin ?? false);
+  const adminEmail = setupStatus?.admin_email ?? null;
 
   useEffect(() => {
     const validModel = modelConfigs.find((cnetModel) => {
@@ -59,19 +67,33 @@ export const UpscaleWarning = () => {
     return null;
   }
 
+  const AdminEmailLink = adminEmail ? (
+    <Link href={`mailto:${adminEmail}`} color="base.50">
+      {adminEmail}
+    </Link>
+  ) : (
+    <Text as="span" color="base.50">
+      your administrator
+    </Text>
+  );
+
   return (
     <Flex bg="error.500" borderRadius="base" padding={4} direction="column" fontSize="sm" gap={2}>
       {!isBaseModelCompatible && <Text>{t('upscaling.incompatibleBaseModelDesc')}</Text>}
       {warnings.length > 0 && (
         <Text>
-          <Trans
-            i18nKey="upscaling.missingModelsWarning"
-            components={{
-              LinkComponent: (
-                <Button size="sm" flexGrow={0} variant="link" color="base.50" onClick={handleGoToModelManager} />
-              ),
-            }}
-          />
+          {isAdmin ? (
+            <Trans
+              i18nKey="upscaling.missingModelsWarning"
+              components={{
+                LinkComponent: (
+                  <Button size="sm" flexGrow={0} variant="link" color="base.50" onClick={handleGoToModelManager} />
+                ),
+              }}
+            />
+          ) : (
+            <Trans i18nKey="upscaling.missingModelsWarningNonAdmin" components={{ AdminEmailLink }} />
+          )}
         </Text>
       )}
       {warnings.length > 0 && (