Dashboard
The first page after you sign in, and how to arrange its widgets for yourself.
Written for highsea 0.1.0.
The Dashboard is the first page you see after signing in. It answers two questions at a glance: is everything working, and what's happening right now. It's made of widgets, and each person who opens the admin arranges their own.
Only Owners and Admins open the admin, so only they have a dashboard. Users watch in the apps.
What each widget shows
| Widget | What it shows |
|---|---|
| Network | Download and upload speed now, over a line of the last 10 minutes, with how many films are downloading. While the VPN is down it says "Stopped while the VPN is down". |
| Storage | Free space on the disk that holds your data, a bar of how much is used, and each root folder on it with how many films it holds. |
| Indexers | How many of your indexers are healthy, and each one's state: Healthy, Backing off (with when it retries), Failing or Disabled. |
| Subtitles | Subtitles synced today, how many are still waiting, and the average offset corrected. |
| Upcoming | Monitored films released in the next 14 days, each linked to its page. |
| Announcement | The announcement that's live now, who sees it and when it ends. With none, Write one opens Curation. |
| Queue | Everything downloading, importing or waiting, live, with tabs for All, Downloading, Seeding and Issues. |
| Recently added | Posters of the newest films in the library. |
| Calendar | This month as a calendar, with release days marked. |
| System health | Health checks that need attention, each marked OK, Notice, Warning or Error. "Everything looks healthy" when there are none. |
When a widget has more than fits, its last line reads, for example, "3 more in Activity", and links to the page with the rest. A film's title in a widget opens the film's page.
A widget that can't load says so inside its own frame, with Try again. The rest of the dashboard keeps working.
The starting layout
Until you change it, your dashboard shows Network, Storage, Indexers, Subtitles, Upcoming and Announcement, with the Queue across the full width below them. Recently added, Calendar and System health are there to add.
On a new server most widgets start empty, and say what fills them: "No indexers yet" with Add indexers, "The queue is empty", "Nothing added yet". They fill in as you add indexers and films.
Arrange your dashboard
Press Customize at the top of the page. You can also open the command palette with ⌘K (Ctrl+K on Windows and Linux) and choose Customize the dashboard from any page.
While you customise, each widget has a handle to drag it by, a corner to resize it, and a button to remove it. Nothing is saved until you press Done; Cancel, or leaving the page, puts everything back as it was.
Move a widget
Drag it by its handle onto the place you want. The other widgets move aside.
Resize a widget
Drag its bottom corner sideways or down. Widgets snap to whole columns and rows, and each one has its own smallest and largest size. The grid is four columns wide on a large screen, and fewer on a smaller one.
Use the keyboard
Tab to a widget's handle, then:
| Key | What it does |
|---|---|
| Space or Enter | Pick the widget up, or drop it |
| Arrow keys | Move it one place earlier or later |
| Shift and Left or Right | Make it a column narrower or wider |
| Shift and Up or Down | Make it a row shorter or taller |
| Escape | Put it back where it was |
Add a widget
Press Add widget. A panel lists the widgets that aren't on your dashboard yet, each with a line on what it shows. Pick one, and it goes at the end of the grid at its usual size; move it from there.
Remove a widget
Press the × in its corner. It's back in Add widget if you want it again.
Save
Press Done. "Dashboard saved" confirms it. Your layout is kept on the server, so it's the same in any browser you sign in on.
Go back to the starting layout
While customising, open the More layout options menu (the button beside Add widget) and choose Reset to default, then Done. From then on you see your role's default layout. For an Admin, that includes any later change the Owner makes to the Admins' default.
Set the layout new Admins start from
This is for the Owner only.
Arrange the dashboard while customising, then open More layout options and choose Make this the default for admins. Admins who haven't arranged their own dashboard see it at once, and new Admins start from it. Anyone who has saved their own layout keeps it, until they choose Reset to default.