Finding your way around

Today

Today is where the app opens. Its heading says how many things need you, and the inbox below lists them. An item is anything a server or site reports as failing or degraded, plus every open on-call incident. Incidents come first, then failures, then everything that is merely degraded. The same count sits beside Today in the sidebar.

Each item has its fix beside it:

• A failed deploy. Redeploy, or show the failed run’s output.
• A certificate. Retry certificate asks Let’s Encrypt again.
• A stopped daemon, database or cache. Start it, or restart it if it failed.
• A failed backup. Back up now.
• A server. Retry provisioning if provisioning failed, or Check now if the server stopped answering.
• A required reboot. Reboot, once you have typed the server’s name.
• A failing uptime check. Opens the monitor, with the site’s Nginx error log one click away.
• An open incident. Acknowledge it.

Anything else opens the page where it gets fixed. A fix runs the same action as the button on the resource’s own page, and the job it starts opens in the console.

Snoozing an item hides it for a day, in this browser only. It comes back early if the problem changes, so a certificate you snoozed while it was expiring returns the moment it fails. Below the inbox, every server shows its CPU over the last hour, memory, disk and status. Alongside, the Activity feed lists the team’s recent jobs. The full Activity page filters them by person, kind and outcome.

↑ ↓ or J K   Select an item
↵            Open the page that answers it
E            Run its fix
H            Snooze it for a day

The sidebar

From the top: the team switcher, the + menu for a new server, a new site or a Forge import, a search box that opens ⌘K, Today, Activity, your fleet, then Logs, Uptime, On-call and Networks. Settings and your account menu sit at the bottom. The account menu shows your plan and how many of its servers you use, and holds the theme switch, the shortcut list, these docs, support and sign out.

The fleet is a live tree. Each server lists its sites and web services underneath, each with a status square. A site that is deploying shows a spinner, and a server that is still provisioning shows the step it has reached. Collapse a server to hide its sites. Right-click a server to pin it to the top, follow its Nginx error log, copy its IP address or SSH command, restart Nginx or PHP-FPM, or reboot it. Pins and collapsed servers are remembered in this browser, per team. Once the fleet is large, a filter field appears above the tree. It matches server names, IP addresses and tags, and site domains and aliases.

The Fleet heading opens the Fleet page: every server and site in one table, with search and status and tag filters.

⌘K

⌘K opens a palette that puts actions before places. Actions come first: deploy a site (or redeploy one whose last deploy failed), follow a server’s logs, run a recipe, add a server or site, import from Forge, show the console. Then places: every site by domain or alias, every server by name, address or tag, and each page of the app. Recipes and migrations have no sidebar entry. You reach them here, or through Import from Forge in the + menu. Once you type, documentation pages match too.

The site or server you are looking at is listed first. An action that cannot run right now stays in the list and says why, such as “already deploying” or “server is not active”. Press ⇥ on a site or server to see everything it offers. For a site that is deploy, its environment, its settings, its application log and a link to visit it. For a server it is each of its logs, running a recipe, and restarting Nginx or PHP-FPM.

↵     Run the highlighted action
⇥     More actions for the highlighted site or server
⌫     Back, when the search is empty
esc   Close

The console

The console is a panel along the bottom of the app. ⌃` shows and hides it, and so does Show console in ⌘K. It holds tabs:

• Jobs. Every job you are following and the team’s recent history. A job that can still be stopped has a cancel button. An empty console opens on this tab.
• A job’s output. Live while the job runs and replayed after it ends. Deploys, rollbacks and restarts you start open here, and so do fixes run from Today.
• A log. A live tail. The + in the tab bar follows a server’s Nginx error or access log, its auth log, or PHP-FPM. Following the same log twice selects the tab already open. See Logs.
• A terminal. A shell on one of your servers, opened from the + menu, a server’s menu or ⌘K. It asks which account to run as and confirms your password first. See Browser terminal.

Tabs stay open while you move between pages. Hiding the console keeps them running, and closing a tab ends its stream, which for a terminal reaps the shell. Drag the top edge to resize it, or maximize it. On a phone it covers the screen.

The site inspector

On any page of a site, ⌘. opens the inspector on the right with the settings you change most. On a phone it opens as a full-screen sheet.

• Domains. The primary domain, its aliases, and the certificate’s state and expiry.
• Source. Repository, branch, and deploy on push, which needs a repository connected through the GitHub App.
• Runtime. The PHP version on PHP sites, switched in place. Other runtimes show what they run.
• Processes. The site’s daemons and cron entries, when it has any.
• Databases. Link a database on the site’s server or on one of the team’s database servers. A link records which site uses which database and changes nothing on a server.
• Maintenance mode. Laravel sites only. See Nginx & access control.

A change applies when you make it, with no save button. The toast that confirms it has an Undo button, and ⌘Z does the same while the toast shows. Repository, branch and deploy on push take effect on the next deploy. A PHP switch or maintenance mode runs as a job straight away.

Where everything else lives

A site has five views: Overview, Deployments, Logs, Environment and Settings. A web service has no Environment. The toolbar above them holds Visit, Roll back once there is an earlier release, and Deploy. The Settings view is one long page, grouped like this:

Domains & SSL    DNS, SSL, Redirects, CORS (web services only)
Build & deploy   Source, Build settings, Deploy script, Deploy trigger URL
Runtime          PHP version (PHP sites), Nginx
Security         Password protection, Symlink protection
Danger zone      Delete

A server has Overview, Sites, Databases, Processes, Firewall and Settings. Sites appears only on a server that can host them, and Processes holds daemons and scheduled tasks. The toolbar holds Run recipe, Command for a one-off shell command, Get help, and a menu to follow a log or copy the SSH command.

Server        General, Access, Monitoring, Alerts
Storage       Backups
Runtime       PHP CLI, Config files
Maintenance   Drift, Power, Danger zone

Settings in the sidebar has four pages:

Account       Profile, Sign-in, Passkeys, Two-factor, Sessions, Product analytics, Your data
Team          Members, Invitations, Roles, Audit log
Billing       Plan, Usage, Change plan
Connections   Cloud providers, Integrations, Notification channels, Registry credentials, SSH keys, API tokens

Signed-in sessions

Account, then Sessions, lists every browser and app signed in as you, with its IP address, when it signed in and when it was last active. Sign one out, or every other one at once. Both need your password if you have not entered it recently. A session you sign out ends on its next request. API tokens are not sessions: signing out, changing your password and resetting it all leave them working. Revoke those under Connections, then API tokens.

Keyboard shortcuts

Press ? anywhere for the full list. On Windows and Linux, use Ctrl in place of ⌘. The console key is Control on every platform. Single-key shortcuts do nothing while you type in a field.

⌘K    Search or run a command
⌃`    Show or hide the console
⌘.    Show or hide the inspector on a site
⌘Z    Undo the change a toast is offering to undo
?     List every shortcut
G T   Go to Today
G A   Go to Activity
G F   Go to Fleet
G L   Go to Logs
G U   Go to Uptime
G S   Go to Settings