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

# Getting Started

From a new tenant to the first deployed package: the decisions to make up front, a standard setup for trials and Intune-only environments, and where the extended guide takes over.

This page is the starting point for every new RealmJoin environment. Read it top to bottom: it lists what you need, the three decisions to make before you start, and the steps that take you from a new tenant to your first deployed package. Each step links to the page with the details.

## Before you start

* A **Microsoft 365 / Entra ID tenant** with **Microsoft Intune** licenses. RealmJoin is licensed per user, see [Licensing](https://docs.realmjoin.com/legal/licensing.md).
* A **Global Administrator** who consents to the RealmJoin applications during onboarding.
* An **Azure subscription** — only if you want the features that run in your own Azure environment (see [Decision 3](#decision-3-which-features-run-in-your-azure-environment)). A trial or an Intune-only setup does not need one.

To understand what RealmJoin does before you start, read the [Overview](https://docs.realmjoin.com/overview.md) and the [Architecture Overview](https://docs.realmjoin.com/deployment/architecture-overview.md).

## Make three decisions

### Decision 1: Quick Setup or Advanced Setup

You choose the setup type when you onboard the RealmJoin Portal.

|              | Quick Setup                                                                                                                                       | Advanced Setup                                                                 |
| ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ |
| How          | One Entra admin consent in the browser                                                                                                            | The RealmJoin PowerShell module creates the service principals and permissions |
| Permissions  | All core and optional portal permissions at once (Intune LAPS, Autopilot, device actions, remediation scripts, sign-ins, BitLocker keys and more) | Only the features you select, optionally read-only                             |
| Effort       | A few clicks                                                                                                                                      | Run and maintain PowerShell commands                                           |
| Choose it if | You accept the full permission set of the RealmJoin application                                                                                   | You need to control or restrict every granted permission                       |
| Switch later | Can be switched to Advanced Setup later (one-way)                                                                                                 | Cannot be switched back to Quick Setup                                         |

The RealmJoin Agent client app and the Microsoft Defender for Endpoint security features are activated separately in both setup types, on the [features page](https://portal.realmjoin.com/organization/features) of the RealmJoin Portal.

{% hint style="info" %}
A tenant onboarded with Quick Setup can move to Advanced Setup later, see [Switching from Quick Setup](https://docs.realmjoin.com/deployment/onboarding-realmjoin-portal/advanced-setup.md#switching-from-quick-setup). The reverse is not possible.
{% endhint %}

### Decision 2: Intune only, or Intune and the RealmJoin Agent

Every Windows package can be delivered by **Microsoft Intune** or by the **RealmJoin Agent**. Intune deployment needs nothing on the device beyond Intune. The Agent adds dependencies and install order, the RealmJoin ESP, self service, user deferral, LAPS with your own Key Vault, notifications and more.

{% content-ref url="/pages/5ngI4HX7rTSMR57KlayF" %}
[Deployment Methods: RealmJoin Agent vs. Intune](https://docs.realmjoin.com/application-management/deployment-methods.md)
{% endcontent-ref %}

### Decision 3: Which features run in your Azure environment

Some features deliberately keep data and execution in your own Azure subscription. Each one is optional, so connect only what you plan to use.

| Feature                                                                                                         | Azure resource          | Needed for                                               |
| --------------------------------------------------------------------------------------------------------------- | ----------------------- | -------------------------------------------------------- |
| [Runbooks](https://docs.realmjoin.com/automation/connecting-azure-automation.md)                                | Automation Account      | Automating administrative tasks                          |
| [Audit Log](https://docs.realmjoin.com/monitoring-and-logs/log-analytics.md)                                    | Log Analytics Workspace | Audit log, archived runbook logs                         |
| [Agent LAPS](https://docs.realmjoin.com/realmjoin-agent/realmjoin-client/local-admin-password-solution-laps.md) | Key Vault               | Local admin passwords managed by the RealmJoin Agent     |
| [Workplace Cloud Storage](https://docs.realmjoin.com/administration-and-settings/workplace-cloud-storage.md)    | Storage Account         | Browser favorites, files and Outlook signature templates |

## Choose your path

| Your scope                                                          | Path                                                                                                                            |
| ------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
| Trial or proof of concept                                           | [Standard path](#standard-path) below                                                                                           |
| Application deployment through Intune only, no Azure resources      | [Standard path](#standard-path) below                                                                                           |
| RealmJoin Agent, Runbooks, audit logs, Defender integration or LAPS | Standard path, then continue with the [Extended Guide](https://docs.realmjoin.com/deployment/getting-started/extended-guide.md) |

## Standard path

{% stepper %}
{% step %}

#### Onboard the RealmJoin Portal

Sign in to the RealmJoin Portal as Global Administrator, consent to the RealmJoin application and choose the setup type from [Decision 1](#decision-1-quick-setup-or-advanced-setup).

{% content-ref url="/pages/TH5ltCfKQq46OCm4Q6G2" %}
[Onboarding](https://docs.realmjoin.com/deployment/onboarding-realmjoin-portal.md)
{% endcontent-ref %}
{% endstep %}

{% step %}

#### Give your team access

During onboarding, the Entra role *Global Administrator* becomes a RealmJoin administrator. Assign RealmJoin roles to Entra groups in **Settings → Permissions** so that your administrators and helpdesk staff can work without the Global Administrator role. Use the pre-defined roles unless you need a custom set of permissions.

{% content-ref url="/pages/IShXlf27koVQgYFHlnhr" %}
[Roles and Permissions](https://docs.realmjoin.com/administration-and-settings/permission.md)
{% endcontent-ref %}
{% endstep %}

{% step %}

#### Deploy your first package

Open the **Package Store**, subscribe to an application, choose the deployment method from [Decision 2](#decision-2-intune-only-or-intune-and-the-realmjoin-agent) and assign it to a pilot group through its managed groups. Once the pilot works, widen the assignment and enable update automation.

{% content-ref url="/pages/qujii1DZUl1kXifaINjB" %}
[Package Store](https://docs.realmjoin.com/application-management/packages/package-store.md)
{% endcontent-ref %}

{% content-ref url="/pages/dybUrRL6OuX8Itod5RAQ" %}
[Package Assignments](https://docs.realmjoin.com/application-management/packages/package-deployment.md)
{% endcontent-ref %}
{% endstep %}

{% step %}

#### Explore your users, groups and devices

The user, group and device pages combine Entra ID, Intune, Autopilot, Defender and sign-in data for each object. Open a known user or device to check that the data from your tenant arrives.

{% content-ref url="/pages/9hhY3AJj09rM2W7ud9PQ" %}
[Navigation](https://docs.realmjoin.com/introduction/navigation.md)
{% endcontent-ref %}

{% content-ref url="/pages/cV2auHYEl0Z9stziuych" %}
[Overview](https://docs.realmjoin.com/ugd-management/user-group-device-management.md)
{% endcontent-ref %}
{% endstep %}
{% endstepper %}

## Next steps

If your scope goes beyond the standard path, continue with the Extended Guide. It adds the RealmJoin Agent, the Azure resources from [Decision 3](#decision-3-which-features-run-in-your-azure-environment) and the optional platform features.

{% content-ref url="/pages/nmfOf6BSjqi5OqRyQPMB" %}
[Extended Guide](https://docs.realmjoin.com/deployment/getting-started/extended-guide.md)
{% endcontent-ref %}

Questions along the way are answered in the [FAQ](https://docs.realmjoin.com/troubleshooting-and-faq/faq.md). For anything else, see [Support & Service Level](https://docs.realmjoin.com/legal/support.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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.realmjoin.com/deployment/getting-started.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
