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.
How to access and log in to the Nexus Dashboard
You need:
https://api.nexus-dev.codezerogroup.com)NEXUS_APP.html in your browserTip: 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.
| Your role | Navigation groups visible |
|---|---|
| Not logged in | None — login screen only |
nexus_user | Documentation (User Manual, Node Registry) |
nexus_admin | Strategy, Architecture, Use Cases, Platform, Documentation |
If something goes wrong during login, the screen shows an error message. Common causes:
| Error | Meaning | Action |
|---|---|---|
| token_exchange_failed | Google authorization code expired or was already used | Click “Sign in with Google” again to start a fresh login |
| invalid_state | Login session expired (too long between click and Google redirect) | Click “Sign in with Google” again |
| account_deactivated | Your account has been deactivated by an administrator | Contact your Nexus administrator to restore access |
| access_denied | You declined the Google permission screen | Click “Sign in with Google” and accept the permissions |
| db_error | Platform database error — contact your administrator | Wait and retry; if persistent, contact admin |
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.
Understanding the main hub screen
After logging in, you see the Hub Dashboard with these areas:
| Element | Location | Function |
|---|---|---|
| NeXus wordmark | Top-left | Brand identity |
| User email | Top-left area | Shows logged-in identity |
| Version badge | Near title | Engine version number |
| Language toggle (PL/EN) | Top-right area | Switch interface language |
| Theme swatches | Top-right area | 6 colour circles to change theme |
| Orchestrator link | Top-right | Opens pipeline canvas editor |
| Logout button | Top-right | Returns to login screen |
| Section | Content |
|---|---|
| System Health | Engine status indicator (healthy/degraded), resource bars (CPU, RAM, Disk), uptime, pipeline activity sparkline |
| Organisation Cards | One card per org you belong to, showing name, domain, stats, and status badges |
| Section | Content |
|---|---|
| Roadmap | Product development items with progress bars, ETAs, and task counts |
| Activity | Recent system events (pipeline runs, logins, health checks) |
Understanding and using org cards
Each card represents one organisation you have access to. Cards show:
Every card shows a coloured dot next to the org name indicating the live health of the production environment:
| Colour | Label | Meaning |
|---|---|---|
| Green | ONLINE | Environment is running normally |
| Amber | DEGRADED | Environment is reachable but reporting errors |
| Red | OFFLINE | Environment is unreachable or stopped |
| Grey | UNKNOWN | Status 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.
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.
Personalise the dashboard appearance
The hub offers 6 visual themes:
| Skin ID | Name | Mood |
|---|---|---|
nexus-dark | Nexus Indigo | Default deep blue-indigo (dark) |
codezero | CodeZero Violet | Rich violet developer aesthetic (dark) |
office-light | Office Light | Clean blue on white, light theme |
apple-frost | Apple Frost | Apple dark blue on near-black |
glass-aurora | Glass Aurora | Cyan glassmorphism on deep navy |
glass-ember | Glass Ember | Orange glassmorphism on near-black |
Tip: Your theme choice is remembered between sessions. You can also cycle themes using the FAB button (see Section 08).
Toggle between Polish and English
Language preference is saved and restored on next visit.
Using the app shell after entering an organisation
After clicking an org card, you enter the workspace view with:
The sidebar shows navigation items specific to this organisation. Items are grouped into sections (main views, actions, pipelines) separated by thin lines.
Displays the result of pipeline execution. Views come in three types:
| View Type | Appearance | Interaction |
|---|---|---|
| Dashboard | KPI metric cards + data table | Read-only; table columns sortable |
| List | Full-width sortable table | Click column headers to sort; click rows to drill down |
| Form | Input form with fields | Fill fields and submit to execute pipeline |
At the bottom of the sidebar you see your avatar initials, display name, role, and team. Click logout to exit the workspace.
How to use pipeline-driven forms
Validation: If required fields are empty or invalid, error messages appear next to the affected fields. Correct and resubmit.
Quick-access navigation widget
A circular button marked "N" appears in the bottom-right corner of both hub and workspace views.
| Action | Icon | Effect |
|---|---|---|
| Hub | H | Return to the hub dashboard from any workspace |
| Orchestrator | O | Open the pipeline canvas editor (new tab) |
| Run Logs | R | Toggle the run log panel (side drawer) |
| Skin | S | Cycle to the next visual theme |
Tip: Click anywhere outside the FAB menu to close it.
Viewing pipeline execution history
Handling pipelines that require human decisions
Some pipelines pause at gate nodes and require your approval or input before continuing.
Common issues and solutions
| Problem | Cause | Solution |
|---|---|---|
| "Hub error: Failed to fetch" | Engine not running or wrong URL | Check engine is running on the specified address. Verify base URL field. |
| "Brak klucza API" | API key missing for org | Contact administrator to assign API key to your user. |
| Health shows "--" | Engine /health endpoint unreachable | Engine may be starting up. Wait 10s for next poll. |
| Blank content area | Pipeline execution failed | Check run log panel for error details. Report to admin. |
| Theme not applying | localStorage blocked | Enable localStorage in browser settings or clear site data. |
| Forms not rendering | ChameleonV2 failed to load | Check browser console for module load errors. Ensure engine serves /arc-ui/static/. |
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.
APP_MGMT.html?org=SLUGAPP_MGMT.html?org=SLUG&env=stagingEach environment row shows action buttons appropriate to its current status:
| Action | Available When | Effect |
|---|---|---|
| Stop | Running | Shuts down the environment. Requires confirmation for production. |
| Restart | Running | Stop + start cycle. |
| Start | Stopped | Brings the environment back online. |
| Backup | Running | Creates a snapshot. A download link appears on completion. |
| Upgrade / Downgrade | Any | Shows a pipeline diff before applying. Downgrade on production requires confirmation. |
| Spin Up New | Always | Opens 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.
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.
| Item | Action |
|---|---|
| Open App | Authenticate and enter the workspace directly (skips App Management page) |
| Open Management | Navigate to the App Management page for this org |
| Open Orchestrator | Open the pipeline canvas editor in a new tab, pre-filtered to this org |
| View Docs | Open 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).
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.
Items tagged DEMO run a guided walkthrough without making any live backend calls. Safe to trigger in any environment.
For users with nexus_admin role only
Nexus uses two role tiers:
nexus_role) — controls nav access and platform management. Set in _tbl_nexus_platform_users. Overrideable via NEXUS_ADMIN_EMAILS env var on the engine.org_user.role) — controls access within a specific application workspace (owner / admin / editor / viewer).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.
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.
APP_MGMT.html?org=SLUGnexus_admin)nexus_admin (full access) or nexus_user (Documentation only)nexus_admin an amber warning appears — confirm the action is intentional