> For the complete documentation index, see [llms.txt](https://docs.pharos.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.pharos.ai/configuration-guide/quick-start.md).

# Quick Start

Use the Quick Start wizard to configure Pharos quickly and get immediate value.

The Quick Start wizard streamlines the initial configuration of Pharos in your Salesforce org. It guides you through essential setup steps—error tracking, connected orgs, and remote site settings—so you can start capturing errors and issues within minutes. The process typically takes a couple of minutes to complete.

***

## Accessing the Wizard

Open the **Pharos** app from the App Launcher, navigate to **Pharos Admin**, then select **Quick Start** from the left-hand navigation menu. The wizard presents two options: **Fresh Install** for new installations, or **Sandbox Refresh** for reconfiguring after a sandbox refresh.

The wizard ribbon has four steps, in this order:

1. **Remote Settings**
2. **Connect an Org**
3. **Error Tracking**
4. **Quick Test** — the final step

{% hint style="info" %}
**Safe to re-run.** Running the wizard against an already-configured org is safe — this is how you verify an org after an [upgrade](https://docs.pharos.ai/configuration-guide/the-basics/upgrade.md). The exception is the **Sandbox Refresh** option, which deliberately clears configuration and should only be used after an actual sandbox refresh.
{% endhint %}

{% embed url="<https://demo.arcade.software/3Qgh7PnjCBA6ilR9KM44?embed>" %}

***

## Option 1: Fresh Install (New Installation)

Use this option when setting up Pharos for the first time — and when verifying an org after an [upgrade](https://docs.pharos.ai/configuration-guide/the-basics/upgrade.md). Click **Launch** to begin. The wizard configures:

* [**Error Tracking**](https://docs.pharos.ai/configuration-guide/error-tracking.md) — Enables automated capture of Apex exceptions, flow errors, batch job failures, and bulk API failures. The wizard creates the email service and updates Salesforce settings to route exception notifications to Pharos.
* [**Connected Orgs**](https://docs.pharos.ai/configuration-guide/connected-orgs.md) — Creates the required **self-org** entry so Pharos can attribute logs to the correct org. Do not delete this entry.
* **Remote site settings** — Configures the URLs Pharos needs to connect to external services and notification channels.

{% hint style="warning" %}
**Do not delete the self-org connected org entry.** It is required for proper log attribution. The one exception: if Pharos logs that this connection *"was created by an earlier Pharos version and can no longer be authenticated"*, delete it and recreate it right away. Log in as the Pharos running user first (see [Running User](#running-user)), then run **Fresh Install** again. See [Connections from an earlier Pharos version](https://docs.pharos.ai/configuration-guide/connected-orgs.md#connections-from-an-earlier-pharos-version).
{% endhint %}

***

## Option 2: Sandbox Refresh

Use this option **after every sandbox refresh**. Salesforce copies production configuration into the sandbox; Pharos must reinitialize for the sandbox environment. Click **Launch** to reinitialize. See [Connected Orgs](https://docs.pharos.ai/configuration-guide/connected-orgs.md) for more on org setup and sandbox refresh.

{% hint style="warning" %}
**Sandbox Refresh clears configuration — only run it on a freshly refreshed sandbox.** It deletes the package email service addresses, deletes the remote site settings Pharos created, deletes your connected orgs, clears connected-org settings, and deactivates every active rule except Archival. Deactivated rules are not deleted; authentication tokens and retention rules are preserved.
{% endhint %}

{% hint style="warning" %}
**Always run Sandbox Refresh after every sandbox refresh.** Otherwise Pharos will not function correctly—it will have the wrong org ID and stale configuration.
{% endhint %}

***

## Quick Test

**Quick Test** is the fourth and final step of the ribbon. It sends a synthetic exception email and then polls for the resulting Log record, verifying the whole inbound path: email → the Pharos email service → the parser → a `Log__c` record. The test is optional—you can skip it if you prefer. See [Error Tracking](https://docs.pharos.ai/configuration-guide/error-tracking.md) for details on how the email service works.

Quick Test does **not** exercise Triton or platform events. To verify those, use the **Run a Test** card under **Pharos Admin → Advanced → Triton → Configuration → Platform Event**.

{% embed url="<https://demo.arcade.software/QsI5XmtwdmSzrndmqVe5?embed>" %}

**Sandbox installations:** If you see a **yellow banner** at the Quick Test step, your sandbox likely has restricted email deliverability. The banner may read "Unable to send an email, please check your deliverability settings in Setup."

![Quick Test deliverability banner — navigate to Setup → Deliverability to resolve](https://4264222071-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fdl9tmJ56lvwg5XY63QYr%2Fuploads%2Fgit-blob-360f3188bb4ea0a8fccc4864ea30a99f87ef34e4%2Fquick-test-deliverability-banner.png?alt=media)

Navigate to **Setup → Deliverability** and update the settings as prompted. If you're not comfortable changing deliverability settings or the option isn't available, skip the test. You can also verify your configuration by installing the Pharos Error Generator ([production](https://resources.pharos.ai/pharos-error-generator-prod) or [sandbox](https://resources.pharos.ai/pharos-error-generator-sandbox)) and simulating errors instead. It installs like any other package. See [Package Installation](https://docs.pharos.ai/configuration-guide/the-basics/package-installation.md).

***

## Path Settings (Optional)

**Path** is a Salesforce feature that displays a status bar on Lightning pages. Pharos uses it on the Issue details page to show the current status of an Issue (e.g., New → In Progress → Review → Completed). In Setup, search for **Path**, locate the Issue object configuration, and click **Enable**. See [Issue Tracker](https://docs.pharos.ai/configuration-guide/issue-tracker.md) for more on Issue lifecycle and configuration.

{% embed url="<https://demo.arcade.software/nLY6hMo0aYafsZ9uxj2Z?embed&show_copy_link=true>" %}

***

## Running User

The user who runs the Quick Start wizard becomes the **Pharos running user**. Log in as the intended running user before opening the wizard. For required permissions and how to change the running user later, see [Pharos Running User](https://docs.pharos.ai/configuration-guide/the-basics/pharos-running-user.md).

**Upgrading an existing org?** The running user must be re-established after a major release upgrade, along with the permission sets and the Triton subscriber user — see [Upgrade](https://docs.pharos.ai/configuration-guide/the-basics/upgrade.md).

***

## Post-Configuration Steps

After the wizard completes, verify [Error Tracking](https://docs.pharos.ai/configuration-guide/error-tracking.md) settings, configure [Integrations](https://docs.pharos.ai/configuration-guide/integrations.md) (e.g., [Slack](https://docs.pharos.ai/configuration-guide/integrations/slack.md) or [Teams](https://docs.pharos.ai/configuration-guide/integrations/teams.md)), and set up [Notification Rules](https://docs.pharos.ai/configuration-guide/notifications.md). Initial error data may take up to 24 hours to appear.

***

## Best Practices

* Run the wizard as a System Administrator or dedicated integration user
* For sandbox refreshes, run **Sandbox Refresh** immediately after the refresh completes
* Document your running user in case they need to be changed later
* Test notification channels after completing the wizard

{% hint style="success" %}
**Next Step:** After the wizard completes, configure [Error Tracking](https://docs.pharos.ai/configuration-guide/error-tracking.md) (verify settings), [Connected Orgs](https://docs.pharos.ai/configuration-guide/connected-orgs.md), and [Integrations](https://docs.pharos.ai/configuration-guide/integrations.md) to enable notifications.
{% endhint %}
