Public Documentation

Codex Switch Web Help Center

Product documentation for Codex Switch Web, covering dashboard operations, chats, file management, runtime controls, account workflows, cloud sync, and developer administration.

Modules

10

Documented product areas and workflows.

Coverage

SEO Ready

Static HTML with crawlable anchors and headings.

Audience

Teams

Operators, developers, and admin users.

Documentation Model

1. Each section documents a specific module or operational area of Codex Switch Web.

2. Feature lists explain what the module supports at a product level.

3. Workflow steps describe the normal operator sequence for using each area safely.

4. Visual references point to interface selectors and routes used inside the authenticated app.

Dashboard

Operational overview for runtime health, developer context, and active chat workload.

Open Module

Features

  1. 1.Server state card with runtime quick link
  2. 2.Developer/account context with remaining limits
  3. 3.Chat activity snapshot and quick navigation
  4. 4.Additional carousel and work stats panels

How to Use

  1. 1.Open Dashboard after login to confirm runtime health.
  2. 2.Verify active developer and account context.
  3. 3.Use card links to jump into detailed modules.

Visual References

Overview Grid

Visual

Top content block containing all primary status cards.

/dashboard[data-tour="dashboard-overview"]

Server Card

Visual

Card that shows running/offline runtime state.

/dashboard[data-tour="dashboard-server-card"]

Chats

Main workspace for prompts, attachments, voice, runtime overrides, and streamed responses.

Open Module

Features

  1. 1.Chat thread list with pin, rename, and delete actions
  2. 2.Message box with markdown rendering and copy actions
  3. 3.Quick templates drawer for reusable prompts
  4. 4.Attachment upload, voice input, and send/stop controls
  5. 5.Live status indicators and feedback/error reporting
  6. 6.In-chat runtime settings for account/model/reasoning/access

How to Use

  1. 1.Create or select a chat from the sidebar.
  2. 2.Compose a prompt, optionally attach files or use voice.
  3. 3.Adjust runtime options from the Settings drawer when needed.
  4. 4.Monitor status and feedback line for execution updates.

Visual References

Chat List

Visual

Left-side list of all available chat sessions.

/dashboard/chats[data-tour="chat-list"]

Chat Box

Visual

Center stream where prompts and responses appear.

/dashboard/chats[data-tour="chat-box"]

Prompt Tools

Visual

Attachment, voice, quick template, and send controls.

/dashboard/chats[data-tour="chat-attachments"]

File Manager

SSH-backed file operations with browser, preview, editing, upload, and server configuration.

Open Module

Features

  1. 1.Server connectivity state and workspace path context
  2. 2.File/folder browsing with breadcrumbs and metadata
  3. 3.Text editor, image preview, and binary handling
  4. 4.Upload, create file/folder, delete, and save actions
  5. 5.Configure Server modal for SSH host credentials

How to Use

  1. 1.Configure server credentials if not connected.
  2. 2.Browse to the desired path and open files.
  3. 3.Edit and save text files or manage filesystem actions.

Visual References

Toolbar

Visual

Action bar for refresh, upload, and configuration controls.

/dashboard/file-manager[data-tour="file-manager-toolbar"]

File Browser

Visual

Directory and file listing with quick operations.

/dashboard/file-manager[data-tour="file-manager-browser"]

Preview Panel

Visual

Right-side panel for previewing and editing selected files.

/dashboard/file-manager[data-tour="file-manager-preview"]

General Settings

Voice typing defaults, audio output preferences, and global branding controls.

Open Module

Features

  1. 1.Browser/OpenAI voice typing mode selection
  2. 2.OpenAI API key save/remove workflows
  3. 3.Output mode, speech speed, and voice choice
  4. 4.Logo upload and reset-to-default branding actions

How to Use

  1. 1.Choose desired voice typing provider.
  2. 2.Configure API key when using OpenAI transcription.
  3. 3.Set voice output mode and test selected voice.
  4. 4.Upload logo only if branding customization is needed.

Visual References

Voice Typing Card

Visual

Default mic mode and API key controls.

/dashboard/settings/general[data-tour="settings-general-voice-typing"]

Branding Card

Visual

Logo preview and upload/reset actions.

/dashboard/settings/general[data-tour="settings-general-branding"]

Server Runtime

Runtime control center for server lifecycle, developer binding, account selection, and limits.

Open Module

Features

  1. 1.Developer/account/model/reasoning/access configuration
  2. 2.Fast mode toggle and public app domain management
  3. 3.Save/Start/Restart/Stop action controls
  4. 4.Runtime status, developer state, and quota insights

How to Use

  1. 1.Set target developer profile and account.
  2. 2.Adjust model, reasoning, and access mode.
  3. 3.Save settings and use runtime action buttons as needed.
  4. 4.Check status section to verify effective state.

Visual References

Configuration

Visual

All runtime configuration fields.

/dashboard/settings/server-runtime[data-tour="settings-runtime-config"]

Runtime Actions

Visual

Save/Start/Restart/Stop controls.

/dashboard/settings/server-runtime[data-tour="settings-runtime-actions"]

Runtime Status

Visual

Live state summary, domain, and account limit panels.

/dashboard/settings/server-runtime[data-tour="settings-runtime-status"]

Accounts

Local account inventory with sync readiness, assignment control, automation, and bulk operations.

Open Module

Features

  1. 1.Live/cached status tabs with filters
  2. 2.Search and developer assignment filtering
  3. 3.Per-account action menu (rename, assign, sync, delete, mirror)
  4. 4.Bulk convert/sync/export operations
  5. 5.Automation settings for refresh and sync jobs

How to Use

  1. 1.Filter by status and developer.
  2. 2.Use action menus for targeted account operations.
  3. 3.Run bulk operations after reviewing warnings.
  4. 4.Use automation settings for scheduled maintenance.

Visual References

Control Row

Visual

Tabs, search, filters, and quick actions.

/dashboard/settings/accounts[data-tour="settings-accounts-controls"]

Accounts Grid

Visual

Main table with limits, sync status, and actions.

/dashboard/settings/accounts[data-tour="settings-accounts-table"]

Codex Sync

Cloud storage integration and cloud-account synchronization management.

Open Module

Features

  1. 1.S3-compatible storage credential configuration
  2. 2.Saved refresh status and cloud refresh automation
  3. 3.Live/cached cloud-account views with presence and assignment
  4. 4.Sync-to-local and cloud-side cleanup actions

How to Use

  1. 1.Configure storage once using account credentials.
  2. 2.Refresh cloud status and verify cache timestamps.
  3. 3.Review cloud accounts and run sync actions.
  4. 4.Enable automation for periodic refresh tasks.

Visual References

Storage Summary

Visual

Credential summary and refresh/update actions.

/dashboard/settings/codex-sync[data-tour="settings-sync-storage"]

Cloud Accounts

Visual

Live/cached cloud account matrix and actions.

/dashboard/settings/codex-sync[data-tour="settings-sync-table"]

Developers

Application user management with role boundaries and one-to-one developer profile assignment.

Open Module

Features

  1. 1.Create/edit users and set active status
  2. 2.Assign each user to a single developer profile
  3. 3.Role-based visibility (Superuser vs User)
  4. 4.Password updates and login-device session management

How to Use

  1. 1.Search or create a developer user.
  2. 2.Assign the correct developer profile during setup.
  3. 3.Use row actions for edit, password, and device controls.
  4. 4.Disable accounts when access needs to be restricted.

Visual References

Developer Controls

Visual

Search and New Developer entry point.

/dashboard/settings/users[data-tour="settings-users-controls"]

Developer Table

Visual

Role, status, assignment, and actions view.

/dashboard/settings/users[data-tour="settings-users-table"]

Assigned Accounts (User View)

Non-admin account workspace showing only accounts assigned to the signed-in developer profile.

Open Module

Features

  1. 1.Live/cached filtering for assigned accounts only
  2. 2.Search and refresh tools for personal account access
  3. 3.Account login onboarding for new assigned accounts
  4. 4.Table and mobile cards optimized for developer day-to-day checks

How to Use

  1. 1.Open Accounts as a non-admin user.
  2. 2.Filter by live or cached account status.
  3. 3.Refresh account limits and confirm provider/expiry visibility.
  4. 4.Use Add New when a new account needs to be assigned to the same developer profile.

Visual References

Assigned Account Controls

Visual

Filter/search row with refresh and Add New actions.

/dashboard/accounts[data-tour="developer-accounts-controls"]

Assigned Account Table

Visual

Personal account status and remaining limit view.

/dashboard/accounts[data-tour="developer-accounts-table"]

Profile

Personal account details, credential updates, and active session security controls.

Open Module

Features

  1. 1.Profile image, name, and email management
  2. 2.In-page password update modal
  3. 3.Current and other device session monitoring
  4. 4.Device-level logout and revoke-all-others controls

How to Use

  1. 1.Update personal details in the profile form.
  2. 2.Rotate password from the Update Password flow.
  3. 3.Review signed-in devices and revoke stale sessions.

Visual References

Profile Form

Visual

Main editor for identity and password actions.

/dashboard/profile[data-tour="profile-form"]

Session Security

Visual

Device list and session revoke controls.

/dashboard/profile[data-tour="profile-sessions"]