# The console

> The Beekon Cloud console. Signing in, the top bar (project switcher, status pill, search and alerts), the task bar and its pages, and the three roles.

Source: https://docs.getbeekon.com/cloud/console/

The console is the web app for a Beekon Cloud organisation. You watch a project’s devices, locations, trips and events, draw its geofences, edit its remote config, issue its API keys and webhooks, and manage the organisation’s members. Reading data, geofences, remote config, webhook endpoints, device commands and erasing a user are also in the [server API](https://docs.getbeekon.com/api/). These are console-only: API keys; creating, renaming, suspending, reactivating and erasing projects; usage and the MAU cap; exporting a user’s data; webhook delivery history and **Send again**; a device’s command history; and members, invitations and the audit log.

## Signing in

Open [console.getbeekon.com](https://console.getbeekon.com) and sign in with your email and password. During [early access](https://docs.getbeekon.com/cloud/) we create your organisation and its first owner; the owner invites everyone else (see [Organisation](https://docs.getbeekon.com/cloud/console/project/#organisation)). Self-serve sign-up is described in [Sign up and set up your workspace](https://docs.getbeekon.com/cloud/sign-up/).

* A wrong email or password says **That email and password don’t match. Check them and try again.**
* After too many wrong tries the console says **Too many attempts. Wait 15 minutes, then try again, or ask an owner or admin to reset your password.** The count is kept by the server, so another browser or device does not reset it.
* **Forgot your password?** Beekon sends no email. An owner or admin of your organisation resets it from **Organisation › Members** and gives you a temporary password.
* A session lasts 12 hours, and ends early when your password is changed or reset.

### Accepting an invitation

An invitation is a link that works once, for 7 days. Opening it shows **Join *organisation*** with who invited you, your email, your role and how long the link works. New to Beekon: enter **Your name** (optional), a **Password** (at least 8 characters) and **Password again**. Already have a Beekon account: use its password. Then click **Join *organisation***.

## The top bar

From left to right:

| Item                      | What it does                                                                                                                                                                                                                                                                                                                                                                                     |
| ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| **Organisation switcher** | The organisations you belong to and your role in each, with a link to **Organisation**.                                                                                                                                                                                                                                                                                                          |
| **Project switcher**      | The organisation’s projects with their region, or **Suspended** on a suspended one. With more than six projects it has a **Find a project…** box. With a project open it links to **Project settings**; owners and admins also get **New project…**. Choosing another project keeps you on the same page.                                                                                        |
| **Search**                | Jumps to a page, or to devices and users matching what you type. Press `⌘K` / `Ctrl+K` or `/`.                                                                                                                                                                                                                                                                                                   |
| **Status pill**           | The project’s live state (below). It opens Locations.                                                                                                                                                                                                                                                                                                                                            |
| **Alerts**                | What needs attention, with **Clear all** and a × per alert. A cleared alert comes back if it gets worse; **Show cleared (*n*)** brings the cleared ones back now. **Nothing needs you right now.** when there are none.                                                                                                                                                                          |
| **Theme**                 | Light or dark. The account menu also offers **System**.                                                                                                                                                                                                                                                                                                                                          |
| **Account menu**          | Your email, organisation and role, **Change password…**, the theme, **Sign out**, and at the foot the organisation’s plan, as the [Billing](https://docs.getbeekon.com/cloud/billing/) tab words it: for example **Free plan**, **Growth plan**, **Growth plan · cancels *date*** or **Scale plan · payment failed**. For owners and admins it opens Billing; members, and a server without billing, see **Beekon Cloud**. |

The status pill reads the project’s newest location:

| Pill                                 | Meaning                                                                                                                                                             |
| ------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Live · last location 8 s ago         | Locations are arriving.                                                                                                                                             |
| Stalled · no location for *duration* | No location for more than 5 minutes, although devices were active in the last 24 hours. (The project’s pill, not a [stalled trip](https://docs.getbeekon.com/api/trips/#the-trip-lifecycle).) |
| Idle · last location *ago*           | No location for more than 5 minutes, and no device was active in the last 24 hours. (The pill, not the SDK’s `Idle` state.)                                         |
| At cap · new users dropped           | The project reached its [MAU cap](https://docs.getbeekon.com/cloud/usage/#usage-and-the-mau-cap).                                                                                             |
| Waiting for first location           | The project has never received a location.                                                                                                                          |
| Suspended · uploads refused          | The project is [suspended](https://docs.getbeekon.com/cloud/console/project/#project-settings).                                                                                               |
| No project                           | No project is open, for example in an organisation with no projects yet.                                                                                            |
| Status unavailable                   | The console could not read the project’s status. It tries again on the next refresh.                                                                                |

### New project

**New project…** (owners and admins) asks for a **Project name** (1 to 64 characters, renameable later) and a **Region**: where its locations, trips and events are stored. The region can’t be changed later. A project starts with no API keys, so the console then opens [API keys](https://docs.getbeekon.com/cloud/console/developers/#api-keys) for its first SDK key. Suspended projects count towards the plan’s project limit.

## The task bar

The task bar on the left lists a project’s pages. Press `[` to collapse or expand it. The breadcrumb above each page reads *Project › Section*, for example *Fleet App › Monitor*. The foot of the task bar holds the **Monthly active users** meter, which opens Usage.

| Group          | Pages                                                                                                                                                                                                                                                                  |
| -------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|                | [Overview](https://docs.getbeekon.com/cloud/console/overview/): the project at a glance                                                                                                                                                                                                          |
| **Monitor**    | [Map](https://docs.getbeekon.com/cloud/console/monitor/#map) (coming soon), [Locations](https://docs.getbeekon.com/cloud/console/monitor/#locations), [Trips](https://docs.getbeekon.com/cloud/console/monitor/#trips), [Events](https://docs.getbeekon.com/cloud/console/monitor/#events), [Devices](https://docs.getbeekon.com/cloud/console/monitor/#devices), [Users](https://docs.getbeekon.com/cloud/console/monitor/#users) |
| **Configure**  | [Geofences](https://docs.getbeekon.com/cloud/console/configure/#geofences), [Remote config](https://docs.getbeekon.com/cloud/console/configure/#remote-config)                                                                                                                                                             |
| **Developers** | [API keys](https://docs.getbeekon.com/cloud/console/developers/#api-keys), [Apps](https://docs.getbeekon.com/cloud/console/developers/#apps), [Webhooks](https://docs.getbeekon.com/cloud/console/developers/#webhooks)                                                                                                                              |
|                | [Usage](https://docs.getbeekon.com/cloud/console/project/#usage), [Project settings](https://docs.getbeekon.com/cloud/console/project/#project-settings), [Organisation](https://docs.getbeekon.com/cloud/console/project/#organisation)                                                                                                             |

On a phone (760 px wide or less) the task bar becomes a bar at the bottom with **Overview**, **Locations**, **Devices** and **Users**; open the other pages from search, and Organisation from the organisation switcher.

Most list pages share the same controls:

* **Auto-refresh** re-reads the page every 30 seconds; the button says when it last updated. Click it to stop (**Auto-refresh off**). On Locations, Trips and a trip’s page it is off until you turn it on.
* **Time range** on Locations and Trips: **Now** (the last 15 minutes), **Today**, **Last 24 h** (the default), **Last 7 days** and **Custom…**.
* **Copy link** copies the current view, filters included. **Export** saves the current page as CSV or JSON, up to 500 rows; the API fetches the rest.
* On Locations and Events, `J` and `K` move between rows, `Enter` opens one and `Esc` closes it.

## Roles

Roles are per organisation and apply to all of its projects. The server checks every change, not only the screen.

|                                                                                                    | Owner | Admin | Member                                                                                                  |
| -------------------------------------------------------------------------------------------------- | ----- | ----- | ------------------------------------------------------------------------------------------------------- |
| See every page and its data                                                                        | yes   | yes   | yes, except Invitations, the Audit log, Remote config › Revision history and Project settings › History |
| Draw geofences, edit remote config, issue and revoke keys, manage webhooks                         | yes   | yes   | no                                                                                                      |
| Send device commands, erase a user                                                                 | yes   | yes   | no                                                                                                      |
| Set the MAU cap, rename, suspend or reactivate a project, create projects                          | yes   | yes   | no                                                                                                      |
| Invite members, change roles and reset passwords (an admin can’t for an owner), read the audit log | yes   | yes   | no                                                                                                      |
| Make someone an owner, erase a project, export a user’s data                                       | yes   | no    | no                                                                                                      |
| See billing and edit the billing details (next backend release)                                    | yes   | yes   | no                                                                                                      |
| Choose, change or cancel the plan (next backend release)                                           | yes   | no    | no                                                                                                      |

An organisation always keeps at least one owner.
