Concepts
The words ShipVitals uses, each in a few sentences, with the guide that covers it in full. Read it once, then use the guides as references.
Workspace
A workspace holds your projects, connections and people, with its own name, currency and time zone. Every workspace has a plan, and people join it by invitation. See Sign in to ShipVitals and Invite people to your workspace.
Project
A project is one thing you run: an app, a website, a library. Its kind is Commercial, Open source, Public good or Client-funded, and an open-source or public-good project shows "Cost to run" where others show profit. ShipVitals proposes projects from what your connections find, and owners and admins can make one by hand. See Projects.
Its surfaces are what people reach it by: domains, npm packages, apps and Firebase projects. A domain you add is watched for uptime, its certificate and its registration. See Surfaces.
Connection
A connection is a service you connected in Connections, such as Stripe, GitHub or Google Cloud. Each is tested before anything is saved, and every key is stored encrypted. A key that can do more than read is refused; where a service has no read-only key, All services says what ShipVitals calls with it. See Connect a service.
Binding
A binding ties a resource a connection found (a Stripe product, a GitHub repo, a Firebase project, a domain) to a project. An id match is Exact; a name, domain or address match is worth a check. A resource that serves several projects is Shared, and its cost can be split between them. See Review bindings.
Pillars
ShipVitals groups what it can see into five pillars: Revenue, Costs, Health, Usage and Obligations. On Connections each says Covered, Partial or Not connected (Obligations says how many are tracked, or None tracked), and links to what would cover it. See Open Connections.
Obligation
An obligation is something with a date and no API to warn you: a membership, a certificate, a key, a renewal. ShipVitals also tracks the domains and certificates it watches, and reminds you before each is due. Mark renewed moves one to its next date. See Expiries and the calendar.
Check, run and runner
A check is one thing that can pass or fail on a machine: a test command, a Docker smoke, a signing verification. A run is one or more checks started together. A runner is a machine paired to a workspace so it can run checks there, either a Laptop or Always on. See Run checks and Pair a runner.
Release gate
The release gate asks whether a project can ship at one commit, from what CI, your runners and your uptime checks proved. It says Shippable, Not yet (something required failed) or Unproven (nothing failed, but proof is missing or too old). It reports; it doesn't stop a deploy. See The release gate.
Incident and alert rule
An alert rule says what raises an alert, such as Check failure, Budget or Runner offline. Sensible rules are on from the start. An incident is what a rule raised: you acknowledge, snooze or mute it, and it recovers on its own when the check passes again. See Alerts.
Roles and amounts
- Owner: everything, and the only one who chooses or buys a plan.
- Admin: manages everything except billing and deleting the workspace.
- Editor: changes their projects: settings, budgets, alerts, checks.
- Viewer: sees the projects shared with them.
Amounts are a separate permission, Can see amounts (revenue, costs, profit). Without it, money figures show as "—" and there is no Costs or Revenue tab. See Invite people to your workspace and Projects.
Plan limits
Each plan, Free, Indie, Studio or Agency (and Beta during the private beta), sets how many projects, connections, seats and monitors a workspace has, how often it syncs and how much history it keeps: see /pricing and Plans and billing.