Skip to content

Commit c9a1740

Browse files
Merge pull request mendix#10916 from mendix/kv-wsc-gMSA
WSC updates
2 parents f1a39b4 + c1883bb commit c9a1740

4 files changed

Lines changed: 56 additions & 10 deletions

File tree

content/en/docs/deployment/on-premises-design/ms-windows/_index.md

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ Before starting this how-to, make sure you have the following prerequisites:
4545

4646
* Suitable database servers are MariaDB, MS SQL Server, MySQL, Oracle Database and PostgreSQL. See [System Requirements](/refguide/system-requirements/#databases) for more information
4747

48-
* A local or domain user with the *“log on as a service”* local security policy set
48+
* A local user, domain user or group managed service account (gMSA) with the *“log on as a service”* local security policy set
4949

5050
## Installing the Mendix Service Console {#service-console}
5151

@@ -88,32 +88,36 @@ To deploy a Mendix app using the Mendix Service Console, follow these steps:
8888
* **Display name** – the description of the app which is visible as a tooltip for the app in the left bar of the Mendix Service Console or as a column in the list of Windows services
8989
* **Description** – a description of the application that will be visible in the Mendix Service Console
9090
* **Startup type** – select whether you want the app to be started automatically when the server starts, started with a delay, started manually, or disabled altogether
91-
* **User name** and **Password** – the app will always run under the user account given here, and the service will be installed with this user account configured (for more information, see [Prerequisites](#Prerequisites))
91+
* **User name** and **Password** – the app will run under the user account given here, and the service will be installed with this user account configured (for more information, see [Prerequisites](#Prerequisites))
92+
* **Install service with LocalSystem account** – optionally, select the checkbox if you want to use a gMSA account for a Mendix app instead of the user account given under **User name** and **Password**.
93+
94+
4. Click **Next >**.
9295

93-
4. Click **Next >**.
96+
5. Optionally, if you selected the **Install service with LocalSystem account** checkbox while creating the app, install the service once your app is created. The service will be installed with the LocalSystem account. (You can verify the service account type in the Services app of Windows.) Execute the following command in the administrator command prompt to change the account type to your gMSA: `sc.exe config MyServiceName obj= "YOURDOMAIN\MyGMSAAccount$"`.
97+
Configure folder access permissions for gMSA account on the directory selected in the **Preferences** setting. For more information, refer to the [Installing the Mendix Service Console](/developerportal/deploy/deploy-mendix-on-microsoft-windows/#service-console) section above.
9498

95-
{{< figure src="/attachments/deployment/on-premises-design/ms-windows/18580728.png" >}}
99+
{{< figure src="/attachments/deployment/on-premises-design/ms-windows/gmsa.png" >}}
96100

97-
5. On the **Project Files** screen, click **Select app…**.
101+
6. On the **Project Files** screen, click **Select app…**.
98102

99103
{{< figure src="/attachments/deployment/on-premises-design/ms-windows/service_console_selectapp.png" >}}
100104

101-
6. Now select the **MDA** file that was [created in Mendix Studio Pro](/refguide/create-deployment-package-dialog/) and contains your application logic. After the installation of your MDA file, you will see which Mendix server (Mendix Runtime) version is needed.
105+
7. Now select the **MDA** file that was [created in Mendix Studio Pro](/refguide/create-deployment-package-dialog/) and contains your application logic. After the installation of your MDA file, you will see which Mendix server (Mendix Runtime) version is needed.
102106

103-
7. Configure the **Database Settings**:
107+
8. Configure the **Database Settings**:
104108

105109
* **Type** – the database server type
106110
* **Host** – the IP address or host name of the database server
107111
* **Name** – the database name
108112
* **User name** and **Password** – the database user name and password
109113

110-
8. Click **Next >**.
114+
9. Click **Next >**.
111115

112116
{{< figure src="/attachments/deployment/on-premises-design/ms-windows/18580726.png" >}}
113117

114-
9. On the **Common Configuration** screen, keep the default settings. These settings should only be changed if this is needed for your application setup.
118+
10. On the **Common Configuration** screen, keep the default settings. These settings should only be changed if this is needed for your application setup.
115119

116-
10. Click **Finish** and start the application.
120+
11. Click **Finish** and start the application.
117121

118122
## Configuring the Microsoft Internet Information Services Server{#configure-msiis}
119123

content/en/docs/deployment/on-premises-design/ms-windows/automate-mendix-deployment-on-microsoft-windows.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -180,6 +180,48 @@ $appName = 'Name of Mendix app'
180180
Install-MxService $appName
181181
```
182182

183+
### Sample Script - Set App Runtime Settings
184+
185+
The following script example demonstrates how to set runtime settings for your app. It applies custom runtime configuration settings to your application using a hashtable of key-value pairs.
186+
187+
```text
188+
$appName = 'Name of Mendix app'
189+
$settings = @{
190+
'MaxJavaHeapSize' = '2048'
191+
'DatabaseHost' = 'localhost'
192+
}
193+
194+
# Set runtime settings
195+
Set-MxAppRuntimeSettings $appName -Settings $settings
196+
```
197+
198+
### Sample Script - Set App Constant
199+
200+
The following script example demonstrates how to set an application constant for your app. It updates a specific constant value in your Mendix app configuration.
201+
202+
```text
203+
$appName = '{Name of your app}'
204+
$constants = @{
205+
'constantName' = 'constantValue'
206+
'constantName2' = 'constantValue2'
207+
}
208+
209+
# Set application constant
210+
Set-MxAppConstants $appName -Constants $constants
211+
```
212+
213+
### Sample Script - Get Server Id
214+
215+
The `Start-MxApp` cmdlet automatically retrieves the Server ID (License ID) when starting a Mendix app. You can use this unique identifier for license tracking and application monitoring. The following script example demonstrates the process required to retrieve Server Id.
216+
217+
```text
218+
# Start the Mendix app and get Server ID
219+
$app = Start-MxApp "MyAppName" -NoService -SynchronizeDatabase
220+
221+
# Display the Server ID
222+
Write-Host "Server ID: $($app.ServerId)"
223+
```
224+
183225
## Troubleshooting
184226

185227
If you encounter any issues while automating Mendix deployment on Windows using cmdlets, use the following troubleshooting tips to help you solve them.
Binary file not shown.
16.5 KB
Loading

0 commit comments

Comments
 (0)