WP OctoDocs
Getting started

Account and workspace

Your account, the workspace your sites live in, and who else can be in it.

One account, one or more workspaces

You sign in to WP Octo with an email address and a password, or with one of the sign-in providers offered on the login page. Two-factor authentication can be enabled from your profile.

Everything you manage lives in a workspace. An agency typically has one workspace for all the sites it looks after; a hosting company may have several. Sites, backups, update rounds, clients, packages and API keys all belong to the workspace, and nothing in one workspace is visible from another — that separation is a property of the product, not a setting.

Members and roles

A workspace has members, and every member has one role in it:

RoleWhat it is for
AdministratorEverything: sites, updates, backups and restores, clients, packages, team, settings and API keys. The person who created the workspace starts as its administrator.
UserSees every site and its pages, and can log in to a site's admin through the dashboard. Changes nothing on the platform itself: rounds, backups, restores and site settings are an administrator's.
ClientRead-only. A client is attached to one or more client accounts and sees only the sites that belong to them: their status, their update rounds, their backups. A client cannot start an update, a restore, a backup, or log in to a site through the dashboard.

Members are invited from Team in the dashboard, with the role they should have. What each role may do is spelled out under Roles and permissions.

Clients

A client is the customer whose site it is: a company or a person your agency works for. Every site is attached to a client, and clients can be given their own read-only members. Clients also carry the notification preference for the emails WP Octo sends about a site's updates.

Packages

A package is the service level a site is on: how often it is updated, how often and where it is backed up, how many pages of it are monitored and how often. You define packages once and assign one to every site; a site can override a package's backup settings on its own. See Packages.

Workspace settings

Under Workspace settings an administrator finds the workspace's name and details, its billing where that applies, and its API keys — the credential an integration uses to read the workspace's data through the API. Keep API keys out of managed sites: a site holds a credential of its own, and an API key on a site would hand the platform to whoever compromises that site.

On this page