> 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/onboarding-realmjoin-portal.md).

# Onboarding

Step by step guide on deploying the RealmJoin Portal to a new tenant

## Self-onboard RealmJoin Portal

{% stepper %}
{% step %}

#### Sign in as a Global Admin

Visit <https://portal.realmjoin.com> and sign in as **Global Admin** of your Entra ID Tenant.

<figure><img src="https://2868468309-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MkrcM7cKOpXKri1kVrh%2Fuploads%2FTkqBWPCWOfdR5UKSGDKC%2Fimage.png?alt=media&amp;token=d6a068a4-cb80-4965-8577-358b7816b69f" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}

#### Accept Permissions

Select "Consent on behalf of your organization" to approve the RealmJoin Portal on behalf of your organization.

<figure><img src="https://2868468309-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MkrcM7cKOpXKri1kVrh%2Fuploads%2F0H1LJb2vDGT5wpxwReeE%2Fimage.png?alt=media&amp;token=ce766c21-cd4a-4427-8c35-98062f03037f" alt=""><figcaption><p>The App will request basic permissions needed to interact with the RealmJoin Portal. These permissions are required for any user interacting with RealmJoin Portal - e.g. to use self-services.</p></figcaption></figure>
{% endstep %}

{% step %}

#### Fill in the form

The nominated email will receive important updates and portal notifications.

<figure><img src="https://2868468309-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MkrcM7cKOpXKri1kVrh%2Fuploads%2F82jGPO4m01SElNWmtDCl%2FSnipaste_2026-01-21_15-07-24.png?alt=media&amp;token=eb1045fc-5ddd-448c-958a-59b89a053597" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}

#### Select "Quick Setup" or "Advanced Setup"

* **Quick Setup** grants all core and optional RealmJoin Portal permissions with a single admin consent.
* **Advanced Setup** lets you select the granted permissions individually with the RealmJoin PowerShell module. Choose it if your organization has special compliance needs or requires maximum control over granted permissions.

You can [switch from Quick Setup to Advanced Setup](https://docs.realmjoin.com/deployment/onboarding-realmjoin-portal/advanced-setup.md#switching-from-quick-setup) later; the switch is one-way. In both setup types, the RealmJoin Client app (required for the RealmJoin Agent) and the security features (Microsoft Defender for Endpoint) are activated separately on the [features page](https://portal.realmjoin.com/organization/features). See [Getting Started](https://docs.realmjoin.com/deployment/getting-started.md#decision-1-quick-setup-or-advanced-setup) for a side-by-side comparison.

<figure><img src="https://2868468309-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MkrcM7cKOpXKri1kVrh%2Fuploads%2FtVDr8WXDvcP0JfY9FdnN%2FSnipaste_2026-01-21_15-07-54.png?alt=media&amp;token=7b53c99e-fbb3-4f47-8660-83907cea8ae3" alt=""><figcaption></figcaption></figure>
{% endstep %}
{% endstepper %}

{% content-ref url="/pages/aM3XHiiAsUIHKzD2Lled" %}
[Advanced Setup](https://docs.realmjoin.com/deployment/onboarding-realmjoin-portal/advanced-setup.md)
{% endcontent-ref %}


---

# 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/onboarding-realmjoin-portal.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.
