Skip to main content

UI overview & navigation

How the CertAutoPilot web UI is laid out: the left sidebar, the search box (⌘K), the project selector that scopes almost everything, the Settings sub-navigation, the account menu with the dark-mode toggle and built-in help pages, and how sessions refresh and expire.

Overall layout​

The UI has a left sidebar and a slim header above the page.

The sidebar, from top to bottom:

  1. Logo + product name + version — clicking it returns to the Dashboard. The version number under the name is the running backend version. On CertAutoPilot OS, org owners and admins also see x.y.z ready there when a newer release can be installed; pointing at it shows the console command and a link to the release notes.
  2. Project selector — the current project's name and your role in it; click it to switch projects (see below).
  3. Main menu — the pages, grouped by job (see below). Click a group title to fold the group away; a folded group still shows the page you are on, and the choice is remembered in the browser.
  4. Account — your name and e-mail at the bottom; click it for the account menu.
  5. Collapse sidebar / Expand sidebar — the button beside the account shrinks the sidebar to icons only (names appear as tooltips). The choice is remembered in the browser.

On a narrow screen (a phone or a small tablet) the sidebar is hidden. The header then shows a menu button that opens it as a drawer from the left, plus the current project's name (tapping it opens the same drawer). Any navigation closes the drawer.

The header holds:

  • Search or jump to… (shortcut ⌘K on a Mac, Ctrl K elsewhere) — type to jump to any page in the menu or in Settings, or to a certificate, a target (operators and up), a discovered certificate or a discovered server of the current project.
  • Certificate health — on wider screens, three counts for the current project: Healthy, Expiring (active and within 30 days, or in the last third of a shorter-lived certificate's life) and Failed (the last renewal failed). Each opens the certificate list filtered to it.

Page content renders below the header with the current page highlighted in the sidebar. Navigating to a new page scrolls back to the top automatically.

Two warning banners can appear directly under the header: a license grace period banner (days remaining before the tier reverts to Free's one-certificate, one-target caps) and a license expired/invalid banner. See License.

The sidebar groups, in order, and where each page is documented:

GroupItemRouteDocs page
OverviewDashboard/Main dashboard
Overview47-day readiness/readiness47-Day Readiness
OverviewReports/reportsPDF reports (operator and up)
CertificatesCertificates/certificatesCertificates pages
CertificatesDomains/domainsDomains
CertificatesDiscovery/discoveryDiscovery pages
DistributionTargets · Target groups · Modules · Credentials · Secret stores · Path sets · Action sets · Variables/settings/distribution?tab=…, /settings/variablesDistribution (operator and up)
OperationsJobs/jobsJobs
OperationsApprovals/my-requestsApprovals
OperationsAudit log/auditAudit log pages
ConfigureSettingsfirst visible settings pageSettings sub-navigation
ConfigureModule guides/module-guidesBuilt-in help pages
ConfigureAPI docs/api-docsBuilt-in help pages

The Distribution group is shown only to operators and up (in the organization or in any project).

Approvals carries a count of the requests waiting for your review in the current project when you are an organization admin or an admin of that project; in the collapsed sidebar and on the phone menu button the count becomes a dot.

Clicking Settings jumps to the first settings page your role can see (Certificate authorities for operators and up, otherwise Notifications).

Project selector​

Most resources — certificates, ACME accounts, AD CS and CA connections, distributions, jobs, discovery, notification channels — are project-scoped. The project selector at the top of the sidebar determines which project every page shows. With more than six projects the list gets a Find a project box.

  • Switching projects immediately refetches all project-scoped data — every list and detail page re-renders for the new project.
  • The choice is persisted in two places: browser localStorage and your favorite project preference on the server, so the same project is pre-selected on your next login (even from another browser).
  • On login the UI selects your favorite project, falling back to the previously saved one, then the first project you have access to.
  • Pages that need a project show a no project selected placeholder if you have none.

Projects themselves are managed under Settings → Projects (Organizations & projects).

Settings sub-navigation​

Opening any Settings page shows the settings sections in a column beside the page; it stays in view while you scroll. On a narrow screen the column becomes a Settings section picker above the page. The sections are grouped and role-filtered:

GroupVisible toEntries (in order)
IssuanceOrg or project operator+Certificate authorities (tabs: ACME Accounts · Custom ACME CAs · Microsoft AD CS · CA Connectors) · DNS credentials · Zones · Certificate policy · Approvals · Chain certificates · Organizations
IssuanceOrg ownerCA providers
AutomationEveryoneNotifications
AutomationOrg admin+Discovery
AccessEveryoneProjects
AccessOrg ownerUsers · Groups · Sign-in (local, LDAP, SSO providers, two-factor policy)
SystemOrg admin+General · System status · Cluster · Encryption keys · Syslog · License

The Distribution pages and Variables are not here: they are in the Distribution group of the sidebar.

Approvals (/settings/approvals) is the selected project's approval policy: every project member can read it, only an organization owner can change it.

Certificate authorities (/settings/certificate-authorities?tab=acme|acme-cas|msca|ca-connectors) is one page with tabs (ACME Accounts · Custom ACME CAs · Microsoft AD CS · CA Connectors). The former addresses /settings/acme-accounts and /settings/msca-connections redirect to the matching tab; the edit forms keep their own pages.

Menu visibility is not the same as access

Pages that do not configure the selected project carry a small Global mark beside their name (in the narrow-screen picker: "(Global)"): they apply to every project (Chain certificates, Organizations, CA providers, Discovery settings, Projects, Users, Groups, Sign-in, General, System status, Cluster, Encryption keys, Syslog, License). Every page without the mark is about the project chosen in the project selector.

The sub-nav shows DNS credentials and Zones to operators, but those two screens are guarded at admin: an operator who clicks them is returned to the Dashboard. Most other settings screens are not guarded client-side at all — they render and the API refuses the call instead. Treat the menu as navigation, not as an access-control statement.

note

The menu filtering is a convenience. Every route is guarded server-side; only some are additionally guarded client-side (those redirect you back to the Dashboard — the rest render and the API refuses the call). Role semantics are described in RBAC & tenancy.

Account menu​

Click your name at the bottom of the sidebar. The menu shows your display name and e-mail, then:

  • Dark mode / Light mode — toggles the theme. The initial theme follows your OS preference; the toggle is persisted in the browser.
  • My profile — password, TOTP, personal settings (Profile).
  • Module guides — built-in help page (see below).
  • API docs — built-in help page (see below).
  • Sign out — logs out and invalidates the session tokens.

The approval workflow page is not in this menu: it is Approvals in the Operations group of the sidebar (Approvals).

Built-in help pages​

Two reference pages ship inside the app itself, reachable from the Configure group of the sidebar and from the account menu:

  • API docs (/api-docs) — an interactive REST API reference. Endpoints are shown in one filterable table (filter by category, method and minimum role) across six tabs: Authentication, Getting Started, Endpoints, Config Schemas, Examples, and Roles & Scoping (Auth, Projects, Certificates, ACME, MSCA, DNS & Zones, Distribution, Discovery, Domains, Jobs, Notifications, Approvals, Audit, Dashboard, License, Organizations, Users, Settings) with method, path, minimum role, request-body fields, an example response, and copy buttons. Complements the API reference in this documentation.
  • Module guides (/module-guides) — per-module setup guides for every distribution module (SSH, Kubernetes, Webhook, NetScaler, F5 BIG-IP, Huawei Cloud, Vault, IIS, SMTP, WinRM, AWS ACM, Azure Key Vault, Cloudflare, cPanel/WHM, MerlinCDN, Microsoft Exchange, PAN-OS, FortiWeb, FortiGate, A10 Thunder, Elchi), each with capability badges, configuration reference, troubleshooting and an FAQ — plus a cross-cutting Deployment Overrides guide explaining per-certificate placement on shared targets. The equivalent docs live under Distribution.

Notifications & errors​

Success and error feedback surfaces as toast pop-ups in the top-right corner — e.g. "Renewal requested", "Failed to link distribution" with the backend error message. Longer-running feedback (bulk actions, distribution runs) additionally renders inline progress bars on the page that started them. Inline alert banners (yellow/red boxes at the top of a page or card) are used for persistent conditions such as policy violations, license limits, or a certificate awaiting approval.

Sessions & expiry​

Authentication uses short-lived access tokens in httpOnly cookies (see Auth & RBAC):

  • When an API call returns 401 because the access token expired, the UI silently refreshes the session and retries the request — you don't notice anything. Concurrent 401s share a single refresh. Your roles are re-synced from the server on every refresh, so a role change takes effect without re-login.
  • CSRF token mismatches after a refresh are also retried transparently.
  • If the refresh fails — refresh token expired (7 days), revoked, or token reuse detected — the UI clears the session and returns you to the login page. The selected project is cleared with it.
  • On a fresh installation (setup not completed) every route redirects to the setup wizard instead.

See also​