feat(settings): self-host settings plane, Sim wordmark in sidebar (#5990)

* feat(settings): self-host settings plane, Sim wordmark in sidebar

Chat keys were only reachable at a standalone /account/settings/chat-keys
page that nothing linked to. They now live on a dedicated self-host plane
alongside the two other settings a self-hoster needs from the managed
service.

- new /selfhost/settings/{general,billing,chat-keys} plane, open to any
  signed-in user
- chat keys move off the account plane entirely; no isHosted gate
- registry `unified` projection is now optional (mirroring `planes`), so a
  section can opt out of the editor sidebar
- plane items resolve their own description and throw when one is missing,
  since a plane-only section has no unified projection to inherit from
- settings sidebar shows the Sim wordmark linking to /?home instead of a
  Back chip; drops the now-dead backHref prop
- `bun run setup` runs `bun install` first so a fresh clone is one command

* docs(readme): point Chat keys at the self-host settings plane

The account-plane URL stopped resolving when chat keys moved to
/selfhost/settings.

* improvement(settings): make the sidebar wordmark a plane attribute

Replacing the Back chip everywhere was too broad — account and
organization are reached from inside the app, so Back is right there.
Self-host is reached from outside it (the CLI wizard, the README), so it
leads with the brand mark instead.

SETTINGS_PLANE_CHROME declares that per plane, keyed on
StandaloneSettingsPlane so adding a plane forces the decision rather than
defaulting silently. It also absorbs the shell's parallel plane-label map.

* fix(settings): hide self-host Chat keys on non-hosted deployments

Chat keys are issued by the managed service and useCopilotKeys is
`enabled: isHosted` for that reason. Moving the section onto the self-host
plane dropped its hosted gate, so a self-hosted deployment rendered a
Chat keys nav item whose list could never populate.

Restores the gate on the plane that now owns the URL. sim.ai is unaffected
— the section stays visible there to every signed-in user, which is the
surface self-hosters are pointed at.

Author: TheodoreSpeaks

README.md

@@ -27,13 +27,12 @@
 ### Self-hosted
 
 ```bash
-npx simstudio
+git clone https://github.com/simstudioai/sim.git && cd sim
+bun run setup
 ```
 
 Open [http://localhost:3000](http://localhost:3000)
 
-Docker must be installed and running. Use `-p, --port <port>` to run Sim on a different port, or `--no-pull` to skip pulling the latest Docker images.
-
 <p align="center">
   <img src="apps/sim/public/static/readme-platform.png" alt="The Sim platform — chat on the left, the visual workflow builder on the right" width="100%"/>
 </p>
@@ -77,12 +76,6 @@ Docker must be installed and running. Use `-p, --port <port>` to run Sim on a di
 
 **Requirements:** [Bun](https://bun.sh/) and [Docker](https://www.docker.com/).
 
-```bash
-git clone https://github.com/simstudioai/sim.git && cd sim
-bun install
-bun run setup
-```
-
 `bun run setup` is an interactive wizard: it provisions the database, generates secrets, writes your `.env` files, connects a Chat API key, and starts Sim the way you choose:
 
 - **Local dev** — run from source to contribute or hack on Sim
@@ -110,7 +103,7 @@ Sim also supports local models via [Ollama](https://ollama.ai) and [vLLM](https:
 
 ## Chat API Keys
 
-Chat is a Sim-managed service. `bun run setup` connects a Chat API key for you — sign in when it opens your browser and the key is stored automatically. To view, create, or revoke keys later, go to [sim.ai/account/settings/chat-keys](https://sim.ai/account/settings/chat-keys).
+Chat is a Sim-managed service. `bun run setup` connects a Chat API key for you — sign in when it opens your browser and the key is stored automatically. To view, create, or revoke keys later, go to [sim.ai/selfhost/settings/chat-keys](https://sim.ai/selfhost/settings/chat-keys).
 
 ## Environment Variables
 

apps/sim/app/account/settings/chat-keys/page.tsx

@@ -0,0 +1,56 @@
+import { Suspense } from 'react'
+import type { Metadata } from 'next'
+import { notFound, redirect } from 'next/navigation'
+import {
+  getSelfHostSettingsHref,
+  getSettingsSectionMeta,
+  parseSettingsPathSection,
+  SELFHOST_SETTINGS_ITEMS,
+} from '@/components/settings/navigation'
+import { SelfHostSettingsRenderer } from '@/components/settings/selfhost-settings-renderer'
+import { getSession } from '@/lib/auth'
+import { isBillingEnabled, isHosted } from '@/lib/core/config/env-flags'
+
+interface SelfHostSettingsSectionPageProps {
+  params: Promise<{ section: string }>
+}
+
+export async function generateMetadata({
+  params,
+}: SelfHostSettingsSectionPageProps): Promise<Metadata> {
+  const { section } = await params
+  const parsed = parseSettingsPathSection({
+    path: section,
+    items: SELFHOST_SETTINGS_ITEMS,
+    defaultSection: null,
+  })
+  const meta = parsed ? getSettingsSectionMeta('selfhost', parsed) : null
+  return { title: meta ? `${meta.label} - Self-host settings` : 'Self-host settings' }
+}
+
+export default async function SelfHostSettingsSectionPage({
+  params,
+}: SelfHostSettingsSectionPageProps) {
+  const session = await getSession()
+  if (!session?.user) redirect('/login')
+
+  const { section } = await params
+  const parsed = parseSettingsPathSection({
+    path: section,
+    items: SELFHOST_SETTINGS_ITEMS,
+    defaultSection: null,
+  })
+  if (!parsed) notFound()
+  if (parsed === 'billing' && !isBillingEnabled) redirect(getSelfHostSettingsHref('general'))
+  if (parsed === 'chat-keys' && !isHosted) redirect(getSelfHostSettingsHref('general'))
+
+  /**
+   * Sections read URL query params via nuqs (which uses `useSearchParams`
+   * internally), so the renderer must sit under a Suspense boundary.
+   */
+  return (
+    <Suspense fallback={null}>
+      <SelfHostSettingsRenderer section={parsed} />
+    </Suspense>
+  )
+}

apps/sim/app/selfhost/settings/[section]/page.tsx

@@ -0,0 +1,10 @@
+import { redirect } from 'next/navigation'
+import { StandaloneSettingsShell } from '@/components/settings/standalone-settings-shell'
+import { getSession } from '@/lib/auth'
+
+export default async function SelfHostSettingsLayout({ children }: { children: React.ReactNode }) {
+  const session = await getSession()
+  if (!session?.user) redirect('/login')
+
+  return <StandaloneSettingsShell plane='selfhost'>{children}</StandaloneSettingsShell>
+}

apps/sim/app/selfhost/settings/layout.tsx

@@ -0,0 +1,6 @@
+import { redirect } from 'next/navigation'
+import { getSelfHostSettingsHref } from '@/components/settings/navigation'
+
+export default function SelfHostSettingsPage() {
+  redirect(getSelfHostSettingsHref('general'))
+}

apps/sim/app/selfhost/settings/page.tsx

@@ -12,12 +12,9 @@ import {
   ChipModalHeader,
   SecretReveal,
 } from '@sim/emcn'
-import { ArrowLeft } from '@sim/emcn/icons'
 import { createLogger } from '@sim/logger'
 import { formatDate } from '@sim/utils/formatting'
 import { Plus } from 'lucide-react'
-import { useRouter } from 'next/navigation'
-import { getAccountSettingsHref } from '@/components/settings/navigation'
 import { SettingsEmptyState } from '@/app/workspace/[workspaceId]/settings/components/settings-empty-state'
 import type { SettingsAction } from '@/app/workspace/[workspaceId]/settings/components/settings-header/settings-header'
 import { SettingsPanel } from '@/app/workspace/[workspaceId]/settings/components/settings-panel'
@@ -29,7 +26,7 @@ import {
   useGenerateCopilotKey,
 } from '@/hooks/queries/copilot-keys'
 
-const logger = createLogger('ChatKeysSettings')
+const logger = createLogger('CopilotSettings')
 
 /** Formats a key's last-used timestamp, falling back to "Never" when unset. */
 function formatLastUsed(dateString?: string | null): string {
@@ -38,11 +35,10 @@ function formatLastUsed(dateString?: string | null): string {
 }
 
 /**
- * Standalone page for managing the Chat API keys used with the Chat feature.
- * Provides functionality to create, view, and delete Chat API keys.
+ * Copilot Keys management component for handling API keys used with the Copilot feature.
+ * Provides functionality to create, view, and delete copilot API keys.
  */
-export function ChatKeysView() {
-  const router = useRouter()
+export function Copilot() {
   const { data: keys = [], isLoading } = useCopilotKeys()
   const generateKey = useGenerateCopilotKey()
   const deleteKeyMutation = useDeleteCopilotKey()
@@ -88,7 +84,7 @@ export function ChatKeysView() {
         setIsCreateDialogOpen(false)
       }
     } catch (error) {
-      logger.error('Failed to generate Chat API key', { error })
+      logger.error('Failed to generate copilot API key', { error })
       setCreateError('Failed to create API key. Please check your connection and try again.')
     }
   }
@@ -102,7 +98,7 @@ export function ChatKeysView() {
 
       await deleteKeyMutation.mutateAsync({ keyId: keyToDelete.id })
     } catch (error) {
-      logger.error('Failed to delete Chat API key', { error })
+      logger.error('Failed to delete copilot API key', { error })
     }
   }
 
@@ -126,19 +122,12 @@ export function ChatKeysView() {
   return (
     <>
       <SettingsPanel
-        back={{
-          text: 'Account',
-          icon: ArrowLeft,
-          onSelect: () => router.push(getAccountSettingsHref('general')),
-        }}
         search={{
           value: searchTerm,
           onChange: setSearchTerm,
           placeholder: 'Search API keys...',
         }}
         actions={actions}
-        title='Chat keys'
-        description='Create and manage the API keys that power Chat.'
       >
         {isLoading ? null : showEmptyState ? (
           <SettingsEmptyState>Click "Create API key" above to get started</SettingsEmptyState>

…nt/settings/chat-keys/chat-keys-view.tsx …/settings/components/copilot/copilot.tsxapps/sim/app/account/settings/chat-keys/chat-keys-view.tsx renamed to apps/sim/app/workspace/[workspaceId]/settings/components/copilot/copilot.tsx apps/sim/app/account/settings/chat-keys/chat-keys-view.tsx renamed to apps/sim/app/workspace/[workspaceId]/settings/components/copilot/copilot.tsx

@@ -49,10 +49,12 @@ describe('unified settings navigation', () => {
   })
 
   it('derives every unified item from exactly one registry entry', () => {
-    expect(allNavigationItems).toHaveLength(SETTINGS_SECTION_REGISTRY.length)
+    expect(allNavigationItems).toHaveLength(
+      SETTINGS_SECTION_REGISTRY.filter(({ unified }) => unified).length
+    )
     for (const item of allNavigationItems) {
       expect(
-        SETTINGS_SECTION_REGISTRY.filter(({ unified }) => unified.id === item.id)
+        SETTINGS_SECTION_REGISTRY.filter(({ unified }) => unified?.id === item.id)
       ).toHaveLength(1)
     }
   })

apps/sim/app/workspace/[workspaceId]/settings/navigation.test.ts

@@ -17,6 +17,7 @@ import {
   parseSettingsPathSection,
   resolveOrganizationSectionAccess,
   resolveWorkspaceNavigation,
+  SELFHOST_SETTINGS_ITEMS,
   SETTINGS_SECTION_REGISTRY,
   WORKSPACE_SETTINGS_ITEMS,
   WORKSPACE_SETTINGS_PATH_ALIASES,
@@ -56,6 +57,7 @@ describe('settings navigation boundaries', () => {
       'admin',
       'mothership',
     ])
+    expect(SELFHOST_SETTINGS_ITEMS.map(({ id }) => id)).toEqual(['general', 'billing', 'chat-keys'])
     expect(ORGANIZATION_SETTINGS_ITEMS.map(({ id }) => id)).toEqual([
       'members',
       'billing',
@@ -83,20 +85,26 @@ describe('settings navigation boundaries', () => {
   })
 
   it('has one registry source for every unified and plane item', () => {
-    const unifiedIds = SETTINGS_SECTION_REGISTRY.map(({ unified }) => unified.id)
+    const unifiedIds = SETTINGS_SECTION_REGISTRY.flatMap(({ unified }) =>
+      unified ? [unified.id] : []
+    )
     const accountIds = SETTINGS_SECTION_REGISTRY.flatMap(({ planes }) =>
       planes?.account ? [planes.account.id] : []
     )
     const organizationIds = SETTINGS_SECTION_REGISTRY.flatMap(({ planes }) =>
       planes?.organization ? [planes.organization.id] : []
     )
+    const selfHostIds = SETTINGS_SECTION_REGISTRY.flatMap(({ planes }) =>
+      planes?.selfhost ? [planes.selfhost.id] : []
+    )
     const workspaceIds = SETTINGS_SECTION_REGISTRY.flatMap(({ planes }) =>
       planes?.workspace ? [planes.workspace.id] : []
     )
 
     expect(new Set(unifiedIds).size).toBe(unifiedIds.length)
     expect(new Set(accountIds).size).toBe(accountIds.length)
     expect(new Set(organizationIds).size).toBe(organizationIds.length)
+    expect(new Set(selfHostIds).size).toBe(selfHostIds.length)
     expect(new Set(workspaceIds).size).toBe(workspaceIds.length)
     expect([...unifiedIds].sort()).toEqual(
       buildUnifiedSettingsNavigation()
@@ -107,6 +115,7 @@ describe('settings navigation boundaries', () => {
     expect([...organizationIds].sort()).toEqual(
       ORGANIZATION_SETTINGS_ITEMS.map(({ id }) => id).sort()
     )
+    expect([...selfHostIds].sort()).toEqual(SELFHOST_SETTINGS_ITEMS.map(({ id }) => id).sort())
     expect([...workspaceIds].sort()).toEqual(WORKSPACE_SETTINGS_ITEMS.map(({ id }) => id).sort())
   })
 
@@ -179,9 +188,6 @@ describe('settings navigation boundaries', () => {
     expect(parseAccountPath('/account/settings/apikeys', null)).toBe('api-keys')
     expect(parseAccountPath('/account/settings/not-a-section', null)).toBeNull()
     expect(parseAccountPath('/account/settings', 'general')).toBe('general')
-    // Chat keys is a real page but deliberately not a nav item — with a null
-    // default it must resolve to nothing so the sidebar highlights no sibling.
-    expect(parseAccountPath('/account/settings/chat-keys', null)).toBeNull()
   })
 
   it('parses canonical, aliased, and invalid organization settings paths', () => {