Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 0 additions & 26 deletions content/en/docs/deployment/docker-deploy/_index.md

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ You will need to add the license credentials and configure the license in the Me

### Cloud Foundry{#cloudfoundry}

The following steps describe activating the license for deployments using the Cloud Foundry Buildpack. If you are deploying using Portable App Distribution, follow the steps in the [Portable App Distribution](#portableappdistribution) section below.
The following steps describe activating the license for deployments using the Cloud Foundry Buildpack. If you are deploying using Mendix Portable Runtime, follow the steps in the [Mendix Portable Runtime](#portableappdistribution) section below.

To activate a license on your app running on Cloud Foundry, you need the license credentials provided by Mendix Support.

Expand All @@ -124,7 +124,7 @@ Then restart the app so that the environment variables are read, and the license

### Docker

The following steps describe activating the license for deployments using the Docker Buildpack. If you are deploying using Portable App Distribution, follow the steps in the [Portable App Distribution](#portableappdistribution) section below.
The following steps describe activating the license for deployments using the Docker Buildpack. If you are deploying using Mendix Portable Runtime, follow the steps in the [Mendix Portable Runtime](#portableappdistribution) section below.

To activate a license on your app running in a Docker container, you need the license credentials provided by Mendix Support.

Expand Down Expand Up @@ -156,7 +156,7 @@ For full instructions on how to do this, see [Activate a Mendix License on Micro

### Unix-Like Server

The following steps describe activating the license for deployments using the M2EE tool. If you are deploying using Portable App Distribution, follow the steps in the [Portable App Distribution](#portableappdistribution) section below.
The following steps describe activating the license for deployments using the M2EE tool. If you are deploying using Mendix Portable Runtime, follow the steps in the [Mendix Portable Runtime](#portableappdistribution) section below.

To license a Mendix app on Linux or another Unix-like operating system, follow these steps:

Expand All @@ -167,9 +167,9 @@ To license a Mendix app on Linux or another Unix-like operating system, follow t

For more instructions on how to do this, see [Linux Deployment](/developerportal/deploy/linux/).

### Portable App Distribution{#portableappdistribution}
### Mendix Portable Runtime{#portableappdistribution}

To activate the license for a Mendix app using Portable App Distribution on Docker, Cloud Foundry, or Unix-like servers, follow these steps:
To activate the license for a Mendix app using Mendix Portable Runtime on Docker, Cloud Foundry, or Unix-like servers, follow these steps:

1. Open the `$ConfigName.conf` in `etc/configurations`.
2. Add the `LicenseID` and `LicenseKey` to your runtime configuration:
Expand Down
16 changes: 16 additions & 0 deletions content/en/docs/deployment/on-premises-design/buildpacks/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
title: "Buildpacks"
url: /developerportal/deploy/buildpacks/
weight: 60
description: "Describes how to deploy your Mendix app to a Docker environment."
no_list: false
description_list: true
aliases:
- /developerportal/deploy/docker/
---

## Introduction

This section describes how to deploy your Mendix app with a buildpack. This is an optional deployment mechanism offered for customers who require this option. For the standard Mendix deployment mechanism, see [Mendix Portable Runtime](/developerportal/deploy/portable-app-distribution-deploy/).

## Documents in This Section
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ aliases:
## Introduction

{{% alert color="warning" %}}
Cloud Foundry buildpack deployment from Studio Pro is deprecated in version 10 and removed in version 11. Consider using the [Portable App Distribution for Cloud Foundry](/developerportal/deploy/cloud-foundry-pad/) option instead.
Cloud Foundry buildpack deployment from Studio Pro is deprecated in version 10 and removed in version 11. Consider using the [Mendix Portable Runtime for Cloud Foundry](/developerportal/deploy/cloud-foundry-pad/) option instead.

The following documentation is provided for reference purposes only.
{{% /alert %}}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Docker Buildpack"
url: /developerportal/deploy/docker-deploy/
weight: 60
weight: 20
description: "Describes how to deploy using a Docker image using a Docker Buildpack."
#If moving or renaming this doc file, implement a temporary redirect and let the respective team know they should update the URL in the product. See Mapping to Products for more details.
---
Expand Down

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ aliases:
- /developerportal/deploy/unix-like/
---

{{% alert color="warning" %}} Linux deployment is only supported on Debian 10 (buster) for the [Mendix Runtime version 9, 10, and 11](/releasenotes/studio-pro/lts-mts/). We will not add support for any other versions of the Mendix Runtime. Consider using the [Portable App Distribution for Linux](/developerportal/deploy/linux-pad/) option instead. {{% /alert %}}
{{% alert color="warning" %}} Linux deployment is only supported on Debian 10 (buster) for the [Mendix Runtime version 9, 10, and 11](/releasenotes/studio-pro/lts-mts/). We will not add support for any other versions of the Mendix Runtime. Consider using the [Mendix Portable Runtime for Linux](/developerportal/deploy/linux-pad/) option instead. {{% /alert %}}

## Introduction

Expand Down
Original file line number Diff line number Diff line change
@@ -1,49 +1,46 @@
---
title: "Portable App Distribution"
title: "Mendix Portable Runtime"
url: /developerportal/deploy/portable-app-distribution-deploy/
weight: 15
description: "Describes the Portable App Distribution deployment method for Mendix apps."
description: "Describes the Mendix Portable Runtime deployment method for Mendix apps."
no_list: false
description_list: true
beta: true
---

{{% alert color="warning" %}} This feature is in beta. For more information, see [Release Status](/releasenotes/release-status/). {{% /alert %}}

## Introduction

Portable App Distribution provides a flexible and straightforward method for isolated server-based deployments. By enabling customers to generate a bundled artifact packaged as a .zip file and run it directly, Portable App Distribution simplifies the deployment process.
Mendix Portable Runtime (previously called Portable App Distribution) provides a flexible and straightforward method for isolated server-based deployments. By enabling customers to generate a bundled artifact packaged as a .zip file and run it directly, Mendix Portable Runtime simplifies the deployment process.

## Benefits

Portable App Distribution offers the following benefits:
Mendix Portable Runtime offers the following benefits:

* Simplified deployment - Portable apps eliminate complex installation procedures, making it easier and faster to get software up and running across different machines. This reduces setup time and potential configuration errors.
* Enhanced consistency - By bundling all dependencies, portable apps ensure a consistent operating environment for the application, regardless of the underlying system configuration.
* Improved mobility and flexibility - Teams can easily move applications between workstations, virtual machines, or even cloud instances without the need for reinstallation, fostering greater agility in project work.
* Reduced system impact - Portable apps often run in isolated environments, which can help prevent conflicts with other installed software and maintain system stability.
* Streamlined updates - Managing updates can be more straightforward, as new versions of a portable application can often be deployed by simply replacing the package.
* Layered configuration - Portable App Distribution supports defining base configurations that can be extended with environment-specific or deployment-type-specific entries (for example, distinct configurations for development, testing, or production environments).
* Layered configuration - Mendix Portable Runtime supports defining base configurations that can be extended with environment-specific or deployment-type-specific entries (for example, distinct configurations for development, testing, or production environments).

## Licensing

You can test Portable App Distribution on a [Free App](/developerportal/deploy/mendix-cloud-deploy/#free-app). For more information about Free Apps and their limitations, as well as licensing apps outside of the Mendix Cloud, see [Licensing Apps](/developerportal/deploy/licensing-apps-outside-mxcloud/).
You can test Mendix Portable Runtime on a [Free App](/developerportal/deploy/mendix-cloud-deploy/#free-app). For more information about Free Apps and their limitations, as well as licensing apps outside of the Mendix Cloud, see [Licensing Apps](/developerportal/deploy/licensing-apps-outside-mxcloud/).

To license a Mendix app on the Portable App Distribution, add it to your configuration. For more information, see [Obtaining a Mendix License](/developerportal/deploy/licensing-apps-outside-mxcloud/#get-license).
To license a Mendix app on the Mendix Portable Runtime, add it to your configuration. For more information, see [Obtaining a Mendix License](/developerportal/deploy/licensing-apps-outside-mxcloud/#get-license).

## Prerequisites

The Portable App Distribution functionality is available in Mendix Studio Pro versions 10.24.19 LTS, 11.9, 11.6.5 MTS, and above. The functionality will be enabled for more Studio Pro versions in future releases.
The Mendix Portable Runtime functionality is available in Mendix Studio Pro versions 10.24.19 LTS, 11.9, 11.6.5 MTS, and above. The functionality will be enabled for more Studio Pro versions in future releases.

You must also ensure that you have the supported version of [Java Runtime Environment](/refguide/system-requirements/#java).

## Creating a Portable App Distribution File
## Creating a Mendix Portable Runtime File

In most production environments, deployment packages are created by using the [Mx-Build](/refguide/mxbuild/) command-line tool. However, you can also [manually create a deployment package](/refguide/create-deployment-package-dialog/) if required, for example, for a local test deployment.

## Deploying Your App

After you create the Portable App Distribution file, deploy it to your environment.
After you create the Mendix Portable Runtime file, deploy it to your environment.

### Deploying Locally

Expand Down Expand Up @@ -72,8 +69,8 @@ On Linux, if the ZIP was extracted on Windows, the +x flag is not preserved. Win

For more information about deploying to a self-hosted environment, refer to the following topics:

* [Portable App Distribution for Docker](/developerportal/deploy/docker-deploy-pad/)
* [Portable App Distribution for Linux](/developerportal/deploy/linux-pad/)
* [Portable App Distribution for Cloud Foundry](/developerportal/deploy/cloud-foundry-pad/)
* [Mendix Portable Runtime for Docker](/developerportal/deploy/docker-deploy-pad/)
* [Mendix Portable Runtime for Linux](/developerportal/deploy/linux-pad/)
* [Mendix Portable Runtime for Cloud Foundry](/developerportal/deploy/cloud-foundry-pad/)

## Read More
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
title: "Portable App Distribution on Cloud Foundry"
title: "Reference Guide for Cloud Foundry Deployments"
url: /developerportal/deploy/cloud-foundry-pad/
weight: 20
description: "Describes how to deploy to a Cloud Foundry environment by using Portable App Distribution."
weight: 70
description: "Describes how to deploy to a Cloud Foundry environment by using Mendix Portable Runtime."
---

## Introduction
Expand All @@ -12,26 +12,26 @@ Cloud Foundry is a platform-as-a-service (PaaS) that automates the deployment, s
This documentation provides guidance on understanding Cloud Foundry on-premise deployments and serves as a helpful reference rather than official implementation support.

{{% alert color="info" %}}
Unlike the Cloud Foundry Buildpack deployment where Mendix provides full end-to-end tooling support, the Portable App Distribution approach only requires Java to run, with Mendix's support strictly limited to the Portable App Distribution package itself. All implementation, configuration, and deployment activities, including Cloud Foundry deployment, remain the sole responsibility of the customer.
Unlike the Cloud Foundry Buildpack deployment where Mendix provides full end-to-end tooling support, the Mendix Portable Runtime approach only requires Java to run, with Mendix's support strictly limited to the Mendix Portable Runtime package itself. All implementation, configuration, and deployment activities, including Cloud Foundry deployment, remain the sole responsibility of the customer.
For information about the scope of support, see [Support for Different Deployment Strategies](/support/deployment-strategy-support/).
{{% /alert %}}

## Prerequisites

To deploy your app to an on-premises Cloud Foundry configuration using [Portable App Distribution](/developerportal/deploy/portable-app-distribution-deploy/), ensure that you fulfill the following prerequisites:
To deploy your app to an on-premises Cloud Foundry configuration using [Mendix Portable Runtime](/developerportal/deploy/portable-app-distribution-deploy/), ensure that you fulfill the following prerequisites:

* You have access to the Cloud Foundry organization and space where the application is deployed.
* You have access to the database configuration from the database service.
* You have access to binding other required Cloud Foundry services.
* The Cloud Foundry CLI is installed.
* You have generated the [Portable App Distribution .zip file](/developerportal/deploy/portable-app-distribution-deploy/).
* You have generated the [Mendix Portable Runtime .zip file](/developerportal/deploy/portable-app-distribution-deploy/).

## Deploying an App with Portable App Distribution
## Deploying an App with Mendix Portable Runtime

To deploy your app to Cloud Foundry, perform the following steps:

1. Log in to Cloud Foundry, and then access the organization and space where the application is deployed.
2. Save the [Portable App Distribution .zip file](/developerportal/deploy/portable-app-distribution-deploy/) to an accessible location.
2. Save the [Mendix Portable Runtime .zip file](/developerportal/deploy/portable-app-distribution-deploy/) to an accessible location.
3. Create a *manifest.yml* file in the root directory of your app.

By default, the `cf push` command uses the *manifest.yml* file in the app directory. To specify a different location for the manifest, you must pass its local path to the `-f` flag when you run `cf push`.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Monitoring Tools in Docker"
url: /developerportal/deploy/docker-monitoring/
weight: 30
weight: 50
description: "Describes the available monitoring tools for Docker deployments of Mendix."
---

Expand Down
Loading
Loading