# Set up Embed

Get your installation ready to show the embed: a website, a partner key, what customers get, and your look.

## You need

- **An Embed license**: Loaded on your installation. Licenses come from GoRunner. See [Your license](https://docs.gorunner.io/self-host/license).
- **An instance-wide platform admin**: With two-factor on. Changes on these pages ask for your two-factor code. One code covers 10 minutes.
- **One https address**: Your installation’s `PUBLIC_URL`, on https, with sign-in on. A page on https can’t show anything from an http address. Behind a proxy or ingress, see [For Embed](https://docs.gorunner.io/self-host/own-proxy#embed).

With the license loaded, the Platform sidebar gains an **Embed** group: **Partner keys**, **What customers get**, **Branding** and **Notifications**.

## Check what is missing

Open **Platform › Partner keys**. Until the embed can show anywhere, a line at the top says what is missing.

![Platform › Partner keys on a new installation: Two things before your app can show the embed: a website and a key.](https://docs.gorunner.io/img/embed/readiness-light.jpg)

## Allow your app’s website

1. Under **Allowed websites**, in **Add a website**, type your app’s address, such as `https://app.example.com`.
2. Press **Add** and enter your two-factor code.

You should see “Allowed https://app.example.com. Pages there can show the embed now.”

- **The address**: The scheme, the host and the port, exactly as the browser shows them, with no path. `http://localhost:3000` and `http://127.0.0.1:3000` are two websites. Plain `http` works only for `localhost`, `127.0.0.1` and `[::1]`.
- **A wildcard**: `https://*.example.com` covers subdomains at any depth, never `https://example.com` itself. A wildcard over a shared domain, such as `*.vercel.app`, is refused.
- **How many**: Up to 200.

Your server can keep this list too, with its key: [Allow a website](https://docs.gorunner.io/embed/api/websites/add-website) and [Stop allowing a website](https://docs.gorunner.io/embed/api/websites/remove-website).

**What if customers open my app on domains of their own?**

Your server allows each customer’s website for that customer only, with [Allow a website for one account](https://docs.gorunner.io/embed/api/websites/add-account-website). Each is an exact address, up to 20 a customer, and shows only that customer’s sessions. Removing one ends their sessions on it at once, unless your own list still allows it.

They show read-only under **Added by your server for customers**.

## Make a partner key

Your server signs customers in with it.

1. Under **Keys**, press **Make a key…**.
2. Name it after where it is used, such as `Production backend`.
3. Under **Allowed from**, list your servers’ IP addresses or ranges, one per line. Leave it empty while you test: then any address may use it.
4. Press **Make the key** and enter your two-factor code.
5. Press **Copy the key**, store it in your server’s secrets, then press **Done**.

![Platform › Partner keys: the key Production backend, then Allowed websites, with Make a key… ringed.](https://docs.gorunner.io/img/embed/partner-keys-light.jpg)

> **Warning** You see the key once. If it wasn’t copied, revoke it and make another.

**What if Make a key… can’t be pressed?**

An installation has at most 20 working keys: “20 keys is the most. Revoke one first.” Revoked and ended keys stay listed under **Revoked keys**.

## Choose what customers get

1. Open **Platform › What customers get**.
2. Press a row, such as **Pages**. Its editor opens beside the table.
3. Turn switches on or off, then save with your two-factor code.

![Platform › What customers get: Pages 6 of 8 on, Building 11 of 12, Runs 2 of 3, Connections 1 of 1, Developers 0 of 4, Apps Every app, Keel for customers Off.](https://docs.gorunner.io/img/embed/customers-light.jpg)

The defaults are a safe start. **Overview**, **Import and export**, **Delete runs** and the **Developers** switches start off. See [Switches](https://docs.gorunner.io/embed/switches). **Apps** narrows the apps customers may use, and **Keel for customers** gives them [the assistant](https://docs.gorunner.io/embed/the-assistant).

## Set the look

1. Open **Platform › Branding** and pick a preset under **Look**: **Paper**, **Soft** or **Crisp**.
2. Under **Names**, enter your **Product name** and **Company name**.
3. Add your logo and colors, and check the preview’s **Embed** tab.
4. Press **Save**. Nothing changes for anyone until you do.

For every setting, see [Appearance and branding](https://docs.gorunner.io/embed/appearance).

## Hand over to your developer

- **The address**: Your installation’s, such as `https://automations.example.com`.
- **The key**: Through your password manager, never in a chat or an email.
- **The code**: [Quick start](https://docs.gorunner.io/embed/quick-start). **Add the embed to your app**, on Partner keys, shows the same two pieces of code with your addresses filled in.

## See it as a customer

Once your server has signed someone in, use **Preview as a customer** on Partner keys.

1. Pick the **Customer** and a **Person**.
2. Choose a **Role** no higher than the person’s own. It starts at **Viewer**, which can only look.
3. Optionally, turn things off under **Switch off for this preview**.
4. Press **Preview as a customer…** and enter your two-factor code.

![Preview as a customer: Customer, Person, Role and Switch off for this preview, with Preview as a customer… ringed.](https://docs.gorunner.io/img/embed/preview-light.jpg)

**Is a preview real?**

Yes. It is a real session in the customer’s account. As an **Operator** or **Editor**, what you change is real, and the account’s audit log records it as yours.

It lasts while its page is open, and ends with **End preview** or when you leave. After your code’s 10 minutes, a renewal asks for the code again; closing that prompt ends the preview.

It lists only people your server has already signed in.

## Related

- [Quick start](https://docs.gorunner.io/embed/quick-start): Your server’s code and the embed in a page · 15 min
- [Platform screens](https://docs.gorunner.io/embed/platform-screens): Every part of these four pages
- [Security](https://docs.gorunner.io/embed/security): Keys, websites and incidents

Source: https://docs.gorunner.io/embed/set-up