> For the complete documentation index, see [llms.txt](https://docs.resifactory.net/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.resifactory.net/getting-started/the-interface.md).

# Finding your way around

## The navigation

Everything is reachable from the left rail. Your pages, grouped by what they are for:

<figure><img src="/files/H8wdmUNbnAgSVHrYbMRG" alt="The navigation drawer listing every page"><figcaption><p>The same page set on a phone, in the slide-in drawer.</p></figcaption></figure>

|                | Page                                        | What it is for                                                          |
| -------------- | ------------------------------------------- | ----------------------------------------------------------------------- |
|                | [**Dashboard**](/the-console/dashboard.md)  | Health at a glance and the most recent mail.                            |
|                | [**Inbox**](/the-console/inbox.md)          | Every message across every mailbox you own.                             |
| **Operate**    | [**Signups**](/the-console/signups.md)      | Mail grouped into patterns — codes, confirmations, entries, wins.       |
|                | [**Orders**](/the-console/orders.md)        | Purchases detected in your mail, with carrier tracking.                 |
|                | [**Accounts**](/the-console/accounts.md)    | The mailboxes you own, their health, and their credentials.             |
|                | [**Batches**](/the-console/batches.md)      | Groups of mailboxes — usually one per purchase.                         |
|                | [**App passwords**](/imap/app-passwords.md) | The credentials your IMAP tools use.                                    |
| **Administer** | [**Catch-all**](/the-console/catch-all.md)  | Point your own domain at the server so `*@yourdomain` lands here.       |
|                | [**Settings**](/the-console/settings.md)    | Your password, recovery address, layout, and the server's own settings. |

{% hint style="info" %}
If a page is not in your rail, it is not part of your access. Deep-linking to it shows a 404 rather than an error — nothing is broken.
{% endhint %}

## Search and commands

Press **⌘K** (macOS) or **Ctrl+K** (Windows/Linux) anywhere, or click the search box in the top bar.

<figure><img src="/files/ma1u1Qn1u9MXjm7hqI2m" alt="The command palette open over the dashboard"><figcaption></figcaption></figure>

It searches across **accounts**, **batches** and **recent messages** at once. Arrow keys move, **Enter** opens, **Esc** closes.

## Right-click anything

Almost every row in the console has a context menu with the actions for that row — copy fields, drill into related mail, run the row's action. On a phone, **long-press** the row instead.

<figure><img src="/files/XbIRNMphv246qS3O2jUK" alt="Right-click menu on an account row"><figcaption><p>Right-click a row for its actions. Long-press does the same on touch.</p></figcaption></figure>

## Two layouts

**Settings → Interface** has a **Mail client layout** toggle.

{% tabs %}
{% tab title="Classic (default)" %}
A sidebar console. Dense tables, filters in a toolbar, full-width lists. Best on a large screen when you are working through a lot of rows.

<figure><img src="/files/cMKP06XvUVcisb5NAgNi" alt="Classic layout inbox"><figcaption></figcaption></figure>
{% endtab %}

{% tab title="Mail client" %}
An icon rail, a message list, and a reading pane — the shape of a normal mail app. Best when you are mostly reading mail rather than managing mailboxes.

<figure><img src="/files/lWfNTVBTXR0JlJTQkxK5" alt="Mail client layout inbox"><figcaption></figcaption></figure>
{% endtab %}
{% endtabs %}

The choice is stored **in that browser**, so each device can differ. Every page and every action exists in both — nothing is hidden by picking one.

## On a phone

The console is built for phones as well as desktops, not merely shrunk to fit.

<figure><img src="/files/MMiPX4LSVynkq2JwLAzu" alt="App passwords on a phone"><figcaption><p>Tables become stacked rows; the kebab holds the row's actions.</p></figcaption></figure>

* Navigation is a drawer behind the menu button.
* Tables become stacked rows with the same information.
* Row actions live behind the **⋯** button or a long-press.

## Reading the status colours

The same four colours mean the same thing everywhere:

| Colour   | Status     | Meaning                                              |
| -------- | ---------- | ---------------------------------------------------- |
| 🟢 Green | `healthy`  | Working. Mail is flowing.                            |
| 🟠 Amber | `degraded` | Reachable but unreliable right now. Often temporary. |
| 🔴 Red   | `expired`  | Not currently able to fetch mail.                    |
| 🔵 Blue  | `pending`  | Newly added, not yet confirmed working.              |

More on what these mean and what to do about them: [Accounts](/the-console/accounts.md).


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.resifactory.net/getting-started/the-interface.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
