# Install on Heroku

## 1. Use the 1-Click Deploy Button

[![Deploy to Heroku](https://img.shields.io/badge/-Deploy%20to%20Heroku-430098?style=for-the-badge\&logo=heroku\&logoColor=ffffff)](https://heroku.com/deploy?template=https://github.com/Squidex/squidex)

## 2. Fill in the details

Make sure that you fill in the **App name** (1) field with something unique, and then fill the **DOMAIN** (2) variable with the external domain you want your Squidex instance to be available on.

You can ignore *MONGO\_USERNAME* and *MONGO\_PASSWORD* for now.

![Fill Details](/files/-MdHzZ_ABBUYfQxPCHbB)

When you are done, click **Deploy App**.

## 3. Wait for the Deployment to Complete

![Deployment Started](/files/-MdHzZ_BfIe7FfqpI09P)

![Deployment Finished](/files/-MdHzZ_CFvIypUw5gCkI)

When it's finished, click **Manage app** (1).

## 4. Create MongoDB database and credentials

On the Dashboard, click **ObjectRocket for MongoDB** (1)**.**

![Open ObjectRocket Dashboard](/files/-MdHzZ_Dc4O591gSijGF)

On the ObjectRocket Dashboard, click **DATABASES** (1) and then **Add Database** (2).

![Open Databases](/files/-MdHzZ_EQnoKgMipUFvJ)

Enter the **database name** (1) (must be `squidex`), the **Username** and the **Password** (2). Keep note of those, as you will need them for the next step.

![Create Database](/files/-MdHzZ_FVh4ANuXwHZJw)

## 5. Fill In the Database Credentials

Back at the Heroku Dashboard, click **Settings** (1), then click **Reveal Config Vars** (2).

![Settings](/files/-MdHzZ_Gnhru1oVEpB6N)

Fill the fields `MONGO_PASSWORD` (1) and `MONGO_USERNAME` (2) with the same credentials you provided in the previous step.

![Config Vars](/files/-MdHzZ_Hk5rOauVaUn08)

You should then be ready to go!

## Troubleshooting

Please check the logs by clicking **More**, and then **View logs.**

![Logs](/files/-MdHzZ_IXUEpH_dunfh-)

### Restart Dynos

In case the deployment gets stuck, go to the top right of the dashboard, click **More** and then **Restart all dynos**.

### More issues?

For other issues, it is likely that you have a configuration problem not related to hosting under Heroku. Checkout the following documentation:

{% content-ref url="/pages/-LrLSGJjFug4kUmNpB9G" %}
[Configuration](/id-01-getting-started/installation/configuration.md)
{% endcontent-ref %}


---

# 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-heroku.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.