# Installation

This article covers two ways to install Umbraco Engage:

* [Via NuGet](#installation-via-nuget), or
* [Via a terminal](#installing-using-the-terminal).

{% hint style="info" %}
Check [the requirements](https://docs.umbraco.com/umbraco-engage/16.latest/installation/system-requirements) before you start installing Umbraco Engage.
{% endhint %}

## Installation via NuGet

Install Umbraco Engage via Nuget in your IDE such as Visual Studio, JetBrains Rider, or VSCode (With [C# DevKit](https://marketplace.visualstudio.com/items?itemName=ms-dotnettools.csdevkit)).

The example shown below uses the Nuget Package Manager in Visual Studio.

1. Open the project in Visual Studio.
2. Go to **Tools** -> **NuGet Package Manager** -> **Manage NuGet Packages for Solution**.
3. Navigate to the **Browse** tab.
4. Search for the **Umbraco.Engage** package.
5. Select the package.
6. Choose which project to install it into.
7. Install the package.

## Installing using the terminal

You can install Umbraco Engage using a terminal, like the Package Manager Console in Visual Studio. The steps for doing so are outlined below.

1. Open the project in Visual Studio.
2. Find and open the Package Manager Console from the Tools menu.
3. Type the following into the terminal:

```console
PM> install-package Umbraco.Engage
```

Alternatively, Umbraco Engage can be installed via the console on your operating machine.

1. Open a terminal window on your operating system.
2. Navigate to the folder containing your Umbraco website.
3. Install the Umbraco Engage Nuget package with the following command:

```console
dotnet add package Umbraco.Engage
```

{% hint style="info" %}
If you have any trouble, go to [Troubleshooting installs](https://docs.umbraco.com/umbraco-engage/16.latest/installation/troubleshooting-installs).
{% endhint %}

## Next steps

![Engage section in the Umbraco Backoffice.](https://43774924-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FuxcASSODULaA0VhgNyJU%2Fuploads%2Fgit-blob-c6468815a845390fa625e138aabf7a0188953e37%2Fimage%20\(4\)%20\(1\).png?alt=media)

When you have installed Umbraco Engage, build or restart your website, and the **Engage** section will appear in the backoffice, as shown above.

The next step is to [configure a license](https://docs.umbraco.com/umbraco-engage/16.latest/installation/licensing).

It is recommended to consider the information detailed in the section below, to get the best out of Umbraco Engage.

### Umbraco Forms

If you have installed **Umbraco Forms** as well and want to automatically track submissions of Umbraco Forms. Install the package [Umbraco.Engage.Forms](https://www.nuget.org/packages/Umbraco.Engage.Forms) via NuGet or using your preferred approach as above.

{% tabs %}
{% tab title="Visual Studio Package Manager" %}

```
PM> install package Umbraco.Engage.Forms
```

{% endtab %}

{% tab title="Console" %}

```console
dotnet add package Umbraco.Engage.Forms
```

{% endtab %}
{% endtabs %}

### Clientside tracking

To capture events that happen on the clientside (frontend) of your website, you need to add the [clientside tracking script](https://docs.umbraco.com/umbraco-engage/16.latest/developers/analytics/client-side-events-and-additional-javascript-files/additional-measurements-with-the-analytics-scripts). This is done by including the following snippet on all of your pages.

```html
<script src="/Assets/Umbraco.Engage/Scripts/umbracoEngage.analytics.js"></script>
```

{% hint style="info" %}
The following client-side tracking script loading types are currently not supported: "async" or "defer".
{% endhint %}

### Cockpit

The Cockpit is a tool to help with testing segments and diagnosing the data that Umbraco Engage collects. It can be viewed on the front end of your website, only if you are logged into Umbraco as well.

As of Umbraco Engage 16, the cockpit is automatically installed.

{% hint style="info" %}
Automatic injection can be disabled by setting ‘Engage:Cockpit:EnableInjection’ configuration to **false**.
{% endhint %}

Learn more [what the Cockpit is and how you can use](https://docs.umbraco.com/umbraco-engage/16.latest/getting-started/for-marketers-and-editors/cockpit) it.

### Optional Extras

Here are some optional extras you can do to improve your experience with Umbraco Engage.

* Add a [Google Analytics bridging script](https://docs.umbraco.com/umbraco-engage/16.latest/developers/analytics/client-side-events-and-additional-javascript-files/bridging-library-for-google-analytics) that automatically sends events that you send to Google Analytics, to Umbraco Engage as well.

```html
<script src="~/Assets/Umbraco.Engage/Scripts/umbracoEngage.analytics.ga4-bridge.min.js"></script>
```

* Add the [Google Analytics blocker detection script](https://docs.umbraco.com/umbraco-engage/16.latest/developers/analytics/client-side-events-and-additional-javascript-files/google-analytics-blocker-detection). This gives you insights in which page traffic Umbraco Engage will track, and Google Analytics will not track.

```html
<script src="/Assets/Umbraco.Engage/Scripts/umbracoEngage.analytics.blockerdetection.js"></script>
```

{% hint style="info" %}
The following Google Analytics bridging or blocker script loading types are currently not supported: "async" or "defer".
{% endhint %}

### Cookie consent

To change the default [Umbraco Engage cookie](https://docs.umbraco.com/umbraco-engage/16.latest/marketers-and-editors/introduction/the-umbraco-engage-cookie) behavior, see the [GDPR & EU regulation](https://docs.umbraco.com/umbraco-engage/16.latest/security-and-privacy/gdpr) article. Alternatively, check the [implementation using Cookiebot](https://docs.umbraco.com/umbraco-engage/16.latest/security-and-privacy/gdpr/how-to-become-gdpr-compliant-using-cookiebot), which can serve as a reference for other cookie consent providers.

{% hint style="warning" %}
If you [change the default cookie behavior](https://docs.umbraco.com/umbraco-engage/16.latest/developers/introduction/the-umbraco-engage-cookie) make sure to perform a **client side reload of the initial page after cookie consent**. If this is not done, visitor referrer and/or campaigns will not be tracked.
{% endhint %}

### Load balancing and CM / CD environments

Are you using a load-balanced setup or separate CM and CD environments? [Check our documentation about this topic](https://docs.umbraco.com/umbraco-engage/16.latest/getting-started/for-developers/loadbalancing-and-cm-cd-environments).

### The first run

When you visit your site locally for the first time, Umbraco Engage will begin tracking page views, visitors, etc. If you go to **Engage** -> **Analytics,** you won't see any data until the first reporting run. By default, reporting data will be generated at 04:00 AM automatically.

<figure><img src="https://43774924-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FuxcASSODULaA0VhgNyJU%2Fuploads%2Fgit-blob-0ad3e4f152a3007375fc0c27d2ec0c53892e2477%2Fimage%20(12).png?alt=media" alt=""><figcaption></figcaption></figure>

To generate reporting data manually on your local installation, go to **Umbraco -> Settings** -> **Engage** section -> **Configuration.** Scroll down to the **Reporting** section and click the red **Regenerate** button.

{% hint style="warning" %}
Use the **Regenerate** button only in non-production environments because it can cause temporary performance degradation.
{% endhint %}