View source for HowTos:Install MDriven Server and Turnkey on Microsoft Azure

__NOTOC__<message>Write the content here to display this box</message>This tutorial will help you set up '''MDriven Turnkey on Microsoft Azure'''.

All the components needed to run MDriven Turnkey (the latest versions of MDriven Server & MDriven Turnkey) are available [https://mdriven.net/downloads here for MDrivenServer] and [https://mdriven.net/downloads here for MDrivenTurnkey] - you will need both.

You can run MDriven Turnkey on your Azure account or set it up on your local IIS. To set up on a local IIS, see [[Documentation:Installing MDriven Server on Windows|Installing MDriven Server on Windows.]]

=== Setting Up Azure ===
Go to '''https://portal.azure.com'''  and log in under your existing account or create a new one.

First, you need to create a '''new Web app''' to run your Turnkey and MDriven Server application.

Create two Azure apps, one to run the MDriven Server and one to run the MDriven Turnkey

To run both the MDriven Server and Turnkey in one Azure app continue below.
[[File:Create new Web app.png|none|thumb|528x528px|Create a new Web app on Azure]]Enter the name of your application and create or choose an existing App Services Plan.
[[File:Name your app and choose App Services Plan.png|none|thumb|533x533px|Name your app and choose App Services Plan]]

=== Pushing App Files To Azure ===
Now, we need to download the publish profile - go to "'''Overview'''" and press "'''Get publish profile'''".[[File:Get publish profile from Azure.png|none|thumb|690x690px|Get the publish profile from Azure]]

Azure provides many different methods to publish your application files including Zip Deploy, [[Documentation:Deploy Turnkey on your own Azure with OneDrive|One Drive]], Github, FTP and many more.

=== Installing MDriven Turnkey ===
Download the latest MDriven Turnkey from https://mdriven.net/downloads

Push the App Files to <code><span class="col-black">'''site\wwwroot'''</span></code> directory of your Azure App

=== Installing MDriven Server ===
Download the latest MDriven Server from https://mdriven.net/downloads

Push App Files to <code><span class="col-black">'''site\wwwroot'''</span></code> directory of your other created Azure App

=== Running the Turnkey and MDriven Server in one Azure App ===
To run the MDriven Server and Turnkey in one app

Upload the Turnkey app files to <code><span class="col-black">'''site\wwwroot'''</span></code> directory

Upload the MDriven Server app files to <code><span class="col-black">'''site\wwwroot\__MDrivenServer'''</span></code> directory

With the Azure App Panel  Goto Settings > Configuration > Path mappings

The MDriven Turnkey will run in the default directory <code><span class="col-black">'''site\wwwroot'''</span></code>

Create a new virtual application for running the MDriven Server

'''Virtual path:'''  /__MDrivenServer

'''Physical Path:''' site\wwwroot\__MDrivenServer

The MDriven Server will now be accessible at  <Your Azure App Domain>/__MDrivenServer/
[[File:azure-app-services-panel.png|none|thumb|794x794px]]

Don't forget to make sure the __MDrivenServer is of Type Application. Do not check any of the check list items
[[File:2024-12-04 21h09 19.png|none|thumb|808x808px]]

=== Setting up MDriven Server ===
Within the MDriven Server app files

Create a CommandLineOverride.xml  file in the location <code><span class="col-black">'''App_Data/CommandLineOverride.xml'''</span></code> specifying the location of MDriven Server. This a requirement of .NET Core applications using IIS.

Contents of CommandLineOverride.xml<syntaxhighlight lang="xml">
<root>
  <arg>iis=https://<Your Azure App domain>/__MDrivenServer</arg>
</root>
</syntaxhighlight>Reset the MDriven Server password for User Name: '''a''' using PwdReset file

Create a PwdReset.txt file with the new password in the location <code><span class="col-black">'''App_Data/PwdReset.txt'''</span></code>

Push updates to the Azure App and try to login to the MDriven Server with User Name: '''a'''  and new password.

Delete PwdReset.txt file after testing the new password.

Upload the model to the MDriven Server with new set credentials
[[File:mdriven-cloud-form.png|none|thumb|818x818px]]

=== Setting up MDriven Turnkey ===
Within the MDriven Turnkey app files

Create a CommandLineOverride.xml  file in the location <code><span class="col-black">'''App_Data/CommandLineOverride.xml'''</span></code> specifying the location of MDriven Turnkey. This a requirement of .NET Core applications using IIS.

Contents of CommandLineOverride.xml<syntaxhighlight lang="xml">
<root>
  <arg>iis=https://<Your Azure App domain></arg>
</root>
</syntaxhighlight>

==== Connection to the MDriven Server ====
Create a MDrivenServerOverride.xml file in the location <code><span class="col-black">'''App_Data/MDrivenServerOverride.xml'''</span></code> specifying the url of the MDriven Server that the Turnkey should connect to.

Contents of MDrivenServerOverride.xml<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<root>
  <MDrivenServerOverride MDrivenServerPWD="<Password for a user>">https://<Your Azure App Domain>/__MDrivenServer/</MDrivenServerOverride>
</root>
</syntaxhighlight>

==== Turnkey Settings ====
Create a TurnkeySettingsOverride.xml file in the location App_Data/TurnkeySetttingsOverride.xml

Check here from more Turnkey settings tags

Contents of TurnkeySettingsOverride.xml<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<root>
    <ShowDebugInfo>True</ShowDebugInfo>
</root>
</syntaxhighlight>After ensuring the Turnkey connects to the MDriven Server when you are able to access the Turnkey Application '''turnoff debug info''' by setting it to '''False'''.

=== Important To Know ===

* Turn on websockets for the Azure App as this is required for the MDriven Turnkey and Server to communicate properly.
[[File:2024-12-04 21h43 43.png|none|thumb|851x851px]]

When all these steps are done, we are ready to go to '''https://portal.mdriven.net'''

'''NOTE:''' It is best to do at least the first deploy with Portal (as described below) since you then get the strong password set and init files updated for your installation - but after initial setup, you can easily deploy new code for Turnkey + server via OneDrive as described here: [[Documentation:Deploy Turnkey on your own Azure with OneDrive|Deploy_Turnkey_on_your_own_Azure_with_OneDrive]]

== Setting Up on MDriven Portal ==
Open https://portal.mdriven.net and log in under your account.

Go to "'''Views"''' -> "'''Show my Turnkey Sites"''' and "'''Register a New Site"'''.

Name your application and upload the publish profile to MDriven Portal and press "Create Turnkey Site" and "Save".

Now, go back to "Show my Turnkey Sites" where you can see that your new site is registered, but not deployed. Click on it and choose "Manage Turnkey Site".
[[File:Manage your Site page.png|none|thumb|694x694px|Manage your site from MDriven Portal]]
On the "Manage" page, you can request a deploy of your website. To request deploy, you need to press the "Request Deploy" button and save it. Deploy takes no more than 5 minutes. When the status of your site changes to "Deployed", press "Send Settings and Restart" and save.

After these steps, you can revisit your site and see your Turnkey application.
[[File:First look of Turnkey app.png|none|thumb|696x696px|First look at the Turnkey app]]
'''NOTE!''' Each Turnkey app must have an Index ViewModel.  

You can go back to https://portal.mdriven.net/ and open MDriven Designer to start modeling.

'''<span style="color: #1a50ad">The MDriven Book</span>''' - '''Next Chapter:''' [[Training:Set up MDriven Turnkey on premise|Set up MDriven Turnkey on premise]]

== Video Tutorial ==

<html>

<p class="video-warn">
  To make your experience smooth, we set the main tags mentioned in the video to the right bar menu of this mini-player. Choose an interesting subtitle on the list and immediately get to the exact theme navigation item place in the video. Now you can pick any topic to be instructed on without watching the whole video.
</p>

<div class="video">
  <div class="video__wrapper">
    <iframe src="https://www.youtube.com/embed/mVVCsM09vXE?rel=0&autoplay=0" frameborder="0" allowfullscreen></iframe>
  </div>
  <div class="video__navigation">
    <span class="navigation-item" data-video="mVVCsM09vXE" data-start="0" tabindex="0"> Setting up MDriven Turnkey on Microsoft Azure </span>
    <span class="navigation-item" data-video="mVVCsM09vXE" data-start="33" tabindex="0"> Setting up on Microsoft Azure </span>
    <span class="navigation-item" data-video="mVVCsM09vXE" data-start="287" tabindex="0"> Setting up on MDriven Portal </span>
  </div>
</div>

</html>

{{Edited|July|12|2025}}


[[Category:Beginner-Friendly]]
[[Category:Deploying on Microsoft Azure]]
[[Category:Deployment]]
[[Category:Priority 20]]

[[Category:HowTos]]

[[Category:Installation and Deployment]]