Installing MDriven Server and Turnkey on Microsoft Azure
    No edit summary
    No edit summary
     
    (48 intermediate revisions by 7 users not shown)
    Line 1: Line 1:
    __NOTOC__
    __NOTOC__<message>Write the content here to display this box</message>This tutorial will help you set up '''MDriven Turnkey on Microsoft Azure'''.
    == Introduction ==
    All the components needed to run MDriven Turnkey is available from the [[download]] page.


    You can run MDriven Turnkey on your Azure account or set it up on you local IIS. To setup on a local IIS, see [[Installing MDriven Server]]
    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.


    Here's a video explaining the setup process below:  
    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.]]


    <html>
    === Setting Up Azure ===
    <h5>  
    Go to '''https://portal.azure.com'''  and log in under your existing account or create a new one.
    An introduction to MDriven Designer is a UML modelling tool that allows you to capture enough details to actually cover every aspect of a software system. It makes you model the full specification of what you want to explain.
     
    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.


      The MDriven designer overview sessions were created to provide the answers to all the questions that you might have during the operation process of our service. This step-by-step guide will assist you in MDriven designer effective application. 
    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>


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


    <p class="warn">
    Check here from more Turnkey settings tags
    <em>To make your experience more comfortable, we set the main tags mentioned in the video to the right bar menu of this mini player. Choose the interesting subtitle on the list and immediately get to the exact theme timeplace in the video. Now you can pick any topic to be instructed without watching the whole video.</em>
    <style type="text/css">
    p.warn {
    opacity: 0.7;
    text-align: justify;
    width: 90%
    }
    </style>
    </p>
    <br>
    <div id="video12">
    <iframe width="740" height="500" src="https://www.youtube.com/embed/pL3tl0nDtrM?rel=0&autoplay=0" frameborder="0" allowfullscreen></iframe>
    </div>
    <script>
    var IMG = document.querySelectorAll('#video12 span'),
        IFRAME = document.querySelector('#video12 iframe');
    for (var i = 0; i < IMG.length; i++) {
      IMG[i].onclick = function() {
        IFRAME.src = 'https://www.youtube.com/embed/' + this.dataset.video + '?rel=0&autoplay=1';
        if(this.dataset.end) IFRAME.src = IFRAME.src.replace(/([\s\S]*)/g, '$1&end=' + this.dataset.end);
        if(this.dataset.start) IFRAME.src = IFRAME.src.replace(/([\s\S]*)/g, '$1&start=' + this.dataset.start);
        this.style.backgroundColor='rgba(0,0,0,.2)';
      }
    }
    </script>
    </html>


    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'''.


    === First ===
    === Important To Know ===
    1. Create your site “YourSite” as webapplication


    2. Create another webapplication under “YourSite” called “__MDrivenServer” (double underscore) so that it ends up like this: “YourSite/__MDrivenServer”
    * 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]]


    3. In “YourSite/__MDrivenServer” you install the MDriven Server zip from the download page
    When all these steps are done, we are ready to go to '''https://portal.mdriven.net'''


    4. In “YourSite” you install the MDriven Turnkey zip from the download page
    '''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]]


    That is all as far installation requirements – the rest is configuration
    == Setting Up on MDriven Portal ==
    Open https://portal.mdriven.net and log in under your account.


    === Second ===
    Go to "'''Views"''' -> "'''Show my Turnkey Sites"''' and "'''Register a New Site"'''.
    1. Make sure your MDrivenServer works


    2. Set up the YourSite/App_Data/TurnkeySettings.xml by looking in the one already there called “TurnkeySettings – NotInEffect.xml”
    Name your application and upload the publish profile to MDriven Portal and press "Create Turnkey Site" and "Save".


    3. You can now use your “a” account and pwd from MDrivenDesigner cloud dialog to upload a model to the MDrivenServer
    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.


    4. After this you can run the prototyper against MDrivenServer
    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. 


    === Third ===
    You can go back to https://portal.mdriven.net/ and open MDriven Designer to start modeling.
    1. You need a ViewModel named Index and one named About, If you have those you should see them showing up as index page and as https://<yoursite>/MDriven/About


    2. You may however want to override these with your own styled static pages. Create Index.cshtml and About.cshtml in <YourSite>\Views\EXT_OverridePages\ The file content can make use of the data in your ViewModels if needed – if so these pages are strictly MVC5 and not AngularJS
    '''<span style="color: #1a50ad">The MDriven Book</span>''' - '''Next Chapter:''' [[Training:Set up MDriven Turnkey on premise|Set up MDriven Turnkey on premise]]


    3. Other ViewModels you add will be defaulted to AngularJS. If you instead want MVC5 for a specific page you set a tagged value on the ViewModel : “MVC=True”
    == Video Tutorial ==


    === Fourth ===
    <html>
    1. You can now run the ”YourApp” as AngularJS app


    2. You can run the WPF-Fat-client against the “YourSite” url
    <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>


    3. You can now make model updates and evolve your system from MDrivenDesigner
    </html>


    {{Edited|July|12|2025}}
    [[Category:MDriven Turnkey]]
    [[Category:MDriven Turnkey]]
    [[Category:Installation]]
    [[Category:Installation]]
    [[Category:Tutorial]]
    [[Category:Tutorial]]

    Latest revision as of 05:07, 20 February 2025

    This page was created by Lars.olofsson@mdriven.net on 2017-01-20. Last edited by Stephanie@mdriven.net on 2025-02-20.

    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 here for MDrivenServer and 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 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.

    Create a new Web app on Azure

    Enter the name of your application and create or choose an existing App Services Plan.

    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".

    Get the publish profile from Azure

    Azure provides many different methods to publish your application files including Zip Deploy, 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 site\wwwroot directory of your Azure App

    Installing MDriven Server

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

    Push App Files to site\wwwroot 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 site\wwwroot directory

    Upload the MDriven Server app files to site\wwwroot\__MDrivenServer directory

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

    The MDriven Turnkey will run in the default directory site\wwwroot

    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/

    azure-app-services-panel.png

    Don't forget to make sure the __MDrivenServer is of Type Application. Do not check any of the check list items

    2024-12-04 21h09 19.png

    Setting up MDriven Server

    Within the MDriven Server app files

    Create a CommandLineOverride.xml file in the location App_Data/CommandLineOverride.xml specifying the location of MDriven Server. This a requirement of .NET Core applications using IIS.

    Contents of CommandLineOverride.xml

    <root>
  <arg>iis=https://<Your Azure App domain>/__MDrivenServer</arg>
</root>

    Reset the MDriven Server password for User Name: a using PwdReset file

    Create a PwdReset.txt file with the new password in the location App_Data/PwdReset.txt

    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

    mdriven-cloud-form.png

    Setting up MDriven Turnkey

    Within the MDriven Turnkey app files

    Create a CommandLineOverride.xml file in the location App_Data/CommandLineOverride.xml specifying the location of MDriven Turnkey. This a requirement of .NET Core applications using IIS.

    Contents of CommandLineOverride.xml

    <root>
  <arg>iis=https://<Your Azure App domain></arg>
</root>

    Connection to the MDriven Server

    Create a MDrivenServerOverride.xml file in the location App_Data/MDrivenServerOverride.xml specifying the url of the MDriven Server that the Turnkey should connect to.

    Contents of MDrivenServerOverride.xml

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

    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

    <?xml version="1.0" encoding="utf-8"?>
<root>
    <ShowDebugInfo>True</ShowDebugInfo>
</root>

    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.
    2024-12-04 21h43 43.png

    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: 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".

    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.

    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.

    The MDriven Book - Next Chapter: Set up MDriven Turnkey on premise

    Video Tutorial

    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.

    Setting up MDriven Turnkey on Microsoft Azure Setting up on Microsoft Azure Setting up on MDriven Portal

    Retrieved from "https://learn.mdriven.net/index.php?title=Documentation:Installing_MDriven_Server_and_Turnkey_on_Microsoft_Azure&oldid=26513"

    © MDRIVEN . All Rights Reserved

    API Docs
    MDriven World | Portal | Blog | YouTube | StackOverflow | Facebook

    © MDRIVEN . All Rights Reserved