Appendices
Appendices
The scopes each connector asks for, keyboard and platform notes, how to reach support, and the owner's Admin Health view.
Appendix A: connector scopes
A scope is one specific permission you give to an app. These are what Cockpit asks for or tells you to add, taken from the product. Most providers have no read-only scope for what Cockpit reads, so it is Cockpit's Sandbox mode, enforced on the server, that keeps it to reading.
| Connector | Door | Scopes or permissions | Notes |
|---|---|---|---|
| Sign-in | Your name and email only | Signing in never asks for more. Files in Google Drive are a separate connection (Google Drive, where it is offered) that you can disconnect without affecting sign-in. | |
| Salesforce | Your External Client App, authorization code with PKCE | api, refresh_token | Salesforce labels these Manage user data via APIs (api) and Perform requests at any time (refresh_token, offline_access). Add no others. PKCE required. |
| MuleSoft | Your connected app, client credentials | View Organization, View Environment, Read Applications, View APIs Configuration | Add only View and Read scopes. Never Create, Edit, Delete, Deploy or Manage. Choose the environments. |
| GitHub | Cockpit's GitHub sign-in | read:user, repo | repo is GitHub's standard access to private repositories; GitHub has no read-only version of it. |
| Slack | Your own Slack app, user token | User scopes: channels:read, groups:read, channels:history, groups:history, search:read, users:read, chat:write | The save-your-app page also lists bot scopes channels:read, chat:write, users:read. chat:write is used only after you approve a post. |
| Slack (optional step) | A separate consent page | im:read, mpim:read, im:history, mpim:history | Direct messages. Asked for on their own, and you can decline. |
| Postman | An API key you create | None. The key can do what its owner can do. | Use a dedicated account. Revoke in Postman. |
Appendix B: keyboard and platform notes
| Where | Key or note |
|---|---|
| Message box | Enter sends. Shift and Enter start a new line. |
| Panels, menus and dialogs | Escape closes the mode panel, an open drawer, a menu or a dialog, and returns focus to the control that opened it. |
| Everywhere | Tab moves through controls in order; the focused control has a visible outline. Tables in this manual are focusable so they can be scrolled with the keyboard. |
| Layout | Under 900 px wide the Chats and Brain panels become drawers. At 480 px and narrower the rail becomes a bottom bar, and controls are at least 44 px tall. |
| Desktop apps | Cockpit menu: Command (Mac) or Ctrl (Windows) + N for a new chat, + Shift + C Connections, + Shift + B Workbench, + Shift + A Approvals. Help menu: Cockpit Manual, Check for Updates, Copy Diagnostics (no account details). On Windows, press Alt to show the menu bar. See 5.10. |
| Workbench | Alt + 1 to 9 for a tab, / for the filter box, ? for the shortcut list, Ctrl or Command + Enter to run. See 13.8. |
| Project board | Alt and the left or right arrow on a focused card moves it one column. See 14.4. |
| Mac | Cockpit for Mac, Apple silicon. First open: macOS asks about an app downloaded from the internet; click Open. |
| Windows | Cockpit for Windows, Windows 10 or 11, 64-bit. Installs for you alone; no administrator password. |
| Sign-in hand-off | The apps open your browser to sign in and come back through cockpit://. |
| Microphone | Uses your browser's or phone's own speech recognition; hidden where there is none. |
| iPhone, Android | Coming. Use the console in a phone browser until then. |
| Printing this manual | Open the print view, choose Letter or A5 palm, and use Print, Save as PDF. Page numbers come from the browser's page margins, which Chromium-based browsers such as Chrome and Edge draw. The print layout has been checked in Chromium only. |
Appendix C: support
Write to support@cockpitai.io.
Include in a message checklist
- The reference code (CKP-...) if the message showed one.
- The step you were on, and what you expected to see.
- The address you signed in with (not a password).
- A screenshot with no secret, key or password in it.
CAUTION
Never send passwords, Consumer Secrets, client secrets, API keys or one-time codes to anyone, including support. If you sent one by mistake, revoke it at the vendor.
The published privacy policy is at cockpitai.io/privacy.
Appendix D: the Admin Health view (owner only)
ARRIVING · Owner only, where switched on
The Health view is a section at the top of the Admin page, which only administrators can open. It appears only on a build where it is switched on. Nobody else sees it, and there is no way to change anything from it.
Sign in as the owner and open Admin in the rail.
You should see A Health section above the Waitlist, reading "Loading health numbers..." and then the numbers. It refreshes by itself every minute.
Read the first line.
You should see It begins OK., Look. or Problem. and says in a sentence why, for example "Nothing unusual in the last 24 hours."
Read the tiles, then the two charts.
| Tile or chart | What it shows |
|---|---|
| Requests | How many calls this server answered in the last 24 hours. |
| Errors (5xx) | How many failed on Cockpit's side, and their share. Above 5 percent, with at least 20 requests, the first line says Problem. |
| Slowest 5% (p95) | The time the slowest 5 percent of calls took or more. Above 1 second the first line says Look. |
| Active runs | Chat runs running or queued now, and how many wait for an approval. |
| Approvals pending | Approval cards waiting for a decision. |
| Workstation hosts and cost today | Machines running now, how many exist, the limit, and today's cost against its ceiling. Shows "off" when Workstation is not on. |
| Requests per hour, Slowest 5% per hour | One bar for each hour, in your time zone. A red bar has a server error, or is above 1 second. Each bar has the number as a tooltip, and a screen reader is given the same numbers as a table. |
ADVISORY
The numbers are this one server's own since it started, so they start again after each update. A line under the charts says since when. If the page says "The Health view is switched off on the brain.", the owner's page is ahead of the service; try again later.