Nexus Hub Dashboard — User Manual — MAN-HUB-01

Hub Dashboard
User Manual

End-user guide for the Nexus System Dashboard. Covers logging in, navigating the hub, entering workspaces, using the sidebar, submitting forms, managing themes, switching languages, and using the floating action button.

Document ID
MAN-HUB-01
Version
1.0
Audience
End Users
Tier
5 — Backlog/Manual

01 — Getting Started

How to access and log in to the Nexus Dashboard

Prerequisites

You need:

Logging In — Google OAuth

  1. Open NEXUS_APP.html in your browser
  2. Click the "Sign in with Google" button
  3. A Google login window opens — select your Google account or enter your email
  4. Google redirects back to Nexus automatically — no password required
  5. The Hub Dashboard loads showing your workspaces and navigation based on your role

Tip: Your session lasts 8 hours. After that, you will be redirected to the login screen again. No manual logout needed unless you want to switch accounts.

What you see depends on your role

Your roleNavigation groups visible
Not logged inNone — login screen only
nexus_userDocumentation (User Manual, Node Registry)
nexus_adminStrategy, Architecture, Use Cases, Platform, Documentation

Login Errors

If something goes wrong during login, the screen shows an error message. Common causes:

ErrorMeaningAction
token_exchange_failedGoogle authorization code expired or was already usedClick “Sign in with Google” again to start a fresh login
invalid_stateLogin session expired (too long between click and Google redirect)Click “Sign in with Google” again
account_deactivatedYour account has been deactivated by an administratorContact your Nexus administrator to restore access
access_deniedYou declined the Google permission screenClick “Sign in with Google” and accept the permissions
db_errorPlatform database error — contact your administratorWait and retry; if persistent, contact admin

Logging Out

Click "Logout" in the hub dashboard. Your session token is deleted from the browser immediately. You are returned to the login screen. No data is transmitted to the server on logout.

02 — Hub Dashboard Overview

Understanding the main hub screen

After logging in, you see the Hub Dashboard with these areas:

Top Bar

ElementLocationFunction
NeXus wordmarkTop-leftBrand identity
User emailTop-left areaShows logged-in identity
Version badgeNear titleEngine version number
Language toggle (PL/EN)Top-right areaSwitch interface language
Theme swatchesTop-right area6 colour circles to change theme
Orchestrator linkTop-rightOpens pipeline canvas editor
Logout buttonTop-rightReturns to login screen

Main Area (Left)

SectionContent
System HealthEngine status indicator (healthy/degraded), resource bars (CPU, RAM, Disk), uptime, pipeline activity sparkline
Organisation CardsOne card per org you belong to, showing name, domain, stats, and status badges

Right Sidebar

SectionContent
RoadmapProduct development items with progress bars, ETAs, and task counts
ActivityRecent system events (pipeline runs, logins, health checks)

03 — Organisation Cards

Understanding and using org cards

Each card represents one organisation you have access to. Cards show:

Card Health Indicator

Every card shows a coloured dot next to the org name indicating the live health of the production environment:

ColourLabelMeaning
GreenONLINEEnvironment is running normally
AmberDEGRADEDEnvironment is reachable but reporting errors
RedOFFLINEEnvironment is unreachable or stopped
GreyUNKNOWNStatus could not be determined (no environment configured)

The health state refreshes every 10 seconds. Clicking the dot opens the environment health detail on the App Management page.

Entering a Workspace

  1. Click any org card — you are taken to the App Management page for that org
  2. Review environments, pipeline versions, and settings
  3. Click the Open App button at the top of the App Management page
  4. The system authenticates you within that organisation
  5. The workspace loads with its custom theme and navigation
  6. You are placed into the first available view automatically

Shortcut: Right-click any org card to open the context menu. "Open App" in that menu enters the workspace directly in one click (see Section 13).

Note: If an org has no API key available, you will see an alert. Contact your administrator to resolve access.

04 — Changing Theme

Personalise the dashboard appearance

The hub offers 6 visual themes:

Skin IDNameMood
nexus-darkNexus IndigoDefault deep blue-indigo (dark)
codezeroCodeZero VioletRich violet developer aesthetic (dark)
office-lightOffice LightClean blue on white, light theme
apple-frostApple FrostApple dark blue on near-black
glass-auroraGlass AuroraCyan glassmorphism on deep navy
glass-emberGlass EmberOrange glassmorphism on near-black

How to Change

  1. Look for the colour circles in the hub top bar
  2. Click any circle to apply that theme instantly
  3. The active theme shows a highlighted ring

Tip: Your theme choice is remembered between sessions. You can also cycle themes using the FAB button (see Section 08).

05 — Switching Language

Toggle between Polish and English

  1. Find the language button in the top bar (shows "PL" or "EN")
  2. Click to toggle to the other language
  3. All interface labels update immediately

Language preference is saved and restored on next visit.

06 — Working in a Workspace

Using the app shell after entering an organisation

After clicking an org card, you enter the workspace view with:

Sidebar (Left)

The sidebar shows navigation items specific to this organisation. Items are grouped into sections (main views, actions, pipelines) separated by thin lines.

  1. Click any sidebar item to load its view
  2. The active item is highlighted with the org accent colour
  3. Some items show badge counts (e.g., unread items)
  4. Greyed-out items are not yet available

Content Area (Centre)

Displays the result of pipeline execution. Views come in three types:

View TypeAppearanceInteraction
DashboardKPI metric cards + data tableRead-only; table columns sortable
ListFull-width sortable tableClick column headers to sort; click rows to drill down
FormInput form with fieldsFill fields and submit to execute pipeline

Profile Footer

At the bottom of the sidebar you see your avatar initials, display name, role, and team. Click logout to exit the workspace.

07 — Submitting Forms

How to use pipeline-driven forms

  1. Navigate to a form view via the sidebar
  2. The form appears with labelled input fields (text, numbers, dropdowns, dates, etc.)
  3. Fill in the required information
  4. Click the Submit button
  5. The pipeline processes your input and shows the result

Validation: If required fields are empty or invalid, error messages appear next to the affected fields. Correct and resubmit.

08 — Floating Action Button (FAB)

Quick-access navigation widget

A circular button marked "N" appears in the bottom-right corner of both hub and workspace views.

  1. Click the "N" button to open the action menu
  2. Choose an action:
ActionIconEffect
HubHReturn to the hub dashboard from any workspace
OrchestratorOOpen the pipeline canvas editor (new tab)
Run LogsRToggle the run log panel (side drawer)
SkinSCycle to the next visual theme

Tip: Click anywhere outside the FAB menu to close it.

09 — Run Log Panel

Viewing pipeline execution history

  1. Open the run log via FAB → "Run Logs"
  2. A panel slides in from the right showing recent pipeline runs
  3. Each entry shows: pipeline name, status (success/error), duration
  4. Click an entry to expand and see individual node execution details
  5. Close the panel by clicking the FAB "Run Logs" again or clicking outside

10 — Approvals & Gates

Handling pipelines that require human decisions

Some pipelines pause at gate nodes and require your approval or input before continuing.

  1. When a pipeline reaches a gate, a special approval view appears instead of normal results
  2. Review the information presented (what the pipeline has done so far)
  3. Choose your action: Approve, Reject, or Request Revision
  4. The pipeline continues (or stops) based on your decision

11 — Troubleshooting

Common issues and solutions

ProblemCauseSolution
"Hub error: Failed to fetch"Engine not running or wrong URLCheck engine is running on the specified address. Verify base URL field.
"Brak klucza API"API key missing for orgContact administrator to assign API key to your user.
Health shows "--"Engine /health endpoint unreachableEngine may be starting up. Wait 10s for next poll.
Blank content areaPipeline execution failedCheck run log panel for error details. Report to admin.
Theme not applyinglocalStorage blockedEnable localStorage in browser settings or clear site data.
Forms not renderingChameleonV2 failed to loadCheck browser console for module load errors. Ensure engine serves /arc-ui/static/.

12 — App Management Page

Managing environments and versions before entering a workspace

The App Management page is the gateway between the hub and a live workspace. It opens when you click an org card and shows all environments, pipeline versions, and configuration for that app.

Opening the Page

  1. Click any org card on the hub dashboard
  2. The App Management page loads at APP_MGMT.html?org=SLUG
  3. The active hub skin is inherited automatically

Page Layout

Entering the Workspace

  1. Click the Open App button at the top of the page
  2. The system authenticates you and loads the workspace for the selected environment
  3. To deep-link directly to staging: use APP_MGMT.html?org=SLUG&env=staging

Environment Actions

Each environment row shows action buttons appropriate to its current status:

ActionAvailable WhenEffect
StopRunningShuts down the environment. Requires confirmation for production.
RestartRunningStop + start cycle.
StartStoppedBrings the environment back online.
BackupRunningCreates a snapshot. A download link appears on completion.
Upgrade / DowngradeAnyShows a pipeline diff before applying. Downgrade on production requires confirmation.
Spin Up NewAlwaysOpens a dialog to create a new environment from a named base version.

Caution: Stop and Downgrade on production environments require an explicit confirmation dialog stating the exact impact. Read it before confirming.

Returning to Hub

  1. Click Back to Hub on the App Management page, or
  2. Use the FAB → Hub from within a workspace to go back all the way to the hub

13 — Card Right-Click Menu

Quick actions on hub org cards without navigating to the management page

Right-clicking any org card opens a context menu positioned at your cursor. It provides the most common actions for that app in one click.

Default Menu Items

ItemAction
Open AppAuthenticate and enter the workspace directly (skips App Management page)
Open ManagementNavigate to the App Management page for this org
Open OrchestratorOpen the pipeline canvas editor in a new tab, pre-filtered to this org
View DocsOpen the documentation link for this org's use-case

Below a separator, the menu may show additional custom items configured by your administrator for that specific app (see Section 12 → Settings tab → RMB Menu Editor).

Environment Action Items

Custom items of type env_action (e.g., "Restart Staging") show an inline confirmation mini-dialog before executing. Read the impact statement and confirm or cancel.

Demo Items

Items tagged DEMO run a guided walkthrough without making any live backend calls. Safe to trigger in any environment.

Dismissing the Menu

Admin — User & Role Management

For users with nexus_admin role only

How roles are assigned

Nexus uses two role tiers:

Static admin escalation (NEXUS_ADMIN_EMAILS)

The system administrator can designate permanent platform admins by setting the NEXUS_ADMIN_EMAILS environment variable on the engine (ECS task definition). Any email address on that list is automatically elevated to nexus_admin on every login, regardless of what is stored in the database. This is the primary mechanism for bootstrapping admin access.

What nexus_admin can do (current build)

Zarządzanie użytkownikami (REQ-AUTH-005)

The Użytkownicy tab in the App Management screen (APP_MGMT.html) is visible only to nexus_admin. It allows platform-level user management without accessing the engine directly.

Viewing the users list

  1. Open any org workspace: click a hub card or navigate to APP_MGMT.html?org=SLUG
  2. Click the Użytkownicy tab (visible only when you are signed in as nexus_admin)
  3. The table loads all registered users: Email / Imię, Rola badge, Status dot, Ostatnie logowanie, Dołączył, Akcje
  4. Your own row is highlighted and action buttons are greyed out (self-protection guard)

Changing a user’s role

  1. In the user’s row click Rola
  2. The role-change modal opens showing the user’s email and display name
  3. Click the target role card: nexus_admin (full access) or nexus_user (Documentation only)
  4. If escalating to nexus_admin an amber warning appears — confirm the action is intentional
  5. Click Zmień rolę. The table refreshes with the updated role badge
  6. You cannot change your own role (own row button is disabled)

Deactivating / reactivating an account

  1. In the user’s row click Dezakt. (active user) or Aktywuj (deactivated user)
  2. A confirmation dialog appears — click OK to proceed
  3. Deactivated accounts show a grey dot and strikethrough email. The user cannot log in until reactivated
  4. The account data is preserved — deactivation is reversible at any time
  5. You cannot deactivate your own account (own row button is disabled)