# Install on Azure using ARM

This version of the installation tutorial deploys Squidex along with MongoDB (for datastore) and Caddy (for reverse proxy along with SSL) as a [Container Group](https://learn.microsoft.com/en-us/azure/container-instances/container-instances-container-groups) in Azure using an [Azure Resource Manager or ARM](https://learn.microsoft.com/en-us/azure/azure-resource-manager/templates/overview) template. The approach is called *Infrastructure as Code*.

The tutorial does not cover the basics of Azure. You should be familiar with them before you begin with the installation instructions.

This tutorial runs MongoDB as a single container and is recommended for non-production or trial environments. For production environments, it is best to use one of the MongoDB Atlas (or Enterprise) offerings from [Azure marketplace](https://azuremarketplace.microsoft.com/en-us/marketplace/apps?search=mongodb\&page=1), which provides capabilities such as High Availability.

Use this tutorial as a getting started guide in Azure to explore Squidex and use it as a Dev/Sandbox environment. This setup may not be recommended for a production environment.

## Prerequisites

Before you begin, ensure you meet the following requirements:

1. An active Azure subscription.
2. The following providers registered in your Azure subscription:
   * Microsoft.ContainerInstance
   * Microsoft.Storage

## Deployment Specifications & Other Details

The ARM template creates the following Azure resources:

* An Azure Storage Account
  * Azure Container
  * Azure Share
* Azure Container Instances (Group)
  * Squidex Web App Container (latest image)
  * MongoDB Container (latest image)
  * Caddy container (latest image)

**Important Details**

* Default resource allocations
  * Squidex container: **1 vCPU and 1.5 GiB memory**
  * MongoDB container: **2 vCPU and 2 GiB memory**
  * Caddy container: **1 vCPU and 1.5 GiB memory**
* Squidex and MongoDB containers remain private and are not exposed to public.
* Squidex talks to MongoDB without authentication (mongodb://localhost:27017). Since MongoDB is private it cannot be accessed from outside, hence secure to an extent. **With the current setup you cannot connect using an external client like MongoDB Compass. You can however connect from Azure Container Instance, click** [**here**](#connecting-to-mongodb-instance) **for instructions**
* Caddy reverse proxies to the Squidex Web App container.
* An FQDN is provided by Azure Container Instance, *Caddy* provides SSL for this as the FQDN does not come with SSL. This FQDN is set as the `URLS__BASEURL` and `VIRTUAL_HOST` for Squidex configuration.

{% hint style="info" %}
NOTE: If you wish to modify any of the variables such as vCPU, Memory etc., you can do so by editing the ARM template. Click \[here]\(#modifying-arm-variables) for basic instructions.
{% endhint %}

## 1. Launch the ARM Template

Simply click **Deploy to Azure** button to load the template in Azure Portal, fill in a few details (instructions below) and deploy Squidex.

[![Deploy To Azure](https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/1-CONTRIBUTION-GUIDE/images/deploytoazure.svg?sanitize=true)](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2Fsangramrath%2Fsquidex-docs2%2Fmaster%2Fscripts%2Fsquidex-minimal-azure-arm.json)

## 2. Configure Details

On the Custom deployment page complete the following steps to submit the deployment.

1. Select your **Subscription** from the list.
2. Select an existing **Resource group** or click **Create new** to create a new Resource group.
   * If creating a new Resource group, enter a name and click Ok.
3. Select your preferred **Region** from the list.
4. Enter a name for the Container Group in **Container Name** field. (It uses the Resource Group name by default but you are free to change it)
5. If you wish to provide your own Domain/Sub-domain (e.g. example.com or squidex.example.com) enter it in the **Squidex Domain** field, otherwise leave it blank.
6. Click **Review + create**.

![Deploy ARM Template](https://2730255609-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LrL94QfeasZ0wF6YAvB%2Fuploads%2Fgit-blob-ebc2a07bf1a6cf0ea21c335bff756aa8a82f9282%2Fsquidex-arm-01.png?alt=media)

1. Ensure that the *validation* is successful.
2. Click **Create** to submit the deployment.

![Review ARM Template](https://2730255609-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LrL94QfeasZ0wF6YAvB%2Fuploads%2Fgit-blob-b85e2e6831eff2f03f29c8bb11c8f697b78ef27f%2Fsquidex-arm-02.png?alt=media)

The deployment process will take a few minutes. (Preferably do not navigate away from this page)

## 3. Access Squidex

1. Once the deployment is complete, Click **Outputs** in the deployment page to retrieve the URL.
2. Copy the URL.

![Deployment Complete](https://2730255609-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LrL94QfeasZ0wF6YAvB%2Fuploads%2Fgit-blob-889938b065365ee838931d66414cda52bf3d47a0%2Fsquidex-arm-03.png?alt=media)

Alternatively, you can also retrieve the FQDN anytime from the Azure Container Instances blade.

{% hint style="info" %}
NOTE: This is only for deployments where custom domain is NOT provided
{% endhint %}

![ACI FQDN](https://2730255609-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LrL94QfeasZ0wF6YAvB%2Fuploads%2Fgit-blob-b5e9e0140dfab9ca2f1da4341c0438ca9bf6f786%2Fsquidex-aci-fqdn-01.png?alt=media)

## 4. Update DNS Record (For Own Domain Deployments Only)

1. Navigate to Azure Container Instances page, click on the Container instance (i.e. squidex) to access the details.
2. Under Overview, to the right you should find the **IP Address (Public)** value, copy it.

![ACI PublicIP](https://2730255609-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LrL94QfeasZ0wF6YAvB%2Fuploads%2Fgit-blob-8c9fa4e131d5d9ed27b323af387874f2c0331c20%2Fsquidex-aci-pip-01.png?alt=media)

1. Now access your domain control panel, and create an **A Record** pointing your domain to this IP address.
2. Continue with the next steps once the DNS propagation is done, this will depend on your domain provider.

{% hint style="info" %}
NOTE: The SSL certificates are not generated (by Caddy) until the DNS resolution works
{% endhint %}

## 5. Completing Squidex Installation

1. Open the URL in a browser to load the *Squidex Installation Page*.

**It may take a few minutes before the certificates are generated and the URL starts working. For own domain scenarios this process may be even take longer**

1. Create the Admin User to complete the installation and login to Squidex.

## Azure Troubleshooting

#### Validation Failed

* Ensure all the fields have been populated.
* If you are rerunning the ARM template (either another installation or due to a previous failure) and using the same names, change them (or delete previously created resources).

#### Deployment failed

In the Microsoft template deployment window click *Deployment failed. Click here for more details* to view the error details and look for clues. This tutorial does not go into the details of Azure troubleshooting.

{% hint style="info" %}
NOTE: Use \_Redeploy\_ to resubmit the deployment again (after fixing errors). This continues the operation instead of creating a fresh deployment.
{% endhint %}

#### Containers in *waiting*, *failed* or *terminated* status.

* Restart the Azure Container Instance

![Deployment Complete](https://2730255609-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LrL94QfeasZ0wF6YAvB%2Fuploads%2Fgit-blob-8634d4d79ac31020ade81c732f83c3192a703702%2Fsquidex-aci-restart-01.png?alt=media)

## Squidex Issues

It is very likely a configuration problem and not related to Azure. Please visit the following page:

[Configuration](https://github.com/Squidex/squidex-docs2/blob/master/01-getting-started/installation/platforms/configuration.md)

## Connecting to MongoDB Instance

1. On the Azure Portal, navigate to **Container Instances** page
2. Click on your Container Instance (e.g. `squidex-crm`)
3. Select *Containers* from the left navigation menu
4. Select the MongoDB container (i.e. `etc-squidex-assets-mongodb`) by clicking on it
5. Select the **Connect** tab
6. Ensure */bin/bash* is selected
7. Click **Connect** again

![Connect to MongoDB ACI](https://2730255609-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LrL94QfeasZ0wF6YAvB%2Fuploads%2Fgit-blob-18c3d90af91c326f3c1e4384b2c2a66df38d0d35%2Fsquidex-mongodb-connect-aci-01.png?alt=media)

This will drop you into the Container Shell. Type `mongosh` to connect to MongoDB shell.

## Modifying ARM Variables

1. After clicking *Deploy to Azure* button, click **Edit template**.

![Edit Template](https://2730255609-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LrL94QfeasZ0wF6YAvB%2Fuploads%2Fgit-blob-12e12193a9dbc9a862deaddb2686e961e47fbaf6%2Fsquidex-edit-arm-template-01.png?alt=media)

1. Click **Variables** on left and this should show the variables section on the right.
2. You can now change any of the variables such as `mongoDBCPUCores` or `mongoDBMemory` etc.

![Modifying ARM Variables](https://2730255609-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LrL94QfeasZ0wF6YAvB%2Fuploads%2Fgit-blob-c9e214fd5775f5f950d863a8cef1e3cfa213d6bd%2Fsquidex-modify-arm-variables-01.png?alt=media)


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.squidex.io/id-01-getting-started/installation/platforms/install-on-azure-arm.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.