Documentation:LocalServers

LocalServers

This page was created by Hans.karlsen on 2020-12-15. Last edited by Wikiadmin on 2026-07-29.

You can use LocalServers in MDriven Designer to run an MDrivenServer Core and MDriven Turnkey Core pair on your Windows computer for local development and testing.

What LocalServers creates

A LocalServer pair is one local installation containing two processes:

Component	Role	Local folder
MDrivenServer	The backend server. It holds the uploaded model, maintains database evolution, and runs server-side jobs.	`MDrServer`
MDriven Turnkey	The frontend server. It serves the user interface and REST services, and connects to MDrivenServer for the model and data.	`MDrTurnkey`

For example, if you create a pair named Server1, its installation contains separate MDrServer and MDrTurnkey folders. Start the pair to run both servers, upload your current model to MDrivenServer, then open Turnkey to use the application.

LocalServers runs the Core editions locally. It is different from a hosted deployment; for Linux deployment, see HowTos:Get Started with WSL (Windows Subsystem for Linux).

Create and run a local server pair

Use this workflow when you want a local MDrivenServer-backed application rather than a prototype.

In MDriven Designer, open the Cloud-connection dialog from the toolbar.
Open the Local Servers tab.
Download the latest local-server packages.
Select Add a server-pair and give the pair a meaningful name, such as Server1.
Select the new pair and refresh or install it. MDriven Designer expands the downloaded server packages into the pair folder.
Select Start Servers. Two command windows should open: one for MDrivenServer and one for MDriven Turnkey.
Open the Active MDriven Server tab.
Enter the address for the MDrivenServer in the pair. For example, if the pair uses port 5000, enter http://localhost:5000.
Enter the default local credentials: user a and password 123456.
Select Check Server status. Before you upload a model, the server can report that it has never started or has no current version.
Return to Local Servers, select the running pair, and select Use Above MDrivenServer. This makes that MDrivenServer the active server in MDriven Designer.
Select Upload model to upload the current model and let MDrivenServer create or evolve its database.
Select Check Server Status again. If the first check occurs while upload processing is still running, wait and check again.
Select Update ServerSide jobs when your model uses server-side jobs.

You can open the MDrivenServer web UI in a browser at the configured local address, for example http://localhost:5000, and sign in with a / 123456.

Important: The default credentials are intended for local development. Do not treat them as production credentials.

Files and folders

MDriven Designer downloads the two Core packages and creates a separate folder for each server pair.

Current local storage location

Local-server files and settings were moved to avoid OneDrive synchronization. The local-server root is:

C:\Users\<username>\AppData\Local\MDrivenServers\

For a pair called Server1, the MDrivenServer application data folder is:

C:\Users\<username>\AppData\Local\MDrivenServers\Server1\MDrServer\App_Data

Migrating an existing local server

If your previous LocalServers installation was stored under OneDrive Documents, the pair may no longer appear after the folder move. Downloading and creating the pair again is the preferred recovery method.

If you need to preserve the MDrivenServer state and settings, copy the old local database into the new pair's App_Data folder.

Previous location example	New location example
`C:\Users\<USER>\OneDrive\Dokument\MDrivenServers\Server1\MDrServer\App_Data\DatabaseVistaDB.vdb6` or `C:\Users\<USER>\OneDrive\Dokument\MDrivenServers\Server1\MDrServer\App_Data\DatabaseCompact.sdf`	`C:\Users\<USER>\AppData\Local\MDrivenServers\Server1\MDrServer\App_Data`

Copy the database while the relevant local server is stopped so that you copy a consistent file.

How Turnkey finds MDrivenServer

Turnkey needs an MDrivenServer address to obtain the model and data. The pair configuration is stored in:

MDrTurnkey\App_Data\MDrivenServerOverride.xml

A local pair can use an override like this:

<?xml version="1.0" encoding="utf-8"?>
<root>
  <MDrivenServerOverride MDrivenServerPWD="123456">http://localhost:5000</MDrivenServerOverride>
</root>

The LocalServers UI in MDriven Designer manages this configuration for the pair. Use the UI rather than editing the file unless you need to inspect or troubleshoot the configured address.

LocalServers compared with Local Turnkey Prototyper

Choose LocalServers when you need the behavior of MDrivenServer, including database evolution and server-side actions. Choose the Local Turnkey Prototyper when you only need a fast preview of how the UI renders.

Capability	LocalServers	Local Turnkey Prototyper
Processes	MDrivenServer and MDriven Turnkey run as a pair.	Turnkey runs alone.
Model source	You upload the model to MDrivenServer.	Turnkey uses a specified `.modlr` or `.ecomdl` file.
Persistence	MDrivenServer uses its local database.	Uses XML persistence.
Database evolution	Supported when the model is uploaded.	Not part of the prototype round trip.
Server-side actions	Supported.	Not supported.

The prototyper configuration identifies the model and enables asset copying on startup, for example:

<?xml version="1.0" encoding="utf-8"?>
<root>
  <MDrivenServerOverride PrototypeWithMDrivenDesignerInPath="C:\&lt;PathToModlrFile&gt;.Modlr" CopyAssetsTKOnStart="True"/>
</root>

Use HTTP or HTTPS

HTTPS protects traffic between two parties, but local HTTPS requires a trusted developer certificate. For a local-only development setup, you can run the Core servers over HTTP by passing -nohttps.

AppCompleteGenericCore.exe -host=10.186.18.39 -port=5019 -nohttps
AppCompleteGenericCore.exe -host=jumpdev_hk.yourdomain.com -port=5019 -nohttps

Builds after 2021-04-05 support this HTTP option for both Turnkey Core and MDrivenServer Core. If you need HTTPS without browser security warnings, follow Documentation:LocalhostDevCert.

If another computer must reach a local server, add a Windows Firewall inbound rule for the port you selected. Local HTTP is appropriate for local development; assess network exposure before making a local server reachable from other machines.

Troubleshooting

The package download fails in MDriven Designer

Some networks prevent the in-app download. Download the packages manually in Edge or Chrome instead:

Copy the download URLs for both MDrivenServer Core and MDriven Turnkey Core from MDriven Designer.
Download both files in the browser.
If Cisco Umbrella interrupts the download, resume it in the browser if the browser offers that option.
Copy the files to C:\Users\<username>\Documents\MDrivenServers\.
Rename the downloaded files to MDrivenServerCore.zip and MDrivenTurnkeyCore.zip by removing the date portion of each filename.
Return to the LocalServers UI and refresh or install the server pair.

A pair does not start after refresh or installation

A file lock can prevent an executable from starting after a refresh or install. Close MDriven Designer, start it again, and then start the pair.

The server-status check times out

Confirm that both command windows are still open and that the MDrivenServer address and port match the running pair. Closing the MDrivenServer command window stops that server; a subsequent status check against its address should time out.

Turnkey cannot connect to the backend

Verify that MDrivenServer starts before Turnkey and that the MDrivenServer address in the active connection matches the pair's configured address. Inspect MDrTurnkey\App_Data\MDrivenServerOverride.xml if you need to confirm the value written by the LocalServers UI.

Local UI assets are part of your source tree

When developing Turnkey assets such as SCSS, CSS, or EXT_Components, use directory symbolic links so the local Turnkey installation can find source-controlled assets without copying them into its file tree. See Documentation:Turnkey local development tips.

Contents