Getting Started

Dashboard

The Kiwire Dashboard is your real-time control centre. It displays live KPI stats, charts, rankings, and system health data through a fully customisable, drag-and-drop widget grid. You can create multiple dashboards and share them with your team.

'alt' => 'Dashboard overview', 'caption' => 'The default Kiwire dashboard layout', 'screenshot' => true, 'class' => '', ]) Drop images into: public/assets/img/docs/{page}/{filename} --}}
Image not uploaded yet public/assets/img/docs/dashboard/overview.png
The default Kiwire Dashboard — drag-and-drop widget grid with KPI stats, charts, and rankings.

The first time you open the dashboard you will see a default system dashboard. You can duplicate or create a brand-new one from the dashboard options menu ().

Dashboard Tabs

At the top of the page you will find the dashboard tab strip. Each tab represents one saved dashboard. Click a tab to switch between them. When you have many dashboards, the strip scrolls horizontally — use the arrow buttons on either side to navigate.

IconMeaning
This is your default dashboard — it loads when you first open the page.
🔒System dashboard — owned by the platform, cannot be deleted.
🌐Shared with all admins in this tenant.
👥Shared with specific roles only.
'alt' => 'Dashboard overview', 'caption' => 'The default Kiwire dashboard layout', 'screenshot' => true, 'class' => '', ]) Drop images into: public/assets/img/docs/{page}/{filename} --}}
Image not uploaded yet public/assets/img/docs/dashboard/tab-strip.png
The dashboard tab strip — switch between dashboards, with scroll arrows when there are many.

Dashboard Options Menu

Click the ⋮ (vertical dots) button in the top-right controls to access the dashboard options menu. From here you can:

  • New Dashboard — Create a blank dashboard with a custom name, icon, and colour.
  • Rename — Change the name of the current dashboard.
  • Duplicate — Clone the current dashboard and all its widgets into a new one.
  • Set as Default — Make this dashboard the one that loads on login.
  • Share / Visibility — Control who can see this dashboard (personal, all admins, or selected roles). Only available for non-system dashboards you own.
  • Export / Import Layout — Save the widget layout as a JSON file, or restore a previously exported layout.
  • Refresh Widgets — Force all widgets on the current dashboard to reload their data.
  • Refresh Data — Clear the server-side data cache and reload.
  • Delete Dashboard — Permanently remove the current dashboard. System dashboards cannot be deleted.

Deleting a dashboard is permanent. Export the layout first if you want to keep a backup.

'alt' => 'Dashboard overview', 'caption' => 'The default Kiwire dashboard layout', 'screenshot' => true, 'class' => '', ]) Drop images into: public/assets/img/docs/{page}/{filename} --}}
Image not uploaded yet public/assets/img/docs/dashboard/options-menu.png
The ⋮ options menu — create, rename, duplicate, share, export, and delete dashboards.

Edit Mode & Layout Customisation

Click Edit Layout to enter edit mode. A yellow banner appears at the top to confirm you are in edit mode.

1
Drag widgets

Click and hold the grip handle at the top of any widget card, then drag it to a new position on the grid.

2
Resize widgets

Drag the resize handle in the bottom-right corner of any widget card to make it wider or taller.

3
Add widgets

Click Add Widget in the yellow banner (or in the ⋮ menu) to open the Widget Library panel. Click any widget to add it instantly, or drag it onto the grid to place it exactly where you want.

4
Remove widgets

In edit mode, a red ✕ button appears in the top-right of each widget. Click it to remove that widget.

5
Save or cancel

Click Save to persist your changes, or Cancel to discard them and return to the previous layout.

'alt' => 'Dashboard overview', 'caption' => 'The default Kiwire dashboard layout', 'screenshot' => true, 'class' => '', ]) Drop images into: public/assets/img/docs/{page}/{filename} --}}
Image not uploaded yet public/assets/img/docs/dashboard/edit-mode.png
Edit mode — drag handles appear at the top of each widget; resize from the bottom-right corner.

Widget Library

The Widget Library panel (accessible in edit mode) is organised into five sections. Each widget can only be added once per dashboard.

Live KPI Stats

These widgets poll the server every ~30 seconds and always show current data.

Active Users

Total unique users who have logged in at least once

Live Connected

Devices currently online right now

Sessions Today

Total login sessions started today

Bandwidth

Total data transferred in the last 24 hours

New Users

Accounts created today

New Vouchers

Vouchers generated today

Failed Logins

Authentication failures in the last 24 hours

Online Devices

Access points currently reporting as online

Summary Stats (Daily Cache)

These widgets display statistics cached once per day. They are cheaper to load but not real-time. Click Refresh Data in the ⋮ menu to force a cache refresh.

Controllers

Total registered device controllers

Accounts by Type

Breakdown of user accounts by type

License Days

Days remaining on your Kiwire license

Total Zones

Number of configured network zones

Journeys

Published captive portal journeys

Campaigns

Active engagement campaigns

Charts

Interactive ApexCharts graphs with configurable time ranges.

WidgetWhat it showsMin size
BandwidthTotal upload + download over time (area chart)8 × 4
SessionsLogin session count over time (bar chart)6 × 4
Conn. StatusOnline vs offline device ratio (pie)4 × 4
Device TypesBreakdown by device type (donut)4 × 4
Top UsersTop users by bandwidth (horizontal bar)6 × 4

Top Rankings

These widgets display ranked lists with a timeframe toggle: Today / Week / Month / All-time. Some also support a live mode showing real-time session data.

Tables & Utility

Miscellaneous utility widgets that don't fit into the stat/chart categories:

WidgetDescription
SessionsLive list of currently active sessions with user, device, and uptime info
ClockDisplays the current time in the tenant's configured timezone
NotesA personal notepad — content is saved per-dashboard, per-admin
Quick LinksConfigurable shortcut buttons to frequently used pages
Tenant InfoA card showing the current tenant's name, logo, license, and key stats
Portal PagesSlideshow of your captive portal page thumbnails with links
Enterprise PagesSlideshow of your enterprise (WPA2) page thumbnails
Network Status4-cell grid showing controller online/offline counts and uptime
Sign-in MethodsLists all active login methods configured in the tenant
Audit TrailLatest admin activity log from the tenant audit table
Portal LogLive tail of the portal request log (radius/captive events)
Session LookupSearch for a user's active session by username or MAC address
Media GalleryThumbnail grid of uploaded portal media files
Top JourneysMost-used captive portal journeys by session count
Top ProfilesMost-used access profiles
'alt' => 'Dashboard overview', 'caption' => 'The default Kiwire dashboard layout', 'screenshot' => true, 'class' => '', ]) Drop images into: public/assets/img/docs/{page}/{filename} --}}
Image not uploaded yet public/assets/img/docs/dashboard/widget-library.png
The Widget Library panel — click to add instantly, or drag onto the grid to place exactly.

Sharing Dashboards

You can share any dashboard you own with other admins in your tenant. Open the ⋮ menu → Share / Visibility.

  • Personal — Only you can see it. Default for all new dashboards.
  • Shared — All Admins — Any admin in this tenant can view the dashboard (but not edit it).
  • Shared — Selected Roles — Only admins with one of the chosen roles can view it.

Use Duplicate to create a personal copy of a shared system dashboard, then customise it for your own workflow without affecting what others see.

'alt' => 'Dashboard overview', 'caption' => 'The default Kiwire dashboard layout', 'screenshot' => true, 'class' => '', ]) Drop images into: public/assets/img/docs/{page}/{filename} --}}
Image not uploaded yet public/assets/img/docs/dashboard/share-modal.png
The Share / Visibility dialog — control whether a dashboard is personal, shared with all admins, or restricted to specific roles.

Export & Import Layouts

Dashboard layouts are exportable as JSON. This is useful for:

  • Backing up a layout before making significant changes
  • Copying a layout from one tenant to another
  • Sharing a layout with a colleague

Go to ⋮ → Export Layout to download a .json file, or Import Layout to restore one. The import replaces the current dashboard's widget layout — widget data is still pulled live from the tenant's own database.

Tips & Tricks

  • Hold Shift while resizing to snap to the nearest grid column.
  • The Clock widget respects the timezone set in System → Settings → General.
  • The Notes widget auto-saves as you type — there is no Save button needed.
  • If a widget shows a loading spinner that never resolves, click Refresh Widgets from the ⋮ menu.
  • Dashboard tabs show in compact (icon-only) mode when there are many dashboards — hover a tab to see its full name.

Superusers see an additional Tenant Info widget and can access system dashboards that show cross-tenant data. These are read-only and cannot be deleted.