Deploying an App to Mendix Cloud

1 Introduction

This page describes how to deploy an app to Mendix Cloud.

The method for deploying an app to Mendix Cloud differs depending on whether you have a licensed app or a Free App:

• For a licensed app, there are several deployment options:
  • Manual deployment – Create a deployment package via Studio Pro or the Developer Portal, and then deploy the package to a node environment where you can run it. For details on how to do this, see Deploying a Licensed App, below. This is the simplest deployment method, especially if you are just getting started with Mendix.
  • Pipelines built with low code – If you want to automate your build and deployment process, you can use Pipelines in the Developer Portal to design and activate a pipeline with a set of configurable, low-code steps. The Pipelines feature makes it quick and easy for teams to automate their CI/CD process, without requiring any third-party tools or DevOps expertise.
  • Pipelines built with APIs – If you use Jenkins, GitLab, or another CI/CD tool, you can use Mendix APIs to automate your build and deployment process. For details, see Implement a Simple CI/CD Pipeline with Mendix APIs. This method is highly customizable but does require CI/CD tooling and DevOps expertise to set up.
• For a Free App, you deploy the app directly from Studio Pro. For details on how to do this, see Deploying a Free App, below.

2 Deploying a Licensed App

Deploying a licensed app is usually a two-step process: First, create a deployment package. Second, deploy it to a node environment where you can run your app. The full process is described in detail below.

2.1 Prerequisites

Before starting the process of deploying a licensed app, make sure to complete these prerequisites:

• Your app is linked to a licensed cloud node
• You have transport rights
• Your two-factor authentication is set up
• The deployment package for your app is not bigger than 1 GB (uncompressed)

2.2 Creating a Deployment Package for a Licensed App

There are two methods for creating a deployment package on Mendix Cloud. You can create it directly via Studio Pro, or through the Developer Portal, using a model committed to the Team Server.

2.2.1 Creating a Deployment Package via Studio Pro

To create a deployment package via Studio Pro, follow these steps:

1. Open the licensed app in Studio Pro.
2. In the top menu bar, click App > Create Deployment Package.

2.2.2 Creating a Deployment Package via the Developer Portal

You can also create a deployment package through the Developer Portal, using a model committed to the Team Server. To do this, follow these steps:

1. Go to the Developer Portal.
2. Open your app’s Environments page.
3. Click Create Deployment Package.
4. Select your desired branch and revision and click Next.
5. Give the build a version number and click Build this revision.

2.3 Deploying the App to an Environment

The previous steps explained how to deploy a deployment package to Mendix Cloud, but the app based on the deployment package is not running yet. To deploy a deployment package to a node environment where you can run the app, follow these steps:

1. Go to the Developer Portal.

2. Open your app’s Environments page.

3. In the Deployment Package Repository, choose your preferred deployment package and click Deploy ().

   

4. Select the environment to which you want to deploy the package.

5. Click Transport.

   

6. If prompted, clean the environment.

7. Review the constants in the Constants tab. Double-click any constant to view more details and edit the value if desired.

8. Configure any scheduled events using the Scheduled Events tab.

9. Click Continue.

10. Click Start application.

11. If prompted, click Synchronize database.

The app is now deployed. You can configure the administrative account.

3 Deploying a Free App

Deploying a Free App is a single-stage process that is completed from Studio Pro. This process is described in detail below.

3.1 Prerequisites

Before starting the process of deploying a Free App, make sure to complete these prerequisites:

• You have created an app
• As with licensed apps, the uncompressed size of the deployment package must not exceed 1 GB

3.2 Deploying the App

With a Free App, you can deploy your app to Mendix Cloud from Studio Pro by using one of the following methods:

• In the top bar of Studio Pro, click Run > Publish. This automatically deploys your app to a Free App environment.

  

• Alternatively, in the top bar of Studio Pro, click Publish.

  

4 Deployment Status and Troubleshooting

The Mendix Platform Status page shows the current status of Mendix services. If you have issues with deployment, you can check the status page to see if deployment is operational (under Mendix Services) or if there are other Mendix issues that may be affecting your deployment. For more information, see Mendix Cloud Status.