Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions .github/workflows/ui-smoke.yml
Original file line number Diff line number Diff line change
Expand Up @@ -58,3 +58,13 @@ jobs:
name: grid-columns
path: grid-columns.png
if-no-files-found: ignore

# Named checks save what they saw (e.g. command-palette.png), so a
# reviewer can look at a UI change without running it.
- name: Upload smoke screenshots
if: always()
uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7
with:
name: ui-smoke-screenshots
path: ui-smoke-screenshots/
if-no-files-found: ignore
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -42,3 +42,6 @@ corral-incus

# Coverage profiles (scripts/coverage-gate.sh, just cover)
cover.out

# UI smoke screenshots (scripts/ui-smoke.mjs)
ui-smoke-screenshots/
19 changes: 19 additions & 0 deletions docs/user-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,25 @@ Access the Proxmox-style Web UI at `http://localhost:8006` or via `corral web`.

![Mobile Dashboard](screenshots/dashboard-mobile.png)

#### Web keyboard shortcuts

Press `Ctrl+K` (`⌘K` on macOS) to open the command palette. Type part of a
name to find a VM, a CT, a node or a pool. Type a verb and a name to find an
action, for example `stop web-prod`. Press `Enter` to run the first result.
The items that you used last show at the top of the list.

| Key | Action |
|---|---|
| `Ctrl+K` | Open the command palette |
| `?` | Show the list of shortcuts |
| `/` | Filter the tree by guest name |
| `c` | Open the console of the selected VM |
| `s` | Start or stop the selected VM |
| `g` then `d` | Go to the datacenter |

The one-key shortcuts do not operate when you type in a field or in a console.
A read-only user does not see the actions that change a guest.

#### Theme & Branding

In Corral's web UI, you can fully customize the accent colour, the header
Expand Down
Loading
Loading